gretel 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3591671a58fa51ef230c08c05fc535f6e8aad39b
-  data.tar.gz: cbd4f1d910a5b92b74c8952cc30cf313c502e2ca
+  metadata.gz: b35944b5de1eba707a9be4b26bc73f5bdc0716fe
+  data.tar.gz: c36db3b340cc0e3a992c0ed4c7f001cea361e594
 SHA512:
-  metadata.gz: 93a1b0736c9fc45bd743f2bbfad9fcb1c629eddbbaae9f77bd5badcda3d2a2488f3de6554f053558a610c10366d077b1c6eb8ce508ebb93ec2b59d184a471826
-  data.tar.gz: 740422f9236bfecb8b0115df2d33007bf09b0fa49f3f1b5b90d01336c2e29bbc6f1980033c275bb5d7683d024f3a2badfb7c7fb3e7ddd43baf96ad9e70822e41
+  metadata.gz: 0de7bbe764ebedc259521e875dbbfbcaf99de5cef1f71d8240a207366ae5ee1204cd9a61e57cf3739aa97189a6d59a6d0a7acd76d415ea685457c3e667fd5fff
+  data.tar.gz: a1e5792570f980b9a67aba3e25498844c6b1df043ebe9d72ac13333f0937070090b4f6bebe8937778ebc10f710e3995ee1af69f1cc18322e8d9d46a6c35b93da

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+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
 -----------
 * 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.

data/README.md

@@ -1,8 +1,9 @@
-[![Build Status](https://secure.travis-ci.org/lassebunk/gretel.png)](http://travis-ci.org/lassebunk/gretel)
+<a href="http://travis-ci.org/lassebunk/gretel"><img src="https://secure.travis-ci.org/lassebunk/gretel.png" alt="Build Status" /></a>
 
-Gretel is a [Ruby on Rails](http://rubyonrails.org) plugin that makes it easy yet flexible to create breadcrumbs.
-It is based around the idea that breadcrumbs are a separate concern, and therefore should be defined in their own place.
-You define a set of breadcrumbs in the config folder and specify in the view which breadcrumb to use.
+<img src="http://i.imgur.com/CAKEaBM.png" alt="Handle breadcrumb trails... like a boss :)" />
+
+([TL;DR](http://i.imgur.com/nH25yiH.png)) Gretel is a [Ruby on Rails](http://rubyonrails.org) plugin that makes it easy yet flexible to create breadcrumbs.
+It is based around the idea that breadcrumbs are a concern of the view, so you define a set of breadcrumbs in *config/breadcrumbs.rb* (or multiple files; see below) and specify in the view which breadcrumb to use.
 Gretel also supports [semantic breadcrumbs](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417) (those used in Google results).
 
 Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mailto:lassebunk@gmail.com).
@@ -17,6 +18,8 @@ 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`.
+
 
 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).
 
@@ -110,7 +113,7 @@ Option                   | Description
 
 ### Styles
 
-These are the styles you can use with `breadcrumb style: :xx`.
+These are the styles you can use with `breadcrumbs style: :xx`.
 
 Style        | Description
 ------------ | -----------
@@ -251,6 +254,13 @@ When configuring breadcrumbs inside a `crumb :xx do ... end` block, you have acc
 If you have a large site and you want to split your breadcrumbs configuration over multiple files, you can create a folder named `config/breadcrumbs` and put your configuration files (e.g. `products.rb` or `frontend.rb`) in there.
 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.
+
+For example `breadcrumb @product` is short for `breadcrumb :product, @product`.
+
+
 ### Automatic reloading of breadcrumb configuration files
 
 Since Gretel version 2.1.0, the breadcrumb configuration files are now reloaded in the Rails development environment if they change. In other environments, like production, the files are loaded once, when first needed.
@@ -301,8 +311,28 @@ in `config/breadcrumbs.rb`.
 
 Follows [semantic versioning](http://semver.org/).
 
+## Contributing
+
+You are very welcome to help improve Gretel if you have suggestions for features that other people can use.
+
+To contribute:
+
+1. Fork the project
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add new feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new pull request
+
+Thanks.
+
 ## Contributors
 
 * [See the list of contributors](https://github.com/lassebunk/gretel/graphs/contributors)
 
+## And then
+
+<img src="http://i.imgur.com/u4Wbt4n.png" alt="After using Gretel, you'll be like this" />
+
+Have fun!
+
 Copyright (c) 2010-2013 [Lasse Bunk](http://lassebunk.dk), released under the MIT license

data/lib/gretel/crumbs.rb

@@ -8,7 +8,7 @@ module Gretel
         crumbs[key] = block
       end
 
-      # Returns an array of all stored crumb blocks.
+      # Returns a hash of all stored crumb blocks.
       def crumbs
         @crumbs ||= {}
       end

data/lib/gretel/version.rb

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

data/lib/gretel/view_helpers.rb

@@ -7,6 +7,10 @@ module Gretel
     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)
+        # Enables calling `breadcrumb @product` instead of `breadcrumb :product, @product`
+        args.unshift key
+        key = key.class.model_name.to_s.underscore.to_sym
       end
       @_gretel_renderer = Gretel::Renderer.new(self, key, *args)
     end

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

@@ -68,4 +68,8 @@ end
 
 crumb :using_view_helper do
   link times_two("Test"), about_path
+end
+
+crumb :project do |project|
+  link project.name, project
 end

data/test/helper_methods_test.rb

@@ -265,6 +265,12 @@ class HelperMethodsTest < ActionView::TestCase
     end
   end
 
+  test "inferred breadcrumb" do
+    breadcrumb Project.first
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">Test Project</span></div>},
+                 breadcrumbs
+  end
+
   # Styles
 
   test "default style" do

metadata

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