module RailsGuides::Helpers - rails-4.2.4 Documentation

# module RailsGuides::Helpers

### Public Instance Methods

author(name, nick, image = 'credits_pic_blank.gif', &block) click to toggle source

    # File guides/rails_guides/helpers.rb, line 39
    def author(name, nick, image = 'credits_pic_blank.gif', &block)
      image = "images/#{image}"

      result = tag(:img, :src => image, :class => 'left pic', :alt => name, :width => 91, :height => 91)
      result << content_tag(:h3, name)
      result << content_tag(:p, capture(&block))
      content_tag(:div, result, :class => 'clearfix', :id => nick)
    end

code(&block) click to toggle source

    # File guides/rails_guides/helpers.rb, line 48
    def code(&block)
      c = capture(&block)
      content_tag(:code, c)
    end

docs_for_menu(position=nil) click to toggle source

    # File guides/rails_guides/helpers.rb, line 29
    def docs_for_menu(position=nil)
      if position.nil?
        documents_by_section
      elsif position == 'L'
        documents_by_section.to(3)
      else
        documents_by_section.from(4)
      end
    end

documents_by_section() click to toggle source

    # File guides/rails_guides/helpers.rb, line 17
    def documents_by_section
      @documents_by_section ||= YAML.load_file(File.expand_path('../../source/documents.yaml', __FILE__))
    end

documents_flat() click to toggle source

    # File guides/rails_guides/helpers.rb, line 21
    def documents_flat
      documents_by_section.flat_map {|section| section['documents']}
    end

finished_documents(documents) click to toggle source

    # File guides/rails_guides/helpers.rb, line 25
    def finished_documents(documents)
      documents.reject { |document| document['work_in_progress'] }
    end

guide(name, url, options = {}, &block) click to toggle source

    # File guides/rails_guides/helpers.rb, line 5
    def guide(name, url, options = {}, &block)
      link = content_tag(:a, :href => url) { name }
      result = content_tag(:dt, link)

      if options[:work_in_progress]
        result << content_tag(:dd, 'Work in progress', :class => 'work-in-progress')
      end

      result << content_tag(:dd, capture(&block))
      result
    end