gretel 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35944b5de1eba707a9be4b26bc73f5bdc0716fe
-  data.tar.gz: c36db3b340cc0e3a992c0ed4c7f001cea361e594
+  metadata.gz: b3e002fa0feb5ee917e81324762d2d48274e7e35
+  data.tar.gz: 16338b4f9d61b4e689ec73c7e4d6bf34152aba11
 SHA512:
-  metadata.gz: 0de7bbe764ebedc259521e875dbbfbcaf99de5cef1f71d8240a207366ae5ee1204cd9a61e57cf3739aa97189a6d59a6d0a7acd76d415ea685457c3e667fd5fff
-  data.tar.gz: a1e5792570f980b9a67aba3e25498844c6b1df043ebe9d72ac13333f0937070090b4f6bebe8937778ebc10f710e3995ee1af69f1cc18322e8d9d46a6c35b93da
+  metadata.gz: ae5738c15905088b11940343d2bfdcb4fa9df67cb999038a9df5334b78caf8db3b9c78c8941f74fb7c38fc991c50cc4f6da80990e98bcc201dbe72a05cac4c9e
+  data.tar.gz: f5571a9bf4caa6df4d4569c90667aeaab7e8e19d5c8d5f456516afffe1d97cdbe45689487654b8f31c024c0565e90b95c85e8449fc3ec5527d2517ba36aa06d1

data/CHANGELOG.md

@@ -1,12 +1,12 @@
-Changelog
-=========
+# Changelog
 
-Version 3.0.1
--------------
+## Version 3.0.2
+* Inferring breadcrumbs is now supported on all instances of objects that respond to `model_name`.
+
+## Version 3.0.1
 * Breadcrumbs can now be inferred if you pass in an ActiveRecord model instance. E.g. `breadcrumb @product` is short for `breadcrumb :product, @product`.
 
-Version 3.0
------------
+# Version 3.0
 * Support for defining breadcrumbs using `Gretel::Crumbs.layout do ... end` in an initializer has been removed. See the readme for details on how to upgrade.
 * Breadcrumbs rendering is now done in a separate class to unclutter the view with helpers. The public API is still the same.
 * 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.
@@ -15,12 +15,10 @@ Version 3.0
 * New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). This can for example be used to create a dynamic back link. 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
------------
+# Version 2.1
 * Breadcrumbs are now configured in `config/breadcrumbs.rb` and `config/breadcrumbs/**/*.rb` and reloaded when changed in the development environment instead of the initializer that required restart when configuration changed.
 
-Version 2.0
------------
+# 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.

data/README.md

@@ -18,7 +18,7 @@ Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mai
 * New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). This can for example be used to create a dynamic back link.
   You can supply options like `:autoroot` etc.
   If you supply a block, it will yield the parent breadcrumb if it is present.
-* Breadcrumbs can now be inferred if you pass in an ActiveRecord model instance. E.g. `breadcrumb @product` is short for `breadcrumb :product, @product`.
+* Breadcrumbs can now be inferred if you pass in an instance of an object that responds to `model_name` (like an ActiveRecord model instance). E.g. `breadcrumb @product` is short for `breadcrumb :product, @product`.
 
 
 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).
@@ -256,10 +256,19 @@ The format is the same as `config/breadcrumbs.rb` which is also loaded.
 
 ### Inferring breadcrumbs
 
-Breadcrumbs can be automatically inferred if you pass in an ActiveRecord model instance.
+Breadcrumbs can be automatically inferred if you pass an instance of an object that responds to `model_name` (like an ActiveRecord model instance).
 
-For example `breadcrumb @product` is short for `breadcrumb :product, @product`.
+For example:
 
+```erb
+<% breadcrumb @product %>
+```
+
+is short for
+
+```erb
+<% breadcrumb :product, @product %>
+```
 
 ### Automatic reloading of breadcrumb configuration files
 

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

data/lib/gretel/view_helpers.rb

@@ -1,13 +1,16 @@
 module Gretel
   module ViewHelpers
     # Sets the current breadcrumb to be rendered elsewhere. Put it somewhere in the view, preferably in the top, before you render any breadcrumbs HTML:
-    #   <%
-    #   breadcrumb :category, @category
-    #   %>
+    # 
+    #   <% breadcrumb :category, @category %>
+    # 
+    # If you pass an instance of an object that responds to +model_name+ (like an ActiveRecord model instance), the breadcrumb can be automatically inferred, so a shortcut for the above would be:
+    # 
+    #   <% breadcrumb @category %>
     def breadcrumb(key = nil, *args)
       if key.nil? || key.is_a?(Hash)
         raise ArgumentError, "The `breadcrumb` method was called with #{key.inspect} as the key. This method is used to set the breadcrumb. Maybe you meant to call the `breadcrumbs` method (with an 's' in the end) which is used to render the breadcrumbs?"
-      elsif key.is_a?(ActiveRecord::Base)
+      elsif key.class.respond_to?(:model_name)
         # Enables calling `breadcrumb @product` instead of `breadcrumb :product, @product`
         args.unshift key
         key = key.class.model_name.to_s.underscore.to_sym
@@ -54,6 +57,10 @@ module Gretel
     end
 
     # Returns or yields parent breadcrumb (second-to-last in the trail) if it is present.
+    # 
+    #   <% parent_breadcrumb do |link| %>
+    #     <%= link_to link.text, link.url %> (<%= link.key %>)
+    #   <% end %>
     def parent_breadcrumb(options = {}, &block)
       if block_given?
         gretel_renderer.yield_parent_breadcrumb(options, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails