crumby 1.1.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails"
+
+group :development do
+  gem 'rspec-rails'
+  gem "yard"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,115 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  rails
+  rspec-rails
+  simplecov
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christoph Chilian
+
+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.rdoc

@@ -0,0 +1,87 @@
+= Crumby
+A simple breadcrumb plugin for rails
+
+== Installation
+add to Gemfile
+  gem 'crumby'
+
+== Configuration
+
+  Crumby.configure do
+    # configure the default renderer
+    # renderer = Renderer::Haml
+  end
+
+== Requirements
+
+* Rails 3 (http://github.com/rails/rails)
+
+== Example
+
+=== controller
+you can add entries global by before_filter and in each methods/actions
+
+  class Addmin::BookController < ApplicationController
+    before_filter { add_crumby "Dashboard", :root }
+    before_filter { add_crumby "Admin", :admin_root }
+    def index
+      add_crumby [:admin, :books]
+    end
+    def show
+      add_crumby [:admin, @book]
+    end
+  end
+
+=== layout
+  %html
+    %head
+      %title= crumby_title "The Admin App"
+    %body
+      #breadcrumb= crumby
+
+=== add_crumby
+add a new entry into breadcrumb trail
+
+  add_crumby :books
+  add_crumby @book
+  add_crumby [:admin, @book]
+  add_crumby "Books", :admin_books
+  add_crumby "Books", [:admin,:books]
+  add_crumby "Book", [:admin, @book]
+  add_crumby "Google", "http://google.de"
+
+=== scopes
+You can use scopes to have more than one breadcrumb
+:subcrumy is equal to "subcrumb"
+
+  add_crumby :books, scope: :subcrumb
+  add_crumby :books, scope: "subcrumb"
+  crumby :subcrumb
+  crumby "subcrumb"
+
+== History
+
+* 0.1 first release
+
+== Roadmap
+
+* Complete all specs
+
+== Maintainers
+
+* Team Phatworx (http://github.com/phatworx)
+* Marco Scholl (http://github.com/traxanos)
+
+== Contributing to Crumby
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Marco Scholl. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "crumby"
+  gem.homepage = "http://github.com/phatworx/crumby"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple breadcrumb plugin for rails}
+  gem.description = %Q{A simple breadcrumb plugin for rails}
+  gem.email = "develop@marco-scholl.de"
+  gem.authors = ["Marco Scholl"]
+  gem.files.exclude 'spec'
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run tests with SimpleCov"
+RSpec::Core::RakeTask.new('coverage') do |t|
+  ENV['COVERAGE'] = "true"
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/crumby.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "crumby"
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marco Scholl"]
+  s.date = "2012-07-31"
+  s.description = "A simple breadcrumb plugin for rails"
+  s.email = "develop@marco-scholl.de"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "crumby.gemspec",
+    "lib/crumby.rb",
+    "lib/crumby/entry.rb",
+    "lib/crumby/helper.rb",
+    "lib/crumby/helper/controller.rb",
+    "lib/crumby/helper/view.rb",
+    "lib/crumby/renderer.rb",
+    "lib/crumby/renderer/base.rb",
+    "lib/crumby/renderer/haml.rb",
+    "lib/crumby/trail.rb",
+    "spec/crumby/entry_spec.rb",
+    "spec/crumby/helper_spec.rb",
+    "spec/crumby/renderer/base_spec.rb",
+    "spec/crumby/trail_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/phatworx/crumby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A simple breadcrumb plugin for rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/crumby.rb

@@ -0,0 +1,41 @@
+require 'active_support/lazy_load_hooks'
+require 'active_support/core_ext/module/attribute_accessors'
+
+# crumy is a breadcrumb plugin for rails
+module Crumby
+  autoload :Entry, 'crumby/entry'
+  autoload :Trail, 'crumby/trail'
+  autoload :Helper, 'crumby/helper'
+  autoload :Renderer, 'crumby/renderer'
+
+  mattr_accessor :renderer
+  # configure the default renderer
+  @@renderer = Renderer::Haml
+
+  class << self
+    # configure crumby
+    # @example
+    #   Crumby.configure do
+    #     # configure the default renderer
+    #     # renderer = Renderer::Haml
+    #   end
+    def configure(&block)
+      self.instance_eval &block
+    end
+
+    # initialize the crumby plugin.
+    # includes Controller and View helpers
+    def init!
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send :include, Crumby::Helper::ControllerHelper
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.send :include, Crumby::Helper::ViewHelper
+      end
+    end
+  end
+
+end
+
+Crumby.init!

data/lib/crumby/entry.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Crumby
+
+  # represent an entry of a breadcrumb menu
+  class Entry < Struct.new(:trail, :position, :label, :route, :options)
+
+    # Returns total entries
+    # @return [Fixnum]
+    def total
+      trail.count
+    end
+
+    # Returns if first entry
+    # @return [Boolean]
+    def first?
+      position.zero?
+    end
+
+    # Returns if last entry
+    # @return [Boolean]
+    def last?
+      (total - position - 1).zero?
+    end
+  end
+
+end

data/lib/crumby/helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# helper package
+module Crumby::Helper
+  autoload :ViewHelper, 'crumby/helper/view'
+  autoload :ControllerHelper, 'crumby/helper/controller'
+end

data/lib/crumby/helper/controller.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Crumby::Helper
+  # controller helper
+  module ControllerHelper
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :crumby_title
+      helper_method :crumby_trail
+    end
+
+    # return crumby_trail by scope
+    # @param [Symbol, String] scope
+    def crumby_trail(scope = :default)
+      raise ArgumentError if scope.nil?
+      scope = scope.to_sym
+      @crumby_trails = {} if @crumby_trails.nil?
+      @crumby_trails[scope] ||= Crumby::Trail.new
+    end
+
+    # render trail
+    # @see Crumby::Trail#render
+    # @see Crumby::Renderer::Base
+    # @overload crumby(options)
+    #   @param [Hash] options passthrough to Trail#render
+    #   @option options [String, Symbol] :scope extract scope from options before passthrough
+    # @overload crumby(scope, options)
+    #   @param [Symbol, String] scope scope of trail
+    #   @param [Hash] options passthrough to Trail#render
+    #   @option options [String, Symbol] :scope extract scope from options before passthrough
+    def add_crumby(*args)
+      options = args.extract_options!
+      scope = options.delete(:scope) || :default
+      crumby_trail(scope).add(*args, options)
+    end
+
+
+    # render trail
+    # @see Crumby::Trail#title
+    # @overload crumby(options)
+    #   @param [Hash] options passthrough to Crumby::Trail#title
+    #   @option options [String, Symbol] :scope extract scope from options before passthrough
+    # @overload crumby(suffix, options)
+    #   @param [String] suffix passthrough to Crumby::Trail#title
+    #   @param [Hash] options passthrough to Crumby::Trail#title
+    #   @option options [String, Symbol] :scope extract scope from options before passthrough
+    def crumby_title(*args)
+      options = args.extract_options!
+      scope = options.delete(:scope) || :default
+      crumby_trail(scope).title(*args, options)
+    end
+  end
+end