easycrumbs 0.1.0 → 1.0.0

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Easy breadcrumbs for your site
 
-* gemcutter[not yet]
+* gemcutter[http://rubygems.org/gems/easycrumbs]
 * repository[http://github.com/staszek/easycrumbs]
 
 == Installation
@@ -12,11 +12,180 @@ If you don't have the {Gemcutter sources}[http://gemcutter.org/pages/gem_docs] y
 
 To install the gem type:
   gem install easycrumbs
+  
+Add it to your Gemfile
+  gem "easycrumbs"
 
-== Usage
+== Quick start
 
-It does not work yet.
+It is really easy to have breadcrumbs in your project. Just type this into any view file and breadcrumbs will work for you.
+  breadcrumbs
 
-== Copyright
+ERB example:
+  <div id=breadcrumbs>
+    <%= breadcrumbs %>
+  </div>
+HAML example:
+  #breadcrumbs
+    = breadcrumbs
+
+You do not need to specify any more options in models or controllers. Easycrumbs will take everything it needs from your routes.rb file.
+
+The routes.rb file with
+  map.resources :countries do |country|
+    country.resources :movies do |movie|
+      movie.resources :actors
+    end
+  end
+could generate this breadcrumb
+  Home > Countries > Country > Movies > Movie > Actors > Edit Actor
+
+== Model names
+=== From database
+If your model has breadcrumb column in database then it will be used to generate breadcrumbs
+  @usa = Country.new(:breadcrumb => "Usa")
+  @titanic = Movie.new(:breadcrumb => "Titanic")
+  @leo = Actor.new(:breadcumb => "Leonardo Di Caprio")
+
+  Home > Countries > Usa > Movies > Titanic > Actors > Edit Leonardo Di Caprio
+
+You can change column name using :name_column option
+  breadcrumbs :name_column => :seo
+
+  @usa = Country.new(:seo => "Usa")
+  @titanic = Movie.new(:seo => "Titanic")
+  @leo = Actor.new(:seo => "Leonardo Di Caprio")
+
+  Home > Countries > Usa > Movies > Titanic > Actors > Edit Leonardo Di Caprio
+
+=== From custom method
+If you need custom name then just create method named breadcrumb in your model
+  class Actor < ActiveRecord::Base
+    def breadcrumb
+      "the best male actor: " + first_name
+    end
+  end
+
+  Home > Countries > Usa > Movies > Titanic > Actors > Edit the best male actor: Leonardo
+
+=== From i18n
+Easycrumbs fully support i18n
+  breadcrumbs :i18n => true
+
+Name will be taken from this key if your model does not have breadcrumb column or method:
+    breadcrumbs.models.model_name
+Example en.yml
+  en:
+      breadcrumbs:
+          models:
+              country: C0untry
+              movie: M0v13
+              actor: 4ct0r
+
+  Home > Countries > C0untry > Movies > M0v13 > Actors > Edit 4act0r
 
+== Controller names
+===From controller name
+Default behavior is to use controller name
+  class CountriesController < ApplicationController
+  class MoviesController < ApplicationController
+  class ActorsController < ApplicationController
+
+  Home > Countries > Usa > Movies > Titanic > Actors > Edit Leonardo Di Caprio
+
+=== From custom method
+Similar to models you can specify custom breadcrumb method
+  class MoviesController < ApplicationController
+    def breadcrumb
+      "Movies (#{collection.size})"
+    end
+  end
+
+  Home > Countries > Usa > Movies (234) > Titanic > Actors > Edit Leonardo Di Caprio
+
+=== From i18n
+Controller can also use i18n names
+  breadcrumbs :i18n => true
+
+Name will be taken from this key if your controller does not have breadcrumb method:
+    breadcrumbs.controllers.controller_name
+Example en.yml
+  en:
+      breadcrumbs:
+        controllers:
+            application: H0m3
+            countries: C0untr135
+            movies: M0v135
+            actors: 4ct0r5
+
+  H0m3 > C0untr135 > Usa > M0v135 > Titanic > 4ct0r5 > Edit Leonardo Di Caprio
+
+== Action prefixes
+For last element you can add current action name as prefix.
+Example with Editing actor object:
+    Home > Countries > Usa > Movies > Titanic > Actors > Edit Leonardo Di Caprio
+
+=== Default
+For default prefix is added only for new and edit actions.
+      Home > Countries > Usa > Movies > Titanic > Actors > Edit Leonardo Di Caprio
+      Home > Countries > Usa > Movies > Titanic > Actors > New Leonardo Di Caprio
+      
+=== Custom
+You can change this behavior. Just set :prefix option as you want:
+* :every - prefix will be added for every action
+    breadcrumbs :prefix => :every
+    action show => Actors > Show Leonardo Di Caprio
+    action new  => Actors > New Leonardo Di Caprio
+    action edit => Actors > Edit Leonardo Di Caprio
+* :none  - prefix will not be added to any action
+    breadcrumbs :prefix => :none
+    action show => Actors > Leonardo Di Caprio
+    action new  => Actors > Leonardo Di Caprio
+    action edit => Actors > Leonardo Di Caprio
+* array of action names - prefix will be added only for specified actions
+    breadcrumbs :prefix => [:show, :new]
+    action show => Actors > Show Leonardo Di Caprio
+    action new  => Actors > New Leonardo Di Caprio
+    action edit => Actors > Leonardo Di Caprio
+  
+=== From i18n
+Action names can also be taken from i18n
+  breadcrumbs :i18n => true
+  
+Name will be taken from this key:
+  breadcrumbs.actions.action_name
+Example en.yml
+    en:
+        breadcrumbs:
+          actions:
+              new: N3w {{name}}
+              edit: 3d1t {{name}}
+              show: {{name}} 5h0w
+
+== Blank links option
+When path will not be recognized then exception will be raised
+  EasyCrumbs::NoPath
+If you would like to have blank link(just text, without hyperlink) instead then just set :blank_links option
+  breadcrumbs :blank_links => true
+
+== Rendering options
+You can set some rendering options also:
+
+=== Separator
+Default breadcrumbs separator is set to " > ", but you can use something else if you want
+  breadcrumbs :separator => ' ==> '
+  Home ==> Countries ==> Usa ==> Movies ==> Titanic ==> Actors ==> Edit Leonardo Di Caprio
+  
+  breadcrumbs :separator => '/'
+  Home/Countries/Usa/Movies/Titanic/Actors/Edit Leonardo Di Caprio
+
+=== Last element as hyperlink
+By default last element will always be render as hyperlink. If you would like to render it in plain text then use :last_link option
+  breadcrumbs :last_link => false
+  <a href="/actors"/>Actors</a> > Edit Leonardo Di Caprio
+  
+  breadcrumbs :last_link => true
+  <a href="/actors"/>Actors</a> > <a href="/actors/1/edit">Edit Leonardo Di Caprio</a>
+  
+== Copyright
 Copyright (c) 2010 Stanisław Kolarzowski. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/easycrumbs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easycrumbs}
-  s.version = "0.1.0"
+  s.version = "1.0.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-08-08}
+  s.date = %q{2010-10-30}
   s.description = %q{Easy breadcrumbs for your website}
   s.email = %q{stanislaw.kolarzowski@gmail.com}
   s.extra_rdoc_files = [

data/lib/easycrumbs/breadcrumb.rb

@@ -1,24 +1,24 @@
 module EasyCrumbs
   class Breadcrumb
     attr_reader :object, :name, :path
-    
+
     # Breadcrumb object:
     # object  -   just object from application. Could be a model or controller
     # name    -   printed name
     # path    -   path to this object
-    def initialize(object, options = {})      
+    def initialize(object, options = {})
       @object = set_object(object)
       @name = set_name(options)
       @path = set_path(options[:path], options[:blank_links])
     end
-    
-    
+
+
     # Object from application must be a model or controller
     def set_object(object)
       raise EasyCrumbs::InvalidObject unless object.is_a?(ActionController::Base) || object.is_a?(ActiveRecord::Base)
       object
     end
-    
+
     # Set name for model or controller
     def set_name(options = {})
       if object.is_a?(ActiveRecord::Base)
@@ -29,29 +29,36 @@ module EasyCrumbs
       end
       add_prefix(name, options[:action], options[:prefix], options[:i18n])
     end
-    
+
     # Set name for model
     # Model has to have column equal to name_column
     def name_for_model(name_column, i18n)
-      raise EasyCrumbs::NoName.new(@object.class, name_column) unless @object.respond_to? name_column
-      name = @object.send name_column
-      name.nil? ? name_for_nil(@object, i18n) : name
-    end
-    
-    # Set name for object if it is nil
-    def name_for_nil(object, i18n)
-      i18n == true ? I18n.t("breadcrumbs.models.#{object.class.to_s.downcase}") : @object.class.to_s
+      if @object.respond_to? name_column
+        @object.send name_column
+      else
+        i18n == true ? I18n.t("breadcrumbs.models.#{object.class.to_s.downcase}") : default_model_name
+      end
     end
-    
+
     # Set name for controller
     def name_for_controller(i18n)
       if @object.respond_to? :breadcrumb
         @object.breadcrumb
       else
-        i18n == true ? I18n.t("breadcrumbs.controllers.#{@object.controller_name}") : @object.controller_name.titlecase
+        i18n == true ? I18n.t("breadcrumbs.controllers.#{@object.controller_name}") : default_controller_name
       end
     end
-    
+
+    #Return default name for model object
+    def default_model_name
+      @object.class.to_s
+    end
+
+    # Return default name for controller object
+    def default_controller_name
+      @object.class == ApplicationController ? "Home" : @object.controller_name.titlecase
+    end
+
     # Add specyfic prefix if action is passed
     # prefix =
     # :every               -  add prefix for every action
@@ -75,12 +82,12 @@ module EasyCrumbs
       end
       name
     end
-    
-    # Return name of action. 
+
+    # Return name of action.
     def action_name(action, i18n, name)
       i18n == true ? I18n.t("breadcrumbs.actions.#{action}", :name => name) : "#{action.titlecase} #{name}"
     end
-    
+
     # Set path using hash from ActionController::Routing::Routes.recognize_path
     # Example looks like:
     # {:country_id => "1", :movie_id => "1", :id => "1", :action => "show", :controller => "movies"}
@@ -90,6 +97,6 @@ module EasyCrumbs
         raise EasyCrumbs::NoPath.new(e.message) unless blank_links == true
         nil
     end
-    
+
   end
 end

data/lib/easycrumbs/errors.rb

@@ -4,29 +4,18 @@ module EasyCrumbs
       "object should be Controller(ActionController::Base) or Model(ActiveRecord::Base)"
     end
   end
-  
-  class NoName < StandardError
-    def initialize(object_class, column)
-      @object_class = object_class
-      @column = column
-    end
-    
-    def message
-      "Can not set name. Model #{@object_class} does not have column \"#{@column}\". Try change column name or create \"#{@column}\" method"
-    end
-  end
-  
+
   class NoPath < StandardError
     def initialize(routing_error)
       @routing_error = routing_error
     end
-    
+
     def message
       "Can not set path. You can use :blank_links to return nil for no-recognized pathes. RoutingError: #{@routing_error}"
     end
   end
-  
-  class NotRecognized < StandardError    
+
+  class NotRecognized < StandardError
     def message
       "Can not recognize main path."
     end

data/test/helper.rb

@@ -13,20 +13,19 @@ require 'easycrumbs'
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 ActiveRecord::Base.configurations = true
- 
+
 ActiveRecord::Schema.verbose = false
 ActiveRecord::Schema.define(:version => 1) do
   create_table :countries do |t|
     t.string :name
     t.string :breadcrumb
   end
-  
+
   create_table :movies do |t|
     t.string :name
     t.integer :country_id
-    t.string :breadcrumb
   end
-  
+
   create_table :actors do |t|
     t.string :first_name
     t.string :last_name
@@ -50,7 +49,7 @@ end
 
 class Actor < ActiveRecord::Base
   belongs_to :movie
-  
+
   def breadcrumb
     "#{first_name} #{last_name}"
   end

data/test/test_easycrumbs.rb

@@ -4,7 +4,7 @@ class TestEasycrumbs < Test::Unit::TestCase
   context "EasyCrumbs tests" do
     setup do
       @usa = Country.create(:name => "USA", :breadcrumb => "United States of America")
-      @titanic = @usa.movies.create(:name => "Titanic", :breadcrumb => "Titanic")
+      @titanic = @usa.movies.create(:name => "Titanic")
       @leo = @titanic.actors.create(:first_name => "Leonardo", :last_name => "Di Caprio")
     end
 
@@ -36,7 +36,7 @@ class TestEasycrumbs < Test::Unit::TestCase
 
       context "set name" do
         context "for model" do
-          should "return breadcrumb column by default" do
+          should "return breadcrumb column by default if it has breadcrumb column" do
             assert_equal("United States of America", Breadcrumb.new(@usa).name)
           end
 
@@ -48,15 +48,11 @@ class TestEasycrumbs < Test::Unit::TestCase
             assert_equal("Leonardo Di Caprio", Breadcrumb.new(@leo).name)
           end
 
-          should "raise exception if can not find name" do
-            assert_raise(NoName) {  Breadcrumb.new(@leo, :name_column => "wrong_column")}
-          end
-
-          should "return model name if column return nil" do
+          should "return model name if it not respond to name_column method and i18n is turned off" do
             assert_equal("Movie", Breadcrumb.new(Movie.new).name)
           end
 
-          should "return model name from i18n if column return nil" do
+          should "return model name from i18n if it not respond to name_column method and i18n is turned on" do
             I18n.expects(:t).with("breadcrumbs.models.movie").returns("Das film")
             assert_equal("Das film", Breadcrumb.new(Movie.new, :i18n => true).name)
           end
@@ -67,9 +63,18 @@ class TestEasycrumbs < Test::Unit::TestCase
             assert_equal("Movies", Breadcrumb.new(MoviesController.new).name)
           end
 
+          should "return Home for ApplicationController" do
+            assert_equal("Home", Breadcrumb.new(ApplicationController.new).name)
+          end
+
           should "return breadcrumb method from controller" do
             assert_equal("Countries list", Breadcrumb.new(CountriesController.new).name)
           end
+
+          should "return transalted name for controller when i18n is turned on" do
+            I18n.expects(:t).with("breadcrumbs.controllers.movies").returns("la movies")
+            assert_equal("la movies", Breadcrumb.new(MoviesController.new, :i18n => true).name)
+          end
         end
 
         context "with prefix option" do
@@ -92,15 +97,8 @@ class TestEasycrumbs < Test::Unit::TestCase
           should "return only name if action is not in prefix array" do
             assert_equal("Leonardo Di Caprio", Breadcrumb.new(@leo, :action => "show", :prefix => [:destroy, :edit]).name)
           end
-        end
-
-        context "with i18n enable" do
-          should "return transalted name for controller" do
-            I18n.expects(:t).with("breadcrumbs.controllers.movies").returns("la movies")
-            assert_equal("la movies", Breadcrumb.new(MoviesController.new, :i18n => true).name)
-          end
 
-          should "return transalted action as a prefix" do
+          should "return transalted action as a prefix when i18n is turned on" do
             name = "Leonardo Di Caprio"
             I18n.expects(:t).with("breadcrumbs.actions.edit", {:name => name}).returns("Editzione #{name}")
             assert_equal("Editzione Leonardo Di Caprio", Breadcrumb.new(@leo, :i18n => true, :action => "edit").name)
@@ -293,9 +291,7 @@ class TestEasycrumbs < Test::Unit::TestCase
 
         should "return array of breadcrumbs objects" do
           assert_equal(@collection.objects.size + 1, @results.size)
-          results = @results.map(&:class).uniq
-          assert_equal(1, results.size)
-          assert_equal(EasyCrumbs::Breadcrumb, results.first)
+          @results.map.uniq == [EasyCrumbs::Breadcrumb]
         end
 
         should "last breadcrumb have name with action prefix" do
@@ -305,11 +301,11 @@ class TestEasycrumbs < Test::Unit::TestCase
 
       context "render" do
         setup do
-          @results = [  "<a href=\"/\">Application</a>",
+          @results = [  "<a href=\"/\">Home</a>",
                       "<a href=\"/countries\">Countries list</a>",
                       "<a href=\"/countries/#{@usa.id}\">United States of America</a>",
                       "<a href=\"/countries/#{@usa.id}/movies\">Movies</a>",
-                      "<a href=\"/countries/#{@usa.id}/movies/#{@titanic.id}\">Titanic</a>",
+                      "<a href=\"/countries/#{@usa.id}/movies/#{@titanic.id}\">Movie</a>",
                       "<a href=\"/countries/#{@usa.id}/movies/#{@titanic.id}/actors\">Actors</a>",
                       "<a href=\"/countries/#{@usa.id}/movies/#{@titanic.id}/actors/#{@leo.id}\">Leonardo Di Caprio</a>"]
         end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: easycrumbs
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - "Stanis\xC5\x82aw Kolarzowski"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-08 00:00:00 +02:00
+date: 2010-10-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency