crumbs 2.1.2 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82f905717d06763bf475faebe14ef2ee7ee5890e
-  data.tar.gz: b172f6203247356d87854c481a76685e42e47742
+  metadata.gz: 91cfd4a3627443e9244d089d713946a5e526d9fa
+  data.tar.gz: 2c519f7541e3ece7b0b0610459f992687cd32759
 SHA512:
-  metadata.gz: 8b192b39ce8639f9c26b67f1b7bd0c6e81040def64645404e46fea05b825b712f082aeef071d3f58604c636af9bcf1702fa152099090514a56c15a7eb4979042
-  data.tar.gz: c003689979884e8a37d3a67240e751d6b687071d5f976f2db6eaed18eae28811f9ed8d52bab30e20cc2abd9c6dbab12597662ea0e07db8bcb5c5fc9efa6c21cb
+  metadata.gz: 7a95f3e6439c69f5bd0315f2ad1141cfc66e95ae9bd8c581fdc407b48260b7fd37b5626edc954dd2c8fb534fb9545775fc79e7d259ef372fadda39bd52cf0b13
+  data.tar.gz: 34af90429178f5832ef5eaa74531a19a809a353a6eada0e6da695bb1314d182a1b9b83ebf0b6acc897861ee40f2082b6abe6107807a05986328ff1f3d5164480

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,7 +5,14 @@
 
 # Crumbs
 
-Adds a handy crumbs variable available in your views in rails.
+Handy crumbs variable for rails views.
+
+## Why
+
+I did this gem to:
+
+- Have a dsl separate from the controllers to define crumbs.
+- Make crumbs remember query parameters from previous requests.
 
 ## Install
 
@@ -19,89 +26,72 @@ Then bundle:
 $ bundle
 ```
 
+NOTE: Because this gem stores queries in session, you may need a gem like redis-store to prevent cookies overflow.
+
 ## Configuration
 
-Generate the initialization and definition files:
+Generate the configuration file:
 ```
-rails g crumbs:install
+$ bundle exec rails g crumbs:install
 ```
 
-The defaults configuration values are:
-```ruby
-Crumbs.configure do |config|
-  config.show_last = false
-end
-```
+## Usage
 
-## DSL
+### Definitions
 
-In your config/crumbs.rb file add crumbs referencing the controller and action with the dsl:
+Use the crumb method to define a crumb:
 ```ruby
 Crumbs.define do
-  controller :site do
-    action :index, 'Home'
-  end
+  crumb 'pages#index', 'Home'
 end
 ```
 
-To translate names you can use the t method (keys starting with dot are  prepended with 'crumbs.'):
+To translate the name you can use the t shortcut method, will prepend "crumbs" to the key:
 ```ruby
 Crumbs.define do
-  controller :site do
-    action :index, t('.home')
-  end
+  crumb 'pages#index', t('.home')
 end
 ```
 
-If you don't like to prepend the namespace of the controller:
+For dynamic names you can use a block, will receive the corresponding parameters:
 ```ruby
 Crumbs.define do
-  namespace :admin do
-    controller :products do
-      action :index, 'Products'
-    end
+  crumb 'products#show' do |params|
+    Product.find(params[:id]).name
   end
 end
 ```
 
-You can use a block for dynamic names, will receive the corresponding url parameters:
+If you need to add multiple crumbs to the same controller:
 ```ruby
 Crumbs.define do
-  controller :products do
-    action :show do |params|
-      Product.find(params[:id]).name
+  namespace :admin do
+    controller :users do
+      crumb :index, 'Users'
+      crumb :edit, 'Edit user'
     end
   end
 end
 ```
 
-## Performance
+### Performance
 
-To disable crumbs for any controller or action:
+To disable crums in some controller:
 ```ruby
 class Api::BaseController < ApplicationController
   skip_before_action :set_crumbs
 end
 ```
 
-## Views
+### Views
 
-In your views would be available a crumbs variable:
+Crumbs variable will be available in your views:
 ```erb
 <% @crumbs.each do |crumb| %>
-  &gt; <%= link_to crumb[:name], crumb[:path] %>
+  &gt; <%= link_to crumb[:name], crumb[:url] %>
 <% end %>
 ```
 
-## Last crumb
-
-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
-end
-```
-
 ## Credits
 
 This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).

data/Rakefile

@@ -4,19 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Crumbs'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -26,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

data/lib/crumbs/definitions.rb

@@ -0,0 +1,26 @@
+module Crumbs
+  class Definitions
+
+    def find(id, params)
+      if registry.has_key?(id)
+        name = registry[id]
+        if name.is_a?(Proc)
+          name.call params
+        else
+          name
+        end
+      end
+    end
+
+    def add(id, name)
+      registry[id] = name
+    end
+
+    private
+
+    def registry
+      @registry ||= {}
+    end
+
+  end
+end

data/lib/crumbs/dsl/controller.rb

@@ -1,25 +1,21 @@
 module Crumbs
-  module DSL
+  module Dsl
     class Controller
 
-      def initialize(controller, &block)
-        @controller = controller
+      def initialize(prefix, &block)
+        @prefix = prefix
         instance_eval &block
       end
 
-      def action(action, name=nil, &block)
-        Crumbs.add(
-          @controller.to_s,
-          action.to_s,
-          (block_given? ? block : name)
-        )
+      def crumb(action, name=nil, &block)
+        Crumbs.definitions.add "#{@prefix}##{action}", (block_given? ? block : name)
       end
 
       def t(key)
-        if key.starts_with? '.'
+        if key.starts_with?('.')
           key.prepend 'crumbs'
         end
-        I18n.t(key)
+        I18n.t key
       end
 
     end

data/lib/crumbs/dsl/namespace.rb

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

data/lib/crumbs/extensions/action_controller/base.rb

@@ -0,0 +1,43 @@
+module Crumbs
+  module Extensions
+    module ActionController
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :set_crumbs
+        end
+
+        private
+
+        def set_crumbs
+          paths = [request.path]
+          until paths.first == '/'
+            paths.prepend File.dirname(paths.first)
+          end
+          session[:referers] ||= {}
+          url, query = request.url.split(/\/?\?/)
+          if query
+            session[:referers][url] = query
+          end
+          @crumbs = []
+          paths.each do |path|
+            url = "#{request.base_url}#{path}".remove(/\/$/)
+            begin
+              params = Rails.application.routes.recognize_path(url)
+            rescue
+              next
+            end
+            if name = Crumbs.definitions.find("#{params[:controller]}##{params[:action]}", params)
+              if query = session[:referers][url]
+                url << "?#{query}"
+              end
+              @crumbs << { name: name, url: url }
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/crumbs/proxy.rb

@@ -5,13 +5,16 @@ module Crumbs
       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
+    def namespace(*args, &block)
+      Dsl::Namespace.new *args, &block
+    end
+
+    def controller(*args, &block)
+      Dsl::Controller.new *args, &block
+    end
+
+    def crumb(action, name=nil, &block)
+      Crumbs.definitions.add action, (block_given? ? block : name)
     end
 
   end

data/lib/crumbs/railtie.rb

@@ -1,8 +1,10 @@
 module Crumbs
   class Railtie < Rails::Railtie
 
-    initializer 'crumbs' do
-      ::ActionController::Base.send :include, Crumbs::ActionController::Base
+    initializer 'crumbs.extensions' do
+      ::ActionController::Base.include(
+        Crumbs::Extensions::ActionController::Base
+      )
     end
 
     config.after_initialize do

data/lib/crumbs/version.rb

@@ -1,5 +1,5 @@
 module Crumbs
 
-  VERSION = '2.1.2'
+  VERSION = '4.0.0.0'
 
 end

data/lib/crumbs.rb

@@ -1,51 +1,20 @@
-require 'crumbs/action_controller/base'
-require 'crumbs/proxy'
 require 'crumbs/dsl/namespace'
 require 'crumbs/dsl/controller'
+require 'crumbs/extensions/action_controller/base'
+require 'crumbs/definitions'
+require 'crumbs/proxy'
 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
-
     def define(&block)
-      Proxy.new(&block)
+      Proxy.new &block
     end
 
-    def find(controller, action, params)
-      if registry.has_key? controller and registry[controller].has_key? action
-        name = registry[controller][action]
-        if name.is_a? Proc
-          name.call params
-        else
-          name
-        end
-      end
-    end
-
-    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 ||= {}
+    def definitions
+      @definitions ||= Definitions.new
     end
 
   end

data/lib/generators/crumbs/install/install_generator.rb

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

data/test/dummy/Rakefile

@@ -2,5 +2,4 @@
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -2,12 +2,12 @@
 // listed below.
 //
 // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // compiled file.
 //
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -3,11 +3,13 @@
  * listed below.
  *
  * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
  *
- *= require_self
  *= require_tree .
+ *= require_self
  */

data/test/dummy/app/controllers/admin/reports/deliveries_controller.rb

@@ -0,0 +1,6 @@
+class Admin::Reports::DeliveriesController < ApplicationController
+
+  def index
+  end
+
+end

data/test/dummy/app/controllers/admin/users_controller.rb

@@ -0,0 +1,9 @@
+class Admin::UsersController < ApplicationController
+
+  def index
+  end
+
+  def show
+  end
+
+end

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

@@ -1,27 +1,6 @@
 class PagesController < ApplicationController
 
   def index
-    render :crumbs
-  end
-
-  def static
-    render :crumbs
-  end
-  
-  def i18n
-    render :crumbs
-  end
-
-  def nested
-    render :crumbs
-  end
-
-  def param
-    render :crumbs
-  end
-
-  def empty
-    render :crumbs
   end
 
 end

data/test/dummy/app/views/application/_crumbs.html.erb

@@ -0,0 +1,3 @@
+<% @crumbs.each do |crumb| %>
+  <%= link_to crumb[:name], crumb[:url] %>
+<% end %>

data/test/dummy/app/views/application/index.html.erb

@@ -0,0 +1 @@
+<%= render 'crumbs' %>

data/test/dummy/app/views/application/show.html.erb

@@ -0,0 +1 @@
+<%= render 'crumbs' %>

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,12 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
-  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
+  <head>
+    <title>Dummy</title>
+    <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/test/dummy/bin/bundle

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   system 'cp config/database.yml.sample config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/test/dummy/config/application.rb

@@ -1,6 +1,11 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'active_model/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
 
 Bundler.require(*Rails.groups)
 require 'crumbs'

data/test/dummy/config/boot.rb

@@ -1,5 +1,5 @@
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/crumbs.rb

@@ -1,21 +1,24 @@
 Crumbs.define do
 
-  namespace :namespace do
-    controller :pages do
-      action :index, 'Namespaced Home'
+  namespace :admin do
+    namespace :reports do
+      controller :deliveries do
+        crumb :index do
+          'deliveries'
+        end
+      end
     end
+    controller :users do
+      crumb :index, 'users'
+    end
+  end
+
+  crumb 'admin/users#show' do |params|
+    "user #{params[:id]}"
   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
+    crumb :index, t('.home')
   end
 
 end