gretel 3.0.0.beta3 → 3.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6dea6327b14a40f5f88c344548da90536778701
-  data.tar.gz: c527f98356d7ca6febb761ea239c030d3cfc6365
+  metadata.gz: f60e571dd44601cf9e016949eaf99b93e7620c32
+  data.tar.gz: eb4b93afaf41a5faaccd58e7fb6996e692c87eda
 SHA512:
-  metadata.gz: e99745536c8bae608186322664689156e303f569961b1086278da7d66cf7ea2cdbcd84565eef961d6ab966d6044988057861656f7c6cec5b35e5a2905dfa53f6
-  data.tar.gz: e3eb531c6e4ac7e1a9e9c0d2e914f9b1321bdbb48f9aead24ff9a611fb3e5a4c93e6a26974c7fabd0529da3d6a89dbc7958af3f12449ad559c3b223f54610dc0
+  metadata.gz: e755b624fad2a00daf9aaf8fbd2deb7f094d0b3b6a14137edc0a6111ba209067349527aa1d66ad898a2ce7a47376c776026f700ce2eb77ea0cba9768e8805bd5
+  data.tar.gz: cbedcf2047c946abbbd64ae8b6d2a2c8086ca6f17d7a0a77b7c3b655b73911dbec6e3da248f14b433237b18f2a2620b0ed5a9d0f67ccefa446ad01d898b150de

data/CHANGELOG.md

@@ -11,6 +11,8 @@ Version 3.0
 * Support for rendering the breadcrumbs in different styles like ul- and ol lists, and for use with [Twitter Bootstrap](http://getbootstrap.com/). See the `:style` option in the readme for more info.
 * The `:show_root_alone` option is now called `:display_single_fragment` and can be used to display the breadcrumbs only when there are more than one link, also if it is not the root breadcrumb.
 * Links yielded from `<%= breadcrumbs do |links| %>` now have a `current?` helper that returns true if the link is the last in the trail.
+* New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). You can supply options like `:autoroot` etc.
+  If you supply a block, it will yield the parent breadcrumb if it is present.
 
 Version 2.1
 -----------

data/README.md

@@ -17,8 +17,11 @@ New in version 3.0 :muscle:
 * Defining breadcrumbs using `Gretel::Crumbs.layout do ... end` in an initializer has been removed. See below for details on how to upgrade.
 * The `:show_root_alone` option is now called `:display_single_fragment` and can be used to hide the breadcrumbs when there is only one link, also if it is not the root breadcrumb.
   The old `:show_root_alone` option is still supported until Gretel version 4.0 and will show a deprecation warning when it's used.
+* Links yielded from `<%= breadcrumbs do |links| %>` now have a `current?` helper that returns true if the link is the last in the trail.
+* New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). You can supply options like `:autoroot` etc.
+  If you supply a block, it will yield the parent breadcrumb if it is present.
 
-I hope you find these changes as useful as I did when I made them – if you have more suggestions, please create an [Issue](https://github.com/lassebunk/gretel/issues) or [Pull Request](https://github.com/lassebunk/gretel/pulls).
+I hope you find these changes as useful as I did – if you have more suggestions, please create an [Issue](https://github.com/lassebunk/gretel/issues) or [Pull Request](https://github.com/lassebunk/gretel/pulls).
 
 See below for more info or the [changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md) for less significant changes.
 
@@ -28,7 +31,7 @@ Installation
 In your *Gemfile*:
 
 ```ruby
-gem "gretel", "3.0.0.beta2"
+gem "gretel", "3.0.0.beta4"
 ```
 
 And run:
@@ -230,6 +233,21 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
 <% end %>
 ```
 
+Getting the parent breadcrumb
+-----------------------------
+
+If you want to add a link to the parent breadcrumb in the trail, you can use the `parent_breadcrumb` view helper.
+By default it returns a link instance that has the properties `#key`, `#text`, and `#url`.
+You can supply options like `autoroot: false` etc.
+
+If you supply a block, it will yield the link if it is present:
+
+```erb
+<% parent_breadcrumb do |parent| %>
+  <%= link_to "Back to #{link.text}", link.url %>
+<% end %>
+```
+
 Setting breadcrumb trails
 --------------------------------
 
@@ -277,7 +295,7 @@ The product view will now have the breadcrumb trail from the first page (reviews
 The default trail param is `params[:trail]`. You can change it in an initializer:
 
 ```ruby
-Gretel::Trail.trail_param = :other_param
+Gretel.trail_param = :other_param
 ```
 
 ### Note

data/lib/gretel/link.rb

@@ -3,7 +3,8 @@ module Gretel
     attr_accessor :key, :text, :url
 
     def initialize(key, text, url)
-      @key, @text, @url = key, text, url
+      # Use accessors so plugins can override their behavior
+      self.key, self.text, self.url = key, text, url
     end
 
     def current!

data/lib/gretel/renderer.rb

@@ -58,10 +58,10 @@ module Gretel
       content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
     end
 
-    # Yields an array of links to be used in a view.
-    def yield_links(options = {}, &block)
+    # Array of links transformed by +options+ (like +:autoroot+ etc.) to be used in a view.
+    def links_with(options = {})
       options = options_for_render(options)
-      yield links_for_render(options)
+      links_for_render(options)
     end
 
     # Returns encoded trail for the breadcrumb.
@@ -69,6 +69,11 @@ module Gretel
       @trail ||= Gretel::Trail.encode(links)
     end
 
+    # Proxy for +context.link_to+ that can be overridden by plugins.
+    def link_to(*args)
+      context.link_to(*args)
+    end
+
     private
 
     attr_reader :context, :breadcrumb_key, :breadcrumb_args
@@ -148,7 +153,7 @@ module Gretel
 
       # Handle autoroot
       if options[:autoroot] && out.map(&:key).exclude?(:root) && Gretel::Crumbs.crumb_defined?(:root)
-        out.unshift *Gretel::Crumb.new(self, :root).links
+        out.unshift *Gretel::Crumb.new(context, :root).links
       end
 
       # Handle show root alone
@@ -172,10 +177,10 @@ module Gretel
     def render_semantic_fragment(fragment_tag, text, url, options = {})
       if fragment_tag
         text = content_tag(:span, text, itemprop: "title")
-        text = render_link(text, url, itemprop: "url") if url.present?
+        text = link_to(text, url, itemprop: "url") if url.present?
         content_tag(fragment_tag, text, class: options[:class], itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
       elsif url.present?
-        content_tag(:div, render_link(content_tag(:span, text, itemprop: "title"), url, class: options[:class], itemprop: "url"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
+        content_tag(:div, link_to(content_tag(:span, text, itemprop: "title"), url, class: options[:class], itemprop: "url"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
       else
         content_tag(:div, content_tag(:span, text, class: options[:class], itemprop: "title"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
       end
@@ -184,10 +189,10 @@ module Gretel
     # Renders regular, non-semantic fragment HTML.
     def render_nonsemantic_fragment(fragment_tag, text, url, options = {})
       if fragment_tag
-        text = render_link(text, url) if url.present?
+        text = link_to(text, url) if url.present?
         content_tag(fragment_tag, text, class: options[:class])
       elsif url.present?
-        render_link(text, url, class: options[:class])
+        link_to(text, url, class: options[:class])
       elsif options[:class].present?
         content_tag(:span, text, class: options[:class])
       else
@@ -195,12 +200,6 @@ module Gretel
       end
     end
 
-    # Renders a link. It is really just a proxy for +link_to+, but this can be
-    # used in plugins that want to change how links are rendered.
-    def render_link(name, url, options = {})
-      link_to(name, url, options)
-    end
-
     # Proxy to view context
     def method_missing(method, *args, &block)
       context.send(method, *args, &block)

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "3.0.0.beta3"
+  VERSION = "3.0.0.beta4"
 end

data/lib/gretel/view_helpers.rb

@@ -25,12 +25,22 @@ module Gretel
     #   <% end %>
     def breadcrumbs(options = {}, &block)
       if block_given?
-        gretel_renderer.yield_links(options, &block)
+        yield gretel_renderer.links_with(options)
       else
         gretel_renderer.render(options)
       end
     end
 
+    # Returns or yields parent breadcrumb (second-to-last in the trail) if it is present.
+    def parent_breadcrumb(options = {}, &block)
+      parent = gretel_renderer.links_with(options)[-2]
+      if block_given? && parent
+        yield parent
+      else
+        parent
+      end
+    end
+
     # Encoded breadcrumb trail to be used in URLs.
     def breadcrumb_trail
       gretel_renderer.trail

data/test/helper_methods_test.rb

@@ -153,6 +153,40 @@ class HelperMethodsTest < ActionView::TestCase
                   [:multiple_links_with_parent, "Contact form", "/about/contact/form"]], out
   end
 
+  test "parent breadcrumb" do
+    breadcrumb :multiple_links_with_parent
+
+    parent = parent_breadcrumb
+    assert_equal [:multiple_links_with_parent, "Contact", "/about/contact"],
+                 [parent.key, parent.text, parent.url]
+  end
+
+  test "yields parent breadcrumb" do
+    breadcrumb :multiple_links_with_parent
+
+    out = parent_breadcrumb do |parent|
+      [parent.key, parent.text, parent.url]
+    end
+    assert_equal [:multiple_links_with_parent, "Contact", "/about/contact"],
+                 out
+  end
+
+  test "parent breadcrumb returns nil if not present" do
+    breadcrumb :basic
+
+    assert_nil parent_breadcrumb(autoroot: false)
+  end
+
+  test "parent breadcrumb yields only if present" do
+    breadcrumb :basic
+
+    out = parent_breadcrumb(autoroot: false) do
+      "yielded"
+    end
+
+    assert_nil out
+  end
+
   test "sets current on last link in array" do
     breadcrumb :multiple_links_with_parent
 
@@ -279,7 +313,7 @@ class HelperMethodsTest < ActionView::TestCase
   end
 
   test "different trail param" do
-    Gretel::Trail.trail_param = :mytest
+    Gretel.trail_param = :mytest
     params[:mytest] = "667ea523f92bdb3a086494575b18f587170e482b_W1siYmFzaWMiLCJBYm91dCIsMCwiL2Fib3V0Il1d"
     breadcrumb :multiple_links
 
@@ -287,6 +321,14 @@ class HelperMethodsTest < ActionView::TestCase
                  breadcrumbs
   end
 
+  test "unknown trail" do
+    params[:trail] = "notfound"
+    breadcrumb :multiple_links
+
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <a href="/about/contact">Contact</a> &rsaquo; <span class="current">Contact form</span></div>},
+                 breadcrumbs
+  end
+
   # Configuration reload
 
   test "reload configuration when file is changed" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta3
+  version: 3.0.0.beta4
 platform: ruby
 authors:
 - Lasse Bunk