crummy 1.0.0 → 1.0.1

data/README.textile

@@ -22,11 +22,13 @@ Then install the Crummy gem:
   </code>
 </pre>
 
-You can also install it as a Rails plugin:
+h3. Rails 3 / Bundler.
+
+Simply add gem dependency to your Gemfile:
 
 <pre>
   <code>
-    script/plugin install git://github.com/zachinglis/crummy.git
+    gem "crummy", ">= 1.0.1"
   </code>
 </pre>
 
@@ -65,7 +67,7 @@ Then in your view:
   </code>
 </pre>
 
-h2. Options for render_crumb_
+h2. Options for render_crumbs
 
 render_crumbs renders the list of crumbs as either html or xml
 
@@ -106,11 +108,12 @@ h2. Todo
 
 h2. Credits
 
-* "Zach Inglis":http://zachinglis.com
+* "Zach Inglis":http://zachinglis.com of "London Made":http://londonmade.co.uk
 * "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
+* "Max Riveiro":http://github.com/kavu
 
-*Copyright (c) 2008 Zach Inglis, released under the MIT license*
+*Copyright (c) 2010 Zach Inglis, released under the MIT license*

data/Rakefile

@@ -13,6 +13,7 @@ begin
     gem.email = "zach@lt3media.com"
     gem.homepage = "http://github.com/zachinglis/crummy"
     gem.authors = ["Zach Inglis"]
+    gem.files = FileList['lib/**/*.rb','tasks/*.rake','init.rb','MIT-LICENSE','Rakefile','README.textile','VERSION', '.gitignore']
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/init.rb

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

data/lib/crummy.rb

@@ -1,121 +1,10 @@
 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 :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
+  if defined?(Rails::Railtie)
+    require 'crummy/railtie'
+  else
+    require 'crummy/action_controller'
+    require 'crummy/action_view'
+    ActionController::Base.send :include,  Crummy::ControllerMethods 
+    ActionView::Base.send :include, Crummy::ViewMethods
+  end	  
+end

data/lib/crummy/action_controller.rb

@@ -0,0 +1,56 @@
+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
+end

data/lib/crummy/action_view.rb

@@ -0,0 +1,65 @@
+module Crummy
+  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 :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/lib/crummy/railtie.rb

@@ -0,0 +1,18 @@
+require 'crummy'
+require 'rails'
+
+module Crummy
+  class Railtie < Rails::Railtie
+    initializer "crummy.action_controller" do |app|
+      if defined?(ActionController)
+        require 'crummy/action_controller'
+	ActionController::Base.send :include,  Crummy::ControllerMethods 
+      end
+    end
+    
+    initializer "crummy.action_view" do |app|
+      require 'crummy/action_view'
+      ActionView::Base.send :include, Crummy::ViewMethods
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crummy
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Zach Inglis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-10 00:00:00 +01:00
+date: 2010-11-26 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -33,18 +33,19 @@ files:
 - README.textile
 - Rakefile
 - VERSION
-- crummy.gemspec
 - init.rb
 - lib/crummy.rb
-- rails/init.rb
+- lib/crummy/action_controller.rb
+- lib/crummy/action_view.rb
+- lib/crummy/railtie.rb
 - tasks/crummy_tasks.rake
 has_rdoc: true
 homepage: http://github.com/zachinglis/crummy
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/crummy.gemspec

@@ -1,46 +0,0 @@
-# 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{crummy}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Zach Inglis"]
-  s.date = %q{2010-09-10}
-  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",
-     "crummy.gemspec",
-     "init.rb",
-     "lib/crummy.rb",
-     "rails/init.rb",
-     "tasks/crummy_tasks.rake"
-  ]
-  s.homepage = %q{http://github.com/zachinglis/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/rails/init.rb

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