crummy 1.7.0 → 1.7.1

data/.gitignore

@@ -2,5 +2,5 @@ rdoc
 nbproject
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-head@crummy"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.7 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+ - 1.9.3
+ - 2.0.0
+gemfile:
+ - gemfiles/rails3_2/Gemfile
+ - gemfiles/rails4_0/Gemfile
+matrix:
+  allow_failures:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails4_0/Gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails4_0/Gemfile

data/CHANGELOG

@@ -1,3 +1,6 @@
+1.7.1
+* [ADDED] :last_crumb_linked option to disable linking crumb on current page
+
 1.7.0
 * [ADDED] Added option for google microdata
 * [REFACTORED] Cleaned up development internals

data/README.md

@@ -1,7 +1,7 @@
 # Crummy
 
 [![Gem Version](https://badge.fury.io/rb/crummy.png)](http://badge.fury.io/rb/crummy)
-[![Build Status](https://secure.travis-ci.org/zachinglis/crummy.png?branch=master)](http://travis-ci.org/zachinglis/crummy)
+[![Build Status](https://secure.travis-ci.org/zachinglis/crummy.png)](http://travis-ci.org/zachinglis/crummy)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/zachinglis/crummy)
 
 Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
@@ -10,38 +10,44 @@ Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
 
 Simply add the dependency to your Gemfile:
 
-    gem "crummy", "~> 1.6.0"
+```ruby
+gem "crummy", "~> 1.7.1"
+```
 
 # Example
 
 In your controllers you may add\_crumb either like a before\_filter or
 within a method (It is also available to views).
 
-    class ApplicationController
-      add_crumb "Home", '/'
-    end
+```ruby
+class ApplicationController
+  add_crumb "Home", '/'
+end
 
-    class BusinessController < ApplicationController
-      add_crumb("Businesses") { |instance| instance.send :businesses_path }
-      add_crumb("Comments", :only => "comments") { |instance| instance.send :businesses_comments_path }
-      before_filter :load_comment, :only => "show"
-      add_crumb :comment, :only => "show"
+class BusinessController < ApplicationController
+  add_crumb("Businesses") { |instance| instance.send :businesses_path }
+  add_crumb("Comments", only: "comments") { |instance| instance.send :businesses_comments_path }
+  before_filter :load_comment, only: "show"
+  add_crumb :comment, only: "show"
 
-      # Example for nested routes:
-      add_crumb(:document) { [:account, :document] }
+  # Example for nested routes:
+  add_crumb(:document) { [:account, :document] }
 
-      def show
-        add_crumb @business.display_name, @business
-      end
+  def show
+    add_crumb @business.display_name, @business
+  end
 
-      def load_comment
-        @comment = Comment.find(params[:id])
-      end
-    end
+  def load_comment
+    @comment = Comment.find(params[:id])
+  end
+end
+```
 
 Then in your view:
 
-    <%= render_crumbs %>
+```erb
+<%= render_crumbs %>
+```
 
 ## Options for render\_crumbs
 
@@ -52,42 +58,57 @@ It takes 3 options
 The output format. Can either be :xml or :html or :html\_list. Defaults
 to :html
 
-    :format => (:html|:html_list|:xml)
+```ruby
+format: (:html|:html_list|:xml)
+```
 
 The separator text. It does not assume you want spaces on either side so
 you must specify. Defaults to `&raquo;` for :html and
 `<crumb>` for :xml
 
-    :separator => string
+```ruby
+separator: string
+```
 
 Render links in the output. Defaults to *true*
 
-    :links => boolean
+```ruby
+links: boolean
 
-    :skip_if_blank => true
+skip_if_blank: true
+```
 
 Render
 [Richsnipet](http:/support.google.com/webmasters/bin/answer.py?hl=en&answer=99170&topic=1088472&ctx=topic/)
 Default to *false*
 
-    :microdata => true
+```
+last_crumb_linked: false
+```
+
+Optionally disable linking of the last crumb, Defaults to *true*
+
+```ruby
+microdata: true
+```
 
 With this option, output will be blank if there are no breadcrumbs.
 
 ### Examples
 
-    render_crumbs                        #=> <a href="/">Home</a> &raquo; <a href="/businesses">Businesses</a>
-    render_crumbs :separator => ' | '    #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
-    render_crumbs :format => :xml        #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
-    render_crumbs :format => :html_list  #=> <ul class="" id=""><li class=""><a href="/">Home</a></li><li class=""><a href="/">Businesses</a></li></ul>
-    render_crumbs :format => :html_list, :microdata => true
-                                         #=> <ul class="" id=""><li class="" itemscope="itemscope" itemtype="http://data-vocabulary.org/Breadcrumb">
-                                         #   <a href="/" itemprop="url"><span itemprop="title">Home</span></a></li></ul>
+```ruby
+render_crumbs                     #=> <a href="/">Home</a> &raquo; <a href="/businesses">Businesses</a>
+render_crumbs separator: ' | '    #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
+render_crumbs format: :xml        #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+render_crumbs format: :html_list  #=> <ul class="" id=""><li class=""><a href="/">Home</a></li><li class=""><a href="/">Businesses</a></li></ul>
+render_crumbs format: :html_list, :microdata => true
+                                  #=> <ul class="" id=""><li class="" itemscope="itemscope" itemtype="http://data-vocabulary.org/Breadcrumb">
+                                  #     <a href="/" itemprop="url"><span itemprop="title">Home</span></a></li></ul>
+```
 
 A crumb with a nil argument for the link will output an unlinked crumb.
 
-With `:format => :html_list` you can specify additional `params:
-:active_li_class, :li_class, :ul_class, :ul_id`
+With `format: :html_list` you can specify additional `params: :li_class, :ul_class, :ul_id`
 
 ### App-wide configuration
 
@@ -102,31 +123,34 @@ overridden in the view.
 
 Insert the following in a file named `config/initializers/crummy.rb`:
 
-    Crummy.configure do |config|
-      config.format = :xml
-    end
+```ruby
+Crummy.configure do |config|
+  config.format = :xml
+end
+```
 
 Possible parameters for configuration are:
 
-    :format
-    :links
-    :skip_if_blank
-    :html_separator
-    :xml_separator
-    :html_list_separator
-    :first_class
-    :last_class
-    :ul_id
-    :ul_class
-    :li_class
-    :active_li_class
-    :microdata
+```ruby
+:format
+:links
+:skip_if_blank
+:html_separator
+:xml_separator
+:html_list_separator
+:first_class
+:last_class
+:ul_id
+:ul_class
+:li_class
+:microdata
+```
 
 See `lib/crummy.rb` for a list of these parameters and their defaults.
 
-## Notes
+## Live example application
 
-Test library is at [Crummy Test](https://github.com/zachinglis/crummy-test)
+An example application is available right inside this gem. That application is documented, see `example/README` for details about usage.
 
 ## Todo
 
@@ -138,8 +162,8 @@ Test library is at [Crummy Test](https://github.com/zachinglis/crummy-test)
 
 ## Credits
 
--   [Zach Inglis](http://zachinglis.com) of [London
-    Made](http://londonmade.co.uk)
+-   [Zach Inglis](http://zachinglis.com) of [Superhero Studios](http://superhero-studios.com)
+-   [Andrew Nesbitt](http://github.com/andrew)
 -   [Rein Henrichs](http://reinh.com)
 -   [Les Hill](http://blog.leshill.org/)
 -   [Sandro Turriate](http://turriate.com/)
@@ -157,6 +181,5 @@ Test library is at [Crummy Test](https://github.com/zachinglis/crummy-test)
 -   [Jan Szumiec](http://github.com/jasiek)
 -   [Jeff Browning](http://github.com/jbrowning)
 -   [Bill Turner](http://github.com/billturner)
--   [Andrew Nesbitt](http://github.com/andrew)
 
 **Copyright 2008-2013 Zach Inglis, released under the MIT license**

data/example/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/example/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/example/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-head@crummy-test"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.7 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/example/Gemfile

@@ -0,0 +1,30 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.1'
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.1.4'
+  gem 'coffee-rails', '~> 3.1.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+gem 'haml'
+gem 'crummy', :path => '../'
+
+group :test do
+  # Pretty printed test output
+  gem 'turn', :require => false
+end
+
+group :test, :development do
+  gem "rspec-rails", "~> 2.0"
+end

data/example/README.md

@@ -0,0 +1,40 @@
+# Crummy Test
+
+## Introduction
+
+This is a test application for [Crummy][crummy], and also a good place where you can see it in action.
+
+  [crummy]: http://github.com/zachinglis/crummy
+
+## Usage
+
+I recommend you to use [RVM][rvm] in order to keep this application gemset distinct from the gem one. Here we use a full Rails stack, which is not true when developping the gem. I you only want to see Crummy in action, you might not care about that. Anyways RVM is not required, but if you use it you'll find an `.rvmrc` file for each context: `example/.rvmrc` and `.rvmrc` respectively for the example app and the gem. Using them is easy and only requires to take care of the directory from where you `bundle install`: if from `example`, you'll update the app bundle, else the gem bundle.
+
+  [rvm]: https://rvm.io
+
+To quickly start the example app:
+
+```bash
+# Enter the example directory and trust the .rvmrc file
+cd crummy/example
+
+# Install the bundle
+bundle install
+# Create the database
+bundle exec rake db:schema:load
+bundle exec rake db:seed
+# Create the test database
+bundle exec rake db:test:clone
+
+# Get the tests green
+bundle exec rake
+
+# Start the server
+rails server
+```
+
+Your app waits for you at [http://localhost:3000](http://localhost:3000).
+
+* * *
+
+I hope this makes the example application a better place to test the gem.

data/example/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+CrummyTest::Application.load_tasks

data/example/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/example/app/assets/javascripts/pages.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/