loaf 0.1.1 → 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,10 @@
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+*.swp
+log
+*.sqlite3
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+environment_id="ruby-1.9.3-p0@loaf"
+
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else
+  echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi

data/.travis.yml

@@ -0,0 +1,4 @@
+script: 'rake'
+rvm:
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+0.2.0 (February  , 2012)
+
+* Change gemspec with new gem dependencies, use git
+* Setup testing environment with dummy rails app
+* Add integration tests for breadcrumbs view rendering
+* Add translation module for breadcrumbs title lookup
+* Add breadcrumb formatting module with tests
+* Refactor names for controller and view extensions

data/Gemfile.lock

@@ -0,0 +1,132 @@
+PATH
+  remote: .
+  specs:
+    loaf (0.1.1)
+      rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.3)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.3)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.7.0)
+    rubyzip (0.9.5)
+    selenium-webdriver (2.15.0)
+      childprocess (>= 0.2.1)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
+      rubyzip
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  capybara
+  loaf!
+  rails (~> 3.1)
+  rspec-rails
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Piotr Murach
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# 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]
+
+[travis]: http://travis-ci.org/peter-murach/loaf
+[gemnasium]: https://gemnasium.com/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.
+
+## Installation
+
+Install from source:
+
+```ruby
+gem install loaf
+```
+
+Add to your Gemfile:
+
+```ruby
+gem 'loaf'
+```
+
+## 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
+
+```ruby
+Loaf.configure do |config|
+  config.crumb_length => 20
+end
+```
+
+## Usage
+
+In controller:
+
+```ruby
+class Blog::CategoriesController < ApplicationController
+
+  add_breadcrumb 'Article Categories', 'blog_categories_path', :only => [:show]
+
+  def show
+    add_breadcrumb "#{@category.title}", 'blog_category_path(@category)'
+  end
+end
+```
+
+You can add breadcrumbs for nested resources, for instance, article categories:
+
+In your view add semantic markup to show breadcrumbs:
+
+```html
+<ul id="breadcrumbs">
+  <%- breadcrumbs :crumb_length => 20 do |name, url, styles| -%>
+    <li class="<%= styles %>">
+      <%= link_to name, url %>
+      <span><%= styles == 'selected' ? '' : '::' %></span>
+    </li>
+  <%- end -%>
+</ul>
+```
+
+Usually best practice is to put such snippet inside its own partial.
+
+## 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
+
+```ruby
+en:
+  breadcrumbs:
+    controller:
+      action:
+```
+
+Therefore in your controller/view one would have
+
+```ruby
+class Blog::CategoriesController < ApplicationController
+
+  add_breadcrumb 'blog.categories', 'blog_categories_path'
+
+end
+
+And corresponding entry in locale:
+
+en:
+  breadcrumbs:
+    blog:
+      categories: 'Article Categories'
+```
+
+## TODO
+
+* Add ability to add breadcrumbs for nested resources
+* Add support for name internationalisation
+* Finish specs
+
+## Contributing to loaf
+
+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.

data/Rakefile

@@ -1,51 +1,8 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require './lib/loaf/version.rb'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "loaf"
-  gem.homepage = "http://github.com/peter-murach/loaf"
-  gem.license = "MIT"
-  gem.summary = %Q{TODO: one-line summary of your gem}
-  gem.description = %Q{TODO: longer description of your gem}
-  gem.email = "pmurach@gmail.com"
-  gem.authors = ["Piotr Murach"]
-  gem.version = Loaf::Version::STRING
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "loaf #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/init.rb

@@ -0,0 +1,3 @@
+require 'loaf'
+require 'loaf/railtie'
+Loaf::Railtie.insert

data/lib/loaf.rb

@@ -1,16 +1,22 @@
-require 'action_controller'
 require 'loaf/configuration'
+require 'loaf/railtie'
+require 'loaf/crumb'
+require 'loaf/builder'
+require 'loaf/translation'
+require 'loaf/controller_extensions'
+require 'loaf/view_extensions'
+require 'loaf/crumb_formatter'
 
 module Loaf
+  extend Configuration
+
   if defined? Rails::Railtie
     require 'loaf/railtie'
   else
-    autoload :Filters, 'loaf/filters'
-    autoload :Helpers, 'loaf/helpers'
+    autoload :ControllerExtensions, 'loaf/controller_extensions'
+    autoload :Helpers, 'loaf/view_extensions'
 
-    ::ActionController::Base.send :include, Loaf::Filters
-    ::ActionController::Base.helper Loaf::Helpers
+    ::ActionController::Base.send :include, Loaf::ControllerExtensions
+    ::ActionController::Base.helper Loaf::ViewExtensions
   end
-
-  extend Configuration
-end
+end # Loaf

data/lib/loaf/configuration.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Loaf
   module Configuration