crumbs 2.0.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a340edbee8381a599cfed3c3c5f495b0bf0bd156
-  data.tar.gz: 3d74d95648151946cc7bf9c11de2d7e3f0dcc63f
+  metadata.gz: ee9ed2bb2383f091cd3122b573be9d7e2eb37b4c
+  data.tar.gz: 31cd1e7ba8675ccddcd534c5c300471f6a3500c2
 SHA512:
-  metadata.gz: 1628bf8db851169079ee1dfdd3ab1435dbdc60989bd1c8629a2225ecbee046e68812069be363155c680d54061ee78705470470c57ebb8d4e58f594cf9e811fa3
-  data.tar.gz: 24e176e3328621d1cf08c47b386a281c9ee618baa886186b0d733a752104eb33d2fa9cfd0fd35cecec26a7c3cc2ef6225bfa307dfc4f6c780cf3b69388066ea0
+  metadata.gz: d54d109fe0722703174e00e9fc14a2bb980dc87cd624470027d30ef0141ae6e1421e9861a32cb574575e792c737f92428ecd1ab2abce8d783b380f76d05236bb
+  data.tar.gz: 61e26356f6bdc4090ff067150320ce8e011cd9dd23c30edb0ea480a7f5056ca4e540086712968dd3178df219b08cfa8fc629cccd097e0558faf04e8506c9634b

data/README.md

@@ -18,7 +18,7 @@ $ bundle
 
 ## Configuration
 
-Generate the initialization file:
+Generate the initialization and definition files:
 ```
 rails g crumbs:install
 ```
@@ -30,29 +30,60 @@ Crumbs.configure do |config|
 end
 ```
 
-## Usage
+## DSL
 
-In your initialization file add crumbs referencing the controller and action with the dsl:
+In your config/crumbs.rb file add crumbs referencing the controller and action with the dsl:
 ```ruby
 Crumbs.define do
   controller :site do
-    action :home, 'Home'
+    action :index, 'Home'
   end
 end
 ```
 
-You can use a lambda, proc or block too, will receive the corresponding url parameters:
+To translate names you can use the t method (keys starting with dot are  prepended with 'crumbs.'):
 ```ruby
 Crumbs.define do
   controller :site do
-    action :product do |params|
+    action :index, t('.home')
+  end
+end
+```
+
+If you don't like to prepend the namespace of the controller:
+```ruby
+Crumbs.define do
+  namespace :admin do
+    controller :products do
+      action :index, 'Products'
+    end
+  end
+end
+```
+
+You can use a block for dynamic names, will receive the corresponding url parameters:
+```ruby
+Crumbs.define do
+  controller :products do
+    action :show do |params|
       Product.find(params[:id]).name
     end
   end
 end
 ```
 
-Then in your views would be available a crumbs variable:
+## Performance
+
+To disable crumbs for any controller or action:
+```ruby
+class Api::BaseController < ApplicationController
+  skip_before_action :set_crumbs
+end
+```
+
+## Views
+
+In your views would be available a crumbs variable:
 ```erb
 <% @crumbs.each do |crumb| %>
   &gt; <%= link_to crumb[:name], crumb[:path] %>
@@ -61,7 +92,7 @@ Then in your views would be available a crumbs variable:
 
 ## Last crumb
 
-If you want to show the last crumb, change the default:
+If you want to show the last crumb, change the default in your config/initializers/crumbs.rb:
 ```ruby
 Crumbs.configure do |config|
   config.crumbs.show_last = true

data/lib/crumbs/action_controller/base.rb

@@ -4,10 +4,10 @@ module Crumbs
       extend ActiveSupport::Concern
 
       included do
-        before_filter :set_crumbs
+        append_before_action :set_crumbs
       end
 
-      protected 
+      protected
 
       def set_crumbs
         paths = [request.path]

data/lib/crumbs/dsl/controller.rb

@@ -0,0 +1,27 @@
+module Crumbs
+  module DSL
+    class Controller
+
+      def initialize(controller, &block)
+        @controller = controller
+        instance_eval &block
+      end
+
+      def action(action, name=nil, &block)
+        Crumbs.add(
+          @controller.to_s,
+          action.to_s,
+          (block_given? ? block : name)
+        )
+      end
+
+      def t(key)
+        if key.starts_with? '.'
+          key.prepend 'crumbs'
+        end
+        I18n.t(key)
+      end
+
+    end
+  end
+end

data/lib/crumbs/dsl/namespace.rb

@@ -0,0 +1,16 @@
+module Crumbs
+  module DSL
+    class Namespace
+
+      def initialize(namespace, &block)
+        @namespace = namespace
+        instance_eval &block
+      end
+
+      def controller(name, &block)
+        Controller.new("#{@namespace}/#{name}", &block)
+      end
+
+    end
+  end
+end

data/lib/crumbs/proxy.rb

@@ -1,8 +1,17 @@
 module Crumbs
   class Proxy
 
-    def controller(name, &block)
-      Controller.new(name).instance_eval(&block)
+    def initialize(&block)
+      instance_eval &block
+    end
+
+    %w(
+      namespace
+      controller
+    ).each do |name|
+      define_method name do |*args, &block|
+        DSL.const_get(name.to_s.classify).new(*args, &block)
+      end
     end
 
   end

data/lib/crumbs/railtie.rb

@@ -5,5 +5,9 @@ module Crumbs
       ::ActionController::Base.send :include, Crumbs::ActionController::Base
     end
 
+    config.after_initialize do
+      load Rails.root.join('config/crumbs.rb')
+    end
+
   end
 end

data/lib/crumbs/version.rb

@@ -1,5 +1,5 @@
 module Crumbs
 
-  VERSION = '2.0.2'
+  VERSION = '2.1.1'
 
 end

data/lib/crumbs.rb

@@ -1,6 +1,7 @@
 require 'crumbs/action_controller/base'
 require 'crumbs/proxy'
-require 'crumbs/controller'
+require 'crumbs/dsl/namespace'
+require 'crumbs/dsl/controller'
 require 'crumbs/railtie'
 
 module Crumbs
@@ -19,12 +20,12 @@ module Crumbs
     end
 
     def define(&block)
-      Proxy.new.instance_eval &block
+      Proxy.new(&block)
     end
 
     def find(controller, action, params)
-      if all.has_key? controller and all[controller].has_key? action
-        name = all[controller][action]
+      if registry.has_key? controller and registry[controller].has_key? action
+        name = registry[controller][action]
         if name.is_a? Proc
           name.call params
         else
@@ -33,8 +34,18 @@ module Crumbs
       end
     end
 
-    def all
-      @all ||= {}
+    def add(controller, action, name)
+      if registry.has_key? controller
+        registry[controller][action] = name
+      else
+        registry[controller] = { action => name }
+      end
+    end
+
+    protected
+
+    def registry
+      @registry ||= {}
     end
 
   end

data/lib/generators/crumbs/install_generator.rb

@@ -6,7 +6,8 @@ module Crumbs
     source_root File.expand_path('../templates', __FILE__)
 
     def create_initializer
-      copy_file 'crumbs.rb', 'config/initializers/crumbs.rb'
+      copy_file 'configure.rb', 'config/initializers/crumbs.rb'
+      copy_file 'define.rb', 'config/crumbs.rb'
     end
 
   end

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

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

data/test/dummy/app/controllers/namespace/pages_controller.rb

@@ -0,0 +1,8 @@
+class Namespace::PagesController < ApplicationController
+
+  def index
+    render template: 'pages/crumbs'
+  end
+
+end
+

data/test/dummy/app/controllers/pages_controller.rb

@@ -1,6 +1,6 @@
 class PagesController < ApplicationController
 
-  def home
+  def index
     render :crumbs
   end
 

data/test/dummy/config/crumbs.rb

@@ -0,0 +1,21 @@
+Crumbs.define do
+
+  namespace :namespace do
+    controller :pages do
+      action :index, 'Namespaced Home'
+    end
+  end
+
+  controller :pages do
+    action :index, 'Home'
+    action :nested, 'Nested'
+    action :i18n, t('.hello')
+    action :static do
+      t('.static')
+    end
+    action :param do |params|
+      "Param#{params[:param]}"
+    end
+  end
+
+end

data/test/dummy/config/locales/en.yml

@@ -20,4 +20,6 @@
 # available at http://guides.rubyonrails.org/i18n.html.
 
 en:
-  hello: "Hello world"
+  crumbs:
+    hello: "Hello world"
+    static: "Static"

data/test/dummy/config/routes.rb

@@ -1,6 +1,6 @@
 Dummy::Application.routes.draw do
   
-  root to: 'pages#home'
+  root to: 'pages#index'
 
   get 'static', to: 'pages#static'
   get 'static/nested', to: 'pages#nested'  
@@ -15,6 +15,8 @@ Dummy::Application.routes.draw do
   get 'i18n', to: 'pages#i18n'
   get 'i18n/nested', to: 'pages#nested'
 
+  get 'namespaced', to: 'namespace/pages#index'
+
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".