gretel 1.2.1 → 2.0.0.beta1

data/lib/gretel/view_helpers.rb

@@ -0,0 +1,122 @@
+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
+    #   %>
+    def breadcrumb(*args)
+      options = args.extract_options!
+
+      if args.any?
+        @_breadcrumb_key = args.shift
+        @_breadcrumb_args = args
+      else
+        breadcrumbs(options)
+      end
+    end
+
+    # Renders the breadcrumbs HTML, for example in your layout. See the readme for default options.
+    #   <%= breadcrumbs :pretext => "You are here: " %>
+    #
+    # If you supply a block, it will yield an array with the breadcrumb links so you can build the breadcrumbs HTML manually:
+    #   <% breadcrumbs do |links| %>
+    #     <% if links.any? %>
+    #       You are here:
+    #       <% links.each do |link| %>
+    #         <%= link_to link.text, link.url %> (<%= link.key %>) %>
+    #       <% end %>
+    #     <% end %>
+    #   <% end %>
+    def breadcrumbs(options = {})
+      options = default_breadcrumb_options.merge(options)
+      links = get_breadcrumb_links(options)
+      if block_given?
+        yield links
+      else
+        render_breadcrumbs(links, options)
+      end
+    end
+
+    # Returns an array of links for the path of the breadcrumb set by +breadcrumb+.
+    def get_breadcrumb_links(options = {})
+      return [] if @_breadcrumb_key.blank?
+      
+      # Get breadcrumb set by the `breadcrumb` method
+      crumb = Gretel::Crumb.new(@_breadcrumb_key, *@_breadcrumb_args)
+
+      # Links of first crumb
+      links = crumb.links.dup
+
+      # Build parents
+      while crumb = crumb.parent
+        links.unshift *crumb.links
+      end
+
+      # Handle autoroot
+      if options[:autoroot] && links.map(&:key).exclude?(:root)
+        links.unshift *Gretel::Crumb.new(:root).links
+      end
+
+      # Handle show root alone
+      if links.count == 1 && links.first.key == :root && !options[:show_root_alone]
+        links.shift
+      end
+
+      links
+    end
+
+    # Renders breadcrumbs HTML.
+    def render_breadcrumbs(links, options)
+      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_breadcrumb_fragment(link.text, link.url, options[:semantic])
+      end
+
+      # The current link is handled a little differently, and is only linked if specified in the options
+      current_link = links.last
+      fragments << render_breadcrumb_fragment(current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], :class => options[:current_class])
+
+      # Build the final HTML
+      html = (options[:pretext] + fragments.join(options[:separator]) + options[:posttext]).html_safe
+      content_tag(:div, html, :id => options[:id], :class => options[:class])
+    end
+
+    # Renders HTML for at breadcrumb fragment, i.e. a breadcrumb link.
+    def render_breadcrumb_fragment(text, url, semantic, options = {})
+      if semantic
+        if url.present?
+          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
+      else
+        if url.present?
+          link_to(text, url, :class => options[:class])
+        elsif options[:class]
+          content_tag(:span, text, :class => options[:class])
+        else
+          text
+        end
+      end
+    end
+
+    # Default options for the breadcrumb rendering.
+    def default_breadcrumb_options
+      { :pretext => "",
+        :posttext => "",
+        :separator => " &gt; ",
+        :autoroot => false,
+        :show_root_alone => false,
+        :link_current => false,
+        :semantic => false,
+        :class => "breadcrumbs",
+        :current_class => "current",
+        :id => nil }
+    end
+  end
+end

data/lib/gretel.rb

@@ -1,8 +1,7 @@
-require 'gretel/crumb'
+require 'gretel/version'
 require 'gretel/crumbs'
-require 'gretel/helper_methods'
-require 'gretel/view_link'
+require 'gretel/crumb'
 require 'gretel/link'
-require 'gretel/parent'
+require 'gretel/view_helpers'
 
-ActionView::Base.send :include, Gretel::HelperMethods
+ActionView::Base.send :include, Gretel::ViewHelpers

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

@@ -40,4 +40,25 @@ Gretel::Crumbs.layout do
     link "Contact form", contact_form_path
     parent :basic
   end
+
+  crumb :with_proc do
+    link Proc.new { "Name from proc" }, Proc.new { "URL from proc" }
+  end
+
+  crumb :with_multiple_params do |a, b, c|
+    link "#{a} and #{b} and #{c}", contact_path
+    parent :parent_with_multiple_params, a * 2, b * 2, c * 2
+  end
+
+  crumb :parent_with_multiple_params do |d, e, f|
+    link "First #{d} then #{e} then #{f}", about_path
+  end
+
+  crumb :with_unsafe_html do
+    link "Test <strong>bold text</strong>", about_path
+  end
+
+  crumb :with_safe_html do
+    link "Test <strong>bold text</strong>".html_safe, about_path
+  end
 end

data/test/dummy/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -5,7 +5,7 @@
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
+  wrap_parameters :format => [:json]
 end
 
 # Disable root element in JSON by default.

data/test/helper_methods_test.rb

@@ -1,100 +1,125 @@
 require 'test_helper'
 
 class HelperMethodsTest < ActionView::TestCase
-  include Gretel::HelperMethods
+  include Gretel::ViewHelpers
   fixtures :all
 
-  test "should show root breadcrumb" do
-    breadcrumb :root
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><span class="current">Home</span></div>}, response
-  end
-
-  test "should show basic breadcrumb" do
+  test "shows basic breadcrumb" do
     breadcrumb :basic
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>},
+                 breadcrumbs
   end
 
-  test "should show breadcrumb with root" do
+  test "shows breadcrumb with root" do
     breadcrumb :with_root
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
+                 breadcrumbs
   end
 
-  test "should show breadcrumb with parent" do
+  test "shows breadcrumb with parent" do
     breadcrumb :with_parent
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <span class="current">Contact</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <span class="current">Contact</span></div>},
+                 breadcrumbs
   end
 
-  test "should show breadcrumb with autopath" do
+  test "shows breadcrumb with autopath" do
     breadcrumb :with_autopath, projects(:one)
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><span class="current">Test Project</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><span class="current">Test Project</span></div>},
+                 breadcrumbs
   end
 
-  test "should show breadcrumb with parent object" do
+  test "shows breadcrumb with parent object" do
     breadcrumb :with_parent_object, issues(:one)
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><a href="/projects/1">Test Project</a> &gt; <span class="current">Test Issue</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/projects/1">Test Project</a> &gt; <span class="current">Test Issue</span></div>},
+                 breadcrumbs
   end
 
-  test "should show multiple links" do
+  test "shows multiple links" do
     breadcrumb :multiple_links
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
+                 breadcrumbs
   end
 
-  test "should show multiple links with parent" do
+  test "shows multiple links with parent" do
     breadcrumb :multiple_links_with_parent
-    response = breadcrumb
-    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/about">About</a> &gt; <a href="/about/contact">Contact</a> &gt; <span class="current">Contact form</span></div>},
+                 breadcrumbs
   end
 
-  test "should show semantic breadcrumb" do
+  test "shows semantic breadcrumb" do
     breadcrumb :with_root
-    response = breadcrumb(:semantic => true)
-    assert_equal %{<div class="breadcrumbs"><div itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb"><a href="/" itemprop="url"><span itemprop="title">Home</span></a></div> &gt; <div itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb"><span class="current" itemprop="title">About</span></div></div>}, response
+    assert_equal %{<div class="breadcrumbs"><div itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb"><a href="/" itemprop="url"><span itemprop="title">Home</span></a></div> &gt; <div itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb"><span class="current" itemprop="title">About</span></div></div>},
+                 breadcrumbs(:semantic => true)
   end
 
-  test "should show no breadcrumb" do
-    assert_equal "", breadcrumb
+  test "shows no breadcrumb" do
+    assert_equal "", breadcrumbs
   end
 
-  test "should link current breadcrumb" do
+  test "links current breadcrumb" do
     breadcrumb :with_root
-    response = breadcrumb(:link_current => true)
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about" class="current">About</a></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <a href="/about" class="current">About</a></div>},
+                 breadcrumbs(:link_current => true)
   end
 
-  test "should show pretext" do
+  test "shows pretext" do
     breadcrumb :basic
-    response = breadcrumb(:pretext => "You are here: ")
-    assert_equal %{<div class="breadcrumbs">You are here: <span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs">You are here: <span class="current">About</span></div>},
+                 breadcrumbs(:pretext => "You are here: ")
   end
 
-  test "should show posttext" do
+  test "shows posttext" do
     breadcrumb :basic
-    response = breadcrumb(:posttext => " - text after breadcrumbs")
-    assert_equal %{<div class="breadcrumbs"><span class="current">About</span> - text after breadcrumbs</div>}, response
+    assert_equal %{<div class="breadcrumbs"><span class="current">About</span> - text after breadcrumbs</div>},
+                 breadcrumbs(:posttext => " - text after breadcrumbs")
   end
 
-  test "should show autoroot" do
+  test "shows autoroot" do
     breadcrumb :basic
-    response = breadcrumb(:autoroot => true)
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
+                 breadcrumbs(:autoroot => true)
   end
 
-  test "should show separator" do
+  test "shows separator" do
     breadcrumb :with_root
-    response = breadcrumb(:separator => " &rsaquo; ")
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <span class="current">About</span></div>},
+                 breadcrumbs(:separator => " &rsaquo; ")
+  end
+
+  test "shows element id" do
+    breadcrumb :basic
+    assert_equal %{<div class="breadcrumbs" id="custom_id"><span class="current">About</span></div>},
+                 breadcrumbs(:id => "custom_id")
+  end
+
+  test "unsafe html" do
+    breadcrumb :with_unsafe_html
+    assert_equal %{<div class="breadcrumbs"><span class="current">Test &lt;strong&gt;bold text&lt;/strong&gt;</span></div>},
+                 breadcrumbs
   end
 
-  test "should show element id" do
+  test "safe html" do
+    breadcrumb :with_safe_html
+    assert_equal %{<div class="breadcrumbs"><span class="current">Test <strong>bold text</strong></span></div>},
+                 breadcrumbs
+  end
+
+  test "works with legacy breadcrumb rendering method" do
     breadcrumb :basic
-    response = breadcrumb(:id => "custom_id")
-    assert_equal %{<div class="breadcrumbs" id="custom_id"><span class="current">About</span></div>}, response
+    assert_equal %{<div class="breadcrumbs"><span class="current">About</span></div>},
+                 breadcrumb
+  end
+
+  test "yields a block containing breadcrumb links array" do
+    breadcrumb :multiple_links_with_parent
+
+    out = nil # Needs to be defined here to be set inside block
+    breadcrumbs do |links|
+      out = links.map { |link| [link.key, link.text, link.url] }
+    end
+
+    assert_equal [[:basic, "About", "/about"],
+                  [:multiple_links_with_parent, "Contact", "/about/contact"],
+                  [:multiple_links_with_parent, "Contact form", "/about/contact/form"]], out
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 1.2.1
-  prerelease: 
+  version: 2.0.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-31 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,31 +45,41 @@ dependencies:
         version: '0'
 description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create
   breadcrumbs.
-email: lassebunk@gmail.com
+email:
+- lassebunk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gretel.gemspec
+- lib/generators/gretel/USAGE
 - lib/generators/gretel/gretel_generator.rb
 - lib/generators/gretel/install_generator.rb
 - lib/generators/gretel/templates/initializer.rb
-- lib/generators/gretel/USAGE
+- lib/gretel.rb
 - lib/gretel/crumb.rb
 - lib/gretel/crumbs.rb
-- lib/gretel/helper_methods.rb
 - lib/gretel/link.rb
-- lib/gretel/parent.rb
-- lib/gretel/view_link.rb
-- lib/gretel.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
+- lib/gretel/version.rb
+- lib/gretel/view_helpers.rb
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.gitkeep
+- test/dummy/app/models/.gitkeep
 - test/dummy/app/models/issue.rb
 - test/dummy/app/models/project.rb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -86,36 +96,23 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20130122163007_create_projects.rb
 - test/dummy/db/migrate/20130122163051_create_issues.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
+- test/dummy/lib/assets/.gitkeep
+- test/dummy/log/.gitkeep
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
 - test/dummy/script/rails
-- test/dummy/tmp/cache/assets/CD0/C10/sprockets%2F54298310314d4114afd54d090ef4eae3
-- test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
-- test/dummy/tmp/cache/assets/D11/910/sprockets%2Fa4743dda75a6c1d923065da98d729f21
-- test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
-- test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
-- test/dummy/tmp/cache/assets/D5F/7E0/sprockets%2F25f5ca97d1c1c044514dd8d2c5cb6d02
-- test/dummy/tmp/cache/assets/D79/060/sprockets%2Fa2cf91ba98db7115dd35bcd7881934f8
-- test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
-- test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - test/fixtures/issues.yml
 - test/fixtures/projects.yml
 - test/helper_methods_test.rb
 - test/test_helper.rb
 homepage: http://github.com/lassebunk/gretel
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,25 +123,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -511168212548034673
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Flexible Ruby on Rails breadcrumbs plugin.
 test_files:
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.gitkeep
+- test/dummy/app/models/.gitkeep
 - test/dummy/app/models/issue.rb
 - test/dummy/app/models/project.rb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -161,30 +165,16 @@ test_files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20130122163007_create_projects.rb
 - test/dummy/db/migrate/20130122163051_create_issues.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
+- test/dummy/lib/assets/.gitkeep
+- test/dummy/log/.gitkeep
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
 - test/dummy/script/rails
-- test/dummy/tmp/cache/assets/CD0/C10/sprockets%2F54298310314d4114afd54d090ef4eae3
-- test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
-- test/dummy/tmp/cache/assets/D11/910/sprockets%2Fa4743dda75a6c1d923065da98d729f21
-- test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
-- test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
-- test/dummy/tmp/cache/assets/D5F/7E0/sprockets%2F25f5ca97d1c1c044514dd8d2c5cb6d02
-- test/dummy/tmp/cache/assets/D79/060/sprockets%2Fa2cf91ba98db7115dd35bcd7881934f8
-- test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
-- test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - test/fixtures/issues.yml
 - test/fixtures/projects.yml
 - test/helper_methods_test.rb