loaf 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.3.0 (February 25, 2012)
+
+* Add loaf gem errors
+* Add custom options validator for filtering invalid breadcrumbs params
+* Renamed main gem helpers for adding breadcrumbs from `add_breadcrumb` to
+  `breadcrumb`, both inside controllers and views.
+* Add specs for isolated view testing.
+
 0.2.1 (February 22, 2012)
 
 * Add more integration tests and fixed bug with adding breadcrumbs inside view

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    loaf (0.2.0)
+    loaf (0.2.1)
       rails
 
 GEM

data/README.md

@@ -59,10 +59,10 @@ In controller:
 ```ruby
 class Blog::CategoriesController < ApplicationController
 
-  add_breadcrumb 'Article Categories', 'blog_categories_path', :only => [:show]
+  breadcrumb 'Article Categories', 'blog_categories_path', :only => [:show]
 
   def show
-    add_breadcrumb "#{@category.title}", 'blog_category_path(@category)'
+    breadcrumb "#{@category.title}", 'blog_category_path(@category)'
   end
 end
 ```
@@ -100,7 +100,7 @@ Therefore in your controller/view one would have
 ```ruby
 class Blog::CategoriesController < ApplicationController
 
-  add_breadcrumb 'blog.categories', 'blog_categories_path'
+  breadcrumb 'blog.categories', 'blog_categories_path'
 
 end
 

data/lib/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  loaf:
+    errors:
+      messages:
+        invalid_options: "Invalid option :%{invalid}. Valid options are: %{valid},          make sure these are the ones you are using."
+

data/lib/loaf.rb

@@ -1,4 +1,5 @@
 require 'loaf/configuration'
+require 'loaf/errors'
 require 'loaf/railtie'
 require 'loaf/crumb'
 require 'loaf/builder'
@@ -6,6 +7,10 @@ require 'loaf/translation'
 require 'loaf/controller_extensions'
 require 'loaf/view_extensions'
 require 'loaf/crumb_formatter'
+require 'loaf/options_validator'
+
+# Add English load path by default
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
 
 module Loaf
   extend Configuration

data/lib/loaf/configuration.rb

@@ -26,6 +26,11 @@ module Loaf
 
     DEFAULT_ROOT = true
 
+    # Sets the Loaf configuration options. Best used by passing a block.
+    #
+    # Loaf.configure do |config|
+    #   config.capitalize = true
+    # end
     def configure
       yield self
     end

data/lib/loaf/controller_extensions.rb

@@ -11,12 +11,13 @@ module Loaf
 
     module ClassMethods
 
-      def add_breadcrumb(name, url, options = {})
+      def breadcrumb(name, url, options = {})
         before_filter(options) do |instance|
           # instance.send(:add_breadcrumb, _normalize_name(name), url)
           instance.send(:add_breadcrumb, name, url, options)
         end
       end
+      alias :add_breadcrumb :breadcrumb
 
       private
 
@@ -54,9 +55,10 @@ module Loaf
         end
       end
 
-      def add_breadcrumb(name, url, options={})
+      def breadcrumb(name, url, options={})
         _breadcrumbs << Loaf::Crumb.new(name, url)
       end
+      alias :add_breadcrumb :breadcrumb
 
       def _breadcrumbs
         @_breadcrumbs ||= []

data/lib/loaf/errors.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Loaf #:nodoc:
+
+  # Default Loaf error for all custom errors.
+  #
+  class LoafError < StandardError
+    BASE_KEY = "loaf.errors.messages"
+
+    def error_message(key, attributes)
+      translate(key, attributes)
+    end
+
+    def translate(key, options)
+      ::I18n.translate("#{BASE_KEY}.#{key}", { :locale => :en }.merge(options))
+    end
+  end
+
+  # Raised when invalid options are passed to breadcrumbs view renderer.
+  #  InvalidOptions.new :name, :crumber, [:crumb]
+  #
+  class InvalidOptions < LoafError
+    def initialize(invalid, valid)
+      super(
+        error_message("invalid_options",
+          { :invalid => invalid, :valid => valid.join(', ') }
+        )
+      )
+    end
+  end
+
+end # Loaf

data/lib/loaf/options_validator.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'loaf/errors'
+
+module Loaf
+  module OptionsValidator
+    def valid?(options)
+      valid_options = Loaf::Configuration::VALID_ATTRIBUTES
+      options.each_key do |key|
+        if !valid_options.include?(key)
+          raise Loaf::InvalidOptions.new(key, valid_options)
+        end
+      end
+      true
+    end
+  end # OptionsValidator
+end # Loaf

data/lib/loaf/version.rb

@@ -3,8 +3,8 @@
 module Loaf
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MINOR = 3
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/lib/loaf/view_extensions.rb

@@ -1,23 +1,26 @@
 # encoding: utf-8
 
 require 'loaf/crumb_formatter'
+require 'loaf/options_validator'
 
 module Loaf
   module ViewExtensions
     include Loaf::CrumbFormatter
+    include Loaf::OptionsValidator
 
-    # Adds breadcrumbs in a view.
+    # Adds breadcrumbs inside view.
     #
-    def add_breadcrumb(name, url)
+    def breadcrumb(name, url)
       _breadcrumbs.push Loaf::Crumb.new(name, url)
     end
+    alias :add_breadcrumb :breadcrumb
 
     # Renders breadcrumbs inside view.
     #
     def breadcrumbs(options={}, &block)
       #builder = Loaf::Builder.new(options)
+      valid? options
       options = Loaf.config.merge(options)
-
       _breadcrumbs.each do |crumb|
         name = format_name crumb, options
 

data/spec/loaf/controller_extensions_spec.rb

@@ -14,7 +14,9 @@ describe Loaf::ControllerExtensions do
   context 'classes extending controller_extensions' do
     subject { Controller }
     specify { should respond_to(:add_breadcrumb) }
+    specify { should respond_to(:breadcrumb) }
     specify { subject.new.should respond_to(:add_breadcrumb) }
+    specify { subject.new.should respond_to(:breadcrumb) }
     specify { subject.new.should respond_to(:add_breadcrumbs) }
     specify { subject.new.should respond_to(:clear_breadcrumbs) }
   end

data/spec/loaf/options_validator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Loaf::OptionsValidator do
+
+  let(:klass) { Class.extend Loaf::OptionsValidator }
+
+  describe '.valid?' do
+    context 'when the passed options are valid' do
+      let(:options) do
+        { :crumb_length => 10 }
+      end
+
+      it 'returns true' do
+        klass.valid?(options).should be_true
+      end
+    end
+    context 'when the passed optiosn are invalid' do
+       let(:options) do
+          { :invalid_param => true }
+       end
+
+       it 'raises an error' do
+         expect do
+           klass.valid? options
+         end.to raise_error(Loaf::InvalidOptions)
+       end
+    end
+  end
+end # Loaf::OptionsValidator

data/spec/loaf/view_extensions_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe Loaf::ViewExtensions do
+
+  class View < ActionView::Base
+    include Loaf::ViewExtensions
+    attr_accessor_with_default :_breadcrumbs, []
+  end
+
+  let(:name) { 'name' }
+  let(:url)  { 'url' }
+  let(:view) { View }
+  let(:instance) { view.new }
+
+  context 'classes extending view_extensions' do
+     subject { View.new }
+     specify { should respond_to(:breadcrumb) }
+     specify { should respond_to(:add_breadcrumb) }
+     specify { should respond_to(:breadcrumbs) }
+  end
+
+  context 'adding view breadcrumb' do
+    it 'calls breadcrumbs helper' do
+      instance.should_receive(:_breadcrumbs).and_return []
+      instance.breadcrumb name, url
+    end
+
+    it 'creates crumb instance' do
+      Loaf::Crumb.should_receive(:new).with(name, url)
+      instance.breadcrumb name, url
+    end
+
+    it 'should add crumb to breadcrumbs storage' do
+      expect do
+        instance.breadcrumb name, url
+      end.to change { instance._breadcrumbs.size }.by(1)
+    end
+  end
+
+  context 'breadcrumbs rendering' do
+
+    let(:block) { lambda { |name, url, styles| } }
+
+    before do
+      @crumbs = []
+      @crumbs << Loaf::Crumb.new('home', :home_path)
+      @crumbs << Loaf::Crumb.new('posts', :posts_path)
+      instance.stub(:_breadcrumbs).and_return @crumbs
+
+      @options = {}
+      Loaf.stub_chain(:config, :merge).and_return @options
+      @crumbs.each do |crumb|
+        instance.stub(:format_name).with(crumb, @options).and_return crumb.name
+        instance.stub(:_process_url_for).with(crumb.url).and_return crumb.name
+      end
+      instance.stub(:current_page?).and_return true
+    end
+
+    it 'validates passed options' do
+      instance.should_receive(:valid?)
+      instance.breadcrumbs &block
+    end
+
+    it 'raises error for unkown option' do
+      expect do
+        instance.breadcrumbs :unsupported => true, &block
+      end.to raise_error(Loaf::InvalidOptions)
+    end
+
+    it 'calls loaf configuration' do
+      Loaf.should_receive(:config).and_return @options
+      @options.should_receive(:merge).with({:crumb_length => 10}).
+        and_return @options
+      instance.breadcrumbs :crumb_length => 10, &block
+    end
+
+    it 'uses breadcrumbs collection helper' do
+      instance.should_receive(:_breadcrumbs)
+      instance.breadcrumbs &block
+    end
+
+    it 'retrieves crumbs collection' do
+      instance._breadcrumbs.should eql @crumbs
+      instance.breadcrumbs &block
+    end
+
+    it 'formats crumb name' do
+      instance.should_receive(:format_name)
+      instance.breadcrumbs &block
+    end
+
+    it 'checks if crumb url is current' do
+      instance.should_receive(:current_page?)
+      instance.breadcrumbs &block
+    end
+
+    context 'rendering inside block' do
+      it 'returns crumb attributes' do
+        crumb = Loaf::Crumb.new name, url
+        instance.stub(:_breadcrumbs).and_return [crumb]
+        instance.should_receive(:format_name).with(crumb, @options).
+          and_return crumb.name
+        instance.should_receive(:_process_url_for).with(crumb.url).
+          and_return crumb.name
+
+        instance.breadcrumbs do |name, url, styles|
+          name.should eql crumb.name
+          url.should eql crumb.name
+          styles.should be_blank
+        end
+      end
+    end
+  end
+end # Loaf::ViewExtensions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loaf
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152603000 !ruby/object:Gem::Requirement
+  requirement: &2160425740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152603000
+  version_requirements: *2160425740
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152602060 !ruby/object:Gem::Requirement
+  requirement: &2160424420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *2152602060
+  version_requirements: *2160424420
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152600360 !ruby/object:Gem::Requirement
+  requirement: &2160422760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152600360
+  version_requirements: *2160422760
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2152598720 !ruby/object:Gem::Requirement
+  requirement: &2160420740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152598720
+  version_requirements: *2160420740
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2152595720 !ruby/object:Gem::Requirement
+  requirement: &2160419820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152595720
+  version_requirements: *2160419820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152594960 !ruby/object:Gem::Requirement
+  requirement: &2160418980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152594960
+  version_requirements: *2160418980
 description: Loaf helps you manage breadcrumbs in your rails app. It aims to handle
   crumb data through easy dsl and expose it through view helpers without any assumptions
   about markup.
@@ -98,12 +98,15 @@ files:
 - README.md
 - Rakefile
 - init.rb
+- lib/config/locales/en.yml
 - lib/loaf.rb
 - lib/loaf/builder.rb
 - lib/loaf/configuration.rb
 - lib/loaf/controller_extensions.rb
 - lib/loaf/crumb.rb
 - lib/loaf/crumb_formatter.rb
+- lib/loaf/errors.rb
+- lib/loaf/options_validator.rb
 - lib/loaf/railtie.rb
 - lib/loaf/translation.rb
 - lib/loaf/version.rb
@@ -114,7 +117,9 @@ files:
 - spec/integration/nested_crumbs_spec.rb
 - spec/loaf/controller_extensions_spec.rb
 - spec/loaf/crumb_formatter_spec.rb
+- spec/loaf/options_validator_spec.rb
 - spec/loaf/translation_spec.rb
+- spec/loaf/view_extensions_spec.rb
 - spec/loaf_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile
@@ -191,7 +196,9 @@ test_files:
 - spec/integration/nested_crumbs_spec.rb
 - spec/loaf/controller_extensions_spec.rb
 - spec/loaf/crumb_formatter_spec.rb
+- spec/loaf/options_validator_spec.rb
 - spec/loaf/translation_spec.rb
+- spec/loaf/view_extensions_spec.rb
 - spec/loaf_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile