gretel 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3e002fa0feb5ee917e81324762d2d48274e7e35
-  data.tar.gz: 16338b4f9d61b4e689ec73c7e4d6bf34152aba11
+  metadata.gz: 8e6f73ad81f2db21b1b45557f25a6f9752874527
+  data.tar.gz: 1fde6352fb2a14d020295b5bf64e56d83b88c54e
 SHA512:
-  metadata.gz: ae5738c15905088b11940343d2bfdcb4fa9df67cb999038a9df5334b78caf8db3b9c78c8941f74fb7c38fc991c50cc4f6da80990e98bcc201dbe72a05cac4c9e
-  data.tar.gz: f5571a9bf4caa6df4d4569c90667aeaab7e8e19d5c8d5f456516afffe1d97cdbe45689487654b8f31c024c0565e90b95c85e8449fc3ec5527d2517ba36aa06d1
+  metadata.gz: 193c5462d11f70efa13f28512deb0268757c6f4367ff27b6d7440beb60a18d3f977fca9a4622eb8ebf2717ff7901be47d54e3a881949b0ba6ba72af8c5cc257a
+  data.tar.gz: 1ad2ee35b362c693da5c579f2a05d268f0dd6e0a45386c456aad3f31a55a380137eafaea60d52e9cf91424f9a8493c53edd816662be2f16b2eb7a4a3eb9820b6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 3.0.3
+* Breadcrumbs can now be rendered for use in the [Foundation 5](http://foundation.zurb.com/) framework. Use `breadcrumbs style: :foundation5`.
+* Breadcrumbs are now automatically loaded from any engines' `config/breadcrumbs.rb` and `config/breadcrumbs/**/*.rb`. See the readme for details.
+* You can now pass options to links to be used when you render manually. See the readme for details.
+* Breadcrumb configuration files can now be put in the `app/views/breadcrumbs/` folder. This is an experimental feature that may replace loading breadcrumbs from the `config` folder in the future.
+
 ## Version 3.0.2
 * Inferring breadcrumbs is now supported on all instances of objects that respond to `model_name`.
 

data/README.md

@@ -115,12 +115,13 @@ Option                   | Description
 
 These are the styles you can use with `breadcrumbs style: :xx`.
 
-Style        | Description
------------- | -----------
-`:default`   | Renders each link by itself with `›` as the seperator.
-`:ol`        | Renders the links in `<li>` elements contained in an outer `<ol>`.
-`:ul`        | Renders the links in `<li>` elements contained in an outer `<ul>`.
-`:bootstrap` | Renders the links for use in [Twitter Bootstrap](http://getbootstrap.com/).
+Style          | Description
+-------------- | -----------
+`:default`     | Renders each link by itself with `&rsaquo;` as the seperator.
+`:ol`          | Renders the links in `<li>` elements contained in an outer `<ol>`.
+`:ul`          | Renders the links in `<li>` elements contained in an outer `<ul>`.
+`:bootstrap`   | Renders the links for use in [Twitter Bootstrap](http://getbootstrap.com/).
+`:foundation5` | Renders the links for use in [Foundation 5](http://foundation.zurb.com/).
 
 Or you can build the breadcrumbs manually for full customization; see below.
 
@@ -238,7 +239,7 @@ 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| %>
+<% parent_breadcrumb do |link| %>
   <%= link_to "Back to #{link.text}", link.url %>
 <% end %>
 ```
@@ -254,6 +255,11 @@ 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.
 
+### Loading breadcrumbs from engines
+
+Breadcrumbs are automatically loaded from any engines' `config/breadcrumbs.rb` and `config/breadcrumbs/**/*.rb`.
+Breadcrumbs defined in your main app will override breadcrumbs from engines.
+
 ### Inferring breadcrumbs
 
 Breadcrumbs can be automatically inferred if you pass an instance of an object that responds to `model_name` (like an ActiveRecord model instance).
@@ -270,6 +276,33 @@ is short for
 <% breadcrumb :product, @product %>
 ```
 
+### Passing options to links
+
+You can pass options to links to be used when you render breadcrumbs manually.
+
+In *config/breadcrumbs.rb*:
+
+```ruby
+crumb :something do
+  link "My Link", my_path, title: "My Title", other: "My Other Option"
+end
+```
+
+Example methods you can then use in the view:
+
+```ruby
+breadcrumbs do |links|
+  links.each do |link|
+    link.title?              # => true
+    link.title               # => "My Title"
+    link.other?              # => true
+    link.other               # => "My Other Option"
+    link.nonexisting_option? # => false
+    link.nonexisting_option  # => nil
+  end
+end
+```
+
 ### 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.

data/lib/gretel.rb

@@ -11,9 +11,18 @@ module Gretel
   class << self
     include Resettable
 
-    # Returns the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+.
+    # Returns the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+
+    # in the app and all loaded engines. Breadcrumbs set in the app will override
+    # breadcrumbs set in engines.
     def breadcrumb_paths
-      @breadcrumb_paths ||= [Rails.root.join("config", "breadcrumbs.rb"), Rails.root.join("config", "breadcrumbs", "**", "*.rb")]
+      @breadcrumb_paths ||= begin
+        engine_roots = Rails::Application::Railties.engines.map { |e| e.config.root }
+        
+        [Rails.root.join("app", "views", "breadcrumbs", "**", "*.rb")] +
+        [*engine_roots, Rails.root].map do |root|
+          [root.join("config", "breadcrumbs.rb"), root.join("config", "breadcrumbs", "**", "*.rb")]
+        end.flatten
+      end
     end
 
     # Sets the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+.

data/lib/gretel/crumb.rb

@@ -11,11 +11,20 @@ module Gretel
     end
 
     # Sets link of the breadcrumb.
-    def link(text, url = nil)
+    # You can supply an optional options hash that will be available on the links
+    # so you can pass info when rendering the breadcrumbs manually.
+    #
+    #   link "My Link", my_link_path
+    #   link "Without URL"
+    #   link "With Options", my_path, title: "Test", other: "Some other value"
+    def link(*args)
+      options = args.extract_options!
+      text, url = args
+
       # Transform objects to real paths.
       url = url_for(url) if url
       
-      links << Gretel::Link.new(key, text, url)
+      links << Gretel::Link.new(key, text, url, options)
     end
 
     # Holds all of the breadcrumb's links as a breadcrumb can have multiple links.

data/lib/gretel/link.rb

@@ -1,18 +1,39 @@
 module Gretel
   class Link
-    attr_accessor :key, :text, :url
+    attr_accessor :key, :text, :url, :options
 
-    def initialize(key, text, url)
+    def initialize(key, text, url, options = {})
       # Use accessors so plugins can override their behavior
-      self.key, self.text, self.url = key, text, url
+      self.key, self.text, self.url, self.options = key, text, url, options
     end
 
+    # Sets current so +current?+ will return +true+.
     def current!
       @current = true
     end
 
+    # Returns +true+ if this is the last link in the breadcrumb trail.
     def current?
       !!@current
     end
+
+    # Enables accessors and predicate methods for values in the +options+ hash.
+    # This can be used to pass information to links when rendering breadcrumbs
+    # manually.
+    #
+    #   link = Link.new(:my_crumb, "My Crumb", my_path, title: "Test Title", other_value: "Other")
+    #   link.title?       # => true
+    #   link.title        # => "Test Title"
+    #   link.other_value? # => true
+    #   link.other_value  # => "Other"
+    #   link.some_other?  # => false
+    #   link.some_other   # => nil
+    def method_missing(method, *args, &block)
+      if method =~ /(.+)\?$/
+        options[$1.to_sym].present?
+      else
+        options[method]
+      end
+    end
   end
 end

data/lib/gretel/renderer.rb

@@ -18,7 +18,8 @@ module Gretel
       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" }
+      bootstrap: { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", current_class: "active" },
+      foundation5: { container_tag: :ul, fragment_tag: :li, class: "breadcrumb", current_class: "current" }
     }
 
     def initialize(context, breadcrumb_key, *breadcrumb_args)
@@ -34,12 +35,9 @@ module Gretel
 
       return "" if links.empty?
 
-      # Array to hold the HTML fragments
-      fragments = []
-
       # Loop through all but the last (current) link and build HTML of the fragments
-      links[0..-2].each do |link|
-        fragments << render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic])
+      fragments = links[0..-2].map do |link|
+        render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic])
       end
 
       # The current link is handled a little differently, and is only linked if specified in the options
@@ -207,4 +205,4 @@ module Gretel
       end
     end
   end
-end
+end

data/lib/gretel/version.rb

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

data/test/dummy/app/views/breadcrumbs/site.rb

@@ -0,0 +1,3 @@
+crumb :from_views do
+  link "Breadcrumb From View", about_path
+end

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

@@ -72,4 +72,9 @@ end
 
 crumb :project do |project|
   link project.name, project
+end
+
+crumb :with_link_options do
+  link "Test", about_path, title: "My Title", other: "Other Option"
+  link "Other Link", some_option: "Test"
 end

data/test/gretel_test.rb

@@ -7,7 +7,7 @@ class GretelTest < ActiveSupport::TestCase
 
   test "defaults" do
     assert_equal [Rails.root.join("config", "breadcrumbs.rb"), Rails.root.join("config", "breadcrumbs", "**", "*.rb")],
-                 Gretel.breadcrumb_paths
+                 Gretel.breadcrumb_paths[-2..-1]
     assert_equal ["development"], Gretel.reload_environments
     assert !Gretel.suppress_deprecation_warnings?
   end

data/test/helper_methods_test.rb

@@ -196,6 +196,31 @@ class HelperMethodsTest < ActionView::TestCase
     assert_equal [false, false, false, true], out
   end
 
+  test "passing options to links" do
+    breadcrumb :with_link_options
+
+    breadcrumbs(autoroot: false) do |links|
+      links[0].tap do |link|
+        assert link.title?
+        assert_equal "My Title", link.title
+        
+        assert link.other?
+        assert_equal "Other Option", link.other
+        
+        assert !link.nonexistent?
+        assert_nil link.nonexistent
+      end
+
+      links[1].tap do |link|
+        assert link.some_option?
+        assert_equal "Test", link.some_option
+      end
+    end
+
+    assert_equal %{<div class="breadcrumbs"><a href="/about">Test</a> &rsaquo; <span class="current">Other Link</span></div>},
+                 breadcrumbs(autoroot: false)
+  end
+
   test "without link" do
     breadcrumb :without_link
     assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; Also without link &rsaquo; <span class="current">Without link</span></div>},
@@ -214,6 +239,12 @@ class HelperMethodsTest < ActionView::TestCase
                  breadcrumbs
   end
 
+  test "from views folder" do
+    breadcrumb :from_views
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">Breadcrumb From View</span></div>},
+                 breadcrumbs
+  end
+
   test "with_breadcrumb" do
     breadcrumb :basic
     
@@ -297,6 +328,12 @@ class HelperMethodsTest < ActionView::TestCase
                  breadcrumbs(style: :bootstrap)
   end
 
+  test "foundation5 style" do
+    breadcrumb :basic
+    assert_equal %{<ul class="breadcrumb"><li><a href="/">Home</a></li><li class="current">About</li></ul>},
+	         breadcrumbs(style: :foundation5)
+  end
+
   test "custom container and fragment tags" do
     breadcrumb :basic
     assert_equal %{<c class="breadcrumbs"><f><a href="/">Home</a></f> &rsaquo; <f class="current">About</f></c>},
@@ -476,4 +513,4 @@ private
 
     path
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -92,6 +92,7 @@ files:
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/issue.rb
 - test/dummy/app/models/project.rb
+- test/dummy/app/views/breadcrumbs/site.rb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.
@@ -160,6 +161,7 @@ test_files:
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/issue.rb
 - test/dummy/app/models/project.rb
+- test/dummy/app/views/breadcrumbs/site.rb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb