bread 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98c70a548e086d12632268d085db36d20684c3cf
-  data.tar.gz: 24710cc8a156a08c27b67482f1eca136c8fada26
+  metadata.gz: 0e8027cf13f5a7e44e18d3f34c45603caf4bf29e
+  data.tar.gz: c2683c97974e9b483bf1ad3e6cef4a941cf16a7e
 SHA512:
-  metadata.gz: 32f26af12aeb8a01177abd148e840eb02e2d8bd1b3a2e8b355561ad9ba6b0a6312f6141271f8b6cde4d83b5b6f689c7d378236c893edd554f6e7867d7e0dc83f
-  data.tar.gz: fcc37eabb4d552435c055c67ec59a1dca7c8202e1e347db0d6917318516d22fac6c623d2d108ef2a1330c39339d17caef2866cb1ee0a4fbe3555203f92a56707
+  metadata.gz: fe0369dcd7ccb742df886727440cb5d2713cd6addcce04b40cec45278d9e1f9e9c0c57e179fe0015396fead0ac242efa16b223af3e9043b03970717cd4adeeb0
+  data.tar.gz: 048f1ef5da222f6be35be27b4a44677f1005bd3910d5d3da382db0921567868102d8a815e4ef4ed143225fb0bb320180588afa1b0ea5ebbe3b6c6472e3bb6712

data/Gemfile

@@ -1,4 +1,19 @@
-source 'https://rubygems.org'
+# source 'http://gems.dev.helloinnovation.com'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in bread.gemspec
+# Declare your gem's dependencies in permissions.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
 gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+gem 'rails', '4.0.0' #  June 25, 2013
+gem 'sqlite3'
+gem 'turn'
+gem 'colorize'

data/Rakefile

@@ -1 +1,34 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+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    = 'Permissions'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/bread/commands/config_command.rb

@@ -0,0 +1,15 @@
+module Bread
+  class ConfigCommand
+
+    attr_reader :crumb_definitions
+
+    def initialize
+      @crumb_definitions = {}
+    end
+
+    def key(key_name, &block)
+      @crumb_definitions[key_name] = block
+    end
+
+  end
+end

data/lib/bread/commands/controller_layout_command.rb

@@ -0,0 +1,44 @@
+module Bread
+  class ControllerLayoutCommand
+
+    attr_reader :keys
+
+    def initialize(controller)
+      IvarsCommand.new(controller).ivars.each do |key, ivar|
+        self.instance_variable_set(key, ivar)
+      end
+      
+      @controller = controller
+      @actions = {}
+      @keys = []
+    end
+
+    def actions(*action_names, &block)
+      action_names.each do |action_name|
+        @actions[action_name] = block
+        is_current_action = action_name.to_s == @controller.action_name
+
+        if is_current_action
+          self.instance_eval(&block)
+          # teria que ter um break aqui, que tambem pare todos os registros de proximas actions =D
+        end
+      end
+    end
+
+    def crumbs(*keys)
+      parent = nil
+      if keys.last.is_a? Hash
+        options = keys.last
+        keys.delete(options)
+        #raise "Unexpected options: #{}"
+        parent = options[:parent]
+      end
+      @keys = keys + @keys
+      if parent
+        blk = @actions[parent]
+        instance_eval(&blk)
+      end
+    end
+
+  end
+end

data/lib/bread/commands/crumb_to_command.rb

@@ -0,0 +1,23 @@
+module Bread
+  class CrumbToCommand
+
+    include ActionDispatch::Routing::UrlFor
+
+    attr_reader :crumb
+
+    def initialize(controller, key, &block)
+      @key = key
+
+      IvarsCommand.new(controller).ivars.each do |key, ivar|
+        instance_variable_set(key, ivar)
+      end
+
+      instance_eval(&block)
+    end
+
+    def crumb_to(title, path, options={})
+      @crumb = Crumb.new(options)
+    end
+
+  end
+end

data/lib/bread/commands/ivars_command.rb

@@ -0,0 +1,16 @@
+module Bread
+  class IvarsCommand
+
+    attr_reader :ivars
+
+    def initialize(target)
+      @ivars = {}
+
+      ivars_keys = target.instance_variables.select { |key| not key.to_s.starts_with?('@_') }
+      ivars_keys.each do |key|
+        @ivars[key] = target.instance_variable_get(key)
+      end
+    end
+
+  end
+end

data/lib/bread/config.rb

@@ -0,0 +1,30 @@
+module Bread
+  class Config
+    include Singleton
+
+    attr_reader :crumb_definitions
+
+    def reload!
+      config_file = Rails.root.join "config/breadcrumbs.rb"
+      if File.exists? config_file
+        load config_file
+      else
+        puts "ACHEI NAO".on_red
+        # `rails g bread:install`
+        # self.reload!
+      end
+    end
+
+    def config(&block)
+      cmd = ConfigCommand.new
+      cmd.instance_eval(&block)
+      @crumb_definitions = cmd.crumb_definitions
+    end
+
+
+
+
+
+
+  end
+end

data/lib/bread/controller.rb

@@ -6,18 +6,13 @@ module Bread
       attr_reader :bread_block
       def bread(&block)
         @bread_block = block
-        before_filter :execute_bread_command
       end
     end
 
-    attr_accessor :_bread_trees
-
-    def _bread_trees
-      @_bread_trees ||= {}
-    end
-
-    def execute_bread_command
-      Command.new(self).instance_eval(&self.class.bread_block)
+    def bread_keys
+      cmd = ControllerLayoutCommand.new(self)
+      cmd.instance_eval(&self.class.bread_block)
+      cmd.keys
     end
 
   end

data/lib/bread/crumb.rb

@@ -0,0 +1,24 @@
+module Bread
+  class Crumb < Hash
+
+    def initialize(context, title, path, options)
+      @context = context
+      options.merge(title: title, path: path).each do |k, v|
+        self[k] = v
+      end
+    end
+
+    def title
+      self[:title]
+    end
+
+    def path
+      self[:path]
+    end
+
+    def current?
+      @context.current_page? path
+    end
+
+  end
+end

data/lib/bread/helper.rb

@@ -2,28 +2,21 @@ module Bread
   module Helper
 
     def bread
-      return @bread if @bread
+      Config.instance.reload! # if should_reload?
 
-      tmp = nil
-      controller._bread_trees.each do |i_action, hash|
-        if i_action.to_s == action_name
-          tmp = hash
-          break
-        end
+      crumb_definitions = Config.instance.crumb_definitions
+      keys_for_current_action = controller.bread_keys
+      
+      @crumbs = []
+      keys_for_current_action.map do |key|
+        crumbs_to_block = crumb_definitions[key] || :crumb_definitions_not_found
+        self.instance_eval(&crumbs_to_block)
       end
+      @crumbs
+    end
 
-      @bread =  if tmp.nil?
-                  puts "No Bread for this Action. Please check https://github.com/yakko/bread for more info".light_yellow
-                  []
-                else
-                  list = []
-                  while tmp
-                    arr = controller.instance_eval(&tmp[:block])
-                    list << {title: arr.first, path: arr.second} if arr
-                    tmp = tmp[:parent]
-                  end
-                  list.reverse
-                end
+    def crumb_to(title, path, options={})
+      @crumbs << Crumb.new(self, title, path, options)
     end
 
   end

data/lib/bread/version.rb

@@ -1,3 +1,3 @@
 module Bread
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/bread.rb

@@ -1,7 +1,14 @@
 require "bread/version"
-require "bread/command"
+
+require "bread/commands/controller_layout_command"
+require "bread/commands/config_command"
+require "bread/commands/ivars_command"
+require "bread/commands/crumb_to_command"
+
 require "bread/controller"
 require "bread/helper"
+require "bread/crumb"
+require "bread/config"
 
 
 module Bread

data/lib/generators/bread/USAGE

@@ -0,0 +1,2 @@
+Description:
+  The bread:install generator creates your config/breadcrumbs.rb file.

data/lib/generators/bread/install_generator.rb

@@ -0,0 +1,12 @@
+module Bread
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_install
+        template "skeleton.rb", "config/breadcrumbs.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/bread/templates/skeleton.rb

@@ -0,0 +1,15 @@
+Bread.config do
+
+  # # products
+  # key(:all_products)         { bread_to("Contacts",     :products, icon: 'list')                                                                                                         } 
+  # key(:make_product)         { bread_to("Add",          [:products, :new], icon: 'plus', target: '_blank') } 
+  # key(:products_by_category) { bread_to(@category.name, [:products, :by_category, @category], icon: 'filter')                                                                            } 
+  # key(:view_product)         { bread_to(@product.name,  @product)                                                                                                                        } 
+  # key(:change_product)       { bread_to("Edit",         [@product, :edit])                                                                                                               } 
+  # key(:product_timeline)     { bread_to("Timeline",     [@product, :timeline])                                                                                                           } 
+  # key(:product_year)         { bread_to(@year,          [@product, :timeline, @year])                                                                                                    } 
+  # key(:product_month)        { bread_to(@month,         [@product, :timeline, @year, @month])                                                                                            } 
+  # key(:product_day)          { bread_to(@day,           [@product, :timeline, @year, @month, @day])                                                                                      } 
+  # key(:product_time)         { bread_to(@time,          [@product, :timeline, @year, @month, @day, @time])                                                                               } 
+
+end

data/test/bread_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BreadTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Bread
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# 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

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

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// 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.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

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

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * 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.
+ *
+ * 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.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,79 @@
+class ProductsController < ApplicationController
+  before_action :set_product, only: [:show, :edit, :update, :destroy]
+
+
+
+  bread do
+    # alias_actions :new,   :create
+    # alias_actions :edit,  :update, :destroy
+
+    actions(:index)          { crumbs :root, :all_products,   parent: nil    }
+      actions(:new, :create) { crumbs :make_product,          parent: :index, lala: 1, lele: 2, lili: 3434 }
+      actions(:by_category)  { crumbs :products_by_category,  parent: :index }
+        actions(:show)    do
+                            parent = @category.present? ? :by_category : :index
+                            crumbs(:view_product, parent: parent)
+                          end
+          actions(:edit)         { crumbs :change_product, parent: :show }
+          actions(:timeline)     { crumbs :product_timeline, parent: :show }
+  end
+
+
+
+
+  # GET /products
+  def index
+    @products = Product.all
+  end
+
+  # GET /products/1
+  def show
+    @category = "lalala"
+  end
+
+  # GET /products/new
+  def new
+    @product = Product.new
+  end
+
+  # GET /products/1/edit
+  def edit
+  end
+
+  # POST /products
+  def create
+    @product = Product.new(product_params)
+
+    if @product.save
+      redirect_to @product, notice: 'Product was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /products/1
+  def update
+    if @product.update(product_params)
+      redirect_to @product, notice: 'Product was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /products/1
+  def destroy
+    @product.destroy
+    redirect_to products_url, notice: 'Product was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_product
+      @product = Product.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def product_params
+      params.require(:product).permit(:name, :category)
+    end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/products_helper.rb

@@ -0,0 +1,2 @@
+module ProductsHelper
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,2 @@
+class Product < ActiveRecord::Base
+end

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

@@ -0,0 +1,22 @@
+<!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>
+
+<ul id="breadcrumbs">
+<% bread.each do |crumb| %>
+  <li class="<%= 'active' if crumb.current? %>">
+    <%= link_to crumb.title, crumb.path, class: "icon icon-#{crumb[:icon]}" %>
+  </li>
+<% end %>
+</ul>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/products/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@product) do |f| %>
+  <% if @product.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@product.errors.count, "error") %> prohibited this product from being saved:</h2>
+
+      <ul>
+      <% @product.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name %><br>
+    <%= f.text_field :name %>
+  </div>
+  <div class="field">
+    <%= f.label :category %><br>
+    <%= f.text_field :category %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>