caveman-crummy 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+rdoc
+pkg
+crummy.gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,118 @@
+h1. Crummy
+
+h2. Introduction
+
+Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
+
+h2. Install
+
+The gem is hosted on gemcutter, so if you haven’t already, add it as a gem source:
+
+<pre>
+  <code>
+    gem sources -a http://gemcutter.org/
+  </code>
+</pre>
+
+Then install the Crummy gem:
+
+<pre>
+  <code>
+    gem install crummy
+  </code>
+</pre>
+
+You can also install it as a Rails plugin:
+
+<pre>
+  <code>
+    script/plugin install git://github.com/zachinglis/crummy.git
+  </code>
+</pre>
+
+h2. Example
+
+In your controllers you may add_crumb either like a before_filter or within a method (It is also available to views).
+
+<pre>
+  <code>
+    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"
+  
+      def show
+        add_crumb @business.display_name, @business
+      end
+      
+      def load_comment
+        @comment = Comment.find(params[:id])
+      end
+    end
+  </code>
+</pre>
+
+Then in your view:
+
+<pre>
+  <code>
+    <%= render_crumbs %>
+  </code>
+</pre>
+
+h2. Options for render_crumb_
+
+render_crumbs renders the list of crumbs as either html or xml
+
+It takes 3 options
+
+The output format. Can either be :xml or :html. Defaults to :html
+
+<code>:format => (:html|:xml|:html_with_list)</code>
+
+The seperator text. It does not assume you want spaces on either side so you must specify. Defaults to <code>&raquo;</code> for :html and <code><crumb></code> for :xml
+
+<code>:seperator => string</code>
+
+Render links in the output. Defaults to +true+
+
+<code>:link => boolean</code>        
+
+h3. Examples
+
+<pre>
+ <code>
+  render_crumbs                     #=> <a href="/">Home</a> &raquo; <a href="/businesses">Businesses</a>
+  render_crumbs :seperator => ' | ' #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
+  render_crumbs :format => :xml     #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+  render_crumbs :seperator => ' > ', :format => :html_with_list 
+  #=> <ul class="breadcrumb"><li><a href="/">Home</a></li><li><a href="/businesses">Businesses</a></li></ul>
+ </code>
+</pre>
+A crumb with a nil link will just output plain text.
+
+h2. Notes
+
+The variable set is set to @_crumbs as to not conflict with your code.
+
+h2. Todo
+
+* Port over rspecs from project to plugin (Fully tested in a project)
+* Accept instances of models as a single argument
+* Allow for variables in names. (The workaround is to do your own before_filter for that currently)
+
+h2. Credits
+
+* "Zach Inglis":http://zachinglis.com
+* "Rein Henrichs":http://reinh.com
+* "Les Hill":http://blog.leshill.org/
+* "Sandro Turriate":http://turriate.com/
+* "Przemysław Kowalczyk":http://szeryf.wordpress.com/2008/06/13/easy-and-flexible-breadcrumbs-for-rails/ - feature ideas
+* "Sharad Jain":http://github.com/sjain
+
+*Copyright (c) 2008 Zach Inglis, released under the MIT license*

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "caveman-crummy"
+    gem.summary = %Q{Tasty breadcrumbs!}
+    gem.description = %Q{Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.}
+    gem.email = "zach@lt3media.com"
+    gem.homepage = "http://github.com/caveman/crummy"
+    gem.authors = ["Zach Inglis", "Randall Chin"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+desc 'Test the crummy plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  gem 'hanna'
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+desc 'Generate documentation for the crummy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Crummy: Tasty Breadcrumbs'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/caveman-crummy.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{caveman-crummy}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zach Inglis", "Randall Chin"]
+  s.date = %q{2010-08-31}
+  s.description = %q{Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.}
+  s.email = %q{zach@lt3media.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "caveman-crummy-0.1.0.gem",
+     "caveman-crummy.gemspec",
+     "init.rb",
+     "lib/crummy.rb",
+     "rails/init.rb",
+     "tasks/crummy_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/caveman/crummy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Tasty breadcrumbs!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+ActionController::Base.send :include, Crummy::ControllerMethods
+ActionView::Base.send       :include, Crummy::ViewMethods

data/lib/crummy.rb

@@ -0,0 +1,130 @@
+module Crummy
+  module ControllerMethods
+    module ClassMethods
+      # Add a crumb to the crumbs array.
+      #
+      #   add_crumb("Home", "/")
+      #   add_crumb("Business") { |instance| instance.business_path }
+      #
+      # Works like a before_filter so +:only+ and +except+ both work.
+      def add_crumb(name, *args)
+        options = args.extract_options!
+        url = args.first
+        raise ArgumentError, "Need more arguments" unless name or options[:record] or block_given?
+        raise ArgumentError, "Cannot pass url and use block" if url && block_given?
+        before_filter(options) do |instance|
+          url = yield instance if block_given?
+          url = instance.send url if url.is_a? Symbol
+          record = instance.instance_variable_get("@#{name}") unless url or block_given?
+          if record and record.respond_to? :to_param
+            name, url = record.to_s, instance.url_for(record)
+          end
+        
+          # FIXME: url = instance.url_for(name) if name.respond_to?("to_param") && url.nil?
+          # FIXME: Add ||= for the name, url above
+          instance.add_crumb(name, url)
+        end
+      end
+    end
+
+    module InstanceMethods
+      # Add a crumb to the crumbs array.
+      #
+      #   add_crumb("Home", "/")
+      #   add_crumb("Business") { |instance| instance.business_path }
+      #
+      def add_crumb(name, url=nil)
+        crumbs.push [name, url]
+      end
+
+      # Lists the crumbs as an array
+      def crumbs
+        get_or_set_ivar "@_crumbs", []
+      end
+
+      def get_or_set_ivar(var, value) # :nodoc:
+        instance_variable_set var, instance_variable_get(var) || value
+      end
+      private :get_or_set_ivar
+    end
+
+    def self.included(receiver) # :nodoc:
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+  
+  module ViewMethods
+    # List the crumbs as an array
+    def crumbs
+      @_crumbs ||= [] # Give me something to push to
+    end
+    
+    # Add a crumb to the +crumbs+ array
+    def add_crumb(name, url=nil)
+      crumbs.push [name, url]
+    end
+    
+    # Render the list of crumbs as either html or xml
+    #
+    # Takes 3 options:
+    # The output format. Can either be xml or html. Default :html
+    #   :format => (:html|:xml) 
+    # The seperator text. It does not assume you want spaces on either side so you must specify. Default +»+ for :html and +crumb+ for xml
+    #   :seperator => string  
+    # Render links in the output. Default +true+
+    #   :link => boolean        
+    # 
+    #   Examples:
+    #   render_crumbs                     #=> <a href="/">Home</a> &raquo; <a href="/businesses">Businesses</a>
+    #   render_crumbs :seperator => ' | ' #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
+    #   render_crumbs :format => :xml     #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+    #   
+    # The only argument is for the seperator text. It does not assume you want spaces on either side so you must specify. Defaults to +&raquo;+
+    #
+    #   render_crumbs(" . ")  #=> <a href="/">Home</a> . <a href="/businesses">Businesses</a>
+    #
+    def render_crumbs(options = {})
+      options[:format] = :html if options[:format] == nil
+      if options[:seperator] == nil
+        options[:seperator] = " &raquo; " if options[:format] == :html 
+        options[:seperator] = "crumb" if options[:format] == :xml 
+      end
+      options[:links] = true if options[:links] == nil
+      case options[:format]
+      when :html
+        crumb_string = crumbs.collect do |crumb|
+          crumb_to_html crumb, options[:links]
+        end * options[:seperator]
+        
+        crumb_string = crumb_string.html_safe if crumb_string.respond_to?(:html_safe)
+        crumb_string
+      when :html_with_list
+        list_items = ''
+        crumbs.each_with_index do |crumb, pos|
+          #append separator unless it is the last item in the list
+          list_item_content = ( pos == crumbs.length-1 ? crumb_to_html(crumb, options[:links]) : crumb_to_html(crumb, options[:links]) + options[:seperator] ) 
+          list_items << content_tag(:li, list_item_content )
+        end
+        content_tag :ul, list_items, :class => 'breadcrumb'
+      when :xml
+        crumbs.collect do |crumb|
+          crumb_to_xml crumb, options[:links], options[:seperator]
+        end * ''
+      else
+        raise "Unknown breadcrumb output format"
+      end
+    end
+    
+    def crumb_to_html(crumb, links)
+      name, url = crumb
+      url && links ? link_to(name, url) : name
+    end
+    
+    def crumb_to_xml(crumb, links, seperator)
+      name, url = crumb
+      url && links ? "<#{seperator} href=\"#{url}\">#{name}</#{seperator}>" : "<#{seperator}>#{name}</#{seperator}>"
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib crummy])
+ActionController::Base.send :include, Crummy::ControllerMethods
+ActionView::Base.send       :include, Crummy::ViewMethods

data/tasks/crummy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :crummy do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: caveman-crummy
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Zach Inglis
+- Randall Chin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-31 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
+email: zach@lt3media.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- caveman-crummy-0.1.0.gem
+- caveman-crummy.gemspec
+- init.rb
+- lib/crummy.rb
+- rails/init.rb
+- tasks/crummy_tasks.rake
+has_rdoc: true
+homepage: http://github.com/caveman/crummy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tasty breadcrumbs!
+test_files: []
+