gretel 3.0.0.beta4 → 3.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f60e571dd44601cf9e016949eaf99b93e7620c32
-  data.tar.gz: eb4b93afaf41a5faaccd58e7fb6996e692c87eda
+  metadata.gz: 7e5effb851a29b8c853f52fcf5cc456cc08af59d
+  data.tar.gz: 27d7b1df1fd9d953b9a3e4d2a70ebd444b6d644f
 SHA512:
-  metadata.gz: e755b624fad2a00daf9aaf8fbd2deb7f094d0b3b6a14137edc0a6111ba209067349527aa1d66ad898a2ce7a47376c776026f700ce2eb77ea0cba9768e8805bd5
-  data.tar.gz: cbedcf2047c946abbbd64ae8b6d2a2c8086ca6f17d7a0a77b7c3b655b73911dbec6e3da248f14b433237b18f2a2620b0ed5a9d0f67ccefa446ad01d898b150de
+  metadata.gz: 6d578d14e488a1fa88d8e60b0bbe392b95a71871857134364a1af6fa2d0c35662cdfc3c4d51623b908b02a0b27795274a47509b4cf7adda7114b64c35e9dcb4d
+  data.tar.gz: 18f43e6bd65b469f517341ad6326224252e041f8ea9392b27dbacdce835137f48fea3256d7bc3b8f90e8e041962b5783655f1fc826295ed8aab24184bb2245a1

data/CHANGELOG.md

@@ -4,14 +4,11 @@ Changelog
 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.
-* Support for setting trails via the URL – `params[:trail]`. This makes it possible to link back to a different breadcrumb trail than the one specified in your breadcrumb,
-  for example if you have a store with products that have a default parent to their category, but when linking from the review section, you want to link back to the reviews instead.
-  See the readme for more info.
 * Breadcrumbs rendering is now done in a separate class to unclutter the view with helpers. The public API is still the same.
 * Support for rendering the breadcrumbs in different styles like ul- and ol lists, and for use with [Twitter Bootstrap](http://getbootstrap.com/). See the `:style` option in the readme for more info.
 * The `:show_root_alone` option is now called `:display_single_fragment` and can be used to display the breadcrumbs only when there are more than one link, also if it is not the root breadcrumb.
 * Links yielded from `<%= breadcrumbs do |links| %>` now have a `current?` helper that returns true if the link is the last in the trail.
-* New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). You can supply options like `:autoroot` etc.
+* 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.
 
 Version 2.1

data/README.md

@@ -10,15 +10,13 @@ Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mai
 New in version 3.0 :muscle:
 ---------------------------
 
-* You can now set trails via the URL – `params[:trail]`. This makes it possible to link back to a different breadcrumb trail than the one specified in your breadcrumb,
-  for example if you have a store with products that have a default parent to their category, but when visiting from the reviews section, you want to link back to the reviews instead.
-  Read more about trails below.
 * 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.
 * The `:show_root_alone` option is now called `:display_single_fragment` and can be used to hide the breadcrumbs when there is only one link, also if it is not the root breadcrumb.
   The old `:show_root_alone` option is still supported until Gretel version 4.0 and will show a deprecation warning when it's used.
 * Links yielded from `<%= breadcrumbs do |links| %>` now have a `current?` helper that returns true if the link is the last in the trail.
-* New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). You can supply options like `:autoroot` etc.
+* 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.
 
 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).
@@ -31,7 +29,7 @@ Installation
 In your *Gemfile*:
 
 ```ruby
-gem "gretel", "3.0.0.beta4"
+gem "gretel", "3.0.0.beta5"
 ```
 
 And run:
@@ -157,28 +155,29 @@ crumb :issue do |issue|
   parent :project_issues, issue.project
 end
 
-# Multiple links per crumb (recursive links for parent categories)
+# Recursive 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
+  link category.name, category
+  if category.parent
+    parent :category, category.parent
+  else
+    parent :categories
   end
-
-  parent :categories
 end
 
-# Product crumb with recursive parent categories
+# Product crumb with recursive parent categories (as defined above)
 crumb :product do |product|
   link product.name, product
   parent :category, product.category
 end
 
+# Crumb with multiple links
+crumb :test do
+  link "One", one_path
+  link "Two", two_path
+  parent :about
+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
@@ -236,7 +235,7 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
 Getting the parent breadcrumb
 -----------------------------
 
-If you want to add a link to the parent breadcrumb in the trail, you can use the `parent_breadcrumb` view helper.
+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`.
 You can supply options like `autoroot: false` etc.
 
@@ -248,60 +247,6 @@ If you supply a block, it will yield the link if it is present:
 <% end %>
 ```
 
-Setting breadcrumb trails
---------------------------------
-
-You can set a breadcrumb trail via `params[:trail]`. This makes it possible to link back to a different breadcrumb trail than the one specified in your breadcrumb.
-
-An example is if you have a store with products that have a default parent to their category, but when visiting from the reviews section, you want to link back to the reviews instead.
-
-### Initial setup
-
-To use breadcrumb trails, you must set a secret to be used when encoding the trails.
-
-You can generate it using the installer:
-
-```bash
-$ rails generate gretel:install
-```
-
-This will create an initializer in *config/initializers/gretel.rb* that will contain a random secret key.
-
-If you want to do it manually, you can put the following in *config/initializers/gretel.rb*:
-
-```
-Gretel::Trail::UrlStore.secret = 'your_key_here' # Must be changed to something else to be secure
-```
-
-You can generate a key using `SecureRandom.hex(64)`.
-
-### Example
-
-This example shows how to link to the trail in the view.
-Gretel has a built-in view helper method named `breadcrumb_trail` that contains the current breadcrumb trail ready for use in a URL.
-
-```erb
-<% breadcrumb :reviews %>
-...
-<% @products.each do |product| %>
-  <%= link_to @product.name, product_path(product, trail: breadcrumb_trail) %>
-<% end %>
-```
-
-The product view will now have the breadcrumb trail from the first page (reviews) instead of its default parent.
-
-### Custom trail param
-
-The default trail param is `params[:trail]`. You can change it in an initializer:
-
-```ruby
-Gretel.trail_param = :other_param
-```
-
-### Note
-
-Please use the trail functionality with care; the trails can get very long.
-
 Nice to know
 ------------
 
@@ -318,6 +263,16 @@ The format is the same as `config/breadcrumbs.rb` which is also loaded.
 
 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.
 
+### Setting breadcrumb trails
+
+The [gretel-trails](https://github.com/lassebunk/gretel-trails) gem can handle adding and hiding trails from the URL automatically. This makes it possible to link back to a different breadcrumb trail than the one specified in your breadcrumb, for example if you have a
+store with products that have a default parent to the category breadcrumb, but when visiting from the reviews section, you want to link back to the reviews instead.
+
+You can apply trails to select links by adding a simple JS selector (`js-append-trail` or another you choose), and after each page load it hides the trail from the URL, so the server sees it but the users don't.
+
+Check out the gem [here](https://github.com/lassebunk/gretel-trails).
+
+
 Upgrading from version 2.0 or below
 -----------------------------------
 

data/gretel.gemspec

@@ -20,6 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rails", ">= 3.2.0"
   gem.add_development_dependency "rails", "~> 3.2.13"
   gem.add_development_dependency "sqlite3"
-  gem.add_development_dependency "fakeredis", "~> 0.4.2"
-  gem.add_development_dependency "timecop", "~> 0.6.3"
 end

data/lib/generators/gretel/install_generator.rb

@@ -8,12 +8,5 @@ module Gretel
     def create_config_file
       copy_file "breadcrumbs.rb", "config/breadcrumbs.rb"
     end
-
-    desc "Creates an initializer with trail secret"
-    def create_initializer
-      initializer "gretel.rb" do
-        %{Gretel::Trail::UrlStore.secret = '#{SecureRandom.hex(64)}'}
-      end
-    end
   end
 end

data/lib/gretel/crumb.rb

@@ -30,7 +30,7 @@ module Gretel
     # Example:
     #   parent :category, category
     def parent(*args)
-      return @parent unless args.any?
+      return @parent if args.empty?
       key = args.shift
 
       @parent = Gretel::Crumb.new(context, key, *args)

data/lib/gretel/deprecated/layout.rb

@@ -0,0 +1,15 @@
+Gretel::Crumbs.class_eval do
+  class << self
+    # Was used to lay out breadcrumbs in an initializer. Deprecated since v2.1.0
+    # and removed in v3.0.0. Will raise an exception if used. Put breadcrumbs in
+    # +config/breadcrumbs.rb+ instead (see
+    # https://github.com/lassebunk/gretel/blob/master/README.md for details).
+    def layout(&block)
+      raise (
+        "Gretel::Crumbs.layout was 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.")
+    end
+  end
+end

data/lib/gretel/deprecated/show_root_alone.rb

@@ -0,0 +1,12 @@
+Gretel::Renderer.class_eval do
+  def options_for_render_with_show_root_alone(options = {})
+    options = options_for_render_without_show_root_alone(options)
+    if show_root_alone = options.delete(:show_root_alone)
+      Gretel.show_deprecation_warning "The :show_root_alone option is deprecated and will be removed in Gretel v4.0.0. Use `breadcrumbs(display_single_fragment: #{show_root_alone.inspect})` instead."
+      options[:display_single_fragment] = show_root_alone
+    end
+    options
+  end
+
+  alias_method_chain :options_for_render, :show_root_alone
+end

data/lib/gretel/deprecated.rb

@@ -1,23 +1,2 @@
-module Gretel
-  module Crumbs
-    class << self
-      # Lay out the breadcrumbs.
-      # Deprecated since v2.1.0 and removed in v3.0.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)
-        raise (
-          "Gretel::Crumbs.layout has been deprecated was 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.")
-      end
-    end
-  end
-end
+require "gretel/deprecated/layout"
+require "gretel/deprecated/show_root_alone"

data/lib/gretel/renderer.rb

@@ -14,20 +14,6 @@ module Gretel
       id: nil
     }
 
-    STYLES = {
-      # Default style
-      default: { container_tag: :div, separator: " › " },
-
-      # Ordered list
-      ol: { container_tag: :ol, fragment_tag: :li },
-
-      # Unordered list
-      ul: { container_tag: :ul, fragment_tag: :li },
-
-      # Twitter Bootstrap
-      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
@@ -58,19 +44,27 @@ module Gretel
       content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
     end
 
-    # Array of links transformed by +options+ (like +:autoroot+ etc.) to be used in a view.
-    def links_with(options = {})
+    # Yields links with applied options.
+    def yield_links(options = {})
       options = options_for_render(options)
-      links_for_render(options)
+      yield links_for_render(options)
     end
 
-    # Returns encoded trail for the breadcrumb.
-    def trail
-      @trail ||= Gretel::Trail.encode(links)
+    # Returns the parent breadcrumb.
+    def parent_breadcrumb(options = {})
+      options = options_for_render(options)
+      links_for_render(options)[-2]
+    end
+
+    # Yields the parent breadcrumb if any.
+    def yield_parent_breadcrumb(options = {})
+      if parent = parent_breadcrumb(options)
+        yield parent
+      end
     end
 
     # Proxy for +context.link_to+ that can be overridden by plugins.
-    def link_to(*args)
+    def breadcrumb_link_to(*args)
       context.link_to(*args)
     end
 
@@ -81,25 +75,35 @@ module Gretel
     # Returns merged options for rendering breadcrumbs.
     def options_for_render(options = {})
       style = options_for_style(options[:style] || DEFAULT_OPTIONS[:style])
-      options = DEFAULT_OPTIONS.merge(style).merge(options)
-      
-      if show_root_alone = options.delete(:show_root_alone)
-        Gretel.show_deprecation_warning "The :show_root_alone option is deprecated. Use `breadcrumbs(display_single_fragment: #{show_root_alone.inspect})` instead."
-        options[:display_single_fragment] = show_root_alone
-      end
-      
-      options
+      DEFAULT_OPTIONS.merge(style).merge(options)
     end
 
     # Returns options for the given +style_key+ and raises an exception if it's not found.
     def options_for_style(style_key)
-      if style = STYLES[style_key]
+      if style = self.class.styles[style_key]
         style
       else
-        raise ArgumentError, "Breadcrumbs style #{style_key.inspect} not found. Use any of #{STYLES.keys.inspect}."
+        raise ArgumentError, "Breadcrumbs style #{style_key.inspect} not found. Use any of #{self.class.styles.keys.inspect}."
       end
     end
 
+    # Array of links with applied options.
+    def links_for_render(options = {})
+      out = links.dup
+
+      # Handle autoroot
+      if options[:autoroot] && out.map(&:key).exclude?(:root) && Gretel::Crumbs.crumb_defined?(:root)
+        out.unshift *Gretel::Crumb.new(context, :root).links
+      end
+
+      # Handle show root alone
+      if out.size == 1 && !options[:display_single_fragment]
+        out.shift
+      end
+
+      out
+    end
+
     # Array of links for the path of the breadcrumb.
     # Also reloads the breadcrumb configuration if needed.
     def links
@@ -119,8 +123,8 @@ module Gretel
             links.last.url = request.fullpath
           end
 
-          # Get trail
-          links.unshift *trail_for(crumb)
+          # Get parent links
+          links.unshift *parent_links_for(crumb)
 
           # Set last link to current
           links.last.try(:current!)
@@ -132,36 +136,13 @@ module Gretel
       end
     end
 
-    # Returns parent links for the crumb, or the trail from `params[:trail]` if it is set.
-    def trail_for(crumb)
-      if params[Gretel::Trail.trail_param].present?
-        # Decode trail from URL
-        Gretel::Trail.decode(params[Gretel::Trail.trail_param])
-      else
-        # Build parents
-        links = []
-        while crumb = crumb.parent
-          links.unshift *crumb.links
-        end
-        links
+    # Returns parent links for the crumb.
+    def parent_links_for(crumb)
+      links = []
+      while crumb = crumb.parent
+        links.unshift *crumb.links
       end
-    end
-
-    # Array of links with applied options.
-    def links_for_render(options = {})
-      out = links.dup
-
-      # Handle autoroot
-      if options[:autoroot] && out.map(&:key).exclude?(:root) && Gretel::Crumbs.crumb_defined?(:root)
-        out.unshift *Gretel::Crumb.new(context, :root).links
-      end
-
-      # Handle show root alone
-      if out.size == 1 && !options[:display_single_fragment]
-        out.shift
-      end
-
-      out
+      links
     end
 
     # Renders HTML for a breadcrumb fragment, i.e. a breadcrumb link.
@@ -177,10 +158,10 @@ module Gretel
     def render_semantic_fragment(fragment_tag, text, url, options = {})
       if fragment_tag
         text = content_tag(:span, text, itemprop: "title")
-        text = link_to(text, url, itemprop: "url") if url.present?
+        text = breadcrumb_link_to(text, url, itemprop: "url") if url.present?
         content_tag(fragment_tag, text, class: options[:class], itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
       elsif 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")
+        content_tag(:div, breadcrumb_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
@@ -189,10 +170,10 @@ module Gretel
     # Renders regular, non-semantic fragment HTML.
     def render_nonsemantic_fragment(fragment_tag, text, url, options = {})
       if fragment_tag
-        text = link_to(text, url) if url.present?
+        text = breadcrumb_link_to(text, url) if url.present?
         content_tag(fragment_tag, text, class: options[:class])
       elsif url.present?
-        link_to(text, url, class: options[:class])
+        breadcrumb_link_to(text, url, class: options[:class])
       elsif options[:class].present?
         content_tag(:span, text, class: options[:class])
       else
@@ -204,5 +185,19 @@ module Gretel
     def method_missing(method, *args, &block)
       context.send(method, *args, &block)
     end
+
+    class << self
+      # Registers a style for later use.
+      # 
+      #   Gretel::Renderer.register_style :ul, { container_tag: :ul, fragment_tag: :li }
+      def register_style(style_key, options)
+        styles[style_key] = options
+      end
+
+      # Hash of registered styles.
+      def styles
+        @styles ||= {}
+      end
+    end
   end
 end

data/lib/gretel/version.rb

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

data/lib/gretel/view_helpers.rb

@@ -25,7 +25,7 @@ module Gretel
     #   <% end %>
     def breadcrumbs(options = {}, &block)
       if block_given?
-        yield gretel_renderer.links_with(options)
+        gretel_renderer.yield_links(options, &block)
       else
         gretel_renderer.render(options)
       end
@@ -33,19 +33,13 @@ module Gretel
 
     # Returns or yields parent breadcrumb (second-to-last in the trail) if it is present.
     def parent_breadcrumb(options = {}, &block)
-      parent = gretel_renderer.links_with(options)[-2]
-      if block_given? && parent
-        yield parent
+      if block_given?
+        gretel_renderer.yield_parent_breadcrumb(options, &block)
       else
-        parent
+        gretel_renderer.parent_breadcrumb(options)
       end
     end
 
-    # Encoded breadcrumb trail to be used in URLs.
-    def breadcrumb_trail
-      gretel_renderer.trail
-    end
-
     private
 
     # Reference to the Gretel breadcrumbs renderer.

data/lib/gretel.rb

@@ -2,7 +2,6 @@ require 'gretel/version'
 require 'gretel/crumbs'
 require 'gretel/crumb'
 require 'gretel/link'
-require 'gretel/trail'
 require 'gretel/renderer'
 require 'gretel/view_helpers'
 require 'gretel/deprecated'
@@ -19,26 +18,6 @@ module Gretel
       @breadcrumb_paths = paths
     end
 
-    # Param to contain trail. See +Gretel::Trail.trail_param+ for details.
-    def trail_param
-      Gretel::Trail.trail_param
-    end
-
-    # Sets the trail param. See +Gretel::Trail.trail_param+ for details.
-    def trail_param=(param)
-      Gretel::Trail.trail_param = param
-    end
-
-    # Trail store. See +Gretel::Trail.store+ for details.
-    def trail_store
-      Gretel::Trail.store
-    end
-
-    # Sets the trail store. See +Gretel::Trail.store+ for details.
-    def trail_store=(store)
-      Gretel::Trail.store = store
-    end
-
     # Whether to suppress deprecation warnings.
     def suppress_deprecation_warnings?
       !!@suppress_deprecation_warnings
@@ -62,13 +41,20 @@ module Gretel
       @reload_environments ||= ["development"]
     end
 
+    # Registers a style for later use.
+    # 
+    #   Gretel.register_style :ul, { container_tag: :ul, fragment_tag: :li }
+    def register_style(style, options)
+      Gretel::Renderer.register_style style, options
+    end
+
     # Sets the Rails environment names with automatic configuration reload. Default is +["development"]+.
     attr_writer :reload_environments
 
     # Yields this +Gretel+ to be configured.
     # 
     #   Gretel.configure do |config|
-    #     config.trail_param = :other_param
+    #     config.reload_environments << "staging"
     #   end
     def configure
       yield self
@@ -78,9 +64,22 @@ module Gretel
     def reset!
       instance_variables.each { |var| remove_instance_variable var }
       Crumbs.reset!
-      Trail.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/test/dummy/db/schema.rb

@@ -11,16 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20131015194052) do
-
-  create_table "gretel_trails", :force => true do |t|
-    t.string   "key",        :limit => 40
-    t.text     "value"
-    t.datetime "expires_at"
-  end
-
-  add_index "gretel_trails", ["expires_at"], :name => "index_gretel_trails_on_expires_at"
-  add_index "gretel_trails", ["key"], :name => "index_gretel_trails_on_key", :unique => true
+ActiveRecord::Schema.define(:version => 20130122163051) do
 
   create_table "issues", :force => true do |t|
     t.string   "title"

data/test/gretel_test.rb

@@ -14,9 +14,9 @@ class GretelTest < ActiveSupport::TestCase
 
   test "configuration block" do
     Gretel.configure do |config|
-      config.trail_param = :other_param
+      config.reload_environments << "staging"
     end
 
-    assert_equal :other_param, Gretel.trail_param
+    assert_equal ["development", "staging"], Gretel.reload_environments
   end
 end

data/test/helper_methods_test.rb

@@ -7,7 +7,6 @@ class HelperMethodsTest < ActionView::TestCase
 
   setup do
     Gretel.reset!
-    Gretel::Trail::UrlStore.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
   end
 
   # Breadcrumb generation
@@ -296,39 +295,6 @@ class HelperMethodsTest < ActionView::TestCase
     end
   end
 
-  # Trails
-
-  test "trail helper" do
-    breadcrumb :basic
-
-    assert_equal "667ea523f92bdb3a086494575b18f587170e482b_W1siYmFzaWMiLCJBYm91dCIsMCwiL2Fib3V0Il1d", breadcrumb_trail
-  end
-
-  test "loading trail" do
-    params[:trail] = "667ea523f92bdb3a086494575b18f587170e482b_W1siYmFzaWMiLCJBYm91dCIsMCwiL2Fib3V0Il1d"
-    breadcrumb :multiple_links
-
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <a href="/about">About</a> &rsaquo; <a href="/about/contact">Contact</a> &rsaquo; <span class="current">Contact form</span></div>},
-                 breadcrumbs
-  end
-
-  test "different trail param" do
-    Gretel.trail_param = :mytest
-    params[:mytest] = "667ea523f92bdb3a086494575b18f587170e482b_W1siYmFzaWMiLCJBYm91dCIsMCwiL2Fib3V0Il1d"
-    breadcrumb :multiple_links
-
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <a href="/about">About</a> &rsaquo; <a href="/about/contact">Contact</a> &rsaquo; <span class="current">Contact form</span></div>},
-                 breadcrumbs
-  end
-
-  test "unknown trail" do
-    params[:trail] = "notfound"
-    breadcrumb :multiple_links
-
-    assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; <a href="/about/contact">Contact</a> &rsaquo; <span class="current">Contact form</span></div>},
-                 breadcrumbs
-  end
-
   # Configuration reload
 
   test "reload configuration when file is changed" do

data/test/test_helper.rb

@@ -3,7 +3,6 @@ ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
-require "timecop"
 
 Rails.backtrace_cleaner.remove_silencers!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta4
+  version: 3.0.0.beta5
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,34 +52,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
 description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create
   breadcrumbs.
 email:
@@ -99,21 +71,14 @@ files:
 - lib/generators/gretel/USAGE
 - lib/generators/gretel/install_generator.rb
 - lib/generators/gretel/templates/breadcrumbs.rb
-- lib/generators/gretel/templates/trail_migration.rb
-- lib/generators/gretel/trail/migration_generator.rb
 - lib/gretel.rb
 - lib/gretel/crumb.rb
 - lib/gretel/crumbs.rb
 - lib/gretel/deprecated.rb
+- lib/gretel/deprecated/layout.rb
+- lib/gretel/deprecated/show_root_alone.rb
 - lib/gretel/link.rb
 - lib/gretel/renderer.rb
-- lib/gretel/trail.rb
-- lib/gretel/trail/stores.rb
-- lib/gretel/trail/stores/active_record_store.rb
-- lib/gretel/trail/stores/redis_store.rb
-- lib/gretel/trail/stores/store.rb
-- lib/gretel/trail/stores/url_store.rb
-- lib/gretel/trail/tasks.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
 - test/deprecated_test.rb
@@ -146,7 +111,6 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20130122163007_create_projects.rb
 - test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/migrate/20131015194052_create_gretel_trails.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -160,10 +124,6 @@ files:
 - test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb
-- test/trails/active_record_store_test.rb
-- test/trails/redis_store_test.rb
-- test/trails/trail_test.rb
-- test/trails/url_store_test.rb
 homepage: http://github.com/lassebunk/gretel
 licenses:
 - MIT
@@ -219,7 +179,6 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20130122163007_create_projects.rb
 - test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/migrate/20131015194052_create_gretel_trails.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -233,7 +192,3 @@ test_files:
 - test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb
-- test/trails/active_record_store_test.rb
-- test/trails/redis_store_test.rb
-- test/trails/trail_test.rb
-- test/trails/url_store_test.rb

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

@@ -1,11 +0,0 @@
-class CreateGretelTrails < ActiveRecord::Migration
-  def change
-    create_table :gretel_trails do |t|
-      t.string :key, limit: 40
-      t.text :value
-      t.datetime :expires_at
-    end
-    add_index :gretel_trails, :key, unique: true
-    add_index :gretel_trails, :expires_at
-  end
-end

data/lib/generators/gretel/trail/migration_generator.rb

@@ -1,20 +0,0 @@
-require 'rails/generators'
-
-module Gretel
-  module Trail
-    class MigrationGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path('../../templates', __FILE__)
-      
-      def self.next_migration_number(path)
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
-      end
-      
-      desc "Creates a migration for a table to store trail data"
-      def create_migration
-        migration_template "trail_migration.rb", "db/migrate/create_gretel_trails.rb"
-      end
-    end
-  end
-end

data/lib/gretel/trail/stores/active_record_store.rb

@@ -1,59 +0,0 @@
-module Gretel
-  module Trail
-    class ActiveRecordStore < Store
-      class << self
-        # Number of seconds to keep the trails in the database.
-        # Default: +1.day+
-        def expires_in
-          @expires_in ||= 1.day
-        end
-
-        # Sets the number of seconds to keep the trails in the database.
-        attr_writer :expires_in
-
-        # Save array to database.
-        def save(array)
-          json = array.to_json
-          key = Digest::SHA1.hexdigest(json)
-          GretelTrail.set(key, array, expires_in.from_now)
-          key
-        end
-
-        # Retrieve array from database.
-        def retrieve(key)
-          GretelTrail.get(key)
-        end
-
-        # Delete expired keys.
-        def delete_expired
-          GretelTrail.delete_expired
-        end
-
-        # Gets the number of trails stored in the database.
-        def key_count
-          GretelTrail.count
-        end
-      end
-      
-      class GretelTrail < ActiveRecord::Base
-        serialize :value, Array
-
-        def self.get(key)
-          find_by_key(key).try(:value)
-        end
-
-        def self.set(key, value, expires_at)
-          find_or_initialize_by_key(key).tap do |rec|
-            rec.value = value
-            rec.expires_at = expires_at
-            rec.save
-          end
-        end
-
-        def self.delete_expired
-          delete_all(["expires_at < ?", Time.now])
-        end
-      end
-    end
-  end
-end

data/lib/gretel/trail/stores/redis_store.rb

@@ -1,54 +0,0 @@
-module Gretel
-  module Trail
-    class RedisStore < Store
-      class << self
-        # Options to connect to Redis.
-        def connect_options
-          @connect_options ||= {}
-        end
-
-        # Sets the Redis connect options.
-        attr_writer :connect_options
-
-        # Number of seconds to keep the trails in Redis.
-        # Default: +1.day+
-        def expires_in
-          @expires_in ||= 1.day
-        end
-
-        # Sets the number of seconds to keep the trails in Redis.
-        attr_writer :expires_in
-
-        # Save array to Redis.
-        def save(array)
-          json = array.to_json
-          key = Digest::SHA1.hexdigest(json)
-          redis.setex redis_key_for(key), expires_in, json
-          key
-        end
-
-        # Retrieve array from Redis.
-        def retrieve(key)
-          if json = redis.get(redis_key_for(key))
-            JSON.parse(json)
-          end
-        end
-
-        # Reference to the Redis connection.
-        def redis
-          @redis ||= begin
-            raise "Redis needs to be installed in order for #{name} to use it. Please add `gem \"redis\"` to your Gemfile." unless defined?(Redis)
-            Redis.new(connect_options)
-          end
-        end
-
-        private
-
-        # Key to be stored in Redis.
-        def redis_key_for(key)
-          "gretel:trail:#{key}"
-        end
-      end
-    end
-  end
-end

data/lib/gretel/trail/stores/store.rb

@@ -1,49 +0,0 @@
-module Gretel
-  module Trail
-    class Store
-      class << self
-        # Save an encoded array to the store. It must return the trail key that
-        # can later be used to retrieve the array from the store.
-        def save(array)
-          raise "#{name} must implement #save to be able to save trails."
-        end
-
-        # Retrieve an encoded array from the store based on the saved key.
-        # It must return either the array, or nil if the key was not found.
-        def retrieve(key)
-          raise "#{name} must implement #retrieve to be able to retrieve trails."
-        end
-
-        # Deletes expired keys from the store.
-        def delete_expired
-          raise "#{name} doesn't support deleting expired keys."
-        end
-
-        # Gets the number of stored trail keys.
-        def key_count
-          raise "#{name} doesn't support counting trail keys."
-        end
-
-        # Encode array of +links+ to unique trail key.
-        def encode(links)
-          arr = links.map { |link| [link.key, link.text, (link.text.html_safe? ? 1 : 0), link.url] }
-          save(arr)
-        end
-
-        # Decode unique trail key to array of links.
-        def decode(key)
-          if arr = retrieve(key)
-            arr.map { |key, text, html_safe, url| Link.new(key.to_sym, (html_safe == 1 ? text.html_safe : text), url) }
-          else
-            []
-          end
-        end
-    
-        # Resets all changes made to the store. Used for testing.
-        def reset!
-          instance_variables.each { |var| remove_instance_variable var }
-        end
-      end
-    end
-  end
-end

data/lib/gretel/trail/stores/url_store.rb

@@ -1,57 +0,0 @@
-module Gretel
-  module Trail
-    class UrlStore < Store
-      class << self
-        # Secret used for crypting trail in URL that should be set to something
-        # unguessable. This is required when using trails, for the reason that
-        # unencrypted trails would be vulnerable to cross-site scripting attacks.
-        attr_accessor :secret
-
-        # Securely encodes encoded array to a trail string to be used in URL.
-        def save(array)
-          base64 = encode_base64(array)
-          hash = generate_hash(base64)
-
-          [hash, base64].join("_")
-        end
-
-        # Securely decodes a URL trail string to encoded array.
-        def retrieve(key)
-          hash, base64 = key.split("_", 2)
-
-          if base64.blank?
-            Rails.logger.info "[Gretel] Trail decode failed: No Base64 in trail"
-            []
-          elsif hash == generate_hash(base64)
-            decode_base64(base64)
-          else
-            Rails.logger.info "[Gretel] Trail decode failed: Invalid hash '#{hash}' in trail"
-            []
-          end
-        end
-
-        private
-
-        # Encodes links array to Base64, internally using JSON for serialization.
-        def encode_base64(array)
-          Base64.urlsafe_encode64(array.to_json)
-        end
-
-        # Decodes links array from Base64.
-        def decode_base64(base64)
-          json = Base64.urlsafe_decode64(base64)
-          JSON.parse(json)
-        rescue
-          Rails.logger.info "[Gretel] Trail decode failed: Invalid Base64 '#{base64}' in trail"
-          []
-        end
-
-        # Generates a salted hash of +base64+.
-        def generate_hash(base64)
-          raise "#{name}.secret is not set. Please set it to an unguessable string, e.g. from `rake secret`, or use `rails generate gretel:install` to generate and set it automatically." if secret.blank?
-          Digest::SHA1.hexdigest([base64, secret].join)
-        end
-      end
-    end
-  end
-end

data/lib/gretel/trail/stores.rb

@@ -1,4 +0,0 @@
-require "gretel/trail/stores/store"
-require "gretel/trail/stores/url_store"
-require "gretel/trail/stores/active_record_store"
-require "gretel/trail/stores/redis_store"

data/lib/gretel/trail/tasks.rb

@@ -1,5 +0,0 @@
-require "rake"
-
-Rake::Task.define_task("gretel:trails:delete_expired" => :environment) do
-  Gretel::Trail.delete_expired
-end

data/lib/gretel/trail.rb

@@ -1,68 +0,0 @@
-require "gretel/trail/stores"
-require "gretel/trail/tasks"
-
-module Gretel
-  module Trail
-    STORES = {
-      url: UrlStore,
-      db: ActiveRecordStore,
-      redis: RedisStore
-    }
-
-    class << self
-      # Gets the store that is used to encode and decode trails.
-      # Default: +Gretel::Trail::UrlStore+
-      def store
-        @store ||= UrlStore
-      end
-
-      # Sets the store that is used to encode and decode trails.
-      # Can be a subclass of +Gretel::Trail::Store+, or a symbol: +:url+, +:db+, or +:redis+.
-      def store=(value)
-        if value.is_a?(Symbol)
-          klass = STORES[value]
-          raise ArgumentError, "Unknown Gretel::Trail.store #{value.inspect}. Use any of #{STORES.inspect}." unless klass
-          self.store = klass
-        else
-          @store = value
-        end
-      end
-
-      # Uses the store to encode an array of links to a unique key that can be used in URLs.
-      def encode(links)
-        store.encode(links)
-      end
-
-      # Uses the store to decode a unique key to an array of links.
-      def decode(key)
-        store.decode(key)
-      end
-
-      # Deletes expired keys from the store.
-      # Not all stores support expiring keys, and will raise an exception if they don't.
-      def delete_expired
-        store.delete_expired
-      end
-
-      # Returns the current number of trails in the store.
-      # Not all stores support counting keys, and will raise an exception if they don't.
-      def count
-        store.key_count
-      end
-
-      # Name of trail param. Default: +:trail+.
-      def trail_param
-        @trail_param ||= :trail
-      end
-      
-      # Sets the trail param.
-      attr_writer :trail_param
-
-      # Resets all changes made to +Gretel::Trail+. Used for testing.
-      def reset!
-        instance_variables.each { |var| remove_instance_variable var }
-        STORES.each_value(&:reset!)
-      end
-    end
-  end
-end

data/test/dummy/db/migrate/20131015194052_create_gretel_trails.rb

@@ -1,11 +0,0 @@
-class CreateGretelTrails < ActiveRecord::Migration
-  def change
-    create_table :gretel_trails do |t|
-      t.string :key, limit: 40
-      t.text :value
-      t.datetime :expires_at
-    end
-    add_index :gretel_trails, :key, unique: true
-    add_index :gretel_trails, :expires_at
-  end
-end

data/test/trails/active_record_store_test.rb

@@ -1,52 +0,0 @@
-require 'test_helper'
-
-class ActiveRecordStoreTest < ActiveSupport::TestCase
-  setup do
-    Gretel.reset!
-    Gretel::Trail.store = :db
-    
-    @links = [
-      [:root, "Home", "/"],
-      [:store, "Store <b>Test</b>".html_safe, "/store"],
-      [:search, "Search", "/store/search?q=test"]
-    ]
-  end
-
-  test "defaults" do
-    assert_equal 1.day, Gretel::Trail::ActiveRecordStore.expires_in
-  end
-
-  test "encoding" do
-    assert_equal "684c211441e72225cee89477a2d1f59e657c9e26",
-                 Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-  end
-
-  test "decoding" do
-    Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-    decoded = Gretel::Trail.decode("684c211441e72225cee89477a2d1f59e657c9e26")
-    assert_equal @links, decoded.map { |link| [link.key, link.text, link.url] }
-    assert_equal [false, true, false], decoded.map { |link| link.text.html_safe? }
-  end
-
-  test "invalid trail" do
-    assert_equal [], Gretel::Trail.decode("asdgasdg")
-  end
-
-  test "delete expired" do
-    10.times { Gretel::Trail.encode([Gretel::Link.new(:test, SecureRandom.hex(20), "/test")]) }
-    assert_equal 10, Gretel::Trail.count
-    
-    Gretel::Trail.delete_expired
-    assert_equal 10, Gretel::Trail.count
-
-    Timecop.travel(14.hours.from_now) do
-      5.times { Gretel::Trail.encode([Gretel::Link.new(:test, SecureRandom.hex(20), "/test")]) }
-      assert_equal 15, Gretel::Trail.count
-    end
-
-    Timecop.travel(25.hours.from_now) do
-      Gretel::Trail.delete_expired
-      assert_equal 5, Gretel::Trail.count
-    end
-  end
-end

data/test/trails/redis_store_test.rb

@@ -1,35 +0,0 @@
-require 'test_helper'
-require 'fakeredis'
-
-class RedisStoreTest < ActiveSupport::TestCase
-  setup do
-    Gretel.reset!
-    Gretel::Trail.store = :redis
-    
-    @links = [
-      [:root, "Home", "/"],
-      [:store, "Store <b>Test</b>".html_safe, "/store"],
-      [:search, "Search", "/store/search?q=test"]
-    ]
-  end
-
-  test "defaults" do
-    assert_equal 1.day, Gretel::Trail::RedisStore.expires_in
-  end
-
-  test "encoding" do
-    assert_equal "684c211441e72225cee89477a2d1f59e657c9e26",
-                 Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-  end
-
-  test "decoding" do
-    Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-    decoded = Gretel::Trail.decode("684c211441e72225cee89477a2d1f59e657c9e26")
-    assert_equal @links, decoded.map { |link| [link.key, link.text, link.url] }
-    assert_equal [false, true, false], decoded.map { |link| link.text.html_safe? }
-  end
-
-  test "invalid trail" do
-    assert_equal [], Gretel::Trail.decode("asdgasdg")
-  end
-end

data/test/trails/trail_test.rb

@@ -1,27 +0,0 @@
-require 'test_helper'
-
-class TrailTest < ActiveSupport::TestCase
-  setup do
-    Gretel.reset!
-  end
-
-  test "defaults" do
-    assert_equal :trail, Gretel::Trail.trail_param
-  end
-
-  test "setting invalid store" do
-    assert_raises ArgumentError do
-      Gretel::Trail.store = :xx
-    end
-  end
-
-  test "setting store options on main module" do
-    assert_equal :trail, Gretel.trail_param
-    Gretel.trail_param = :other_param
-    assert_equal :other_param, Gretel::Trail.trail_param
-
-    assert_equal Gretel::Trail::UrlStore, Gretel.trail_store
-    Gretel.trail_store = :redis
-    assert_equal Gretel::Trail::RedisStore, Gretel::Trail.store
-  end
-end

data/test/trails/url_store_test.rb

@@ -1,38 +0,0 @@
-require 'test_helper'
-
-class UrlStoreTest < ActiveSupport::TestCase
-  setup do
-    Gretel.reset!
-    
-    Gretel::Trail.store = :url
-    Gretel::Trail::UrlStore.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
-    
-    @links = [
-      [:root, "Home", "/"],
-      [:store, "Store <b>Test</b>".html_safe, "/store"],
-      [:search, "Search", "/store/search?q=test"]
-    ]
-  end
-
-  test "encoding" do
-    assert_equal "5543214e6d7bbc3ba5209b2362cd7513d500f61b_W1sicm9vdCIsIkhvbWUiLDAsIi8iXSxbInN0b3JlIiwiU3RvcmUgPGI-VGVzdDwvYj4iLDEsIi9zdG9yZSJdLFsic2VhcmNoIiwiU2VhcmNoIiwwLCIvc3RvcmUvc2VhcmNoP3E9dGVzdCJdXQ==",
-                 Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-  end
-
-  test "decoding" do
-    decoded = Gretel::Trail.decode("5543214e6d7bbc3ba5209b2362cd7513d500f61b_W1sicm9vdCIsIkhvbWUiLDAsIi8iXSxbInN0b3JlIiwiU3RvcmUgPGI-VGVzdDwvYj4iLDEsIi9zdG9yZSJdLFsic2VhcmNoIiwiU2VhcmNoIiwwLCIvc3RvcmUvc2VhcmNoP3E9dGVzdCJdXQ==")
-    assert_equal @links, decoded.map { |link| [link.key, link.text, link.url] }
-    assert_equal [false, true, false], decoded.map { |link| link.text.html_safe? }
-  end
-
-  test "invalid trail" do
-    assert_equal [], Gretel::Trail.decode("28f104524f5eaf6b3bd035710432fd2b9cbfd62c_X1sicm9vdCIsIkhvbWUiLDAsIi8iXSxbInN0b3JlIiwiU3RvcmUiLDAsIi9zdG9yZSJdLFsic2VhcmNoIiwiU2VhcmNoIiwwLCIvc3RvcmUvc2VhcmNoP3E9dGVzdCJdXQ==")
-  end
-
-  test "raises error if no secret set" do
-    Gretel::Trail::UrlStore.secret = nil
-    assert_raises RuntimeError do
-      Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
-    end
-  end
-end