breadcrumbs_for 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Dmitry Naumov
+
+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/README.rdoc

@@ -0,0 +1,78 @@
+= breadcrumbs_for
+
+Breadcrumbs for Rails made right.
+
+== Installation
+ gem install breadcrumbs_for
+
+== Requirements
+ Was tested with Rails 3.0.0
+
+== Usage
+Let say:
+* You have a Blog and Post models in your app.
+* Posts are nested in Blogs.
+* You have :admin namespace to manage them.
+* Blog and Post have a 'title' or 'name' methods
+
+===Examples:
+ breadcrumbs_for :blogs                         # Home / Blogs
+ breadcrumbs_for :blogs, 'new'                  # Home / Blogs / New
+ breadcrumbs_for :blogs, @blog                  # Home / Blogs / My blog
+ breadcrumbs_for :blogs, @blog, 'edit'          # Home / Blogs / My blog / Edit
+ breadcrumbs_for @blog                          # Home / My blog
+ breadcrumbs_for :blogs, @blog, [@blog, @post]  # Home / Blogs / My blog / My Post
+
+ breadcrumbs_for [:admin,:blogs], [:admin, @blog]
+ breadcrumbs_for [:admin,:blogs], ['edit', :admin, @blog, @post]
+ breadcrumbs_for [:admin,:blogs], [:admin, @blog], ['edit', :admin, @blog, @post]
+
+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.
+
+If you have an admin_path in your routes you can do:
+ breadcrumbs_for :admin, [:admin,:blogs], ['new', :admin, @blog], :crumbs_options=>{:root=>false}
+
+=== Customize
+* Don't inculde the Home(root) link:
+ breadcrumbs_for :blogs, @blog, :crumbs_options=>{:root=>false}
+* By default breadcrumbs are rendered as a ul(html unorderd list). You can disable this:
+ breadcrumbs_for :blogs, @blog, :crumbs_options=>{:type=>:plain}
+* The default separator is /. Chage it:
+ breadcrumbs_for :blogs, @blog, :crumbs_options=>{:sep=>'→'}
+
+=== Custom captions and i18n
+Define captions for breadcrumbs in your locale file:
+ en:
+  breadcrumbs:
+    root: 'Home'
+    actions:
+      new: 'Add new'
+      edit: 'Edit one'
+    names:
+      admin: 'Manage'
+      blogs: 'The blogs'
+      posts: 'The posts'
+
+== Note on Patches/Pull Requests
+
+((*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.
+
+== Copyright
+
+Copyright (c) 2010 Dmitry Naumov. Released under the MIT license. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+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.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
+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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "breadcrumbs_for #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/breadcrumbs_for.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{breadcrumbs_for}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dmitry Naumov"]
+  s.date = %q{2010-09-13}
+  s.description = %q{Breadcrumbs for Rails done in a rails way. Built on url_for, your routes and i18n.}
+  s.email = %q{naumovmail@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "breadcrumbs_for.gemspec",
+     "init.rb",
+     "lib/breadcrumbs_for.rb",
+     "test/helper.rb",
+     "test/test_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"
+  ]
+
+  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"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'breadcrumbs_for'

data/lib/breadcrumbs_for.rb

@@ -0,0 +1,113 @@
+module BreadcrumbsFor
+  def breadcrumbs_for *crumbs_list
+    list, options = extract_crumb_params(crumbs_list)
+    crumbs = []
+    crumbs << crumb_html(root_crumb,options,'root') if options[:root]
+    crumbs_count = list.size
+    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))
+      crumbs << crumb_html(item,options,is_last_crumb ? 'active' : nil)
+    end
+    crumbs_html(crumbs,options)
+  end
+  alias :crumbs_for :breadcrumbs_for
+
+  def extract_crumb_params options
+    defaults = {
+      :root => true,
+      :type => :list,
+      :sep => '/',
+    }
+    last_option = options.last
+    if last_option.is_a?(Hash) && last_option[:crumbs_options]
+      opts = options.pop
+      [options, defaults.merge(opts[:crumbs_options])]
+    else
+      [options, defaults]
+    end
+  end
+
+  def crumb_html(item,options,pos=nil)
+    if options[:type]==:list
+      content_tag(:li, item, :class=>"crumb #{pos}")
+    else
+      item
+    end
+  end
+
+  def crumbs_html(crumbs,options)
+    if options[:type]==:list
+      sep = "<li class=\"sep\">#{options[:sep]}</li>"
+      raw ['<ul class="breadcrumbs">', crumbs.join(sep), '</ul>'].join
+    else
+      sep = content_tag(:span, options[:sep], :class=>'sep')
+      raw crumbs.join(sep)
+    end
+  end
+
+  def crumb_link caption, path, options={}
+    options[:class] = ['crumb',options[:class]].compact.join(' ')
+    link_to(caption, path, options)
+  end
+
+  def root_crumb
+    crumb_link(root_caption, root_path, :class=>'home_crumb')
+  end
+
+  def root_caption
+    t("breadcrumbs.root", :default => 'Home' )
+  end
+
+  def string_to_caption crumb
+    t("breadcrumbs.actions.#{crumb.to_s}", :default => crumb.to_s.capitalize)
+  end
+
+  def symbol_caption crumb
+    return root_caption if crumb == :root
+    t("breadcrumbs.names.#{crumb.to_s}", :default => crumb.to_s.capitalize)
+  end
+
+  def array_to_caption crumb
+    if crumb.size>1
+      case crumb.first.class.to_s
+        when 'Symbol' # Is a namespace. Skip it
+          cramb_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)
+      end
+    else
+      cramb_caption(crumb[0])
+    end
+  end
+
+  def crumb_to_caption crumb
+    case crumb.class.to_s
+      when 'Symbol'
+        symbol_caption(crumb)
+      when 'String'
+        string_to_caption(crumb)
+      when 'Array'
+        array_to_caption(crumb)
+      when 'Hash'
+        crumb.delete(:crumb)
+      else
+        cramb_caption(crumb)
+    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
+    end
+  end
+end
+
+ActionView::Base.send :include, BreadcrumbsFor

data/test/helper.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,7 @@
+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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: breadcrumbs_for
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dmitry Naumov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 +03: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.
+email: naumovmail@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- 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: 
+- --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
+signing_key: 
+specification_version: 3
+summary: Breadcrumbs for Rails made right.
+test_files: 
+- test/helper.rb
+- test/test_breadcrumbs_for.rb