gretel 3.0.0.beta2 → 3.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db6f1e42bb6b92c94ae0ea17349b87d352fda758
-  data.tar.gz: 0b5532349fe0a6829bfd2e7d4c52aad04f7232a1
+  metadata.gz: a6dea6327b14a40f5f88c344548da90536778701
+  data.tar.gz: c527f98356d7ca6febb761ea239c030d3cfc6365
 SHA512:
-  metadata.gz: a8975240e40fa018ba3a80ff04782657d3a13045ba293162655e0ddd8f3b33b2d6685e9695d4a8f46e7dd9e25cc169e183ee75412aae95d84282ea625c01a35c
-  data.tar.gz: 105977c62283b95aa4c886ed38f85d2be8bb0ef64793c68673032bb416b9de284964de94d34a7cbe661d04c4a9f48bf7aeb3024c60c9e26f02ed84c2b59b1c4e
+  metadata.gz: e99745536c8bae608186322664689156e303f569961b1086278da7d66cf7ea2cdbcd84565eef961d6ab966d6044988057861656f7c6cec5b35e5a2905dfa53f6
+  data.tar.gz: e3eb531c6e4ac7e1a9e9c0d2e914f9b1321bdbb48f9aead24ff9a611fb3e5a4c93e6a26974c7fabd0529da3d6a89dbc7958af3f12449ad559c3b223f54610dc0

data/CHANGELOG.md

@@ -10,6 +10,7 @@ Version 3.0
 * 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.
 
 Version 2.1
 -----------

data/README.md

@@ -7,15 +7,15 @@ Gretel also supports [semantic breadcrumbs](http://support.google.com/webmasters
 
 Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mailto:lassebunk@gmail.com).
 
-New in version 3.0
-------------------
+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 linking from the reviews section, you want to link back to the reviews instead.
+  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 are only one link, also if it is not the root breadcrumb.
+* 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.
 
 I hope you find these changes as useful as I did when I made them – if you have more suggestions, please create an [Issue](https://github.com/lassebunk/gretel/issues) or [Pull Request](https://github.com/lassebunk/gretel/pulls).
@@ -224,7 +224,7 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
   <% if links.any? %>
     You are here:
     <% links.each do |link| %>
-      <%= link_to link.text, link.url %> (<%= link.key %>)
+      <%= link_to link.text, link.url, class: (link.current? ? "current" : nil) %> (<%= link.key %>)
     <% end %>
   <% end %>
 <% end %>
@@ -235,7 +235,7 @@ 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 linking from the reviews section, you want to link back to the reviews instead.
+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
 
@@ -252,7 +252,7 @@ This will create an initializer in *config/initializers/gretel.rb* that will con
 If you want to do it manually, you can put the following in *config/initializers/gretel.rb*:
 
 ```
-Gretel::Trail.secret = 'your_key_here' # Must be changed to something else to be secure
+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)`.
@@ -287,9 +287,9 @@ Please use the trail functionality with care; the trails can get very long.
 Nice to know
 ------------
 
-### Access to view helpers
+### Access to view methods
 
-When configuring breadcrumbs, you have access to all view helpers of the view where the breadcrumbs are inserted.
+When configuring breadcrumbs inside a `crumb :xx do ... end` block, you have access to all methods that are normally accessible in the view where the breadcrumbs are inserted. This includes your view helpers, `params`, `request`, etc.
 
 ### Using multiple breadcrumb configuration files
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler/gem_tasks'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
 

data/gretel.gemspec

@@ -17,6 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.require_paths = ["lib"]
 
+  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

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

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,20 @@
+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.rb

@@ -19,6 +19,26 @@ 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
@@ -45,6 +65,15 @@ module Gretel
     # 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
+    #   end
+    def configure
+      yield self
+    end
+
     # Resets all changes made to +Gretel+, +Gretel::Crumbs+, and +Gretel::Trail+. Used for testing.
     def reset!
       instance_variables.each { |var| remove_instance_variable var }

data/lib/gretel/link.rb

@@ -5,5 +5,13 @@ module Gretel
     def initialize(key, text, url)
       @key, @text, @url = key, text, url
     end
+
+    def current!
+      @current = true
+    end
+
+    def current?
+      !!@current
+    end
   end
 end

data/lib/gretel/renderer.rb

@@ -117,6 +117,9 @@ module Gretel
           # Get trail
           links.unshift *trail_for(crumb)
 
+          # Set last link to current
+          links.last.try(:current!)
+
           links
         else
           []
@@ -169,10 +172,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 = render_link(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, render_link(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
@@ -181,10 +184,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 = render_link(text, url) if url.present?
         content_tag(fragment_tag, text, class: options[:class])
       elsif url.present?
-        link_to(text, url, class: options[:class])
+        render_link(text, url, class: options[:class])
       elsif options[:class].present?
         content_tag(:span, text, class: options[:class])
       else
@@ -192,6 +195,12 @@ module Gretel
       end
     end
 
+    # Renders a link. It is really just a proxy for +link_to+, but this can be
+    # used in plugins that want to change how links are rendered.
+    def render_link(name, url, options = {})
+      link_to(name, url, options)
+    end
+
     # Proxy to view context
     def method_missing(method, *args, &block)
       context.send(method, *args, &block)

data/lib/gretel/trail.rb

@@ -1,32 +1,53 @@
+require "gretel/trail/stores"
+require "gretel/trail/tasks"
+
 module Gretel
   module Trail
+    STORES = {
+      url: UrlStore,
+      db: ActiveRecordStore,
+      redis: RedisStore
+    }
+
     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
+      # Gets the store that is used to encode and decode trails.
+      # Default: +Gretel::Trail::UrlStore+
+      def store
+        @store ||= UrlStore
+      end
 
-      # Securely encodes array of links to a trail string to be used in URL.
+      # 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)
-        base64 = encode_base64(links)
-        hash = generate_hash(base64)
+        store.encode(links)
+      end
 
-        [hash, base64].join("_")
+      # Uses the store to decode a unique key to an array of links.
+      def decode(key)
+        store.decode(key)
       end
 
-      # Securely decodes a URL trail string to array of links.
-      def decode(trail)
-        hash, base64 = trail.split("_", 2)
+      # 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
 
-        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
+      # 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+.
@@ -34,35 +55,13 @@ module Gretel
         @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 }
-      end
-
-    private
-
-      # Encodes links array to Base64, internally using JSON for serialization.
-      def encode_base64(links)
-        arr = links.map { |link| [link.key, link.text, (link.text.html_safe? ? 1 : 0), link.url] }
-        Base64.urlsafe_encode64(arr.to_json)
-      end
-
-      # Decodes links array from Base64.
-      def decode_base64(base64)
-        json = Base64.urlsafe_decode64(base64)
-        arr = JSON.parse(json)
-        arr.map { |key, text, html_safe, url| Link.new(key.to_sym, (html_safe == 1 ? text.html_safe : text), url) }
-      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 "Gretel::Trail.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)
+        STORES.each_value(&:reset!)
       end
     end
   end

data/lib/gretel/trail/stores.rb

@@ -0,0 +1,4 @@
+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/stores/active_record_store.rb

@@ -0,0 +1,59 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,57 @@
+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/tasks.rb

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

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "3.0.0.beta2"
+  VERSION = "3.0.0.beta3"
 end

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

@@ -0,0 +1,11 @@
+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/dummy/db/schema.rb

@@ -11,19 +11,28 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20130122163051) do
+ActiveRecord::Schema.define(:version => 20131015194052) do
 
-  create_table "issues", force: true do |t|
+  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
+
+  create_table "issues", :force => true do |t|
     t.string   "title"
     t.integer  "project_id"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
-  create_table "projects", force: true do |t|
+  create_table "projects", :force => true do |t|
     t.string   "name"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
 end

data/test/gretel_test.rb

@@ -11,4 +11,12 @@ class GretelTest < ActiveSupport::TestCase
     assert_equal ["development"], Gretel.reload_environments
     assert !Gretel.suppress_deprecation_warnings?
   end
+
+  test "configuration block" do
+    Gretel.configure do |config|
+      config.trail_param = :other_param
+    end
+
+    assert_equal :other_param, Gretel.trail_param
+  end
 end

data/test/helper_methods_test.rb

@@ -7,7 +7,7 @@ class HelperMethodsTest < ActionView::TestCase
 
   setup do
     Gretel.reset!
-    Gretel::Trail.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
+    Gretel::Trail::UrlStore.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
   end
 
   # Breadcrumb generation
@@ -153,6 +153,16 @@ class HelperMethodsTest < ActionView::TestCase
                   [:multiple_links_with_parent, "Contact form", "/about/contact/form"]], out
   end
 
+  test "sets current on last link in array" do
+    breadcrumb :multiple_links_with_parent
+
+    out = breadcrumbs do |links|
+      links.map(&:current?)
+    end
+
+    assert_equal [false, false, false, true], out
+  end
+
   test "without link" do
     breadcrumb :without_link
     assert_equal %{<div class="breadcrumbs"><a href="/">Home</a> &rsaquo; Also without link &rsaquo; <span class="current">Without link</span></div>},

data/test/test_helper.rb

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

data/test/trails/active_record_store_test.rb

@@ -0,0 +1,52 @@
+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

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,27 @@
+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/{trail_test.rb → trails/url_store_test.rb}

@@ -1,8 +1,12 @@
 require 'test_helper'
 
-class TrailTest < ActiveSupport::TestCase
+class UrlStoreTest < ActiveSupport::TestCase
   setup do
-    Gretel::Trail.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
+    Gretel.reset!
+    
+    Gretel::Trail.store = :url
+    Gretel::Trail::UrlStore.secret = "128107d341e912db791d98bbe874a8250f784b0a0b4dbc5d5032c0fc1ca7bda9c6ece667bd18d23736ee833ea79384176faeb54d2e0d21012898dde78631cdf1"
+    
     @links = [
       [:root, "Home", "/"],
       [:store, "Store <b>Test</b>".html_safe, "/store"],
@@ -10,10 +14,6 @@ class TrailTest < ActiveSupport::TestCase
     ]
   end
 
-  test "defaults" do
-    assert_equal :trail, Gretel::Trail.trail_param
-  end
-
   test "encoding" do
     assert_equal "5543214e6d7bbc3ba5209b2362cd7513d500f61b_W1sicm9vdCIsIkhvbWUiLDAsIi8iXSxbInN0b3JlIiwiU3RvcmUgPGI-VGVzdDwvYj4iLDEsIi9zdG9yZSJdLFsic2VhcmNoIiwiU2VhcmNoIiwwLCIvc3RvcmUvc2VhcmNoP3E9dGVzdCJdXQ==",
                  Gretel::Trail.encode(@links.map { |key, text, url| Gretel::Link.new(key, text, url) })
@@ -28,4 +28,11 @@ class TrailTest < ActiveSupport::TestCase
   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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.0.beta3
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ 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:
@@ -57,6 +99,8 @@ 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
@@ -64,6 +108,12 @@ files:
 - 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
@@ -96,6 +146,7 @@ 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
@@ -109,7 +160,10 @@ files:
 - test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb
-- test/trail_test.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
@@ -165,6 +219,7 @@ 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
@@ -178,4 +233,7 @@ test_files:
 - test/gretel_test.rb
 - test/helper_methods_test.rb
 - test/test_helper.rb
-- test/trail_test.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