class RailsGuides::Generator - rails-4.2.4 Documentation

# class RailsGuides::Generator

### Constants

GUIDES_RE

### Attributes

all[R]
edge[R]
guides_dir[R]
output_dir[R]
source_dir[R]
warnings[R]

### Public Class Methods

new(output=nil) click to toggle source

    # File guides/rails_guides/generator.rb, line 70
    def initialize(output=nil)
      set_flags_from_environment

      if kindle?
        check_for_kindlegen
        register_kindle_mime_types
      end

      initialize_dirs(output)
      create_output_dir_if_needed
    end

### Public Instance Methods

generate() click to toggle source

    # File guides/rails_guides/generator.rb, line 96
    def generate
      generate_guides
      copy_assets
      generate_mobi if kindle?
    end

register_kindle_mime_types() click to toggle source

    # File guides/rails_guides/generator.rb, line 91
    def register_kindle_mime_types
      Mime::Type.register_alias("application/xml", :opf, %w(opf))
      Mime::Type.register_alias("application/xml", :ncx, %w(ncx))
    end

set_flags_from_environment() click to toggle source

    # File guides/rails_guides/generator.rb, line 82
    def set_flags_from_environment
      @edge     = ENV['EDGE']     == '1'
      @warnings = ENV['WARNINGS'] == '1'
      @all      = ENV['ALL']      == '1'
      @kindle   = ENV['KINDLE']   == '1'
      @version  = ENV['RAILS_VERSION'] || 'local'
      @lang     = ENV['GUIDES_LANGUAGE']
    end

### Private Instance Methods

check_for_kindlegen() click to toggle source

    # File guides/rails_guides/generator.rb, line 108
    def check_for_kindlegen
      if %x`which kindlegen`.blank?
        raise "Can't create a kindle version without `kindlegen`."
      end
    end

check_fragment_identifiers(html, anchors) click to toggle source

    # File guides/rails_guides/generator.rb, line 236
    def check_fragment_identifiers(html, anchors)
      html.scan(/<a\s+href="#([^"]+)/).flatten.each do |fragment_identifier|
        next if fragment_identifier == 'mainCol' # in layout, jumps to some DIV
        unless anchors.member?(fragment_identifier)
          guess = anchors.min { |a, b|
            Levenshtein.distance(fragment_identifier, a) <=> Levenshtein.distance(fragment_identifier, b)
          }
          puts "*** BROKEN LINK: ##{fragment_identifier}, perhaps you meant ##{guess}."
        end
      end
    end

copy_assets() click to toggle source

    # File guides/rails_guides/generator.rb, line 168
    def copy_assets
      FileUtils.cp_r(Dir.glob("#{guides_dir}/assets/*"), output_dir)
    end

create_output_dir_if_needed() click to toggle source

    # File guides/rails_guides/generator.rb, line 137
    def create_output_dir_if_needed
      FileUtils.mkdir_p(output_dir)
    end

extract_anchors(html) click to toggle source

    # File guides/rails_guides/generator.rb, line 219
    def extract_anchors(html)
      # Markdown generates headers with IDs computed from titles.
      anchors = Set.new
      html.scan(/<h\d\s+id="([^"]+)/).flatten.each do |anchor|
        if anchors.member?(anchor)
          puts "*** DUPLICATE ID: #{anchor}, please make sure that there're no headings with the same name at the same level."
        else
          anchors << anchor
        end
      end

      # Footnotes.
      anchors += Set.new(html.scan(/<p\s+class="footnote"\s+id="([^"]+)/).flatten)
      anchors += Set.new(html.scan(/<sup\s+class="footnote"\s+id="([^"]+)/).flatten)
      return anchors
    end

generate?(source_file, output_file) click to toggle source

    # File guides/rails_guides/generator.rb, line 184
    def generate?(source_file, output_file)
      fin  = File.join(source_dir, source_file)
      fout = output_path_for(output_file)
      all || !File.exist?(fout) || File.mtime(fout) < File.mtime(fin)
    end

generate_guide(guide, output_file) click to toggle source

    # File guides/rails_guides/generator.rb, line 190
    def generate_guide(guide, output_file)
      output_path = output_path_for(output_file)
      puts "Generating #{guide} as #{output_file}"
      layout = kindle? ? 'kindle/layout' : 'layout'

      File.open(output_path, 'w') do |f|
        view = ActionView::Base.new(source_dir, :edge => @edge, :version => @version, :mobi => "kindle/#{mobi}")
        view.extend(Helpers)

        if guide =~ /\.(\w+)\.erb$/
          # Generate the special pages like the home.
          # Passing a template handler in the template name is deprecated. So pass the file name without the extension.
          result = view.render(:layout => layout, :formats => [$1], :file => $`)
        else
          body = File.read(File.join(source_dir, guide))
          result = RailsGuides::Markdown.new(view, layout).render(body)

          warn_about_broken_links(result) if @warnings
        end

        f.write(result)
      end
    end

generate_guides() click to toggle source

    # File guides/rails_guides/generator.rb, line 141
    def generate_guides
      guides_to_generate.each do |guide|
        output_file = output_file_for(guide)
        generate_guide(guide, output_file) if generate?(guide, output_file)
      end
    end

generate_mobi() click to toggle source

    # File guides/rails_guides/generator.rb, line 114
    def generate_mobi
      require 'rails_guides/kindle'
      out = "#{output_dir}/kindlegen.out"
      Kindle.generate(output_dir, mobi, out)
      puts "(kindlegen log at #{out})."
    end

guides_to_generate() click to toggle source

    # File guides/rails_guides/generator.rb, line 148
    def guides_to_generate
      guides = Dir.entries(source_dir).grep(GUIDES_RE)

      if kindle?
        Dir.entries("#{source_dir}/kindle").grep(GUIDES_RE).map do |entry|
          next if entry == 'KINDLE.md'
          guides << "kindle/#{entry}"
        end
      end

      ENV.key?('ONLY') ? select_only(guides) : guides
    end

initialize_dirs(output) click to toggle source

    # File guides/rails_guides/generator.rb, line 125
    def initialize_dirs(output)
      @guides_dir = File.join(File.dirname(__FILE__), '..')
      @source_dir = "#@guides_dir/source/#@lang"
      @output_dir = if output
        output
      elsif kindle?
        "#@guides_dir/output/kindle/#@lang"
      else
        "#@guides_dir/output/#@lang"
      end.sub(%r</$>, '')
    end

kindle?() click to toggle source

    # File guides/rails_guides/generator.rb, line 104
    def kindle?
      @kindle
    end

mobi() click to toggle source

    # File guides/rails_guides/generator.rb, line 121
    def mobi
      "ruby_on_rails_guides_#@version%s.mobi" % (@lang.present? ? ".#@lang" : '')
    end

output_file_for(guide) click to toggle source

    # File guides/rails_guides/generator.rb, line 172
    def output_file_for(guide)
      if guide.end_with?('.md')
        guide.sub(/md\z/, 'html')
      else
        guide.sub(/\.erb\z/, '')
      end
    end

output_path_for(output_file) click to toggle source

    # File guides/rails_guides/generator.rb, line 180
    def output_path_for(output_file)
      File.join(output_dir, File.basename(output_file))
    end

select_only(guides) click to toggle source

    # File guides/rails_guides/generator.rb, line 161
    def select_only(guides)
      prefixes = ENV['ONLY'].split(",").map(&:strip)
      guides.select do |guide|
        prefixes.any? { |p| guide.start_with?(p) || guide.start_with?("kindle") }
      end
    end

warn_about_broken_links(html) click to toggle source

    # File guides/rails_guides/generator.rb, line 214
    def warn_about_broken_links(html)
      anchors = extract_anchors(html)
      check_fragment_identifiers(html, anchors)
    end