gretel 2.0.0.beta1 → 2.0.0

data/.travis.yml

@@ -3,4 +3,6 @@ rvm:
   - 1.9.3
   - 1.8.7
 before_script:
-  - "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
+  - "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
+notifications:
+  email: false

data/CHANGELOG.md

@@ -12,4 +12,5 @@ Version 2.0
 * 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*).
+* Breadcrumbs are now rendered with `<%= breadcrumbs %>`, although you can still use the old `<%= breadcrumb %>` (without *s*).
+* You can now access view helpers from inside `Gretel::Crumbs.layout do .. end`.

data/README.md

@@ -12,6 +12,12 @@ In your *Gemfile*:
 gem 'gretel', '2.0.0.beta1'
 ```
 
+Or, if you want to run the stable version ([see documentation](https://github.com/lassebunk/gretel/tree/v1.2.1)):
+
+```ruby
+gem 'gretel', '1.2.1'
+```
+
 And run:
 
 ```bash
@@ -29,6 +35,89 @@ $ rails generate gretel:install
 
 Then, in *config/initializers/breadcrumbs.rb*:
 
+```ruby
+Gretel::Crumbs.layout do
+  # Root crumb
+  crumb :root do
+    link "Home", root_path
+  end
+
+  # Issue list
+  crumb :issues do
+    link "All issues", issues_path
+  end
+
+  # Issue
+  crumb :issue do |issue|
+    link issue.title, issue
+    parent :issues
+  end
+end
+```
+
+At the top of *app/views/issues/show.html.erb*, set the current breadcrumb (assuming you have loaded `@issue` with an issue):
+
+```erb
+<% breadcrumb :issue, @issue %>
+```
+
+Then, in *app/views/layouts/application.html.erb*:
+
+```erb
+<%= breadcrumbs :pretext => "You are here: ",
+                :separator => " &rsaquo; " %>
+```
+
+This will generate the following HTML (indented for readability):
+
+```html
+<div class="breadcrumbs">
+  You are here:
+  <a href="/">Home</a> &rsaquo;
+  <a href="/issues">All issues</a> &rsaquo;
+  <span class="current">My Issue</span>
+</div>
+```
+
+Options
+-------
+
+You can pass options to `<%= breadcrumbs %>`, e.g. `<%= breadcrumbs :pretext => "You are here: " %>`:
+
+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.                                           | True
+: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
+:id              | ID for the breadcrumbs container.                                                                                          | None
+:class           | CSS class for the breadcrumbs container.                                                                                   | `"breadcrumbs"`
+:current_class   | CSS class for the current link or span.                                                                                    | `"current"`
+
+Building the breadcrumbs manually
+---------------------------------
+
+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 do |links| %>
+  <% if links.any? %>
+    You are here:
+    <% links.each do |link| %>
+      <%= link_to link.text, link.url %> (<%= link.key %>)
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+More examples
+-------------
+
+In *config/initializers/breadcrumbs.rb*:
+
 ```ruby
 Gretel::Crumbs.layout do
   # Root crumb
@@ -80,63 +169,34 @@ Gretel::Crumbs.layout do
     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*, set the current breadcrumb:
 
-```erb
-<% breadcrumb :issue, @issue %>
-```
-
-Then, in *app/views/layouts/application.html.erb*:
-
-```erb
-<%= breadcrumbs :pretext => "You are here: ",
-                :separator => " &rsaquo; ",
-                :semantic => true %>
-```
-
-This will generate a `<div class="breadcrumbs">` containing the breadcrumbs.
-
-Building the breadcrumbs manually
----------------------------------
+  # Breadcrumb without link URL; will not generate a link
+  crumb :without_link do
+    link "Breadcrumb without link"
+  end
 
-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:
+  # Breadcrumb using view helper
+  module UsersHelper
+    def user_name_for(user)
+      user.name
+    end
+  end
 
-```erb
-<% breadcrumbs do |links| %>
-  <% if links.any? %>
-    You are here:
-    <% links.each do |link| %>
-      <%= link_to link.text, link.url %> (<%= link.key %>) %>
-    <% end %>
-  <% end %>
-<% end %>
+  crumb :user do |user|
+    link user_name_for(user), user
+  end
+end
 ```
 
-Options
--------
-
-You can pass options to `<%= breadcrumb %>`, e.g. `<%= breadcrumb :pretext => "You are here:" %>`:
+Access to view helpers
+----------------------
 
-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
+When inside `Gretel::Crumbs.layout do .. end`, you have access to all view helpers of the current view where the breadcrumbs are inserted.
 
 Documentation
 -------------
 
-* [Full documentation](http://rubydoc.info/github/lassebunk/gretel)
+* [Full documentation](http://rubydoc.info/gems/gretel)
 * [Changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md)
 
 Contributors

data/lib/gretel/crumb.rb

@@ -2,15 +2,16 @@ module Gretel
   class Crumb
     # 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)
+    def initialize(context, key, *args)
       block = Gretel::Crumbs.crumbs[key]
       raise ArgumentError, "Breadcrumb :#{key} not found." unless block
       @key = key
+      @context = context
       instance_exec *args, &block
     end
 
     # Sets link of the breadcrumb.
-    def link(text, url)
+    def link(text, url = nil)
       links << Gretel::Link.new(key, text, url)
     end
 
@@ -28,11 +29,17 @@ module Gretel
     def parent(*args)
       return @parent unless args.any?
       key = args.shift
-      
-      @parent ||= Gretel::Crumb.new(key, *args)
+
+      @parent = Gretel::Crumb.new(context, key, *args)
     end
 
     # Key of the breadcrumb.
     attr_reader :key
+    attr_reader :context
+
+    # Proxy to view context
+    def method_missing(method, *args, &block)
+      context.send(method, *args, &block)
+    end
   end
-end
+end

data/lib/gretel/crumbs.rb

@@ -4,17 +4,12 @@ module Gretel
       # Lay out the breadcrumbs.
       #
       # Example:
-      #
       #   Gretel::Crumbs.layout do
       #     crumb :root do
       #       link "Home", root_path
       #     end
       #   end
       def layout(&block)
-        # 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
 
@@ -27,6 +22,11 @@ module Gretel
       def crumbs
         @crumbs ||= {}
       end
+
+      # Returns true if a crumb with the given key has been set.
+      def crumb_defined?(key)
+        crumbs.has_key?(key)
+      end
     end
   end
-end
+end

data/lib/gretel/version.rb

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

data/lib/gretel/view_helpers.rb

@@ -23,7 +23,7 @@ module Gretel
     #     <% if links.any? %>
     #       You are here:
     #       <% links.each do |link| %>
-    #         <%= link_to link.text, link.url %> (<%= link.key %>) %>
+    #         <%= link_to link.text, link.url %> (<%= link.key %>)
     #       <% end %>
     #     <% end %>
     #   <% end %>
@@ -40,9 +40,9 @@ module Gretel
     # Returns an array of links for the path of the breadcrumb set by +breadcrumb+.
     def get_breadcrumb_links(options = {})
       return [] if @_breadcrumb_key.blank?
-      
+
       # Get breadcrumb set by the `breadcrumb` method
-      crumb = Gretel::Crumb.new(@_breadcrumb_key, *@_breadcrumb_args)
+      crumb = Gretel::Crumb.new(self, @_breadcrumb_key, *@_breadcrumb_args)
 
       # Links of first crumb
       links = crumb.links.dup
@@ -53,8 +53,8 @@ module Gretel
       end
 
       # Handle autoroot
-      if options[:autoroot] && links.map(&:key).exclude?(:root)
-        links.unshift *Gretel::Crumb.new(:root).links
+      if options[:autoroot] && links.map(&:key).exclude?(:root) && Gretel::Crumbs.crumb_defined?(:root)
+        links.unshift *Gretel::Crumb.new(self, :root).links
       end
 
       # Handle show root alone
@@ -86,7 +86,7 @@ module Gretel
       content_tag(:div, html, :id => options[:id], :class => options[:class])
     end
 
-    # Renders HTML for at breadcrumb fragment, i.e. a breadcrumb link.
+    # Renders HTML for a breadcrumb fragment, i.e. a breadcrumb link.
     def render_breadcrumb_fragment(text, url, semantic, options = {})
       if semantic
         if url.present?
@@ -110,7 +110,7 @@ module Gretel
       { :pretext => "",
         :posttext => "",
         :separator => " &gt; ",
-        :autoroot => false,
+        :autoroot => true,
         :show_root_alone => false,
         :link_current => false,
         :semantic => false,
@@ -119,4 +119,4 @@ module Gretel
         :id => nil }
     end
   end
-end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def times_two(text)
+    text * 2
+  end
 end

data/test/dummy/config/initializers/breadcrumbs.rb

@@ -45,12 +45,12 @@ Gretel::Crumbs.layout do
     link Proc.new { "Name from proc" }, Proc.new { "URL from proc" }
   end
 
-  crumb :with_multiple_params do |a, b, c|
+  crumb :with_multiple_arguments do |a, b, c|
     link "#{a} and #{b} and #{c}", contact_path
-    parent :parent_with_multiple_params, a * 2, b * 2, c * 2
+    parent :parent_with_multiple_arguments, a * 2, b * 2, c * 2
   end
 
-  crumb :parent_with_multiple_params do |d, e, f|
+  crumb :parent_with_multiple_arguments do |d, e, f|
     link "First #{d} then #{e} then #{f}", about_path
   end
 
@@ -61,4 +61,17 @@ Gretel::Crumbs.layout do
   crumb :with_safe_html do
     link "Test <strong>bold text</strong>".html_safe, about_path
   end
+
+  crumb :without_link do
+    link "Without link"
+    parent :parent_without_link
+  end
+
+  crumb :parent_without_link do
+    link "Also without link"
+  end
+
+  crumb :using_view_helper do
+    link times_two("Test"), about_path
+  end
 end

data/test/helper_methods_test.rb

@@ -3,10 +3,11 @@ require 'test_helper'
 class HelperMethodsTest < ActionView::TestCase
   include Gretel::ViewHelpers
   fixtures :all
+  helper :application
 
   test "shows basic breadcrumb" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
                  breadcrumbs
   end
 
@@ -18,31 +19,31 @@ class HelperMethodsTest < ActionView::TestCase
 
   test "shows breadcrumb with parent" do
     breadcrumb :with_parent
-    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <span class="current">Contact</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about">About</a> &gt; <span class="current">Contact</span></div>},
                  breadcrumbs
   end
 
   test "shows breadcrumb with autopath" do
     breadcrumb :with_autopath, projects(:one)
-    assert_equal %{<div class="breadcrumbs"><span class="current">Test Project</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">Test Project</span></div>},
                  breadcrumbs
   end
 
   test "shows breadcrumb with parent object" do
     breadcrumb :with_parent_object, issues(:one)
-    assert_equal %{<div class="breadcrumbs"><a href="/projects/1">Test Project</a> &gt; <span class="current">Test Issue</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/projects/1">Test Project</a> &gt; <span class="current">Test Issue</span></div>},
                  breadcrumbs
   end
 
   test "shows multiple links" do
     breadcrumb :multiple_links
-    assert_equal %{<div class="breadcrumbs"><a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
                  breadcrumbs
   end
 
   test "shows multiple links with parent" do
     breadcrumb :multiple_links_with_parent
-    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about">About</a> &gt; <a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
                  breadcrumbs
   end
 
@@ -52,6 +53,17 @@ class HelperMethodsTest < ActionView::TestCase
                  breadcrumbs(:semantic => true)
   end
 
+  test "doesn't show root alone" do
+    breadcrumb :root
+    assert_equal "", breadcrumbs
+  end
+
+  test "shows root alone" do
+    breadcrumb :root
+    assert_equal %{<div class="breadcrumbs"><span class="current">Home</span></div>},
+                 breadcrumbs(:show_root_alone => true)
+  end
+
   test "shows no breadcrumb" do
     assert_equal "", breadcrumbs
   end
@@ -64,20 +76,20 @@ class HelperMethodsTest < ActionView::TestCase
 
   test "shows pretext" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs">You are here: <span class="current">About</span></div>},
+    assert_equal %{<div class="breadcrumbs">You are here: <a href="/">Home</a> &gt; <span class="current">About</span></div>},
                  breadcrumbs(:pretext => "You are here: ")
   end
 
   test "shows posttext" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs"><span class="current">About</span> - text after breadcrumbs</div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span> - text after breadcrumbs</div>},
                  breadcrumbs(:posttext => " - text after breadcrumbs")
   end
 
-  test "shows autoroot" do
+  test "autoroot disabled" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
-                 breadcrumbs(:autoroot => true)
+    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>},
+                 breadcrumbs(:autoroot => false)
   end
 
   test "shows separator" do
@@ -88,38 +100,77 @@ class HelperMethodsTest < ActionView::TestCase
 
   test "shows element id" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs" id="custom_id"><span class="current">About</span></div>},
+    assert_equal %{<div class="breadcrumbs" id="custom_id"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
                  breadcrumbs(:id => "custom_id")
   end
 
+  test "shows custom container class" do
+    breadcrumb :basic
+    assert_equal %{<div class="custom_class"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
+                 breadcrumbs(:class => "custom_class")
+  end
+
+  test "shows custom current class" do
+    breadcrumb :basic
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="custom_current_class">About</span></div>},
+                 breadcrumbs(:current_class => "custom_current_class")
+  end
+
   test "unsafe html" do
     breadcrumb :with_unsafe_html
-    assert_equal %{<div class="breadcrumbs"><span class="current">Test &lt;strong&gt;bold text&lt;/strong&gt;</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">Test &lt;strong&gt;bold text&lt;/strong&gt;</span></div>},
                  breadcrumbs
   end
 
   test "safe html" do
     breadcrumb :with_safe_html
-    assert_equal %{<div class="breadcrumbs"><span class="current">Test <strong>bold text</strong></span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">Test <strong>bold text</strong></span></div>},
                  breadcrumbs
   end
 
   test "works with legacy breadcrumb rendering method" do
     breadcrumb :basic
-    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>},
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
                  breadcrumb
   end
 
   test "yields a block containing breadcrumb links array" do
     breadcrumb :multiple_links_with_parent
 
-    out = nil # Needs to be defined here to be set inside block
+    out = nil # Needs to be defined here to be set inside block and then accessed outside
     breadcrumbs do |links|
       out = links.map { |link| [link.key, link.text, link.url] }
     end
 
-    assert_equal [[:basic, "About", "/about"],
+    assert_equal [[:root, "Home", "/"],
+                  [:basic, "About", "/about"],
                   [:multiple_links_with_parent, "Contact", "/about/contact"],
                   [:multiple_links_with_parent, "Contact form", "/about/contact/form"]], out
   end
+
+  test "without link" do
+    breadcrumb :without_link
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; Also without link &gt; <span class="current">Without link</span></div>},
+                 breadcrumbs
+  end
+
+  test "view context" do
+    breadcrumb :using_view_helper
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">TestTest</span></div>},
+                 breadcrumbs
+  end
+
+  test "multiple arguments" do
+    breadcrumb :with_multiple_arguments, "One", "Two", "Three"
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about">First OneOne then TwoTwo then ThreeThree</a> &gt; <span class="current">One and Two and Three</span></div>},
+                 breadcrumb
+  end
+
+  test "calling breadcrumbs helper twice" do
+    breadcrumb :with_parent
+    2.times do
+      assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about">About</a> &gt; <span class="current">Contact</span></div>},
+                   breadcrumbs
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
-  prerelease: 6
+  version: 2.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -125,13 +125,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -511168212548034673
+      hash: -3983291336719230651
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -3983291336719230651
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25