crumbs 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f70ae6eeba2b20e9ee261ff06383f9df40b93e0
-  data.tar.gz: a386fbd54af37f2c1e0cc0d4657848e0e6a224a6
+  metadata.gz: 081d368a0f3413cccc92fedb8eeec622b626ee1a
+  data.tar.gz: b8f970e0e85570aab1f4cb493c050b0126625bd0
 SHA512:
-  metadata.gz: 3930d7d633e0acf5b7fd4076bd78c8aee1499a8578259df8c77726c22d35b07b80bdde6e38e56a3887d4ac0cb3bdd0fca22c07354c343f28957acdc4628beeaa
-  data.tar.gz: 6ccf8263cab04beaddb7319a1314542b9851473411506041e0a1ba0f8f68a2c3c14c6fc8ee7c35b94c0f6a7bfa653a40de73dbbb742920fda1fd1a706abfeaf2
+  metadata.gz: 3f195ea732621d1be2cb8761d978baa3b1227c3581d0ecf7e63a523e28c080750743538882055827355c1f9472d277f070ed3b8274c7b2493d0312281266acbd
+  data.tar.gz: 3d91bb86d4a4a38f9d88ea4261c0dc65eecfd64780a741dd9091fb3b607adee49b9ac1b591a046a57c87e46f8d2bda2302dae812f9da549bb93433688677eb8d

data/README.md

@@ -0,0 +1,67 @@
+[![Gem Version](https://badge.fury.io/rb/crumbs.svg)](http://badge.fury.io/rb/crumbs) [![Code Climate](https://codeclimate.com/github/museways/crumbs/badges/gpa.svg)](https://codeclimate.com/github/museways/crumbs) [![Build Status](https://travis-ci.org/museways/crumbs.svg?branch=master)](https://travis-ci.org/museways/crumbs)
+
+# Crumbs
+
+Adds a handy crumbs variable available in your views in rails.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'crumbs'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Configuration
+
+Generate the configuration file:
+```
+rails g crumbs:install
+```
+
+The defaults values are:
+```ruby
+Crumbs.configure do |config|
+  config.show_last = false
+end
+```
+
+## Usage
+
+In your controllers add crumbs to the actions you want:
+```ruby
+crumb :home, 'Home'
+```
+
+You can use a lambda, proc or block too, will receive the corresponding url parameters:
+```ruby
+crumb :product, proc { |params| Product.find(params[:id]).name }
+```
+
+Then in your views would be available a crumbs variable:
+```erb
+<% @crumbs.each do |crumb| %>
+  &gt; <%= link_to crumb[:name], crumb[:path] %>
+<% end %>
+```
+
+## Last crumb
+
+If you want to show the last crumb, change the default:
+```ruby
+Crumbs.configure do |config|
+  config.crumbs.show_last = true
+end
+```
+
+## Credits
+
+This gem is maintained and funded by [museways](http://museways.com).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/crumbs/action_controller/base.rb

@@ -22,7 +22,7 @@ module Crumbs
         elsif
           session[:referers] = [referer]
         end
-        paths.pop unless Rails.application.config.crumbs.show_last
+        paths.pop unless Crumbs.config.show_last
         @crumbs = []
         paths.each do |path|
           params = Rails.application.routes.recognize_path("#{request.base_url}#{path}") rescue next
@@ -39,17 +39,15 @@ module Crumbs
         paths = [paths] unless paths.is_a? Array
         session[:referers].rindex { |referer| paths.include? referer[:path] }
       end
- 
+
       module ClassMethods
- 
+
         protected
- 
+
         def crumb(action, name=nil, &block)
-          controller = self.name.gsub('::', '/').gsub('Controller', '').underscore
-          name = block_given? ? block : name
-          Crumbs::Definitions.add controller.to_s, action.to_s, name
+          Crumbs::Definitions.add controller_path, action.to_s, (block_given? ? block : name)
         end
- 
+
       end
     end
   end

data/lib/crumbs/definitions.rb

@@ -1,11 +1,11 @@
 module Crumbs
   class Definitions
     class << self
-    
+
       def all
         @all ||= {}
       end
-    
+
       def add(controller, action, name)
         if all.has_key? controller
           all[controller][action] = name
@@ -13,14 +13,14 @@ module Crumbs
           all[controller] = { action => name }
         end
       end
-  
+
       def find(controller, action, params)
         if all.has_key? controller and all[controller].has_key? action
           name = all[controller][action]
           name.is_a?(Proc) ? name.call(params) : name
         end
       end
-  
+
     end
   end
 end

data/lib/crumbs/railtie.rb

@@ -1,9 +1,6 @@
 module Crumbs
   class Railtie < Rails::Railtie
 
-    config.crumbs = ActiveSupport::OrderedOptions.new
-    config.crumbs.show_last = false
-
     initializer 'crumbs' do
       ::ActionController::Base.send :include, Crumbs::ActionController::Base
     end

data/lib/crumbs/version.rb

@@ -1,5 +1,5 @@
 module Crumbs
 
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 
 end

data/lib/crumbs.rb

@@ -1,7 +1,21 @@
 require 'crumbs/action_controller/base'
 require 'crumbs/definitions'
 require 'crumbs/railtie'
-require 'crumbs/version'
 
 module Crumbs
+  class << self
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= begin
+        ActiveSupport::OrderedOptions.new.tap do |config|
+          config.show_last = false
+        end
+      end
+    end
+
+  end
 end

data/lib/generators/crumbs/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module Crumbs
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer
+      copy_file 'crumbs.rb', 'config/initializers/crumbs.rb'
+    end
+
+  end
+end

data/lib/generators/crumbs/templates/crumbs.rb

@@ -0,0 +1,2 @@
+Crumbs.configure do |config|
+end