gretel 3.0.0.beta5 → 3.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e5effb851a29b8c853f52fcf5cc456cc08af59d
-  data.tar.gz: 27d7b1df1fd9d953b9a3e4d2a70ebd444b6d644f
+  metadata.gz: bfc2f52236380030c267c75b1c8aba7e9d8a7b84
+  data.tar.gz: e6f06f5449009b772d4afeb5489f7e6de8c57d7a
 SHA512:
-  metadata.gz: 6d578d14e488a1fa88d8e60b0bbe392b95a71871857134364a1af6fa2d0c35662cdfc3c4d51623b908b02a0b27795274a47509b4cf7adda7114b64c35e9dcb4d
-  data.tar.gz: 18f43e6bd65b469f517341ad6326224252e041f8ea9392b27dbacdce835137f48fea3256d7bc3b8f90e8e041962b5783655f1fc826295ed8aab24184bb2245a1
+  metadata.gz: 84a25e66d9e93c6e525252668e85bfcd0f7546e1f41807fbe8dcab9a15ea7e08b04ecbdd9a67a6506ba7a29c318d6f290a936dfb4bd8faf4f0a1a1c4f230ddd4
+  data.tar.gz: b661508b6442f2b83966e105a0e7dfc6aa6ca2a77a29d48649cf37e8e50c94cddde3991b430e35956a0e58397509d3b64a1a6b84ec3595a4dd578b29733abbfc

data/README.md

@@ -7,8 +7,7 @@ Gretel also supports [semantic breadcrumbs](http://support.google.com/webmasters
 
 Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mailto:lassebunk@gmail.com).
 
-New in version 3.0 :muscle:
----------------------------
+## New in version 3.0
 
 * Breadcrumbs can now be rendered in different styles like ul- and ol lists, and for use with the [Twitter Bootstrap](http://getbootstrap.com/) framework. See the `:style` option below for more info.
 * Defining breadcrumbs using `Gretel::Crumbs.layout do ... end` in an initializer has been removed. See below for details on how to upgrade.
@@ -23,8 +22,7 @@ I hope you find these changes as useful as I did – if you have more suggestion
 
 See below for more info or the [changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md) for less significant changes.
 
-Installation
-------------
+## Installation
 
 In your *Gemfile*:
 
@@ -38,8 +36,7 @@ And run:
 $ bundle install
 ```
 
-Example
--------
+## Example
 
 Start by generating breadcrumbs configuration file:
 
@@ -91,8 +88,7 @@ This will generate the following HTML (indented for readability):
 </div>
 ```
 
-Options
--------
+## Options
 
 You can pass options to `<%= breadcrumbs %>`, e.g. `<%= breadcrumbs pretext: "You are here: " %>`:
 
@@ -127,8 +123,7 @@ Or you can build the breadcrumbs manually for full customization; see below.
 
 If you add other widely used styles, please submit a [Pull Request](https://github.com/lassebunk/gretel/pulls) so others can use them too.
 
-More examples
--------------
+## More examples
 
 In *config/breadcrumbs.rb*:
 
@@ -216,8 +211,7 @@ crumb :user do |user|
 end
 ```
 
-Building the breadcrumbs manually
----------------------------------
+## 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:
 
@@ -232,8 +226,7 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
 <% end %>
 ```
 
-Getting the parent breadcrumb
------------------------------
+## Getting the parent breadcrumb
 
 If you want to add a link to the parent breadcrumb, you can use the `parent_breadcrumb` view helper.
 By default it returns a link instance that has the properties `#key`, `#text`, and `#url`.
@@ -247,8 +240,7 @@ If you supply a block, it will yield the link if it is present:
 <% end %>
 ```
 
-Nice to know
-------------
+## Nice to know
 
 ### Access to view methods
 
@@ -273,8 +265,7 @@ You can apply trails to select links by adding a simple JS selector (`js-append-
 Check out the gem [here](https://github.com/lassebunk/gretel-trails).
 
 
-Upgrading from version 2.0 or below
------------------------------------
+## Upgrading from version 2.0 or below
 
 Instead of using the initializer that in Gretel version 2.0 and below required restarting the application after breadcrumb configuration changes, the configuration of the breadcrumbs is now loaded from `config/breadcrumbs.rb` (and `config/breadcrumbs/*.rb` if you want to split your breadcrumbs configuration across multiple files).
 In the Rails development environment, these files are automatically reloaded when changed.
@@ -301,19 +292,16 @@ end
 
 in `config/breadcrumbs.rb`.
 
-Documentation
--------------
+## Documentation
 
 * [Full documentation](http://rubydoc.info/gems/gretel)
 * [Changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md)
 
-Versioning
-----------
+## Versioning
 
 Follows [semantic versioning](http://semver.org/).
 
-Contributors
-------------
+## Contributors
 
 * [See the list of contributors](https://github.com/lassebunk/gretel/graphs/contributors)
 

data/lib/gretel.rb

@@ -1,4 +1,5 @@
 require 'gretel/version'
+require 'gretel/resettable'
 require 'gretel/crumbs'
 require 'gretel/crumb'
 require 'gretel/link'
@@ -8,6 +9,8 @@ require 'gretel/deprecated'
 
 module Gretel
   class << self
+    include Resettable
+
     # Returns the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+.
     def breadcrumb_paths
       @breadcrumb_paths ||= [Rails.root.join("config", "breadcrumbs.rb"), Rails.root.join("config", "breadcrumbs", "**", "*.rb")]
@@ -59,27 +62,7 @@ module Gretel
     def configure
       yield self
     end
-
-    # Resets all changes made to +Gretel+, +Gretel::Crumbs+, and +Gretel::Trail+. Used for testing.
-    def reset!
-      instance_variables.each { |var| remove_instance_variable var }
-      Crumbs.reset!
-    end
   end
 end
 
-Gretel.configure do |config|
-  # Default style
-  config.register_style :default, { container_tag: :div, separator: " &rsaquo; " }
-
-  # Ordered list
-  config.register_style :ol, { container_tag: :ol, fragment_tag: :li }
-
-  # Unordered list
-  config.register_style :ul, { container_tag: :ul, fragment_tag: :li }
-
-  # Twitter Bootstrap
-  config.register_style :bootstrap, { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", current_class: "active" }
-end
-
 ActionView::Base.send :include, Gretel::ViewHelpers

data/lib/gretel/crumbs.rb

@@ -1,6 +1,8 @@
 module Gretel
   module Crumbs
     class << self
+      include Resettable
+
       # Stores the supplied block for later use.
       def crumb(key, &block)
         crumbs[key] = block
@@ -52,11 +54,6 @@ module Gretel
         Dir[*Gretel.breadcrumb_paths]
       end
 
-      # Resets all changes made to +Gretel::Crumbs+. Used for testing.
-      def reset!
-        instance_variables.each { |var| remove_instance_variable var }
-      end
-
     private
 
       def loaded_file_mtimes

data/lib/gretel/renderer.rb

@@ -14,6 +14,13 @@ module Gretel
       id: nil
     }
 
+    DEFAULT_STYLES = {
+      default: { container_tag: :div, separator: " › " },
+      ol: { container_tag: :ol, fragment_tag: :li },
+      ul: { container_tag: :ul, fragment_tag: :li },
+      bootstrap: { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", current_class: "active" }
+    }
+
     def initialize(context, breadcrumb_key, *breadcrumb_args)
       @context = context
       @breadcrumb_key = breadcrumb_key
@@ -64,8 +71,8 @@ module Gretel
     end
 
     # Proxy for +context.link_to+ that can be overridden by plugins.
-    def breadcrumb_link_to(*args)
-      context.link_to(*args)
+    def breadcrumb_link_to(name, url, options = {})
+      context.link_to(name, url, options)
     end
 
     private
@@ -96,43 +103,41 @@ module Gretel
         out.unshift *Gretel::Crumb.new(context, :root).links
       end
 
+      # Set current link to actual path
+      if out.any? && request
+        out.last.url = request.fullpath
+      end
+
       # Handle show root alone
       if out.size == 1 && !options[:display_single_fragment]
         out.shift
       end
 
+      # Set last link to current
+      out.last.try(:current!)
+
       out
     end
 
     # Array of links for the path of the breadcrumb.
     # Also reloads the breadcrumb configuration if needed.
     def links
-      @links ||= begin
-        if @breadcrumb_key.present?
-          # Reload breadcrumbs configuration if needed
-          Gretel::Crumbs.reload_if_needed
-
-          # Get breadcrumb set by the `breadcrumb` method
-          crumb = Gretel::Crumb.new(context, breadcrumb_key, *breadcrumb_args)
-
-          # Links of first crumb
-          links = crumb.links.dup
-          
-          # Set current link to actual path
-          if links.any? && request
-            links.last.url = request.fullpath
-          end
-
-          # Get parent links
-          links.unshift *parent_links_for(crumb)
-
-          # Set last link to current
-          links.last.try(:current!)
-
-          links
-        else
-          []
-        end
+      @links ||= if @breadcrumb_key.present?
+        # Reload breadcrumbs configuration if needed
+        Gretel::Crumbs.reload_if_needed
+
+        # Get breadcrumb set by the `breadcrumb` method
+        crumb = Gretel::Crumb.new(context, breadcrumb_key, *breadcrumb_args)
+
+        # Links of first crumb
+        links = crumb.links.dup
+        
+        # Get parent links
+        links.unshift *parent_links_for(crumb)
+
+        links
+      else
+        []
       end
     end
 
@@ -187,6 +192,8 @@ module Gretel
     end
 
     class << self
+      include Resettable
+      
       # Registers a style for later use.
       # 
       #   Gretel::Renderer.register_style :ul, { container_tag: :ul, fragment_tag: :li }
@@ -196,7 +203,7 @@ module Gretel
 
       # Hash of registered styles.
       def styles
-        @styles ||= {}
+        @styles ||= DEFAULT_STYLES
       end
     end
   end

data/lib/gretel/resettable.rb

@@ -0,0 +1,13 @@
+module Gretel
+  module Resettable
+    # Resets all instance variables and calls +reset!+ on all child modules and
+    # classes. Used for testing.
+    def reset!
+      instance_variables.each { |var| remove_instance_variable var }
+      constants.each do |c|
+        c = const_get(c)
+        c.reset! if c.respond_to?(:reset!)
+      end
+    end
+  end
+end

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "3.0.0.beta5"
+  VERSION = "3.0.0.beta6"
 end

data/lib/gretel/view_helpers.rb

@@ -11,6 +11,24 @@ module Gretel
       @_gretel_renderer = Gretel::Renderer.new(self, key, *args)
     end
 
+    # Yields a block where inside the block you have a different breadcrumb than outside.
+    # 
+    #   <% breadcrumb :about %>
+    # 
+    #   <%= breadcrumbs # shows the :about breadcrumb %>
+    # 
+    #   <% with_breadcrumb :product, Product.first do %>
+    #     <%= breadcrumbs # shows the :product breadcrumb %>
+    #   <% end %>
+    # 
+    #   <%= breadcrumbs # shows the :about breadcrumb %>
+    def with_breadcrumb(key, *args, &block)
+      original_renderer = @_gretel_renderer
+      @_gretel_renderer = Gretel::Renderer.new(self, key, *args)
+      yield
+      @_gretel_renderer = original_renderer
+    end
+
     # Renders the breadcrumbs HTML, for example in your layout. See the readme for default options.
     #   <%= breadcrumbs pretext: "You are here: " %>
     #

data/test/helper_methods_test.rb

@@ -214,6 +214,21 @@ class HelperMethodsTest < ActionView::TestCase
                  breadcrumbs
   end
 
+  test "with_breadcrumb" do
+    breadcrumb :basic
+    
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">About</span></div>},
+                 breadcrumbs
+
+    with_breadcrumb(:with_parent_object, issues(:one)) do
+      assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <a href="/projects/1">Test Project</a> &rsaquo; <span class="current">Test Issue</span></div>},
+                   breadcrumbs
+    end    
+    
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">About</span></div>},
+                 breadcrumbs
+  end
+
   test "calling breadcrumbs helper twice" do
     breadcrumb :with_parent
     2.times do
@@ -295,6 +310,15 @@ class HelperMethodsTest < ActionView::TestCase
     end
   end
 
+  test "register style" do
+    Gretel.register_style :test_style, { container_tag: :one, fragment_tag: :two }
+    
+    breadcrumb :basic
+
+    assert_equal %{<one class="breadcrumbs"><two><a href="/">Home</a></two><two class="current">About</two></one>},
+                 breadcrumbs(style: :test_style)
+  end
+
   # Configuration reload
 
   test "reload configuration when file is changed" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta5
+  version: 3.0.0.beta6
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,6 +79,7 @@ files:
 - lib/gretel/deprecated/show_root_alone.rb
 - lib/gretel/link.rb
 - lib/gretel/renderer.rb
+- lib/gretel/resettable.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
 - test/deprecated_test.rb
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.