loaf 0.5.0 → 0.6.0

data/loaf.gemspec

@@ -3,19 +3,26 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'loaf/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'loaf'
-  s.version     = Loaf::VERSION.dup
-  s.authors     = ['Piotr Murach']
-  s.email       = [""]
-  s.homepage    = 'https://github.com/peter-murach/loaf'
-  s.summary     = %q{Loaf manages and displays breadcrumb trails in your Rails application.}
-  s.description = %q{Loaf manages and displays breadcrumb trails in your Rails app. It aims to handle breadcrumb data through easy dsl and expose it through view helpers without any assumptions about markup.}
+Gem::Specification.new do |spec|
+  spec.name        = 'loaf'
+  spec.version     = Loaf::VERSION.dup
+  spec.authors     = ['Piotr Murach']
+  spec.email       = [""]
+  spec.homepage    = 'https://github.com/piotrmurach/loaf'
+  spec.summary     = %q{Loaf manages and displays breadcrumb trails in your Rails application.}
+  spec.description = %q{Loaf manages and displays breadcrumb trails in your Rails app. It aims to handle breadcrumb data through easy dsl and expose it through view helpers without any assumptions about markup.}
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  s.add_dependency 'rails', '>= 3.1'
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['source_code_uri'] = 'https://github.com/piotrmurach/loaf'
+  spec.metadata['changelog_uri'] = 'https://github.com/piotrmurach/loaf/blob/master/CHANGELOG.md'
+
+  spec.add_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
 end

data/spec/integration/{crumbs_routing_spec.rb → breadcrumb_trail_spec.rb}

@@ -1,25 +1,30 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe "crumbs routing" do
+RSpec.describe "breadcrumbs trail" do
   include ActionView::TestCase::Behavior
 
-  it "doens't show empty breadcrumbs" do
+  it "shows root breadcrumb" do
     visit root_path
-    expect(page).to_not have_content("breadcrumbs")
+
+    within '#breadcrumbs .selected' do
+      expect(page.html).to include('<a href="/">Home</a>')
+    end
   end
 
   it "inherits controller breadcrumb and adds index action breadcrumb" do
     visit posts_path
+
     within '#breadcrumbs' do
       expect(page.html).to include('<a href="/">Home</a>')
-      expect(page.html).to include('<a href="/posts">All Posts</a>')
+      within '.selected' do
+        expect(page.html).to include('<a href="/posts">All Posts</a>')
+      end
     end
   end
 
   it 'filters out controller breadcrumb and adds new action breadcrumb' do
     visit new_post_path
+
     within '#breadcrumbs' do
       expect(page).to_not have_content('Home')
       expect(page).to have_content('New Post')
@@ -28,25 +33,27 @@ RSpec.describe "crumbs routing" do
 
   it "adds breadcrumb in view with path variable" do
     visit post_path(1)
-    within '#breadcrumbs' do
+
+    within '#breadcrumbs .selected' do
       expect(page.html).to include('<a href="/posts/1">Show Post in view</a>')
     end
   end
 
   it 'is current when forced' do
     visit new_post_path
-    click_button "Create"
 
-    expect(page.current_path).to eq(posts_path)
+    expect(page.current_path).to eq(new_post_path)
     within '#breadcrumbs' do
-      expect(page).to have_content('New Post')
-      expect(page).to have_selector('.selected')
+      expect(page).to have_selector('li.selected', count: 2)
+      expect(page.html).to include('<a href="/posts">All</a>')
+      expect(page.html).to include('<a href="/posts/new">New Post</a>')
     end
   end
 
   it "allows for procs in name and url" do
     visit post_comments_path(1)
-    within '#breadcrumbs' do
+
+    within '#breadcrumbs .selected' do
       expect(page.html).to include('<a href="/posts/1/comments">Post comments</a>')
     end
   end

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

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

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

@@ -1,9 +1,6 @@
 class Post < Struct.new(:id); end
 
 class PostsController < ApplicationController
-
-  breadcrumb 'Home', :root_path, only: :index
-
   def index
     breadcrumb 'all_posts', posts_path
   end
@@ -13,11 +10,11 @@ class PostsController < ApplicationController
   end
 
   def new
+    breadcrumb 'All', :posts_path, match: :force
     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,9 +1,11 @@
-<% if breadcrumbs? %>
+<% if breadcrumb_trail.any? %>
 <ul id='breadcrumbs'>
-  <% breadcrumbs do |name, url, styles| %>
-    <li class="<%= styles %>">
-      <%= link_to name, url %>
-      <span><%= styles == 'selected' ? '' : '::' %></span>
+  <% breadcrumb_trail do |crumb| %>
+    <li class="<%= crumb.current? ? 'selected' : '' %>">
+      <%= link_to crumb.name, crumb.url %>
+      <% unless crumb.current? %>
+        <span>::</span>
+      <% end %>
     </li>
   <% end %>
 </ul>

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

@@ -2,8 +2,6 @@
 <html>
 <head>
   <title>RailsApp</title>
-  <%= stylesheet_link_tag    "application" %>
-  <%= javascript_include_tag "application" %>
   <%= csrf_meta_tags %>
 </head>
 <body>

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

@@ -8,7 +8,7 @@ RailsApp::Application.configure do
   config.cache_classes = true
 
   # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
+  config.serve_static_files = true
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching

data/spec/rails_app/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: c392df63ec28b42b36b92a5b9e8603fa62d7807024d07801ab162ec7a2a165a87d27a4a8535ce09cd2bf4a82afe45e3080fb8cc56613d608e5b18335594782b3
+
+test:
+  secret_key_base: 4b1fba0d12c53b8b21880fda47b603b3dcca117ccf41fcc70091351b88ede5d4c5c91371f407cd056efd66fa5f306c23add65a89d4304e06a4243289ee97be1d
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 
-if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+if (ENV['COVERAGE'] || ENV['TRAVIS']) && RUBY_VERSION < '2.4.0'
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'

data/spec/support/dummy_controller.rb

@@ -0,0 +1,9 @@
+class DummyController < ActionController::Base
+  def self.before_filter(options, &block)
+    yield self.new
+  end
+  class << self
+    alias before_action before_filter
+  end
+  include Loaf::ControllerExtensions
+end

data/spec/support/dummy_view.rb

@@ -1,7 +1,47 @@
+require 'action_view'
+
 class DummyView < ActionView::Base
+  module FakeRequest
+    class Request
+      attr_accessor :path, :fullpath, :protocol, :host_with_port
+      def get?
+        true
+      end
+    end
+    def request
+      @request ||= Request.new
+    end
+    def params
+      @params ||= {}
+    end
+  end
+
+  include FakeRequest
+  include ActionView::Helpers::UrlHelper
   include Loaf::ViewExtensions
+
   attr_reader :_breadcrumbs
 
-  def url_for(*); end
-  def current_page?(*); end
+  routes = ActionDispatch::Routing::RouteSet.new
+  routes.draw do
+    get "/" => "foo#bar", :as => :home
+    get "/posts" => "foo#posts"
+    get "/posts/:title" => "foo#posts"
+    get "/post/:id" => "foo#post", :as => :post
+    get "/post/:title" => "foo#title"
+    get "/post/:id/comments" => "foo#comments"
+
+    namespace :blog do
+      get "/" => "foo#bar"
+    end
+  end
+
+  include routes.url_helpers
+
+  def set_path(path)
+    request.path = path
+    request.fullpath = path
+    request.protocol = 'http://'
+    request.host_with_port = 'www.example.com'
+  end
 end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+RSpec.describe Loaf::Configuration do
+  it "allows to set and read attributes" do
+    config = Loaf::Configuration.new
+
+    config.crumb_length = 4
+
+    expect(config.crumb_length).to eq(4)
+  end
+
+  it "accepts attributes at initialization" do
+    options = { crumb_length: 12 }
+    config = Loaf::Configuration.new(options)
+
+    expect(config.crumb_length).to eq(12)
+  end
+
+  it "exports configuration as hash" do
+    config = Loaf::Configuration.new
+    expect(config.to_hash).to eq({
+      capitalize: false,
+      crumb_length: 30,
+      locales_path: '/'
+    })
+  end
+
+  it "yields configuration" do
+    conf = double(:conf)
+    allow(Loaf).to receive(:configuration).and_return(conf)
+    expect { |b|
+      Loaf.configure(&b)
+    }.to yield_with_args(conf)
+  end
+end

data/spec/unit/controller_extensions_spec.rb

@@ -1,14 +1,5 @@
 # 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
@@ -16,18 +7,18 @@ RSpec.describe Loaf::ControllerExtensions do
     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)
+    it 'invokes before_action' do
+      allow(DummyController).to receive(:before_action)
+      allow(DummyController).to receive(:respond_to?).and_return(true)
       DummyController.breadcrumb('name', 'url_path')
-      expect(DummyController).to have_received(:before_filter)
+      expect(DummyController).to have_received(:before_action)
     end
 
-    it 'delegates to instance' do
+    it 'delegates breadcrumb registration to controller instance' do
       name    = 'List objects'
       url     = :object_path
       options = {force: true}

data/spec/unit/generators/install_generator_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'spec_helper'
+require 'fileutils'
 require 'generators/loaf/install_generator'
 
 RSpec.describe Loaf::Generators::InstallGenerator, type: :generator do
@@ -12,5 +12,6 @@ RSpec.describe Loaf::Generators::InstallGenerator, type: :generator do
     run_generator
     locale = file("config/locales/loaf.en.yml")
     expect(locale).to exist
+    FileUtils.rm_rf(File.expand_path("../../../tmp", __FILE__))
   end
 end

data/spec/unit/view_extensions/breadcrumb_trail_spec.rb

@@ -0,0 +1,232 @@
+# encoding: utf-8
+
+RSpec.describe Loaf::ViewExtensions, '#breadcrumb_trail' do
+  it "resolves breadcrumb paths" do
+    view = DummyView.new
+    view.breadcrumb('home', :home_path)
+    view.breadcrumb('posts', :posts_path)
+    view.set_path('/posts')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(&block)
+
+    expect(yielded).to eq([
+      ['home', '/', false],
+      ['posts', '/posts', true]
+    ])
+  end
+
+  it "matches current path with :inclusive option as default" do
+    view = DummyView.new
+    view.breadcrumb('home', :home_path)
+    view.breadcrumb('posts', :posts_path)
+    view.set_path('/posts?id=73-title')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(&block)
+
+    expect(yielded).to eq([
+      ['home', '/', false],
+      ['posts', '/posts', true]
+    ])
+  end
+
+  it "matches current path with :inclusive when query params" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :inclusive)
+    view.set_path('/posts?foo=bar')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "matches current path with :inclusive when nested" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :inclusive)
+    view.set_path('/posts/1/comment')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "matches current path with :inclusive when nested" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :inclusive)
+    view.set_path('/posts/1/comment')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "doesn't match with :inclusive when unrelated path" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :inclusive)
+    view.set_path('/post/1')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', false]])
+  end
+
+  it "matches current path with :inclusive when extra trailing slash" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts/', match: :inclusive)
+    view.set_path('/posts')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts/', true]])
+  end
+
+  it "matches current path with :inclusive when absolute path" do
+    view = DummyView.new
+    view.breadcrumb('posts', 'http://www.example.com/posts/', match: :inclusive)
+    view.set_path('/posts')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([
+      ['posts', 'http://www.example.com/posts/', true]
+    ])
+  end
+
+  it "matches current path with :exact when trailing slash" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts/', match: :exact)
+    view.set_path('/posts')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts/', true]])
+  end
+
+  it "fails to match current path with :exact when nested" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :exact)
+    view.set_path('/posts/1/comment')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', false]])
+  end
+
+  it "fails to match current path with :exact when query params" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :exact)
+    view.set_path('/posts?foo=bar')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', false]])
+  end
+
+  it "matches current path with :exclusive option when query params" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :exclusive)
+    view.set_path('/posts?foo=bar')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "fails to match current path with :exclusive option when nested" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: :exclusive)
+    view.set_path('/posts/1/comment')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', false]])
+  end
+
+  it "matches current path with regex option when query params" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: %r{/po})
+    view.set_path('/posts?foo=bar')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "matches current path with query params option" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: {foo: :bar})
+    view.set_path('/posts?foo=bar&baz=boo')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', true]])
+  end
+
+  it "fails to match current path with query params option" do
+    view = DummyView.new
+    view.breadcrumb('posts', '/posts', match: {foo: :bar})
+    view.set_path('/posts?foo=2&baz=boo')
+
+    expect(view.breadcrumb_trail.map(&:to_a)).to eq([['posts', '/posts', false]])
+  end
+
+  it "failse to recognize the match option" do
+    view = DummyView.new
+    view.breadcrumb('posts', 'http://www.example.com/posts/', match: :boom)
+    view.set_path('/posts')
+    block = -> (*args) { }
+    expect {
+      view.breadcrumb_trail(&block)
+    }.to raise_error(ArgumentError, "Unknown `:boom` match option!")
+  end
+
+  it "forces current path" do
+    view = DummyView.new
+    view.breadcrumb('home', :home_path)
+    view.breadcrumb('posts', :posts_path, match: :force)
+    view.set_path('/')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(&block)
+
+    expect(yielded).to eq([
+      ['home', '/', true],
+      ['posts', '/posts', true]
+    ])
+  end
+
+  it "returns enumerator without block" do
+    view = DummyView.new
+    view.breadcrumb('home', :home_path)
+    view.breadcrumb('posts', :posts_path)
+    view.set_path('/posts')
+
+    result = view.breadcrumb_trail
+
+    expect(result).to be_a(Enumerable)
+    expect(result.take(2).map(&:to_a)).to eq([
+      ['home', '/', false],
+      ['posts', '/posts', true]
+    ])
+  end
+
+  it 'validates passed options' do
+    view = DummyView.new
+    block = -> (name, url, styles) {  }
+    expect {
+      view.breadcrumb_trail(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)
+    view = DummyView.new
+    view.breadcrumb('home-sweet-home', :home_path)
+    view.breadcrumb('posts-for-everybody', :posts_path)
+    view.set_path('/posts')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(&block)
+
+    expect(yielded).to eq([
+      ['home-sw...', '/', false],
+      ['posts-f...', '/posts', true]
+    ])
+  end
+
+  it "allows to overwrite global configuration" do
+    allow(Loaf.configuration).to receive(:crumb_length).and_return(10)
+    view = DummyView.new
+    view.breadcrumb('home-sweet-home', :home_path)
+    view.breadcrumb('posts-for-everybody', :posts_path)
+    view.set_path('/posts')
+
+    yielded = []
+    block = -> (crumb) { yielded << crumb.to_a }
+    view.breadcrumb_trail(crumb_length: 15, &block)
+
+    expect(yielded).to eq([
+      ['home-sweet-home', '/', false],
+      ['posts-for-ev...', '/posts', true]
+    ])
+  end
+end