gretel 1.2.1 → 2.0.0.beta1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.DS_Store

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+before_script:
+  - "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../.."

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+Changelog
+=========
+
+Version 2.0
+-----------
+
+* Totally rewritten for better structure.
+* `options[:autoroot]` is now `true` by default which means it will automatically link to the `:root` breadcrumb if no parent is specified.
+* Now accepts `options[:class]` for specifying the CSS class for the breadcrumbs container. Default: `"breadcrumbs"`.
+* Now accepts `options[:current_class]` for specifying the CSS class for the current link / span. Default: `"current"`.
+* `options[:link_last]` was deprecated in a previous version and is now removed. Use `options[:link_current]` instead.
+* The `link` method in `crumb :xx do ... end` no longer takes HTML options. The method for this is now by building the breadcrumbs manually (see the readme).
+* No longer supports procs for link text or URL as this is unnecessary when you can pass arguments to the block anyway.
+* It now accepts multiple arguments for `crumb` and `parent` (see the readme).
+* Breadcrumbs are now rendered with `<%= breadcrumbs %>`, although you can still use the old `<%= breadcrumb %>` (without *s*).

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in gretel.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    gretel (2.0.0.beta1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (2.2.0)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.4)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.11)
+      actionmailer (= 3.2.11)
+      actionpack (= 3.2.11)
+      activerecord (= 3.2.11)
+      activeresource (= 3.2.11)
+      activesupport (= 3.2.11)
+      bundler (~> 1.0)
+      railties (= 3.2.11)
+    railties (3.2.11)
+      actionpack (= 3.2.11)
+      activesupport (= 3.2.11)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gretel!
+  jquery-rails
+  rails (~> 3.2.11)
+  sqlite3

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,5 +1,7 @@
 Copyright (c) 2010-2013 Lasse Bunk
 
+MIT License
+
 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
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/lassebunk/gretel.png)](http://travis-ci.org/lassebunk/gretel)
+
 Gretel is a [Ruby on Rails](http://rubyonrails.org) plugin that makes it easy yet flexible to create breadcrumbs.
 
 
@@ -7,11 +9,14 @@ Installation
 In your *Gemfile*:
 
 ```ruby
-gem 'gretel'
+gem 'gretel', '2.0.0.beta1'
 ```
 
-And run `bundle install`.
+And run:
 
+```bash
+$ bundle install
+```
 
 Example
 -------
@@ -26,36 +31,29 @@ Then, in *config/initializers/breadcrumbs.rb*:
 
 ```ruby
 Gretel::Crumbs.layout do
-  
-  # root crumb
+  # Root crumb
   crumb :root do
     link "Home", root_path
   end
   
-  # custom styles
+  # Regular crumb
   crumb :projects do
-    link "Projects", projects_path, :class => "breadcrumb", :style => "font-weight: bold;"
+    link "Projects", projects_path
   end
 
-  # lambdas
-  crumb :project do |project|
-    link lambda { |project| "#{project.name} (#{project.id.to_s})" }, project_path(project)
-    parent :projects
-  end
-  
-  # parent crumbs
+  # Parent crumbs
   crumb :project_issues do |project|
     link "Issues", project_issues_path(project)
     parent :project, project
   end
   
-  # child 
+  # Child 
   crumb :issue do |issue|
     link issue.name, issue_path(issue)
     parent :project_issues, issue.project
   end
   
-  # multiple links per crumb (recursive links for parent categories)
+  # Multiple links per crumb (recursive links for parent categories)
   crumb :category do |category|
     parents = [category]
   
@@ -71,83 +69,79 @@ Gretel::Crumbs.layout do
     parent :categories
   end
   
-  # product crumb with recursive parent categories
+  # Product crumb with recursive parent categories
   crumb :product do |product|
     link product.name, product
     parent :category, product.category
   end
+
+  # Multiple arguments
+  crumb :multiple_test do |a, b, c|
+    link "Test #{a}, #{b}, #{c}", test_path
+    parent :other_test, 3, 4, 5
+  end
 end
 ```
 
-At the top of *app/views/issues/show.html.erb*:
+At the top of *app/views/issues/show.html.erb*, set the current breadcrumb:
 
 ```erb
 <% breadcrumb :issue, @issue %>
 ```
 
-In *app/views/layouts/application.html.erb*:
+Then, in *app/views/layouts/application.html.erb*:
 
 ```erb
-<%= breadcrumb :pretext => "You are here: ",
-               :posttext => " &laquo; that was the breadcrumbs!",
-               :separator => " &rsaquo; ",
-               :autoroot => true,
-               :show_root_alone => true,
-               :link_current => false,
-               :semantic => true,
-               :id => "topcrumbs"
-               %>
+<%= breadcrumbs :pretext => "You are here: ",
+                :separator => " &rsaquo; ",
+                :semantic => true %>
 ```
 
-This will generate a `<div>` containing the breadcrumbs.
+This will generate a `<div class="breadcrumbs">` containing the breadcrumbs.
+
+Building the breadcrumbs manually
+---------------------------------
 
-Or, if you want to customize your breadcrumbs:
+If you supply a block to the `breadcrumbs` method, it will yield an array with the breadcrumb links so you can build the breadcrumbs HTML manually:
 
 ```erb
-<% breadcrumbs(:autoroot => true, :show_root_alone => false).each_with_index do |crumb, index| %>
-  <% if index > 0 %> &gt;<% end %>
-  <% if crumb.current? %>
-    <span class="current"><%= crumb.text %></span>
-  <% else %>
-    <%= link_to crumb.text, crumb.url %>
+<% breadcrumbs do |links| %>
+  <% if links.any? %>
+    You are here:
+    <% links.each do |link| %>
+      <%= link_to link.text, link.url %> (<%= link.key %>) %>
+    <% end %>
   <% end %>
 <% end %>
 ```
 
-Options for <code><%= breadcrumb %></code>:
-
-**:pretext**
-Text to be rendered before breadcrumb, if any. Default: none
-
-**:posttext**
-Text to be appended after breadrcumb, if any: Default: none
-
-**:separator**
-Separator between links. Default: `&gt;`
-
-**:autoroot**
-Whether it should automatically link to :root if no root parent is given. Default: false
+Options
+-------
 
-**:show_root_alone**
-Whether it should show :root if this is the only link. Default: false
+You can pass options to `<%= breadcrumb %>`, e.g. `<%= breadcrumb :pretext => "You are here:" %>`:
 
-**:link_current**
-Whether the current crumb should be linked to. Default: false
+Option           | Description                                                                                                                | Default
+---------------- | -------------------------------------------------------------------------------------------------------------------------- | -------
+:pretext         | Text to be rendered before breadcrumb, e.g. `"You are here: "`                                                             | None
+:posttext        | Text to be appended after breadcrumb, e.g. `"Text after breacrumb"`                                                        | None
+:separator       | Separator between links, e.g. `" &rsaquo; "`                                                                               | `" &gt; "`
+:autoroot        | Whether it should automatically link to the `:root` crumb if no parent is given.                                           | False
+:show_root_alone | Whether it should show `:root` if that is the only link.                                                                   | False
+:link_current    | Whether the current crumb should be linked to.                                                                             | False
+:semantic        | Whether it should generate [semantic breadcrumbs](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417). | False
+:class           | CSS class for the breadcrumbs container.                                                                                   | `"breadcrumbs"`
+:current_class   | CSS class for the current link / span.                                                                                     | `"current"`
+:id              | ID for the `<div class="breadcrumbs">` element.                                                                            | None
 
-**:semantic**
-Whether it should generate [semantic breadcrumbs](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417).
-Default: false
+Documentation
+-------------
 
-**:id**
-HTML element ID to be inserted. Default: none
+* [Full documentation](http://rubydoc.info/github/lassebunk/gretel)
+* [Changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md)
 
 Contributors
 ------------
 
-* Lasse Bunk (creator)
-* Alan Larkin
-* David Doan
-* Carl Johnson
-* Tom Canham
+* [See the list of contributors](https://github.com/lassebunk/gretel/graphs/contributors)
 
 Copyright (c) 2010-2013 [Lasse Bunk](http://lassebunk.dk), released under the MIT license

data/Rakefile

@@ -1,38 +1,10 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Gretel'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
 end
 
-
-task :default => :test
+task :default => :test

data/gretel.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gretel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gretel"
+  gem.version       = Gretel::VERSION
+  gem.authors       = ["Lasse Bunk"]
+  gem.email         = ["lassebunk@gmail.com"]
+  gem.description   = %q{Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.}
+  gem.summary       = %q{Flexible Ruby on Rails breadcrumbs plugin.}
+  gem.homepage      = "http://github.com/lassebunk/gretel"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rails", "~> 3.2.11"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/generators/gretel/templates/initializer.rb

@@ -1,7 +1,6 @@
+# Remember to restart your application after editing this file.
+
 Gretel::Crumbs.layout do
-  
-  # Remember to restart your application after editing this file.
-  
   # Example crumbs:
   
   # crumb :root do

data/lib/gretel/crumb.rb

@@ -1,9 +1,38 @@
 module Gretel
   class Crumb
-    attr_accessor :links, :parent
-    
-    def initialize(links, parent)
-      @links, @parent = links, parent
+    # Initializes a new crumb from the given +key+.
+    # It finds the breadcrumb created in +Gretel::Crumbs.layout+ and renders the block using the arguments supplied in +args+.
+    def initialize(key, *args)
+      block = Gretel::Crumbs.crumbs[key]
+      raise ArgumentError, "Breadcrumb :#{key} not found." unless block
+      @key = key
+      instance_exec *args, &block
     end
+
+    # Sets link of the breadcrumb.
+    def link(text, url)
+      links << Gretel::Link.new(key, text, url)
+    end
+
+    # Holds all of the breadcrumb's links as a breadcrumb can have multiple links.
+    def links
+      @links ||= []
+    end
+
+    # Sets or gets the parent breadcrumb.
+    # If you supply a parent key and optional arguments, it will set the parent.
+    # If nothing is supplied, it will return the parent, if this has been set.
+    #
+    # Example:
+    #   parent :category, category
+    def parent(*args)
+      return @parent unless args.any?
+      key = args.shift
+      
+      @parent ||= Gretel::Crumb.new(key, *args)
+    end
+
+    # Key of the breadcrumb.
+    attr_reader :key
   end
 end

data/lib/gretel/crumbs.rb

@@ -1,51 +1,31 @@
 module Gretel
-  class Crumbs
+  module Crumbs
     class << self
+      # Lay out the breadcrumbs.
+      #
+      # Example:
+      #
+      #   Gretel::Crumbs.layout do
+      #     crumb :root do
+      #       link "Home", root_path
+      #     end
+      #   end
       def layout(&block)
-        # needs to be done here because Rails.application isn't set when this file is required
-        self.class.send :include, Rails.application.routes.url_helpers
-        
+        # The URL helpers include needs to be done here because
+        # Rails.application isn't set when this file is required
+        # TODO: Can this be done otherwise?
+        Gretel::Crumb.send :include, Rails.application.routes.url_helpers
         instance_eval &block
       end
-      
-      def all
-        @crumbs ||= {}
-      end
 
-      def crumb(name, &block)
-        all[name] = block
-      end
-      
-      def get_crumb(name, object = nil)
-        crumb = all[name]
-        raise ArgumentError, "Breadcrumb :#{name} not found." unless crumb
-        
-        @object = object # share the object so we can call it from link() and parent()
-        @parent = nil
-        
-        crumb.call(object)
-        Gretel::Crumb.new(@links, @parent)
+      # Stores the supplied block for later use.
+      def crumb(key, &block)
+        crumbs[key] = block
       end
-      
-      def link(*args)
-        options = args.extract_options!
-        text = args[0]
-        url = args[1]
-        
-        text = text.call(@object) if text.is_a?(Proc)
-        url = url.call(@object) if url.is_a?(Proc)
-        
-        @links ||= []
-        @links << Gretel::Link.new(text, url, options)
-        
-        @links
-      end
-      
-      def parent(name, object = nil)
-        name = name.call(@object) if name.is_a?(Proc)
-        object = object.call(@object) if object.is_a?(Proc)
 
-        @parent = Gretel::Parent.new(name, object)
+      # Returns an array of all stored crumb blocks.
+      def crumbs
+        @crumbs ||= {}
       end
     end
   end

data/lib/gretel/link.rb

@@ -1,9 +1,9 @@
 module Gretel
   class Link
-    attr_accessor :options, :text, :url
-    
-    def initialize(text, url, options = {})
-      @text, @url, @options = text, url, options
+    attr_accessor :key, :text, :url
+
+    def initialize(key, text, url)
+      @key, @text, @url = key, text, url
     end
   end
 end

data/lib/gretel/version.rb

@@ -0,0 +1,3 @@
+module Gretel
+  VERSION = "2.0.0.beta1"
+end