Contents

require "i18n"
require "breadcrumbs/render"
require "breadcrumbs/action_controller_ext" if defined?(ActionController)
require "active_support/inflector"

class Breadcrumbs
  attr_accessor :items

  def initialize # :nodoc:
    self.items = []
  end

  # Add a new breadcrumbs.
  #
  #   breadcrumbs.add 'Home'
  #   breadcrumbs.add 'Home', '/'
  #   breadcrumbs.add 'Home', '/', class: 'home'
  #
  # If you provide a symbol as text, it will try to
  # find it as I18n scope.
  #
  def add(text, url = nil, options = {})
    options = {i18n: true}.merge(options)
    text = translate(text) if options.delete(:i18n)
    items << [text.to_s, url, options]
  end

  alias :<< :add

  # Render breadcrumbs using the specified format.
  # Use HTML lists by default, but can be plain links.
  #
  #   breadcrumbs.render
  #   breadcrumbs.render(format: 'inline')
  #   breadcrumbs.render(format: 'inline', separator: '|')
  #   breadcrumbs.render(format: 'list')
  #   breadcrumbs.render(format: 'ordered_list')
  #   breadcrumbs.render(id: 'breadcrumbs')
  #   breadcrumbs.render(class: 'breadcrumbs')
  #
  # You can also define your own formatter. Just create a class that implements a +render+ instance
  # method and you're good to go.
  #
  #   class Breadcrumbs::Render::Dl
  #     def render
  #       # return breadcrumbs wrapped in a <DL> tag
  #     end
  #   end
  #
  # To use your new format, just provide the <tt>:format</tt> option.
  #
  #   breadcrumbs.render(format: 'dl')
  #
  def render(options = {})
    options[:format] ||= :list

    klass_name = options.delete(:format).to_s.classify
    klass = Breadcrumbs::Render.const_get(klass_name)
    html = klass.new(self, options).render

    html.respond_to?(:html_safe) ? html.html_safe : html
  end

  def translate(scope) # :nodoc:
    text = I18n.t(scope, scope: 'breadcrumbs', raise: true) rescue nil
    text ||= I18n.t(scope, default: scope.to_s) rescue scope
    text
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
breadcrumbs-0.1.7	lib/breadcrumbs.rb