easycrumbs 1.0.0 → 1.1.0

data/README.rdoc

@@ -187,5 +187,41 @@ By default last element will always be render as hyperlink. If you would like to
   breadcrumbs :last_link => true
   <a href="/actors"/>Actors</a> > <a href="/actors/1/edit">Edit Leonardo Di Caprio</a>
   
+== Custom collection
+If you do not like idea that breadcrumbs are recognized using routes.rb file then you can write your own breadcrumbs generator.
+Create new class inherited from EasyCrumbs::Collection or just monkey patch initialize method from EasyCrumbs::Collection
+
+Look at example for acts_as_tree gem
+
+  class EasyCrumbs::Collection
+    def initialize(request, options = {})
+      object = options[:object]
+      collection = []
+      path = {:action => 'show', :controller => 'people'}
+
+      while(!object.nil?)
+        collection << Breadcrumb.new(object, options.merge(:path => path.merge(:id => object.id)))
+        object = object.parent
+      end
+      @breadcrumbs = collection.reverse
+    end
+  end
+  
+* you will get request object and options hash from view helper(look at lib/easycrumbs/view_helpers.rb for more details)
+* you have to set @breadcrumbs as collection of EasyCrumbs::Breadcrumb objects
+* remember to pass options hash to every EasyCrumbs::Breadcrumb object
+* path have to be a hash and has to be recognized by rails routing system 
+ 
+For objects:
+  grandfather = Person.create, :breadcrumb => "Grandfather"
+  father = Person.create :parent => grandfather, :breadcrumb => "Father"
+  son = Person.create :parent => father, :breadcrumb => "Son"
+The code:
+  breadcrumbs, :last_link => false
+will generate this:
+  <a href="/people/1">Grandfather</a> > <a href="/people/2">Father</a> > Son
+  
+Look at code at tests for more details
+  
 == Copyright
 Copyright (c) 2010 Stanisław Kolarzowski. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/easycrumbs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easycrumbs}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stanis\305\202aw Kolarzowski"]
-  s.date = %q{2010-10-30}
+  s.date = %q{2010-10-31}
   s.description = %q{Easy breadcrumbs for your website}
   s.email = %q{stanislaw.kolarzowski@gmail.com}
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/easycrumbs/view_helpers.rb",
      "test/helper.rb",
      "test/routes.rb",
+     "test/test_custom_collection.rb",
      "test/test_easycrumbs.rb"
   ]
   s.homepage = %q{http://github.com/staszek/easycrumbs}
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/routes.rb",
+     "test/test_custom_collection.rb",
      "test/test_easycrumbs.rb"
   ]
 

data/test/test_custom_collection.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class CustomCollection < EasyCrumbs::Collection
+  def initialize(request, options = {})
+    object = options[:object]
+    collection = []
+    path = {:action => 'show', :controller => 'countries'}
+
+    while(!object.nil?)
+      collection << Breadcrumb.new(object, options.merge(:path => path.merge(:id => object.id)))
+      object = object.parent
+    end
+    @breadcrumbs = collection.reverse
+  end
+end
+
+class TestCustomCollection < Test::Unit::TestCase
+  context "Custom collection tests" do
+    setup do
+      @usa = Country.create(:breadcrumb => "USA")
+      @usa_son = Country.create(:breadcrumb => "USA son")
+      @usa_grandson = Country.create(:breadcrumb => "USA grandson")
+
+      @usa_grandson.stubs(:parent => @usa_son, :id => 3)
+      @usa_son.stubs(:parent => @usa, :id => 2)
+      @usa.stubs(:parent => nil, :id => 1)
+    end
+
+    context "Collection of breadcrumbs" do
+      should "reurned names be proper" do
+        result = ['USA', "USA son", "USA grandson"]
+        assert_equal(result, CustomCollection.new('request object', {:object => @usa_grandson}).breadcrumbs.map(&:name))
+      end
+
+      should "reurned paths be proper" do
+        result = ['/countries/1', "/countries/2", "/countries/3"]
+        assert_equal(result, CustomCollection.new('request object', {:object => @usa_grandson}).breadcrumbs.map(&:path))
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: easycrumbs
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Stanis\xC5\x82aw Kolarzowski"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 +02:00
+date: 2010-10-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - lib/easycrumbs/view_helpers.rb
 - test/helper.rb
 - test/routes.rb
+- test/test_custom_collection.rb
 - test/test_easycrumbs.rb
 has_rdoc: true
 homepage: http://github.com/staszek/easycrumbs
@@ -94,4 +95,5 @@ summary: Easy breadcrumbs
 test_files: 
 - test/helper.rb
 - test/routes.rb
+- test/test_custom_collection.rb
 - test/test_easycrumbs.rb