breadcrumbs 0.1.0

data/README.rdoc

@@ -0,0 +1,92 @@
+= Breadcrumbs
+
+Breadcrumbs is a simple plugin that adds a +breadcrumbs+ object to controllers and views.
+
+== Instalation
+
+Just run <tt>sudo gem install breadcrumbs</tt>
+
+== Usage
+
+On your controller (optional):
+
+  class ApplicationController < ActionController::Base
+    before_filter :add_initial_breadcrumbs
+
+    private
+    def add_initial_breadcrumbs
+      breadcrumbs.add 'Home', root_path
+    end
+  end
+
+  class ThingsController < ApplicationController
+    def index
+      breadcrumbs.add 'Things', things_path
+    end
+  end
+
+You don't need to provide an URL; in that case, a span will be generated
+instead of a link:
+
+  breadcrumbs.add 'Some page'
+
+You can set additional HTML attributes if you need to:
+
+  breadcrumbs.add 'Home', root_path, :id => 'home', :title => 'Go to the home page'
+
+On your view (possibly application.html.erb):
+
+  <%= breadcrumbs.render %>
+
+You can render as inline links.
+
+  <%= breadcrumbs.render(:format => :inline) %>
+
+You can set your own separator:
+
+  <p>
+    You are here: <%= breadcrumbs.render(:format => :inline, :separator => '|') %>
+  </p>
+
+=== I18n
+
+Breadcrumbs is integrated with I18n. You can set translations like:
+
+  en:
+    breadcrumbs:
+      home: "Home"
+
+And then you just call
+
+  breadcrumbs.add :home
+
+In fact, you can provide any scope you want.
+
+  breadcrumbs.add "titles.home"
+
+== Maintainer
+
+* Nando Vieira - http://simplesideias.com.br
+
+License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/breadcrumbs.rb

@@ -0,0 +1,50 @@
+require "i18n" unless defined?(I18n)
+require "breadcrumbs/render"
+require "breadcrumbs/action_controller_ext" if defined?(ActionController)
+
+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 = {})
+    items << [translate(text), url, options]
+  end
+
+  # 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(:id => "breadcrumbs")
+  #   breadcrumbs.render(:class => "breadcrumbs")
+  #
+  def render(options = {})
+    if options[:format] == :inline
+      Breadcrumbs::Render::Inline.new(self, options).render
+    else
+      Breadcrumbs::Render::List.new(self, options).render
+    end
+  end
+
+  alias :<< :add
+
+  def translate(scope) # :nodoc:
+    text = I18n.t(scope, :scope => :breadcrumbs, :raise => true) rescue nil
+    text ||= I18n.t(scope, :default => scope)
+    text
+  end
+end

data/lib/breadcrumbs/action_controller_ext.rb

@@ -0,0 +1,13 @@
+class Breadcrumbs
+  module ActionController # :nodoc: all
+    def self.included(base)
+      base.send :helper_method, :breadcrumbs
+    end
+
+    def breadcrumbs
+      @breadcrumbs ||= Breadcrumbs.new
+    end
+  end
+end
+
+ActionController::Base.send :include, Breadcrumbs::ActionController

data/lib/breadcrumbs/render.rb

@@ -0,0 +1,3 @@
+require "breadcrumbs/render/base"
+require "breadcrumbs/render/inline"
+require "breadcrumbs/render/list"

data/lib/breadcrumbs/render/base.rb

@@ -0,0 +1,31 @@
+class Breadcrumbs
+  module Render
+    class Base # :nodoc: all
+      attr_accessor :breadcrumbs
+      attr_accessor :default_options
+
+      def initialize(breadcrumbs, default_options = {})
+        @breadcrumbs = breadcrumbs
+        @default_options = default_options
+      end
+
+      # Build a HTML tag.
+      #
+      #   tag(:p, "Hello!")
+      #   tag(:p, "Hello!", :class => "hello")
+      #   tag(:p, :class => "phrase") { "Hello" }
+      #
+      def tag(name, *args, &block)
+        options = args.pop if args.last.kind_of?(Hash)
+        options ||= {}
+
+        content = args.first
+        content = self.instance_eval(&block) if block_given?
+
+        attrs = " " + options.collect {|n, v| %[%s="%s"] % [n, v] }.join(" ") unless options.empty?
+
+        %[<#{name}#{attrs}>#{content}</#{name}>]
+      end
+    end
+  end
+end

data/lib/breadcrumbs/render/inline.rb

@@ -0,0 +1,40 @@
+class Breadcrumbs
+  module Render
+    class Inline < Base # :nodoc: all
+      def render
+        options = {:class => "breadcrumbs", :separator => "&#187;"}.merge(default_options)
+
+        html = []
+        items = breadcrumbs.items
+        size = items.size
+
+        items.each_with_index do |item, i|
+          html << render_item(item, i, size)
+        end
+
+        separator = tag(:span, options[:separator], :class => "separator")
+
+        html.join(" #{separator} ")
+      end
+
+      def render_item(item, i, size)
+        text, url, options = *item
+        options[:class] ||= ""
+
+        css = []
+        css << "first" if i == 0
+        css << "last" if i == size - 1
+        css << "item-#{i}"
+
+        options[:class] << " #{css.join(" ")}"
+        options[:class].gsub!(/^ *(.*?)$/, '\\1')
+
+        if url
+          text = tag(:a, text, options.merge(:href => url))
+        else
+          text = tag(:span, text, options)
+        end
+      end
+    end
+  end
+end

data/lib/breadcrumbs/render/list.rb

@@ -0,0 +1,34 @@
+class Breadcrumbs
+  module Render
+    class List < Base # :nodoc: all
+      def render
+        options = {:class => "breadcrumbs"}.merge(default_options)
+
+        tag(:ul, options) do
+          html = ""
+          items = breadcrumbs.items
+          size = items.size
+
+          items.each_with_index do |item, i|
+            html << render_item(item, i, size)
+          end
+
+          html
+        end
+      end
+
+      def render_item(item, i, size)
+        css = []
+        css << "first" if i == 0
+        css << "last" if i == size - 1
+        css << "item-#{i}"
+
+        text, url, options = *item
+
+        text = tag(:a, text, options.merge(:href => url)) if url
+
+        tag(:li, text, :class => css.join(" "))
+      end
+    end
+  end
+end

data/lib/breadcrumbs/version.rb

@@ -0,0 +1,8 @@
+class Breadcrumbs
+  module Version # :nodoc: all
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/test/breadcrumbs_test.rb

@@ -0,0 +1,152 @@
+require "test_helper"
+
+class BreadcrumbsTest < Test::Unit::TestCase
+  def setup
+    @breadcrumbs = Breadcrumbs.new
+    @inline = Breadcrumbs::Render::Inline.new(@breadcrumbs)
+  end
+
+  def test_add_item
+    @breadcrumbs.add "Home"
+    assert_equal 1, @breadcrumbs.items.count
+
+    @breadcrumbs << "Home"
+    assert_equal 2, @breadcrumbs.items.count
+  end
+
+  def test_tag
+    assert_equal "<span>Hi!</span>", @inline.tag(:span, "Hi!")
+  end
+
+  def test_tag_with_attributes
+    expected = %[<span class="greetings" id="hi">Hi!</span>]
+    assert_equal expected, @inline.tag(:span, "Hi!", :class => "greetings", :id => "hi")
+  end
+
+  def test_tag_with_block
+    assert_equal "<span>Hi!</span>", @inline.tag(:span) { "Hi!" }
+  end
+
+  def test_tag_with_block_and_attributes
+    expected = %[<span class="greetings" id="hi">Hi!</span>]
+    assert_equal expected, @inline.tag(:span, :class => "greetings", :id => "hi") { "Hi!" }
+  end
+
+  def test_nested_tags
+    expected = %[<span class="greetings"><strong id="hi">Hi!</strong></span>]
+    actual = @inline.tag(:span, :class => "greetings") { tag(:strong, "Hi!", :id => "hi") }
+    assert_equal expected, actual
+  end
+
+  def test_render_as_list
+    @breadcrumbs.add "Home", "/", :class => "home"
+    html = Nokogiri::HTML(@breadcrumbs.render)
+
+    assert_not_nil html.at("ul.breadcrumbs")
+  end
+
+  def test_render_as_list_with_custom_attributes
+    @breadcrumbs.add "Home", "/", :class => "home"
+    html = Nokogiri::HTML(@breadcrumbs.render(:id => "breadcrumbs", :class => "top"))
+
+    assert_not_nil html.at("ul.top#breadcrumbs")
+  end
+
+  def test_render_as_list_add_items
+    @breadcrumbs.add "Home", "/", :class => "home"
+    @breadcrumbs.add "About", "/about", :class => "about"
+    @breadcrumbs.add "People"
+
+    html = Nokogiri::HTML(@breadcrumbs.render)
+    items = html.search("li")
+
+    assert_equal 3, items.count
+
+    assert_equal "first item-0", items[0]["class"]
+    assert_equal "Home", items[0].inner_text
+
+    link = items[0].at("a")
+    assert_equal "home", link["class"]
+    assert_equal "/", link["href"]
+
+    assert_equal "item-1", items[1]["class"]
+    assert_equal "About", items[1].inner_text
+
+    link = items[1].at("a")
+    assert_equal "about", link["class"]
+    assert_equal "/about", link["href"]
+
+    assert_equal "last item-2", items[2]["class"]
+    assert_equal "People", items[2].inner_text
+    assert_nil items[2].at("a")
+  end
+
+  def test_render_inline
+    @breadcrumbs.add "Home", "/", :class => "home"
+    html = Nokogiri::HTML(@breadcrumbs.render(:format => :inline))
+
+    assert_nil html.at("ul.breadcrumbs")
+  end
+
+  def test_render_inline_add_items
+    @breadcrumbs.add "Home", "/", :class => "home"
+    @breadcrumbs.add "About", "/about", :class => "about"
+    @breadcrumbs.add "People"
+
+    html = @breadcrumbs.render(:format => :inline)
+    html = Nokogiri::HTML("<div>#{html}</div>")
+    separator = Nokogiri::HTML("<span>&#187;</span>").at("span").inner_text
+
+    items = html.search("div *")
+
+    assert_equal 5, items.count
+
+    assert_equal "a", items[0].name
+    assert_equal "home first item-0", items[0]["class"]
+    assert_equal "Home", items[0].inner_text
+    assert_equal "/", items[0]["href"]
+
+    assert_equal "span", items[1].name
+    assert_equal "separator", items[1]["class"]
+    assert_equal separator, items[1].inner_text
+
+    assert_equal "a", items[2].name
+    assert_equal "about item-1", items[2]["class"]
+    assert_equal "About", items[2].inner_text
+    assert_equal "/about", items[2]["href"]
+
+    assert_equal "span", items[3].name
+    assert_equal "separator", items[3]["class"]
+    assert_equal separator, items[3].inner_text
+
+    assert_equal "span", items[4].name
+    assert_equal "last item-2", items[4]["class"]
+    assert_equal "People", items[4].inner_text
+  end
+
+  def test_render_inline_with_custom_separator
+    @breadcrumbs.add "Home", "/", :class => "home"
+    @breadcrumbs.add "People"
+
+    html = Nokogiri::HTML(@breadcrumbs.render(:format => :inline, :separator => "|"))
+
+    assert_equal "|", html.at("span.separator").inner_text
+  end
+
+  def test_render_internationalized_text_using_default_scope
+    @breadcrumbs.add :home
+    @breadcrumbs.add :people
+
+    html = Nokogiri::HTML(@breadcrumbs.render)
+
+    items = html.search("li")
+
+    assert_equal "Página inicial", items[0].inner_text
+    assert_equal "Nosso time", items[1].inner_text
+  end
+
+  def test_pimp_action_controller
+    methods = ActionController::Base.instance_methods
+    assert (methods.include?(:breadcrumbs) || methods.include?("breadcrumbs"))
+  end
+end

data/test/resources/pt.yml

@@ -0,0 +1,6 @@
+pt:
+  people: "Nosso time"
+
+  breadcrumbs:
+    home: "Página inicial"
+    about: "Sobre"

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "test/unit"
+require "nokogiri"
+require "action_controller"
+
+require "breadcrumbs"
+
+I18n.load_path << File.dirname(__FILE__) + "/resources/pt.yml"
+I18n.locale = :pt

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: breadcrumbs
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-24 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Breadcrumbs is a simple plugin that adds a `breadcrumbs` object to controllers and views.
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/breadcrumbs.rb
+- lib/breadcrumbs/action_controller_ext.rb
+- lib/breadcrumbs/render.rb
+- lib/breadcrumbs/render/base.rb
+- lib/breadcrumbs/render/inline.rb
+- lib/breadcrumbs/render/list.rb
+- lib/breadcrumbs/version.rb
+- test/breadcrumbs_test.rb
+- test/resources/pt.yml
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fnando/games_radar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Breadcrumbs is a simple plugin that adds a `breadcrumbs` object to controllers and views.
+test_files: 
+- test/breadcrumbs_test.rb
+- test/test_helper.rb