gretel 2.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20b6074d04a88e299ce92a69065f183ba6e299ca
+  data.tar.gz: 33fa2c8f9ff4cb909a430786d1e4b467ffec40f5
+SHA512:
+  metadata.gz: 38c61ee418788d568672b173f8fb72e67d45b00c6022210c37009a0bb9a53b6885c71d286647a583ebf0390544ee495e094129945919147161e201a2d68164a9
+  data.tar.gz: af07be5e7434820b66b08f3e48959e8f123658ec5cd5f978264a80c2443480c70a46181f813ed38048d68fc2ff013490a3dfd03e067dca1e39f933be5084b104

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.8.7
 before_script:

data/CHANGELOG.md

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

data/README.md

@@ -2,20 +2,40 @@
 
 Gretel is a [Ruby on Rails](http://rubyonrails.org) plugin that makes it easy yet flexible to create breadcrumbs.
 
+New in version 2.1
+------------------
+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.
 
-Installation
-------------
+Using the initializer (e.g. `config/initializers/breadcrumbs.rb`) is deprecated but still supported until Gretel version 3.0.
 
-In your *Gemfile*:
+To update, use `bundle update gretel`. Then remove the `Gretel::Crumbs.layout do ... end` block, so instead of:
 
 ```ruby
-gem 'gretel', '2.0.0.beta1'
+Gretel::Crumbs.layout do
+  crumb :root do
+    link "Home", root_path
+  end
+end
 ```
 
-Or, if you want to run the stable version ([see documentation](https://github.com/lassebunk/gretel/tree/v1.2.1)):
+in the initializer, you write:
 
 ```ruby
-gem 'gretel', '1.2.1'
+crumb :root do
+  link "Home", root_path
+end
+```
+
+in `config/breadcrumbs.rb`.
+
+Installation
+------------
+
+In your *Gemfile*:
+
+```ruby
+gem "gretel"
 ```
 
 And run:
@@ -27,31 +47,29 @@ $ bundle install
 Example
 -------
 
-Start by generating an initializer:
+Start by generating breadcrumbs configuration file:
 
 ```bash
 $ rails generate gretel:install
 ```
 
-Then, in *config/initializers/breadcrumbs.rb*:
+Then, in *config/breadcrumbs.rb*:
 
 ```ruby
-Gretel::Crumbs.layout do
-  # Root crumb
-  crumb :root do
-    link "Home", root_path
-  end
+# Root crumb
+crumb :root do
+  link "Home", root_path
+end
 
-  # Issue list
-  crumb :issues do
-    link "All issues", issues_path
-  end
+# Issue list
+crumb :issues do
+  link "All issues", issues_path
+end
 
-  # Issue
-  crumb :issue do |issue|
-    link issue.title, issue
-    parent :issues
-  end
+# Issue
+crumb :issue do |issue|
+  link issue.title, issue
+  parent :issues
 end
 ```
 
@@ -97,6 +115,94 @@ Option           | Description
 :class           | CSS class for the breadcrumbs container.                                                                                   | `"breadcrumbs"`
 :current_class   | CSS class for the current link or span.                                                                                    | `"current"`
 
+More examples
+-------------
+
+In *config/breadcrumbs.rb*:
+
+```ruby
+# Root crumb
+crumb :root do
+  link "Home", root_path
+end
+
+# Regular crumb
+crumb :projects do
+  link "Projects", projects_path
+end
+
+# Parent crumbs
+crumb :project_issues do |project|
+  link "Issues", project_issues_path(project)
+  parent :project, project
+end
+
+# Child 
+crumb :issue do |issue|
+  link issue.name, issue_path(issue)
+  parent :project_issues, issue.project
+end
+
+# Multiple links per crumb (recursive links for parent categories)
+crumb :category do |category|
+  parents = [category]
+
+  parent_category = category
+  while parent_category = parent_category.parent_category
+    parents.unshift parent_category
+  end
+
+  parents.each do |category|
+    link category.name, category
+  end
+
+  parent :categories
+end
+
+# Product crumb with recursive parent categories
+crumb :product do |product|
+  link product.name, product
+  parent :category, product.category
+end
+
+# Example of using params to alter the parent, e.g. to
+# match the user's actual navigation path
+# URL: /products/123?q=my+search
+crumb :search do |keyword|
+  link "Search for #{keyword}", search_path(:q => keyword)
+end
+
+crumb :product do |product|
+  if keyword = params[:q].presence
+    parent :search, keyword
+  else # default
+    parent :category, product.category
+  end
+end
+
+# Multiple arguments
+crumb :multiple_test do |a, b, c|
+  link "Test #{a}, #{b}, #{c}", test_path
+  parent :other_test, 3, 4, 5
+end
+
+# Breadcrumb without link URL; will not generate a link
+crumb :without_link do
+  link "Breadcrumb without link"
+end
+
+# Breadcrumb using view helper
+module UsersHelper
+  def user_name_for(user)
+    user.name
+  end
+end
+
+crumb :user do |user|
+  link user_name_for(user), user
+end
+```
+
 Building the breadcrumbs manually
 ---------------------------------
 
@@ -113,85 +219,21 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
 <% end %>
 ```
 
-More examples
--------------
-
-In *config/initializers/breadcrumbs.rb*:
-
-```ruby
-Gretel::Crumbs.layout do
-  # Root crumb
-  crumb :root do
-    link "Home", root_path
-  end
-  
-  # Regular crumb
-  crumb :projects do
-    link "Projects", projects_path
-  end
-
-  # Parent crumbs
-  crumb :project_issues do |project|
-    link "Issues", project_issues_path(project)
-    parent :project, project
-  end
-  
-  # Child 
-  crumb :issue do |issue|
-    link issue.name, issue_path(issue)
-    parent :project_issues, issue.project
-  end
-  
-  # Multiple links per crumb (recursive links for parent categories)
-  crumb :category do |category|
-    parents = [category]
-  
-    parent_category = category
-    while parent_category = parent_category.parent_category
-      parents.unshift parent_category
-    end
-  
-    parents.each do |category|
-      link category.name, category
-    end
-
-    parent :categories
-  end
-  
-  # Product crumb with recursive parent categories
-  crumb :product do |product|
-    link product.name, product
-    parent :category, product.category
-  end
+Nice to know
+------------
 
-  # Multiple arguments
-  crumb :multiple_test do |a, b, c|
-    link "Test #{a}, #{b}, #{c}", test_path
-    parent :other_test, 3, 4, 5
-  end
+### Access to view helpers
 
-  # Breadcrumb without link URL; will not generate a link
-  crumb :without_link do
-    link "Breadcrumb without link"
-  end
+When inside `Gretel::Crumbs.layout do .. end`, you have access to all view helpers of the current view where the breadcrumbs are inserted.
 
-  # Breadcrumb using view helper
-  module UsersHelper
-    def user_name_for(user)
-      user.name
-    end
-  end
+### Using multiple breadcrumb configuration files
 
-  crumb :user do |user|
-    link user_name_for(user), user
-  end
-end
-```
+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.
 
-Access to view helpers
-----------------------
+### Automatic reloading of breadcrumb configuration files
 
-When inside `Gretel::Crumbs.layout do .. end`, you have access to all view helpers of the current view where the breadcrumbs are inserted.
+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.
 
 Documentation
 -------------
@@ -199,6 +241,11 @@ Documentation
 * [Full documentation](http://rubydoc.info/gems/gretel)
 * [Changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md)
 
+Versioning
+----------
+
+Follows [semantic versioning](http://semver.org/).
+
 Contributors
 ------------
 

data/gretel.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rails", "~> 3.2.11"
+  gem.add_development_dependency "rails", "~> 3.2.13"
   gem.add_development_dependency "sqlite3"
 end

data/lib/generators/gretel/USAGE

@@ -1,8 +1,8 @@
 Description:
-  Generates initializer for Gretel.
+  Generates a sample breadcrumbs configuration file for Gretel.
 
 Example:
   rails generate gretel:install
 
   This will create:
-    config/initializers/breadcrumbs.rb
+    config/breadcrumbs.rb

data/lib/generators/gretel/install_generator.rb

@@ -4,9 +4,9 @@ module Gretel
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     
-    desc "Creates an initializer for breadcrumbs in config/initializers/breadcrumbs.rb"
-    def create_initializer
-      copy_file "initializer.rb", "config/initializers/breadcrumbs.rb"
+    desc "Creates a sample configuration file in config/breadcrumbs.rb"
+    def create_config_file
+      copy_file "breadcrumbs.rb", "config/breadcrumbs.rb"
     end
   end
 end

data/lib/generators/gretel/templates/breadcrumbs.rb

@@ -0,0 +1,28 @@
+crumb :root do
+  link "Home", root_path
+end
+
+# crumb :projects do
+#   link "Projects", projects_path
+# end
+
+# crumb :project do |project|
+#   link project.name, project_path(project)
+#   parent :projects
+# end
+
+# crumb :project_issues do |project|
+#   link "Issues", project_issues_path(project)
+#   parent :project, project
+# end
+
+# crumb :issue do |issue|
+#   link issue.title, issue_path(issue)
+#   parent :project_issues, issue.project
+# end
+
+# If you want to split your breadcrumbs configuration over multiple files, you
+# can create a folder named `config/breadcrumbs` and put your configuration
+# files there. All *.rb files (e.g. `frontend.rb` or `products.rb`) in that
+# folder are loaded and reloaded automatically when you change them, just like
+# this file (`config/breadcrumbs.rb`).

data/lib/gretel.rb

@@ -3,5 +3,51 @@ require 'gretel/crumbs'
 require 'gretel/crumb'
 require 'gretel/link'
 require 'gretel/view_helpers'
+require 'gretel/deprecated'
+
+module Gretel
+  class << self
+    # 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")]
+    end
+
+    # Sets the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+.
+    def breadcrumb_paths=(paths)
+      @breadcrumb_paths = paths
+    end
+
+    # Whether to suppress deprecation warnings.
+    def suppress_deprecation_warnings?
+      !!@suppress_deprecation_warnings
+    end
+
+    # Sets whether to suppress deprecation warnings.
+    def suppress_deprecation_warnings=(value)
+      @suppress_deprecation_warnings = value
+    end
+
+    # Shows a deprecation warning.
+    def show_deprecation_warning(message)
+      return if suppress_deprecation_warnings?
+      puts message
+      Rails.logger.warn message
+    end
+
+    # Array of Rails environment names with automatic configuration reload. Default is +["development"]+.
+    def reload_environments
+      @reload_environments ||= ["development"]
+    end
+
+    # Sets the Rails environment names with automatic configuration reload. Default is +["development"]+.
+    attr_writer :reload_environments
+
+    # Resets all changes made to +Gretel+ and +Gretel::Crumbs+. Used for testing.
+    def reset!
+      instance_variables.each { |var| remove_instance_variable var }
+      Crumbs.reset!
+    end
+  end
+end
 
 ActionView::Base.send :include, Gretel::ViewHelpers

data/lib/gretel/crumb.rb

@@ -35,6 +35,8 @@ module Gretel
 
     # Key of the breadcrumb.
     attr_reader :key
+
+    # The current view context.
     attr_reader :context
 
     # Proxy to view context

data/lib/gretel/crumbs.rb

@@ -1,18 +1,6 @@
 module Gretel
   module Crumbs
     class << self
-      # Lay out the breadcrumbs.
-      #
-      # Example:
-      #   Gretel::Crumbs.layout do
-      #     crumb :root do
-      #       link "Home", root_path
-      #     end
-      #   end
-      def layout(&block)
-        instance_eval &block
-      end
-
       # Stores the supplied block for later use.
       def crumb(key, &block)
         crumbs[key] = block
@@ -27,6 +15,56 @@ module Gretel
       def crumb_defined?(key)
         crumbs.has_key?(key)
       end
+
+      # Loads the breadcrumb configuration files.
+      def load_breadcrumbs
+        @crumbs = {}
+
+        # Deprecated in v2.1.0.
+        instance_eval &deprecated_breadcrumbs_block
+
+        loaded_file_mtimes.clear
+        breadcrumb_files.each do |file|
+          instance_eval open(file).read, file
+          loaded_file_mtimes << File.mtime(file)
+        end
+
+        @loaded = true
+      end
+
+      # Reloads the breadcrumb configuration files if they have changed.
+      def reload_if_needed
+        load_breadcrumbs if reload?
+      end
+
+      # Returns true if a breadcrumbs reload is needed based on configuration file changes.
+      def reload?
+        return true unless loaded?
+        return false unless Gretel.reload_environments.include?(Rails.env)
+
+        loaded_file_mtimes != breadcrumb_files.map { |file| File.mtime(file) }
+      end
+
+      # Returns true if the breadcrumb configuration files have been loaded.
+      def loaded?
+        !!@loaded
+      end
+
+      # List of breadcrumb configuration files.
+      def breadcrumb_files
+        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
+        @loaded_file_mtimes ||= []
+      end
     end
   end
 end

data/lib/gretel/deprecated.rb

@@ -0,0 +1,27 @@
+module Gretel
+  module Crumbs
+    class << self
+      # Lay out the breadcrumbs.
+      # Deprecated since v2.1.0. Put breadcrumbs in +config/breadcrumbs.rb+ instead (see https://github.com/lassebunk/gretel/blob/master/README.md for details).
+      #
+      # Example:
+      #   Gretel::Crumbs.layout do
+      #     crumb :root do
+      #       link "Home", root_path
+      #     end
+      #   end
+      def layout(&block)
+        Gretel.show_deprecation_warning(
+          "Gretel::Crumbs.layout has been deprecated and will be removed in Gretel version 3.0. " +
+          "Please put your breadcrumbs in `config/breadcrumbs.rb`. " +
+          "This will also automatically reload your breadcrumbs when you change them in the development environment. " +
+          "See https://github.com/lassebunk/gretel/blob/master/README.md for details.")
+        @deprecated_breadcrumbs_block = block
+      end
+
+      def deprecated_breadcrumbs_block
+        @deprecated_breadcrumbs_block ||= Proc.new {}
+      end
+    end
+  end
+end

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/gretel/view_helpers.rb

@@ -28,6 +28,8 @@ module Gretel
     #     <% end %>
     #   <% end %>
     def breadcrumbs(options = {})
+      Gretel::Crumbs.reload_if_needed
+      
       options = default_breadcrumb_options.merge(options)
       links = get_breadcrumb_links(options)
       if block_given?

data/test/deprecated_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class DeprecatedTest < ActionView::TestCase
+  include Gretel::ViewHelpers
+  fixtures :all
+  helper :application
+
+  setup do
+    Gretel.reset!
+  end
+
+  test "deprecated configuration block" do
+    Gretel.suppress_deprecation_warnings = true
+    
+    Gretel::Crumbs.layout do
+      crumb :deprecated_parent do
+        link "Test deprecated", root_path
+      end
+
+      crumb :deprecated_child do
+        link "Child", about_path
+        parent :deprecated_parent
+      end
+    end
+
+    breadcrumb :deprecated_child
+    assert_equal %{<div class="breadcrumbs"><a href="/">Test deprecated</a> &gt; <span class="current">Child</span></div>},
+                 breadcrumbs(:autoroot => false)
+  end
+end

data/test/dummy/config/breadcrumbs.rb

@@ -0,0 +1,3 @@
+crumb :root do
+  link "Home", root_path
+end

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

@@ -0,0 +1,71 @@
+crumb :basic do
+  link "About", about_path
+end
+
+crumb :with_root do
+  link "About", about_path
+  parent :root
+end
+
+crumb :with_parent do
+  link "Contact", contact_path
+  parent :basic
+end
+
+crumb :object do |project|
+  link project.name, project
+end
+
+crumb :with_autopath do |project|
+  link project.name, project
+end
+
+crumb :with_parent_object do |issue|
+  link issue.title, project_issue_path(issue.project, issue)
+  parent :object, issue.project
+end
+
+crumb :multiple_links do
+  link "Contact", contact_path
+  link "Contact form", contact_form_path
+end
+
+crumb :multiple_links_with_parent do
+  link "Contact", contact_path
+  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_arguments do |a, b, c|
+  link "#{a} and #{b} and #{c}", contact_path
+  parent :parent_with_multiple_arguments, a * 2, b * 2, c * 2
+end
+
+crumb :parent_with_multiple_arguments 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
+
+crumb :without_link do
+  link "Without link"
+  parent :parent_without_link
+end
+
+crumb :parent_without_link do
+  link "Also without link"
+end
+
+crumb :using_view_helper do
+  link times_two("Test"), about_path
+end

data/test/gretel_test.rb

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

data/test/helper_methods_test.rb

@@ -5,6 +5,10 @@ class HelperMethodsTest < ActionView::TestCase
   fixtures :all
   helper :application
 
+  setup do
+    Gretel.reset!
+  end
+
   test "shows basic breadcrumb" do
     breadcrumb :basic
     assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &gt; <span class="current">About</span></div>},
@@ -137,9 +141,8 @@ class HelperMethodsTest < ActionView::TestCase
   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 and then accessed outside
-    breadcrumbs do |links|
-      out = links.map { |link| [link.key, link.text, link.url] }
+    out = breadcrumbs do |links|
+      links.map { |link| [link.key, link.text, link.url] }
     end
 
     assert_equal [[:root, "Home", "/"],
@@ -173,4 +176,154 @@ class HelperMethodsTest < ActionView::TestCase
                    breadcrumbs
     end
   end
+
+  test "reload configuration when file is changed" do
+    path = setup_loading_from_tmp_folder
+    Gretel.reload_environments << "test"
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (loaded)", root_path
+        end
+        crumb :about do
+          link "About (loaded)", about_path
+        end
+      EOT
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <span class="current">About (loaded)</span></div>}, breadcrumbs
+
+    sleep 1 # File change interval is 1 second
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (reloaded)", "/test"
+        end
+        crumb :about do
+          link "About (reloaded)", "/reloaded"
+        end
+      EOT
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/test">Home (reloaded)</a> &gt; <span class="current">About (reloaded)</span></div>}, breadcrumbs
+  end
+
+  test "reload configuration when file is added" do
+    path = setup_loading_from_tmp_folder
+    Gretel.reload_environments << "test"
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (loaded)", root_path
+        end
+      EOT
+    end
+
+    assert_raises ArgumentError do
+      breadcrumb :about
+      breadcrumbs
+    end
+
+    File.open(path.join("pages.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :about do
+          link "About (loaded)", about_path
+        end
+      EOT
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <span class="current">About (loaded)</span></div>}, breadcrumbs
+  end
+
+  test "reload configuration when file is deleted" do
+    path = setup_loading_from_tmp_folder
+    Gretel.reload_environments << "test"
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (loaded)", root_path
+        end
+        crumb :about do
+          link "About (loaded)", about_path
+        end
+      EOT
+    end
+
+    File.open(path.join("pages.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :contact do
+          link "Contact (loaded)", "/contact"
+          parent :about
+        end
+      EOT
+    end
+
+    breadcrumb :contact
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <a href="/about">About (loaded)</a> &gt; <span class="current">Contact (loaded)</span></div>}, breadcrumbs
+
+    File.delete path.join("pages.rb")
+
+    assert_raises ArgumentError do
+      breadcrumb :contact
+      breadcrumbs
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <span class="current">About (loaded)</span></div>}, breadcrumbs
+  end
+
+  test "reloads only in development environment" do
+    path = setup_loading_from_tmp_folder
+
+    assert_equal ["development"], Gretel.reload_environments
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (loaded)", root_path
+        end
+        crumb :about do
+          link "About (loaded)", about_path
+        end
+      EOT
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <span class="current">About (loaded)</span></div>}, breadcrumbs
+
+    sleep 1
+
+    File.open(path.join("site.rb"), "w") do |f|
+      f.write <<-EOT
+        crumb :root do
+          link "Home (reloaded)", "/test"
+        end
+        crumb :about do
+          link "About (reloaded)", "/reloaded"
+        end
+      EOT
+    end
+
+    breadcrumb :about
+    assert_equal %{<div class="breadcrumbs"><a href="/">Home (loaded)</a> &gt; <span class="current">About (loaded)</span></div>}, breadcrumbs
+  end
+
+private
+
+  def setup_loading_from_tmp_folder
+    path = Rails.root.join("tmp", "testcrumbs")
+    FileUtils.rm_rf path
+    FileUtils.mkdir_p path
+
+    Gretel.breadcrumb_paths = [path.join("*.rb")]
+
+    path
+  end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.13
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create
@@ -55,21 +50,21 @@ files:
 - .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/templates/breadcrumbs.rb
 - lib/gretel.rb
 - lib/gretel/crumb.rb
 - lib/gretel/crumbs.rb
+- lib/gretel/deprecated.rb
 - lib/gretel/link.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
+- test/deprecated_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -82,13 +77,14 @@ files:
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
+- test/dummy/config/breadcrumbs.rb
+- test/dummy/config/breadcrumbs/test_crumbs.rb
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/breadcrumbs.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -108,40 +104,35 @@ files:
 - test/dummy/script/rails
 - test/fixtures/issues.yml
 - test/fixtures/projects.yml
+- test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb
 homepage: http://github.com/lassebunk/gretel
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3983291336719230651
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3983291336719230651
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.
 test_files:
+- test/deprecated_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -154,13 +145,14 @@ test_files:
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
+- test/dummy/config/breadcrumbs.rb
+- test/dummy/config/breadcrumbs/test_crumbs.rb
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/breadcrumbs.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -180,5 +172,6 @@ test_files:
 - test/dummy/script/rails
 - test/fixtures/issues.yml
 - test/fixtures/projects.yml
+- test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb

data/lib/generators/gretel/gretel_generator.rb

@@ -1,10 +0,0 @@
-module Gretel
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    
-    desc "Creates an initializer for breadcrumbs in config/initializers/breadcrumbs.rb"
-    def create_initializer
-      copy_file "initializer.rb", "config/initializers/breadcrumbs.rb"
-    end
-  end
-end

data/lib/generators/gretel/templates/initializer.rb

@@ -1,29 +0,0 @@
-# Remember to restart your application after editing this file.
-
-Gretel::Crumbs.layout do
-  # Example crumbs:
-  
-  # crumb :root do
-  #   link "Home", root_path
-  # end
-  
-  # crumb :projects do
-  #   link "Projects", projects_path
-  # end
-  
-  # crumb :project do |project|
-  #   link lambda { |project| "#{project.name} (#{project.id.to_s})" }, project_path(project)
-  #   parent :projects
-  # end
-  
-  # crumb :project_issues do |project|
-  #   link "Issues", project_issues_path(project)
-  #   parent :project, project
-  # end
-  
-  # crumb :issue do |issue|
-  #   link issue.name, issue_path(issue)
-  #   parent :project_issues, issue.project
-  # end
-
-end

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

@@ -1,77 +0,0 @@
-Gretel::Crumbs.layout do
-  crumb :root do
-    link "Home", root_path
-  end
-
-  crumb :basic do
-    link "About", about_path
-  end
-
-  crumb :with_root do
-    link "About", about_path
-    parent :root
-  end
-
-  crumb :with_parent do
-    link "Contact", contact_path
-    parent :basic
-  end
-
-  crumb :object do |project|
-    link project.name, project
-  end
-
-  crumb :with_autopath do |project|
-    link project.name, project
-  end
-
-  crumb :with_parent_object do |issue|
-    link issue.title, project_issue_path(issue.project, issue)
-    parent :object, issue.project
-  end
-
-  crumb :multiple_links do
-    link "Contact", contact_path
-    link "Contact form", contact_form_path
-  end
-
-  crumb :multiple_links_with_parent do
-    link "Contact", contact_path
-    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_arguments do |a, b, c|
-    link "#{a} and #{b} and #{c}", contact_path
-    parent :parent_with_multiple_arguments, a * 2, b * 2, c * 2
-  end
-
-  crumb :parent_with_multiple_arguments 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
-
-  crumb :without_link do
-    link "Without link"
-    parent :parent_without_link
-  end
-
-  crumb :parent_without_link do
-    link "Also without link"
-  end
-
-  crumb :using_view_helper do
-    link times_two("Test"), about_path
-  end
-end