loaf 0.3.0 → 0.4.0

data/spec/rails_app/app/controllers/application_controller.rb

@@ -1,5 +1,3 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
-
-  add_breadcrumb 'Home', 'root_path'
 end

data/spec/rails_app/app/controllers/posts_controller.rb

@@ -1,12 +1,23 @@
+class Post < Struct.new(:id); end
+
 class PostsController < ApplicationController
 
-  add_breadcrumb 'All Posts', :posts_path
+  breadcrumb 'Home', :root_path, only: :index
 
   def index
+    breadcrumb 'All Posts', posts_path
+  end
+
+  def show
+    @post = ::Post.new(1)
   end
 
   def new
-    add_breadcrumb 'New Post', 'new_post_path' 
+    breadcrumb 'New Post', new_post_path
   end
 
+  def create
+    breadcrumb 'New Post', new_post_path, force: true
+    render action: :new
+  end
 end

data/spec/rails_app/app/views/layouts/_breadcrumbs.html.erb

@@ -1,3 +1,4 @@
+<% if breadcrumbs? %>
 <ul id='breadcrumbs'>
   <% breadcrumbs do |name, url, styles| %>
     <li class="<%= styles %>">
@@ -6,3 +7,4 @@
     </li>
   <% end %>
 </ul>
+<% end %>

data/spec/rails_app/app/views/posts/index.html.erb

@@ -1,3 +1 @@
-<% add_breadcrumb 'View Post', :posts_path %>
-
 <h1>Posts:index</h1>

data/spec/rails_app/app/views/posts/new.html.erb

@@ -1 +1,4 @@
 <h1>Posts:new</h1>
+<%= form_tag posts_path, :method => "POST" do %>
+  <% submit_tag "Create"%>
+<% end %>

data/spec/rails_app/app/views/posts/show.html.erb

@@ -0,0 +1 @@
+<% breadcrumb 'Show Post in view', post_path(@post.id) %>

data/spec/rails_app/config/environments/development.rb

@@ -27,4 +27,6 @@ RailsApp::Application.configure do
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  config.eager_load = false
 end

data/spec/rails_app/config/environments/production.rb

@@ -57,4 +57,6 @@ RailsApp::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
+
+  config.eager_load = true
 end

data/spec/rails_app/config/environments/test.rb

@@ -11,9 +11,6 @@ RailsApp::Application.configure do
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -39,4 +36,6 @@ RailsApp::Application.configure do
 
   # Allow pass debug_assets=true as a query parameter to load pages with unpackaged assets
   config.assets.allow_debugging = true
+
+  config.eager_load = false
 end

data/spec/rails_app/config/routes.rb

@@ -1,9 +1,7 @@
 RailsApp::Application.routes.draw do
-
   root :to => 'home#index'
 
   resources :posts do
     resources :comments
   end
-
 end

data/spec/spec_helper.rb

@@ -1,15 +1,53 @@
+# encoding: utf-8
+
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../rails_app/config/environment.rb",  __FILE__)
 require 'rspec/rails'
 
-Rails.backtrace_cleaner.remove_silencers!
+require 'loaf'
 
-# Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  config.use_transactional_fixtures = true
-  config.mock_with :rspec
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
 end

data/spec/support/dummy_view.rb

@@ -0,0 +1,7 @@
+class DummyView < ActionView::Base
+  include Loaf::ViewExtensions
+  attr_reader :_breadcrumbs
+
+  def url_for(*); end
+  def current_page?(*); end
+end

data/spec/unit/controller_extensions_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+class DummyController < ActionController::Base
+  def self.before_filter(options, &block)
+    yield self.new
+  end
+  include Loaf::ControllerExtensions
+end
+
+RSpec.describe Loaf::ControllerExtensions do
+
+  context 'when classes extend controller_extensions' do
+    it { expect(DummyController).to respond_to(:add_breadcrumb) }
+    it { expect(DummyController).to respond_to(:breadcrumb) }
+    it { expect(DummyController.new).to respond_to(:add_breadcrumb) }
+    it { expect(DummyController.new).to respond_to(:breadcrumb) }
+    it { expect(DummyController.new).to respond_to(:add_breadcrumbs) }
+    it { expect(DummyController.new).to respond_to(:clear_breadcrumbs) }
+  end
+
+  context 'class methods' do
+    it 'invokes before_filter' do
+      allow(DummyController).to receive(:before_filter)
+      DummyController.breadcrumb('name', 'url_path')
+      expect(DummyController).to have_received(:before_filter)
+    end
+
+    it 'delegates to instance' do
+      name    = 'List objects'
+      url     = :object_path
+      options = {force: true}
+      instance = double(:controller_instance).as_null_object
+
+      allow(DummyController).to receive(:new).and_return(instance)
+      DummyController.breadcrumb(name, url, options)
+      expect(instance).to have_received(:breadcrumb).with(name, url, options)
+    end
+  end
+
+  context 'instance methods' do
+    it 'instantiates breadcrumbs container' do
+      name     = 'List objects'
+      url      = :object_path
+      instance = DummyController.new
+
+      allow(Loaf::Crumb).to receive(:new)
+      instance.breadcrumb(name, url)
+      expect(Loaf::Crumb).to have_received(:new).with(name, url, {})
+    end
+
+    it 'adds breadcrumb to collection' do
+      name     = 'List objects'
+      url      = :object_path
+      instance = DummyController.new
+
+      expect {
+        instance.breadcrumb(name, url)
+      }.to change { instance._breadcrumbs.size }.by(1)
+    end
+  end
+end

data/spec/unit/crumb_formatter_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Loaf::CrumbFormatter, '.format_name' do
+  let(:formatter) {
+    Class.new do
+      extend Loaf::CrumbFormatter
+
+      def self.truncate(name, options)
+        name
+      end
+    end
+  }
+
+  it 'returns name error if breadcrumb name is nil' do
+    expect(formatter.format_name('')).to eql('')
+  end
+
+  it "doesn't capitalize by default" do
+    name = 'some random name'
+    formatted = formatter.format_name(name)
+    expect(formatted).to eql(name)
+  end
+
+  it 'capitalizes crumb name with capitalize option' do
+    name = 'some random name'
+    formatted = formatter.format_name(name, capitalize: true)
+    expect(formatted).to eql('Some random name')
+  end
+
+  it 'shortens crumb to provided length' do
+    name = 'very long name that is more that 30 characters long'
+    allow(formatter).to receive(:truncate).with(name, length: 30).
+      and_return(name[0..30])
+    expect(formatter.format_name(name, crumb_length: 30)).to eql(name[0..30])
+  end
+end

data/spec/unit/options_validator_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Loaf::OptionsValidator, '.valid?' do
+  let(:klass) { Class.extend Loaf::OptionsValidator }
+
+  it 'validates succesfully known option' do
+    expect(klass.valid?(crumb_length: 10)).to eq(true)
+  end
+
+  it 'validates unknown option with an error' do
+    expect {
+      klass.valid?(invalid_param: true)
+    }.to raise_error(Loaf::InvalidOptions)
+  end
+end

data/spec/unit/translation_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Loaf::Translation do
+
+  before { I18n.backend = I18n::Backend::Simple.new }
+
+  it 'translates breadcrumb title' do
+    I18n.backend.store_translations 'en', breadcrumbs: { home: 'Home'}
+    expect(described_class.breadcrumb_title('breadcrumbs.home')).to eql('Home')
+  end
+
+  it 'translates breadcrumb name with default scope' do
+    I18n.backend.store_translations 'en', breadcrumbs: {home: 'Home'}
+    expect(described_class.breadcrumb_title('home')).to eql('Home')
+  end
+
+  it 'translates breadcrumb name using default option' do
+    expect(described_class.breadcrumb_title('home', default: 'breadcrumb default name')).to eql('breadcrumb default name')
+  end
+end

data/spec/unit/view_extensions/breadcrumb_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Loaf::ViewExtensions, '.breadcrumb' do
+
+  it { expect(DummyView.new).to respond_to(:add_breadcrumb) }
+
+  it 'creates crumb instance' do
+    instance = DummyView.new
+    name = 'Home'
+    url  = :home_path
+    allow(Loaf::Crumb).to receive(:new).with(name, url, {})
+    instance.breadcrumb name, url
+    expect(Loaf::Crumb).to have_received(:new).with(name, url, {})
+  end
+
+  it 'adds crumb to breadcrumbs storage' do
+    instance = DummyView.new
+    expect {
+      instance.breadcrumb 'Home', :home_path
+    }.to change { instance._breadcrumbs.size }.by(1)
+  end
+end

data/spec/unit/view_extensions/breadcrumbs_spec.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Loaf::ViewExtensions, '.breadcrumbs' do
+  it "yields to block all breadcrumbs" do
+    instance = DummyView.new
+    instance.breadcrumb('home', :home_path)
+    instance.breadcrumb('posts', :posts_path)
+
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    expect {
+      instance.breadcrumbs(&block)
+    }.to change { yielded.size }.from(0).to(2)
+  end
+
+  it "resolves breadcrumb paths" do
+    instance = DummyView.new
+    instance.breadcrumb('home', :home_path)
+    instance.breadcrumb('posts', :posts_path)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    instance.breadcrumbs(&block)
+    expect(yielded).to eq([
+      ['home', '/home', ''],
+      ['posts', '/posts', '']
+    ])
+  end
+
+  it "checks current path and provides styles" do
+    instance = DummyView.new
+    instance.breadcrumb('home', :home_path)
+    instance.breadcrumb('posts', :posts_path)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+    allow(instance).to receive(:current_page?).with('/home').and_return(false)
+    allow(instance).to receive(:current_page?).with('/posts').and_return(true)
+
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    instance.breadcrumbs(&block)
+    expect(yielded).to eq([
+      ['home', '/home', ''],
+      ['posts', '/posts', 'selected']
+    ])
+  end
+
+  it "allows to force current path" do
+    instance = DummyView.new
+    instance.breadcrumb('home', :home_path)
+    instance.breadcrumb('posts', :posts_path, force: true)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+    allow(instance).to receive(:current_page?).and_return(false)
+
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    instance.breadcrumbs(&block)
+    expect(yielded).to eq([
+      ['home', '/home', ''],
+      ['posts', '/posts', 'selected']
+    ])
+  end
+
+  it "returns enumerator without block" do
+    instance = DummyView.new
+    instance.breadcrumb('home', :home_path)
+    instance.breadcrumb('posts', :posts_path)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+
+    result = instance.breadcrumbs
+    expect(result).to be_a(Enumerable)
+    expect(result.take(2)).to eq([
+      ['home', '/home', ''],
+      ['posts', '/posts', '']
+    ])
+  end
+
+  it 'validates passed options' do
+    instance = DummyView.new
+    block = lambda { |name, url, styles| }
+    expect {
+      instance.breadcrumbs(unknown: true, &block)
+    }.to raise_error(Loaf::InvalidOptions)
+  end
+
+  it 'uses global configuration for crumb formatting' do
+    allow(Loaf.configuration).to receive(:crumb_length).and_return(10)
+    instance = DummyView.new
+    instance.breadcrumb('home-sweet-home', :home_path)
+    instance.breadcrumb('posts-for-everybody', :posts_path)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    instance.breadcrumbs(&block)
+    expect(yielded).to eq([
+      ['home-sw...', '/home', ''],
+      ['posts-f...', '/posts', '']
+    ])
+  end
+
+  it "allows to overwrite global configuration" do
+    allow(Loaf.configuration).to receive(:crumb_length).and_return(10)
+    instance = DummyView.new
+    instance.breadcrumb('home-sweet-home', :home_path)
+    instance.breadcrumb('posts-for-everybody', :posts_path)
+
+    allow(instance).to receive(:url_for).with(:home_path).and_return('/home')
+    allow(instance).to receive(:url_for).with(:posts_path).and_return('/posts')
+    yielded = []
+    block = lambda { |name, url, styles| yielded << [name, url, styles]}
+    instance.breadcrumbs(crumb_length: 15, &block)
+    expect(yielded).to eq([
+      ['home-sweet-home', '/home', ''],
+      ['posts-for-ev...', '/posts', '']
+    ])
+  end
+end