RubyGems - gretel-trails - Versions diffs - 0.0.2 → 0.0.3 - Mend

gretel-trails 0.0.2 → 0.0.3

Files changed (16) hide show

checksums.yaml +4 -4
data/README.md +39 -15
data/gretel-trails.gemspec +1 -1
data/lib/gretel/trails.rb +17 -9
data/lib/gretel/trails/patches/renderer.rb +15 -1
data/lib/gretel/trails/patches/view_helpers.rb +8 -0
data/lib/gretel/trails/stores/store.rb +2 -5
data/lib/gretel/trails/strategies/hidden_strategy.rb +17 -0
data/lib/gretel/trails/version.rb +1 -1
data/test/dummy/app/controllers/home_controller.rb +7 -0
data/test/dummy/app/views/home/about.html.erb +11 -0
data/test/dummy/app/views/home/index.html.erb +1 -0
data/test/{gretel_trails_test.rb → strategies/hidden_strategy_test.rb} +21 -5
data/test/trails_test.rb +12 -0
metadata +13 -9
data/test/dummy/config/initializers/gretel.rb +0 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e37b779cdb1997c44fbffe04b0e99cdcaeffa9ac
-  data.tar.gz: d90ed701b34331eae74e4d60ea6f3c465b3841f6
+  metadata.gz: 5ecb5003348bd54d39ff554ef56de1f38c82f0bf
+  data.tar.gz: 4c2cde48545343930bb454cda4d2e2f63cb330e9
 SHA512:
-  metadata.gz: c5351e3714d5dbaf54f423248c1919876e129b02fab2f2260097b63962f43def0598b485a11ca18596bc0c526387efce9813dbc1f8f07d233de0f6518eb9a0d7
-  data.tar.gz: 0f29f72ea2058d12e67a32408fffe33e40d2040f614968d88c12a0f38ec3eecf86b1c3585860b633e783c0687dff2f03e299d0e590d898b8dd096afd2cfad620
+  metadata.gz: 70a4faff241e9417d5791048af7a7972a33f3c3f2e101e5756ca8426f6e5deade6796aec721962c0c15bf6ce3f16b384a44244f278fca391da44548a0221f9c6
+  data.tar.gz: 38cf86aeef2f3e9cb402c4697dfac4815d825215b778460a52c396a641b94dc60f2820418767104e51cb043d59421a8ce1aceea25d74b851e610b397002bf433

data/README.md CHANGED Viewed

@@ -29,7 +29,9 @@ The default store is the URL store that encodes trails directly in the URL. Note
 In order to use the URL store, you must set a secret that's used to prevent cross-site scripting attacks. In an initializer, e.g. *config/initializers/gretel.rb*:
 ```
-Gretel::Trails::UrlStore.secret = 'your_key_here' # Must be changed to something else to be secure
+Gretel::Trails.configure do |config|
+  config.store.secret = 'your_key_here' # Must be changed to something else to be secure
+end
 ```
 You can generate a secret using `SecureRandom.hex(64)` or `rake secret`.
@@ -51,7 +53,9 @@ The product view will now have the breadcrumb trail from the first page (reviews
 The default trail param is `params[:trail]`. You can change it in an initializer:
 ```ruby
-Gretel::Trails.trail_param = :other_param
+Gretel::Trails.configure do |config|
+  config.trail_param = :other_param
+end
 ```
 ## Hiding trails in URLs
@@ -61,7 +65,9 @@ Gretel::Trails has a `:hidden` strategy that can be used to hide trails in URLs
 To hide trails, you set the strategy in an initializer, e.g. *config/initializers/gretel.rb*:
 ```ruby
-Gretel::Trails.strategy = :hidden
+Gretel::Trails.configure do |config|
+  config.strategy = :hidden
+end
 ```
 Add a data attribute with the trail to your `<body>` tag, in *application.html.erb*:
@@ -117,24 +123,30 @@ If you want to do custom breadcrumb links with these changes applied, you can us
 The link will now have a URL without the trail param and `data-trail` containing the trail.
-## Customization
+### Customization
-### JS selector
+#### JS selector
 If you want to customize the JS selector (the default is `.js-append-trail`), you can do so in an initializer:
 ```ruby
-Gretel::Trails::HiddenStrategy.js_selector = ".my-other-selector"
+Gretel::Trails.configure do |config|
+  config.strategy = :hidden
+  config.hidden.js_selector = ".my-other-selector"
+end
 ```
 It supports all [CSS selectors](http://api.jquery.com/category/selectors/) that you can use in jQuery.
-### Data attribute
+#### Data attribute
 The default trail data attribute for `<body>` and links is `data-trail` but you can change this in an initializer:
 ```ruby
-Gretel::Trails::HiddenStrategy.data_attribute = "other-data-attribute"
+Gretel::Trails.configure do |config|
+  config.strategy = :hidden
+  config.hidden.data_attribute = "other-data-attribute"
+end
 ```
 `data-` is added automatically, so if for example you want the attribute to be `data-my-attr`, you just set it to `my-attr`.
@@ -150,8 +162,10 @@ The default store is the URL store which is great for simple use, but if you hav
 To use the URL store, set it in an initializer, e.g. *config/initializers/gretel.rb*:
 ```ruby
-Gretel::Trails.store = :url # Not really needed as this is the default
-Gretel::Trails::UrlStore.secret = 'your_key_here' # Must be changed to something else to be secure
+Gretel::Trails.configure do |config|
+  config.store = :url # Not really needed as this is the default
+  config.store.secret = 'your_key_here' # Must be changed to something else to be secure
+end
 ```
 The secret is used to prevent cross-site scripting attacks. You can generate a secure one using `SecureRandom.hex(64)` or `rake secret`.
@@ -163,7 +177,9 @@ The database store stores trails in the database so the trail keys have a maximu
 To use the database store, set it an initializer, e.g. *config/initializers/gretel.rb*:
 ```ruby
-Gretel::Trails.store = :db
+Gretel::Trails.configure do |config|
+  config.store = :db
+end
 ```
 You also need to create a migration for the database table that holds the trails:
@@ -187,7 +203,10 @@ If you need a gem for managing recurring tasks, [Whenever](https://github.com/ja
 The default expiration period is 1 day. To set a custom expiration period, in an initializer:
 ```ruby
-Gretel::Trails::ActiveRecordStore.expires_in = 2.days
+Gretel::Trails.configure do |config|
+  config.store = :db
+  config.store.expires_in = 2.days
+end
 ```
 ### Redis store
@@ -197,8 +216,10 @@ If you want to store trails in [Redis](https://github.com/redis/redis), you can
 To use the Redis store, set it in an initializer, e.g. *config/initializers/gretel.rb*:
 ```ruby
-Gretel::Trails.store = :redis
-Gretel::Trails::RedisStore.connect_options = { host: "10.0.1.1", port: 6380 }
+Gretel::Trails.configure do |config|
+  config.store = :redis
+  config.store.connect_options = { host: "10.0.1.1", port: 6380 }
+end
 ```
 Trails are now stored in Redis and expired automatically after 1 day (by default).
@@ -206,7 +227,10 @@ Trails are now stored in Redis and expired automatically after 1 day (by default
 To set a custom expiration period, in an initializer:
 ```ruby
-Gretel::Trails::RedisStore.expires_in = 2.days
+Gretel::Trails.configure do |config|
+  config.store = :redis
+  config.store.expires_in = 2.days
+end
 ```
 ## Requirements

data/gretel-trails.gemspec CHANGED Viewed

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^test/})
   spec.require_paths = ["lib"]
-  spec.add_dependency "gretel", ">= 3.0.0.beta5"
+  spec.add_dependency "gretel", ">= 3.0.0.beta6"
   spec.add_dependency "rails", ">= 3.2.0"
   spec.add_development_dependency "rails", "~> 3.2.13"
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/gretel/trails.rb CHANGED Viewed

@@ -7,13 +7,15 @@ require "gretel/trails/engine"
 module Gretel
   module Trails
-    STORES = {
+    DEFAULT_STORES = {
       url: UrlStore,
       db: ActiveRecordStore,
       redis: RedisStore
     }
     class << self
+      include Gretel::Resettable
       # Activated strategies
       def strategies
         @strategies ||= []
@@ -40,14 +42,26 @@ module Gretel
       # Can be a subclass of +Gretel::Trails::Store+, or a symbol: +:url+, +:db+, or +:redis+.
       def store=(value)
         if value.is_a?(Symbol)
-          klass = STORES[value]
-          raise ArgumentError, "Unknown Gretel::Trails.store #{value.inspect}. Use any of #{STORES.inspect}." unless klass
+          klass = available_stores[value]
+          raise ArgumentError, "Unknown Gretel::Trails.store #{value.inspect}. Use any of #{available_stores.inspect}." unless klass
           self.store = klass
         else
           @store = value
         end
       end
+      # Registers a store for use with `Gretel::Trails.store = :key`.
+      #
+      #   Gretel::Trails.register_store :url, UrlStore
+      def register_store(key, klass)
+        available_stores[key] = klass
+      end
+      # Hash of registered stores.
+      def available_stores
+        @available_stores ||= DEFAULT_STORES
+      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)
@@ -93,12 +107,6 @@ module Gretel
       def configure
         yield self
       end
-      # 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/lib/gretel/trails/patches/renderer.rb CHANGED Viewed

@@ -12,6 +12,20 @@ Gretel::Renderer.class_eval do
   # Returns encoded trail for the breadcrumb.
   def trail
-    @trail ||= Gretel::Trails.encode(links)
+    @trail ||= begin
+      transformed_links = links.dup
+      if transform_current_path && transformed_links.any? && request
+        transformed_links.last.url = request.fullpath
+      end
+      Gretel::Trails.encode(transformed_links)
+    end
+  end
+  # Whether to set the current link path to +request.fullpath+.
+  def transform_current_path
+    return @transform_current_path if defined?(@transform_current_path)
+    @transform_current_path = true
   end
+  attr_writer :transform_current_path
 end

data/lib/gretel/trails/patches/view_helpers.rb CHANGED Viewed

@@ -3,4 +3,12 @@ Gretel::ViewHelpers.class_eval do
   def breadcrumb_trail
     gretel_renderer.trail
   end
+  # Yields a block having the breadcrumb trail set to the breadcrumb given by +key+.
+  def with_breadcrumb_trail(key, *args, &block)
+    with_breadcrumb(key, *args) do
+      gretel_renderer.transform_current_path = false
+      yield
+    end
+  end
 end

data/lib/gretel/trails/stores/store.rb CHANGED Viewed

@@ -2,6 +2,8 @@ module Gretel
   module Trails
     class Store
       class << self
+        include Gretel::Resettable
         # 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)
@@ -43,11 +45,6 @@ module Gretel
             []
           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

data/lib/gretel/trails/strategies/hidden_strategy.rb CHANGED Viewed

@@ -5,6 +5,8 @@ module Gretel
       DEFAULT_DATA_ATTRIBUTE = "trail"
       class << self
+        include Gretel::Resettable
         # jQuery selector for links that should have the trail appended
         # to them on click. Default: +.js-append-trail+
         def js_selector
@@ -27,6 +29,21 @@ module Gretel
   end
 end
+Gretel::Trails.class_eval do
+  class << self
+    def hidden
+      Gretel::Trails::HiddenStrategy
+    end
+    def reset_with_hidden!
+      reset_without_hidden!
+      hidden.reset!
+    end
+    alias_method_chain :reset!, :hidden
+  end
+end
 Gretel::Renderer.class_eval do
   # Moves the trail from the querystring into a data attribute.
   def breadcrumb_link_to_with_hidden_trail(name, url, options = {})

data/lib/gretel/trails/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Gretel
   module Trails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/dummy/app/controllers/home_controller.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class HomeController < ApplicationController
+  def index
+  end
+  def about
+  end
+end

data/test/dummy/app/views/home/about.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<% breadcrumb :about %>
+<h1>About</h1>
+<%= link_to "Recent products before different trail", recent_products_path, data: { trail: breadcrumb_trail } %>
+<% with_breadcrumb_trail :product, Product.find_by_slug("one") do %>
+  <%= link_to "Recent products with different trail", recent_products_path, data: { trail: breadcrumb_trail } %>
+<% end %>
+<%= link_to "Recent products after different trail", recent_products_path, data: { trail: breadcrumb_trail } %>

data/test/dummy/app/views/home/index.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <h1>Welcome!</h1>

data/test/{gretel_trails_test.rb → strategies/hidden_strategy_test.rb} RENAMED Viewed

@@ -1,6 +1,22 @@
 require 'test_helper'
 class GretelTrailsTest < ActionDispatch::IntegrationTest
+  setup do
+    Gretel.reset!
+    Gretel::Trails.configure do |config|
+      config.store = :db
+      config.strategy = :hidden
+    end
+  end
+  test "configuration block" do
+    Gretel::Trails.configure do |config|
+      config.hidden.js_selector = ".test"
+    end
+    assert_equal ".test", Gretel::Trails::HiddenStrategy.js_selector
+  end
   test "regular breadcrumbs" do
     visit "/categories/one"
@@ -23,24 +39,24 @@ class GretelTrailsTest < ActionDispatch::IntegrationTest
   end
   test "invisibly applying trail" do
-    visit "/products/recent"
+    visit "/products/recent?page=2"
     within "#products" do
       click_link "Product One"
     end
     assert_equal "/products/one", current_fullpath
-    assert_equal ["/", "/products/recent"], all(".breadcrumbs a").map { |a| a[:href] }
+    assert_equal ["/", "/products/recent?page=2"], all(".breadcrumbs a").map { |a| a[:href] }
     click_link "See reviews"
     assert_equal "/products/one/reviews", current_fullpath
-    assert_equal ["/", "/products/recent", "/products/one"], all(".breadcrumbs a").map { |a| a[:href] }
+    assert_equal ["/", "/products/recent?page=2", "/products/one"], all(".breadcrumbs a").map { |a| a[:href] }
     all(".breadcrumbs a").last.click
     assert_equal "/products/one", current_fullpath
-    assert_equal ["/", "/products/recent"], all(".breadcrumbs a").map { |a| a[:href] }
+    assert_equal ["/", "/products/recent?page=2"], all(".breadcrumbs a").map { |a| a[:href] }
     all(".breadcrumbs a").last.click
-    assert_equal "/products/recent", current_fullpath
+    assert_equal "/products/recent?page=2", current_fullpath
   end
   test "breadcrumb_link_to" do

data/test/trails_test.rb CHANGED Viewed

@@ -11,10 +11,13 @@ class TrailsTest < ActiveSupport::TestCase
   test "configuration block" do
     Gretel::Trails.configure do |config|
+      config.store = :url
+      config.store.secret = "1234"
       config.trail_param = :set_from_config
     end
     assert_equal :set_from_config, Gretel::Trails.trail_param
+    assert_equal "1234", Gretel::Trails::UrlStore.secret
   end
   test "setting invalid store" do
@@ -22,4 +25,13 @@ class TrailsTest < ActiveSupport::TestCase
       Gretel::Trails.store = :xx
     end
   end
+  test "register store" do
+    klass = Class.new(Gretel::Trails::Store)
+    Gretel::Trails.register_store :test_store, klass
+    Gretel::Trails.store = :test_store
+    assert_equal klass, Gretel::Trails.store
+  end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel-trails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gretel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta5
+        version: 3.0.0.beta6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta5
+        version: 3.0.0.beta6
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/categories_controller.rb
+- test/dummy/app/controllers/home_controller.rb
 - test/dummy/app/controllers/products_controller.rb
 - test/dummy/app/controllers/reviews_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -200,6 +201,8 @@ files:
 - test/dummy/app/models/category.rb
 - test/dummy/app/models/product.rb
 - test/dummy/app/views/categories/show.html.erb
+- test/dummy/app/views/home/about.html.erb
+- test/dummy/app/views/home/index.html.erb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/products/recent.html.erb
 - test/dummy/app/views/products/show.html.erb
@@ -214,7 +217,6 @@ files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/gretel.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -235,10 +237,10 @@ files:
 - test/dummy/script/rails
 - test/dummy/test/fixtures/categories.yml
 - test/dummy/test/fixtures/products.yml
-- test/gretel_trails_test.rb
 - test/stores/active_record_store_test.rb
 - test/stores/redis_store_test.rb
 - test/stores/url_store_test.rb
+- test/strategies/hidden_strategy_test.rb
 - test/test_helper.rb
 - test/trails_test.rb
 - test/view_helpers_test.rb
@@ -262,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key:
 specification_version: 4
 summary: Collection of strategies for handling Gretel trails.
@@ -273,6 +275,7 @@ test_files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/categories_controller.rb
+- test/dummy/app/controllers/home_controller.rb
 - test/dummy/app/controllers/products_controller.rb
 - test/dummy/app/controllers/reviews_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -281,6 +284,8 @@ test_files:
 - test/dummy/app/models/category.rb
 - test/dummy/app/models/product.rb
 - test/dummy/app/views/categories/show.html.erb
+- test/dummy/app/views/home/about.html.erb
+- test/dummy/app/views/home/index.html.erb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/products/recent.html.erb
 - test/dummy/app/views/products/show.html.erb
@@ -295,7 +300,6 @@ test_files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/gretel.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -316,10 +320,10 @@ test_files:
 - test/dummy/script/rails
 - test/dummy/test/fixtures/categories.yml
 - test/dummy/test/fixtures/products.yml
-- test/gretel_trails_test.rb
 - test/stores/active_record_store_test.rb
 - test/stores/redis_store_test.rb
 - test/stores/url_store_test.rb
+- test/strategies/hidden_strategy_test.rb
 - test/test_helper.rb
 - test/trails_test.rb
 - test/view_helpers_test.rb

data/test/dummy/config/initializers/gretel.rb DELETED Viewed

	@@ -1,2 +0,0 @@
1	- Gretel::Trails.store = :db
2	- Gretel::Trails.strategy = :hidden