loaf 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cb34b106f14868575b5831d9de8255e52e94f2d
+  data.tar.gz: 8f3fdcef497c132f17cd4496b124a60b92cbc67a
+SHA512:
+  metadata.gz: 568cd3729c360ab6d1aa4a8c19d9618d8d6dfb8312a57693896c940d94cddd5f4979e8f656ad0c3cd76db67b2b62c9d9f3fb0d5dce802bb2048a3dcc9d7aa344
+  data.tar.gz: 8cb65d4d05998f474f9356490f7cfe9a923b65de0e7ec8855a9bad4057f3306941a6f9bb38fea283d100e28a6349015beb79a708f84e278fe437285adef5bdab

data/.gitignore

@@ -1,10 +1,23 @@
-coverage
-rdoc
-doc
-.yardoc
+*.gem
+*.rbc
 .bundle
+.config
+.yardoc
+Gemfile.lock
+gemfiles/*.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
 pkg
-*.swp
-log
-*.sqlite3
-.bundle
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -1,4 +1,25 @@
-script: 'rake'
+language: ruby
+sudo: false
+bundler_args: --without yard benchmarks
+install: 'travis_retry bin/setup'
+script: 'bundle exec appraisal rake ci'
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+matrix:
+  include:
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+  fast_finish: true
+branches:
+  only: master

data/Appraisals

@@ -0,0 +1,18 @@
+if RUBY_VERSION < "2.2.0"
+  appraise 'rails3.2' do
+    gem 'rails', '~> 3.2.21'
+  end
+end
+
+appraise 'rails4.0' do
+  gem 'rails', '~> 4.0.13'
+  gem 'test-unit'
+end
+
+appraise 'rails4.1' do
+  gem 'rails', '~> 4.1.9'
+end
+
+appraise 'rails4.2' do
+  gem 'rails', '~> 4.2.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.4.0 (January 10, 2015)
+
+* Change breadcrumbs view method to return enumerator without block
+* Change Crumb to ruby class and add force option
+* Change Configuration to ruby class and scope config options
+* Add ability to force current path through :force option
+* Change format_name to only take name argument
+* Change to expose config settings on configuration
+* Fix bug with url parameter to allow for regular rails path variables
+* Update test suite to work against different rubies 1.9.x, 2.x
+* Test Rails 3.2.x, 4.0, 4.1, 4.2
+
 0.3.0 (February 25, 2012)
 
 * Add loaf gem errors

data/Gemfile

@@ -1,3 +1,18 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+gem 'bundler', '~> 1.3'
+gem 'appraisal', '~> 1.0.2'
+gem 'rake',     '~> 10.4.2'
+gem 'yard',     '~> 0.8.7'
+gem 'sqlite3',  '~> 1.3.10', platforms: :ruby
+gem 'activerecord-jdbcsqlite3-adapter', '~> 1.3.10', platforms: :jruby
+gem 'capybara', '~> 2.4.4'
+gem 'rspec-rails', '~> 3.1.0'
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.2'
+  gem 'simplecov', '~> 0.9.1'
+  gem 'yardstick', '~> 0.9.9'
+end

data/README.md

@@ -1,90 +1,114 @@
-# Loaf [![Build Status](https://secure.travis-ci.org/peter-murach/loaf.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/loaf.png?travis)][gemnasium]
-
+# Loaf
+[![Gem Version](https://badge.fury.io/rb/loaf.png)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/loaf.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/loaf.png)][codeclimate]
+[![Dependency Status](https://gemnasium.com/peter-murach/loaf.png?travis)][gemnasium]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/loaf/badge.png?branch=master)][coveralls]
+[![Inline docs](http://inch-ci.org/github/peter-murach/loaf.png?branch=master)][inchpages]
+
+[gem]: http://badge.fury.io/rb/loaf
 [travis]: http://travis-ci.org/peter-murach/loaf
+[codeclimate]: https://codeclimate.com/github/peter-murach/loaf
 [gemnasium]: https://gemnasium.com/peter-murach/loaf
+[coveralls]: https://coveralls.io/r/peter-murach/loaf
+[inchpages]: http://inch-ci.org/github/peter-murach/loaf
 
-Breadcrumbs creation library.
-
-* Helps in creating breadcrumbs.
-* Uses controllers to specify names and routes for parts of breadcrum trails or collections of breadcrumbs.
-* Stays out of your way when it comes to markup exposing only single helper method to access breadcrumb data.
-* Supports Rails 2 & 3.
+> **Loaf** manages and displays breadcrumb trails in your Rails application.
 
-## Installation
+## Features
 
-Install from source:
+* Uses controllers or views to specify breadcrumb trails
+* No markup assumptions for breadcrumbs rendering
+* Use locales file for names - optional
+* Tested with Rails 3.2, 4.0, 4.1, 4.2
 
-```ruby
-gem install loaf
-```
+## Installation
 
-Add to your Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
 gem 'loaf'
 ```
 
-## Configuration
-
-There is a small set of custom opinionated defaults. The following options are valid parameters:
+And then execute:
 
 ```ruby
-:crumb_length  # breadcrumb length in integer, default length is 30 characters
-:root          # boolean, default is true, displays the home crumb
-:capitalize    # set breadcrumbs to have initial letter uppercase, default false
-:style_classes # CSS class to be used to style current breadcrumb,
-               # defaults to 'selected'
+$ bundle
 ```
 
-You can override them in your views by passing them to the view `breadcrumb` helper
+Or install it yourself as:
 
 ```ruby
-<% breadcrumbs :crumb_length => 20 do |name, url, styles| %>
-  ..
-<% end %>
+gem install loaf
 ```
 
-or by adding initializer
+## 1. Usage
 
-```ruby
-Loaf.configure do |config|
-  config.crumb_length => 20
-end
-```
-
-## Usage
+**Loaf** allows you to add breadcrumbs in controllers and views.
 
-In controller:
+In order to add breadcrumbs in controller use `breadcrumb` method. Outside of controller actions the `breadcrumb` helper behaviour is similar to filters and as such you can limit breadcrumb scope with familiar options `:only`, `:except`. Any breadcrumb specified inside actions creates another level in breadcrumbs trail.
 
 ```ruby
 class Blog::CategoriesController < ApplicationController
 
-  breadcrumb 'Article Categories', 'blog_categories_path', :only => [:show]
+  breadcrumb 'Article Categories', :blog_categories_path, only: [:show]
 
   def show
-    breadcrumb "#{@category.title}", 'blog_category_path(@category)'
+    breadcrumb "#{@category.title}", blog_category_path(@category)
   end
 end
 ```
 
-You can add breadcrumbs for nested resources, for instance, article categories:
+**Loaf** adds `breadcrumb` helper also to the views. Together with controller breadcrumbs, the view breadcrumbs are appended as the last. For instance, to specify view breadcrumb do:
+
+```ruby
+<% breadcrumb "#{@category.title}", blog_category_path(@category) %>
+```
 
-In your view add semantic markup to show breadcrumbs:
+Finally, in your view layout add semantic markup to show breadcrumbs:
 
 ```html
-<ul id="breadcrumbs">
-  <%- breadcrumbs :crumb_length => 20 do |name, url, styles| -%>
+<ul class='breadcrumbs'>
+  <% breadcrumbs do |name, url, styles| %>
     <li class="<%= styles %>">
       <%= link_to name, url %>
       <span><%= styles == 'selected' ? '' : '::' %></span>
     </li>
-  <%- end -%>
+  <% end %>
 </ul>
 ```
 
 Usually best practice is to put such snippet inside its own partial.
 
-## Locale
+## 2. Configuration
+
+There is a small set of custom opinionated defaults. The following options are valid parameters:
+
+```ruby
+:crumb_length  # breadcrumb length in integer, default length is 30 characters
+:root          # boolean, default is true, displays the home crumb
+:capitalize    # set breadcrumbs to have initial letter uppercase, default false
+:style_classes # CSS class to be used to style current breadcrumb,
+               # defaults to 'selected'
+```
+
+You can override them in your views by passing them to the view `breadcrumb` helper
+
+```ruby
+<% breadcrumbs crumb_length: 20 do |name, url, styles| %>
+  ..
+<% end %>
+```
+
+or by adding initializer in `config/initializers/loaf.rb`:
+
+```ruby
+Loaf.configure do |config|
+  config.crumb_length = 20
+end
+```
+
+## 3. Locale
 
 When adding breadcrumbs one can use locales for their titles. The only assumption it makes is that all breadcrumb names are scoped inside `breadcrumbs` namespace. However, this can be easily changed by passing `:scope => 'new_scope_name'` configuration option
 
@@ -112,17 +136,10 @@ en:
       categories: 'Article Categories'
 ```
 
-## TODO
-
-* Add ability to add breadcrumbs for nested resources
-* Add support for name internationalisation
-* Finish specs
-
-## Contributing to loaf
+## Contributing
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/peter-murach/loaf/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
 
 ## Copyright
 
-Copyright (c) 2011 Piotr Murach. See LICENSE.txt for
-further details.
+Copyright (c) 2011-2015 Piotr Murach. See LICENSE.txt for further details.

data/Rakefile

@@ -1,8 +1,10 @@
 # encoding: utf-8
 
+require 'rubygems'
+require 'bundler/setup'
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+FileList['tasks/**/*.rake'].each(&method(:import))
 
-task :default => :spec
+desc 'Run all specs'
+task ci: %w[ spec ]

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+# Install gems required by Appraisal
+bundle install
+bundle exec appraisal install

data/gemfiles/rails3.2.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "appraisal", "~> 1.0.2"
+gem "rake", "~> 10.3.2"
+gem "yard", "~> 0.8.7"
+gem "sqlite3", "~> 1.3.10", :platforms => :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.10", :platforms => :jruby
+gem "capybara", "~> 2.4.4"
+gem "rspec-rails", "~> 3.1.0"
+gem "rails", "~> 3.2.21"
+
+group :metrics do
+  gem "coveralls", "~> 0.7.2"
+  gem "simplecov", "~> 0.9.1"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec :path => "../"

data/gemfiles/rails4.0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "appraisal", "~> 1.0.2"
+gem "rake", "~> 10.3.2"
+gem "yard", "~> 0.8.7"
+gem "sqlite3", "~> 1.3.10", :platforms => :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.10", :platforms => :jruby
+gem "capybara", "~> 2.4.4"
+gem "rspec-rails", "~> 3.1.0"
+gem "rails", "~> 4.0.13"
+gem "test-unit"
+
+group :metrics do
+  gem "coveralls", "~> 0.7.2"
+  gem "simplecov", "~> 0.9.1"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec :path => "../"

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "appraisal", "~> 1.0.2"
+gem "rake", "~> 10.3.2"
+gem "yard", "~> 0.8.7"
+gem "sqlite3", "~> 1.3.10", :platforms => :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.10", :platforms => :jruby
+gem "capybara", "~> 2.4.4"
+gem "rspec-rails", "~> 3.1.0"
+gem "rails", "~> 4.1.9"
+
+group :metrics do
+  gem "coveralls", "~> 0.7.2"
+  gem "simplecov", "~> 0.9.1"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec :path => "../"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "appraisal", "~> 1.0.2"
+gem "rake", "~> 10.3.2"
+gem "yard", "~> 0.8.7"
+gem "sqlite3", "~> 1.3.10", :platforms => :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.10", :platforms => :jruby
+gem "capybara", "~> 2.4.4"
+gem "rspec-rails", "~> 3.1.0"
+gem "rails", "~> 4.2.0"
+
+group :metrics do
+  gem "coveralls", "~> 0.7.2"
+  gem "simplecov", "~> 0.9.1"
+  gem "yardstick", "~> 0.9.9"
+end
+
+gemspec :path => "../"

data/lib/loaf.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'loaf/configuration'
 require 'loaf/errors'
 require 'loaf/railtie'
@@ -13,7 +15,28 @@ require 'loaf/options_validator'
 I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
 
 module Loaf
-  extend Configuration
+  # Set global configuration
+  #
+  # @api public
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Get global configuration
+  #
+  # @api public
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Sets the Loaf configuration options. Best used by passing a block.
+  #
+  # Loaf.configure do |config|
+  #   config.capitalize = true
+  # end
+  def self.configure
+    yield configuration
+  end
 
   if defined? Rails::Railtie
     require 'loaf/railtie'