breadcrumbs 0.1.4 → 0.1.5

data/README.rdoc

@@ -52,6 +52,19 @@ You can set your own separator:
     You are here: <%= breadcrumbs.render(:format => :inline, :separator => '|') %>
   </p>
 
+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)
+
 === I18n
 
 Breadcrumbs is integrated with I18n. You can set translations like:

data/lib/breadcrumbs.rb

@@ -1,6 +1,7 @@
 require "i18n" unless defined?(I18n)
 require "breadcrumbs/render"
 require "breadcrumbs/action_controller_ext" if defined?(ActionController)
+require "active_support/inflector"
 
 class Breadcrumbs
   attr_accessor :items
@@ -24,6 +25,8 @@ class Breadcrumbs
     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.
   #
@@ -35,15 +38,28 @@ class Breadcrumbs
   #   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 = {})
-    if options[:format] == :inline
-      Breadcrumbs::Render::Inline.new(self, options).render
-    else
-      Breadcrumbs::Render::List.new(self, options).render
-    end
-  end
+    options[:format] ||= :list
 
-  alias :<< :add
+    klass_name = options[: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

data/lib/breadcrumbs/render.rb

@@ -1,3 +1,8 @@
-require "breadcrumbs/render/base"
-require "breadcrumbs/render/inline"
-require "breadcrumbs/render/list"
+class Breadcrumbs
+  module Render
+    autoload :Base,         "breadcrumbs/render/base"
+    autoload :Inline,       "breadcrumbs/render/inline"
+    autoload :List,         "breadcrumbs/render/list"
+    autoload :OrderedList,  "breadcrumbs/render/ordered_list"
+  end
+end

data/lib/breadcrumbs/render/base.rb

@@ -26,6 +26,15 @@ class Breadcrumbs
 
         %[<#{name}#{attrs}>#{content}</#{name}>]
       end
+
+      protected
+      def wrap_item(url, text, options)
+        if url
+          tag(:a, text, options.merge(:href => url))
+        else
+          tag(:span, text, options)
+        end
+      end
     end
   end
 end

data/lib/breadcrumbs/render/inline.rb

@@ -29,13 +29,7 @@ class Breadcrumbs
         options[:class] << " #{css.join(" ")}"
         options[:class].gsub!(/^ *(.*?)$/, '\\1')
 
-        text = CGI.escapeHTML(text)
-
-        if url
-          text = tag(:a, text, options.merge(:href => url))
-        else
-          text = tag(:span, text, options)
-        end
+        wrap_item(url, CGI.escapeHTML(text), options)
       end
     end
   end

data/lib/breadcrumbs/render/list.rb

@@ -3,12 +3,9 @@ class Breadcrumbs
     class List < Base # :nodoc: all
       def render
         options = {
-          :class => "breadcrumbs",
-          :format => :list
+          :class => "breadcrumbs"
         }.merge(default_options)
 
-        list_style = options[:format] == :list ? :ul : :ol
-
         tag(list_style, options) do
           html = ""
           items = breadcrumbs.items
@@ -22,6 +19,10 @@ class Breadcrumbs
         end
       end
 
+      def list_style
+        :ul
+      end
+
       def render_item(item, i, size)
         css = []
         css << "first" if i == 0
@@ -29,9 +30,7 @@ class Breadcrumbs
         css << "item-#{i}"
 
         text, url, options = *item
-        text = CGI.escapeHTML(text)
-        text = tag(:a, text, options.merge(:href => url)) if url
-
+        text = wrap_item(url, CGI.escapeHTML(text), options)
         tag(:li, text, :class => css.join(" "))
       end
     end

data/lib/breadcrumbs/render/ordered_list.rb

@@ -0,0 +1,9 @@
+class Breadcrumbs
+  module Render
+    class OrderedList < List # :nodoc: all
+      def list_style
+        :ol
+      end
+    end
+  end
+end

data/lib/breadcrumbs/version.rb

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

data/test/breadcrumbs_test.rb

@@ -6,6 +6,13 @@ class BreadcrumbsTest < Test::Unit::TestCase
     @inline = Breadcrumbs::Render::Inline.new(@breadcrumbs)
   end
 
+  def test_return_safe_html
+    html_mock = mock
+    html_mock.expects(:html_safe).once
+    Breadcrumbs::Render::List.any_instance.stubs(:render).returns(html_mock)
+    @breadcrumbs.render(:format => :list)
+  end
+
   def test_add_item
     @breadcrumbs.add "Home"
     assert_equal 1, @breadcrumbs.items.count
@@ -86,6 +93,7 @@ class BreadcrumbsTest < Test::Unit::TestCase
     assert_equal "last item-2", items[2]["class"]
     assert_equal "People", items[2].inner_text
     assert_nil items[2].at("a")
+    assert_not_nil items[2].at("span")
   end
 
   def test_render_inline

data/test/test_helper.rb

@@ -1,8 +1,10 @@
 require "rubygems"
+gem "test-unit"
 require "test/unit"
 require "cgi"
 require "nokogiri"
 require "action_controller"
+require "mocha"
 
 require "breadcrumbs"
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: breadcrumbs
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Nando Vieira
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 -03:00
+date: 2010-08-26 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +35,7 @@ files:
 - lib/breadcrumbs/render/base.rb
 - lib/breadcrumbs/render/inline.rb
 - lib/breadcrumbs/render/list.rb
+- lib/breadcrumbs/render/ordered_list.rb
 - lib/breadcrumbs/version.rb
 - test/breadcrumbs_test.rb
 - test/resources/pt.yml
@@ -43,21 +50,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Breadcrumbs is a simple plugin that adds a `breadcrumbs` object to controllers and views.