breadcrumbs_for 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -1,12 +1,16 @@
 = breadcrumbs_for
 
-Breadcrumbs for Rails made right.
+Breadcrumbs Rails helper.
+
+Breadcrumbs helper for Rails done in a rails way.
+
+Built on url_for, your routes, model names and i18n.
 
 == Installation
  gem install breadcrumbs_for
 
 == Requirements
- Was tested with Rails 3.0.0
+Was tested with Rails 3
 
 == Usage
 Let say:
@@ -32,7 +36,6 @@ etc.
 Note: There is a shorter alias crumbs_for, so you can do:
  crumbs_for :blogs, @blog
 
-
 You can even do the following:
  breadcrumbs_for {:controller=>'blogs', :action=>'index', :crumb=>'All Blogs'}, @blog
 Note on :crumb=>'All Blogs'. Here you need to provide the breadcrumb caption text directly via the :crumb key.
@@ -40,6 +43,43 @@ Note on :crumb=>'All Blogs'. Here you need to provide the breadcrumb caption tex
 If you have an admin_path in your routes you can do:
  breadcrumbs_for :admin, [:admin,:blogs], ['new', :admin, @blog], :crumbs_options=>{:root=>false}
 
+=== Produced HTML
+By default it will render breadcrumbs as an unordered list.
+
+The following code
+
+  <%= crumbs_for :posts, 'New' %>
+
+will produce html:
+
+  <ul class="breadcrumbs">
+   <li class="crumb root">
+     <a href="/" class="crumb home_crumb">Home</a>
+   </li>
+   <li class="sep">/</li>
+   <li class="crumb ">
+     <a href="/posts" class="crumb">Posts</a>
+   </li>
+   <li class="sep">/</li>
+   <li class="crumb active">
+     New
+   </li>
+  </ul>
+
+You can also render bredcrumbs in plain.
+
+The following code
+
+  <%= crumbs_for :posts, 'New', :crumbs_options => { :type => :plain } %>
+
+will produce html:
+
+  <a href="/" class="crumb home_crumb">Home</a>
+  <span class="sep">/</span>
+  <a href="/admin/themes" class="crumb">Themes</a>
+  <span class="sep">/</span>
+  New
+
 === Customize
 * Don't inculde the Home(root) link:
  breadcrumbs_for :blogs, @blog, :crumbs_options=>{:root=>false}
@@ -61,17 +101,23 @@ Define captions for breadcrumbs in your locale file:
       blogs: 'The blogs'
       posts: 'The posts'
 
+=== Tips & Tricks
+When providing action as a String it will include action name in breadcrumb caption.
+
+  crumbs_for :blogs, ['edit', @blog]  # => Home / Blogs / Edit My blog
+
+When providing action as a Symbol it will skip action name in breadcrumb caption.
+
+  crumbs_for :blogs, [:edit, @blog]  # => Home / Blogs / My blog
+
 == Note on Patches/Pull Requests
 
-((*Patches/Pull Requests are welcome!*))
+Patches/Pull Requests are welcome!
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Commit.
+* Send a pull request.
 
 == Copyright
 

data/Rakefile

@@ -5,12 +5,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "breadcrumbs_for"
-    gem.summary = %Q{Breadcrumbs for Rails made right.}
-    gem.description = %Q{Breadcrumbs for Rails done in a rails way. Built on url_for, your routes and i18n.}
+    gem.summary = %Q{Breadcrumbs Rails helper.}
+    gem.description = %Q{Breadcrumbs helper for Rails done in a rails way. Built on url_for, your routes, model names and i18n.}
     gem.email = "naumovmail@gmail.com"
     gem.homepage = "http://github.com/naumov/breadcrumbs_for"
     gem.authors = ["Dmitry Naumov"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -18,26 +17,6 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
 task :test => :check_dependencies
 
 task :default => :test
@@ -50,4 +29,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "breadcrumbs_for #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/breadcrumbs_for.gemspec

@@ -1,53 +1,45 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{breadcrumbs_for}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dmitry Naumov"]
-  s.date = %q{2010-10-30}
-  s.description = %q{Breadcrumbs for Rails done in a rails way. Built on url_for, your routes and i18n.}
+  s.date = %q{2010-11-19}
+  s.description = %q{Breadcrumbs helper for Rails done in a rails way. Built on url_for, your routes, model names and i18n.}
   s.email = %q{naumovmail@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "breadcrumbs_for.gemspec",
-    "init.rb",
-    "lib/breadcrumbs_for.rb",
-    "test/helper.rb",
-    "test/test_breadcrumbs_for.rb"
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "breadcrumbs_for.gemspec",
+     "init.rb",
+     "lib/breadcrumbs_for.rb"
   ]
   s.homepage = %q{http://github.com/naumov/breadcrumbs_for}
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Breadcrumbs for Rails made right.}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_breadcrumbs_for.rb"
-  ]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Breadcrumbs Rails helper.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
   end
 end
-

data/lib/breadcrumbs_for.rb

@@ -7,7 +7,7 @@ module BreadcrumbsFor
     list.each_with_index do |crumb,index|
       caption = crumb_to_caption(crumb)
       is_last_crumb = ((index+1) == crumbs_count)
-      item = is_last_crumb ? caption : crumb_link(caption, url_for(crumb))
+      item = crumb.is_a?(String) ? caption : crumb_link(caption, url_for(crumb))
       crumbs << crumb_html(item,options,is_last_crumb ? 'active' : nil)
     end
     crumbs_html(crumbs,options)
@@ -73,14 +73,14 @@ module BreadcrumbsFor
     if crumb.size>1
       case crumb.first.class.to_s
         when 'Symbol' # Is a namespace. Skip it
-          cramb_caption(crumb.last)
+          crumb_to_caption(crumb.last)
         when 'String' # Is an action name. Use it
           string_to_caption(crumb.first) << ' ' << cramb_caption(crumb.last)
         else # Use last item only
-          cramb_caption(crumb.last)
+          cramb_to_caption(crumb.last)
       end
     else
-      cramb_caption(crumb[0])
+      cramb_to_caption(crumb[0])
     end
   end
 
@@ -99,14 +99,16 @@ module BreadcrumbsFor
     end
   end
 
-  def cramb_caption crumb
-    if crumb.respond_to?(:title)
-      crumb.title
-    elsif crumb.respond_to?(:name)
-      crumb.name
-    else
-      crumb.class.to_s.humanize
+  def cramb_caption obj, method='name'
+    [method,'name','title'].each do |name_method|
+      if obj.respond_to?(name_method)
+        was_method       = "#{name_method}_was"
+        changed_method   = "#{name_method}_changed?"
+        tracking_enabled = obj.respond_to?(was_method) && obj.respond_to?(changed_method)
+        return (tracking_enabled && obj.send(changed_method)) ? obj.send(was_method) : obj.send(method.to_s)
+      end
     end
+    crumb.class.to_s.humanize
   end
 end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: breadcrumbs_for
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dmitry Naumov
@@ -15,24 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 +03:00
+date: 2010-11-19 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-description: Breadcrumbs for Rails done in a rails way. Built on url_for, your routes and i18n.
+dependencies: []
+
+description: Breadcrumbs helper for Rails done in a rails way. Built on url_for, your routes, model names and i18n.
 email: naumovmail@gmail.com
 executables: []
 
@@ -43,6 +29,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -50,42 +37,35 @@ files:
 - breadcrumbs_for.gemspec
 - init.rb
 - lib/breadcrumbs_for.rb
-- test/helper.rb
-- test/test_breadcrumbs_for.rb
 has_rdoc: true
 homepage: http://github.com/naumov/breadcrumbs_for
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Breadcrumbs for Rails made right.
-test_files: 
-- test/helper.rb
-- test/test_breadcrumbs_for.rb
+summary: Breadcrumbs Rails helper.
+test_files: []
+

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'breadcrumbs_for'
-
-class Test::Unit::TestCase
-end

data/test/test_breadcrumbs_for.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestBreadcrumbsFor < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end