gretel 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lasse Bunk
+
+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,73 @@
+Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.
+
+
+== Installation
+
+In Rails 3, in your Gemfile:
+
+  gem 'gretel'
+
+
+== Example
+
+Start by generating initializer:
+
+  $ rails generate gretel breadcrumbs
+
+In <code>config/initializers/breadcrumbs.rb</code>:
+
+  Gretel::Crumbs.layout do
+ 
+    crumb :root do
+      link "Home", root_path
+    end
+ 
+    crumb :projects do
+      link "Projects", projects_path
+    end
+ 
+    crumb :project do |project|
+      link lambda { |project| "#{project.name} (#{project.id.to_s})" }, project_path(project)
+      parent :projects
+    end
+ 
+    crumb :project_issues do |project|
+      link "Issues", project_issues_path(project)
+      parent :project, project
+    end
+ 
+    crumb :issue do |issue|
+      link issue.name, issue_path(issue)
+      parent :project_issues, issue.project
+    end
+
+  end
+
+In <code>app/views/layouts/application.html.erb</code>:
+
+  <%= breadcrumb :pretext => "You are here:",
+                 :separator => ">",
+                 :autoroot => true,
+                 :show_root_alone => true,
+                 :link_last => false %>
+
+In <code>app/views/xx/xx.html.erb</code>:
+
+  <% breadcrumb :issue, @issue %>
+  
+This could also be done in the controller, if you prefer:
+
+  def show
+    @project = Project.find(params[:id])
+    breadcrumb :project, @project
+  end
+
+Options for <code><%= breadcrumb %></code>:
+
+  :pretext          Text to be rendered before breadcrumb, if any. Default: none
+  :separator        Separator between links. Default: &gt;
+  :autoroot         Whether it should automatically link to :root if no root parent is given. Default: false
+  :show_root_alone  Whether it should show :root if this is the only link. Default: false
+  :link_last        Whether the last crumb should be linked to. Default: false
+
+Copyright (c) 2010 Lasse Bunk, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the gretel plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the gretel plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Gretel'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/gretel.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = "gretel"
+  s.version = "1.0.0"
+
+  s.author = "Lasse Bunk"
+  s.email = "lassebunk@gmail.com"
+  s.description = "Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs."
+  s.summary = "Flexible Ruby on Rails breadcrumbs plugin."
+  s.homepage = "http://github.com/lassebunk/gretel"
+  s.files = Dir['**/*']
+end

data/init.rb

@@ -0,0 +1 @@
+ActionController::Base.send :include, Gretel::HelperMethods

data/initializers/breadcrumbs.rb

@@ -0,0 +1,30 @@
+Gretel::Crumbs.layout do
+  
+  # Remember to restart your application after editing this file.
+  
+  # Example crumbs:
+  
+  # crumb :root do
+  #   link "Home", root_path
+  # end
+  
+  # crumb :projects do
+  #   link "Projects", projects_path
+  # end
+  
+  # crumb :project do |project|
+  #   link lambda { |project| "#{project.name} (#{project.id.to_s})" }, project_path(project)
+  #   parent :projects
+  # end
+  
+  # crumb :project_issues do |project|
+  #   link "Issues", project_issues_path(project)
+  #   parent :project, project
+  # end
+  
+  # crumb :issue do |issue|
+  #   link issue.name, issue_path(issue)
+  #   parent :project_issues, issue.project
+  # end
+
+end

data/lib/generators/gretel/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates initializer for Gretel.
+
+Example:
+    rails generate gretel breadcrumbs
+
+    This will create:
+        config/initializers/breadcrumbs.rb

data/lib/generators/gretel/gretel_generator.rb

@@ -0,0 +1,7 @@
+class GretelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def create_initializer
+    copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
+  end
+end

data/lib/generators/gretel/templates/initializer.rb

@@ -0,0 +1,30 @@
+Gretel::Crumbs.layout do
+  
+  # Remember to restart your application after editing this file.
+  
+  # Example crumbs:
+  
+  # crumb :root do
+  #   link "Home", root_path
+  # end
+  
+  # crumb :projects do
+  #   link "Projects", projects_path
+  # end
+  
+  # crumb :project do |project|
+  #   link lambda { |project| "#{project.name} (#{project.id.to_s})" }, project_path(project)
+  #   parent :projects
+  # end
+  
+  # crumb :project_issues do |project|
+  #   link "Issues", project_issues_path(project)
+  #   parent :project, project
+  # end
+  
+  # crumb :issue do |issue|
+  #   link issue.name, issue_path(issue)
+  #   parent :project_issues, issue.project
+  # end
+
+end

data/lib/gretel/crumb.rb

@@ -0,0 +1,9 @@
+module Gretel
+  class Crumb
+    attr_accessor :link, :parent
+    
+    def initialize(link, parent)
+      @link, @parent = link, parent
+    end
+  end
+end

data/lib/gretel/crumbs.rb

@@ -0,0 +1,46 @@
+module Gretel
+  class Crumbs
+    class << self
+      include Rails.application.routes.url_helpers
+      include ActionView::Helpers::UrlHelper
+      def controller # hack because Rails.application.routes.url_helpers needs a controller method
+      end
+      def layout(&block)
+        instance_eval &block
+      end
+      
+      def all
+        @crumbs ||= {}
+      end
+
+      def crumb(name, &block)
+        all[name] = block
+      end
+      
+      def get_crumb(name, object = nil)
+        raise "Crumb '#{name}' not found." unless all[name]
+        
+        @object = object # share the object so we can call it from link() and parent()
+        @link = nil
+        @parent = nil
+        
+        all[name].call(object)
+        Gretel::Crumb.new(@link, @parent)
+      end
+      
+      def link(text, url)
+        text = text.call(@object) if text.is_a?(Proc)
+        url = url.call(@object) if url.is_a?(Proc)
+        
+        @link = Gretel::Link.new(text, url)
+      end
+      
+      def parent(name, object = nil)
+        name = name.call(@object) if name.is_a?(Proc)
+        object = object.call(@object) if object.is_a?(Proc)
+
+        @parent = Gretel::Parent.new(name, object)
+      end
+    end
+  end
+end

data/lib/gretel/helper_methods.rb

@@ -0,0 +1,59 @@
+module Gretel
+  module HelperMethods
+    include ActionView::Helpers::UrlHelper
+    def controller # hack because ActionView::Helpers::UrlHelper needs a controller method
+    end
+    
+    def self.included(base)
+      base.send :helper_method, :breadcrumb_for, :breadcrumb
+    end
+    
+    def breadcrumb(*args)
+      options = args.extract_options!
+      name, object = args[0], args[1]
+      
+      if name
+        @_breadcrumb_name = name
+        @_breadcrumb_object = object
+      else
+        if @_breadcrumb_name
+          crumb = breadcrumb_for(@_breadcrumb_name, @_breadcrumb_object, options)
+        elsif options[:show_root_alone]
+          crumb = breadcrumb_for(:root, options)
+        end
+      end
+      
+      if crumb && options[:pretext]
+        crumb = options[:pretext].html_safe + " " + crumb
+      end
+      
+      crumb
+    end
+    
+    def breadcrumb_for(*args)
+      options = args.extract_options!
+      link_last = options[:link_last]
+      options[:link_last] = true
+      separator = (options[:separator] || ">").html_safe
+
+      name, object = args[0], args[1]
+      
+      crumb = Crumbs.get_crumb(name, object)
+      out = link_to_if(link_last, crumb.link.text, crumb.link.url)
+      
+      while parent = crumb.parent
+        last_parent = parent.name
+        crumb = Crumbs.get_crumb(parent.name, parent.object)
+        out = link_to(crumb.link.text, crumb.link.url) + " " + separator + " " + out
+      end
+      
+      # TODO: Refactor this
+      if options[:autoroot] && name != :root && last_parent != :root
+        crumb = Crumbs.get_crumb(:root)
+        out = link_to(crumb.link.text, crumb.link.url) + " " + separator + " " + out
+      end
+      
+      out
+    end
+  end
+end

data/lib/gretel/link.rb

@@ -0,0 +1,9 @@
+module Gretel
+  class Link
+    attr_accessor :text, :url
+    
+    def initialize(text, url)
+      @text, @url = text, url
+    end
+  end
+end

data/lib/gretel/parent.rb

@@ -0,0 +1,9 @@
+module Gretel
+  class Parent
+    attr_accessor :name, :object
+    
+    def initialize(name, object)
+      @name, @object = name, object
+    end
+  end
+end

data/test/gretel_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class GretelTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: gretel
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Lasse Bunk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-10 00:00:00 Z
+dependencies: []
+
+description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.
+email: lassebunk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- gretel.gemspec
+- init.rb
+- initializers/breadcrumbs.rb
+- lib/generators/gretel/gretel_generator.rb
+- lib/generators/gretel/templates/initializer.rb
+- lib/generators/gretel/USAGE
+- lib/gretel/crumb.rb
+- lib/gretel/crumbs.rb
+- lib/gretel/helper_methods.rb
+- lib/gretel/link.rb
+- lib/gretel/parent.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/gretel_test.rb
+- test/test_helper.rb
+homepage: http://github.com/lassebunk/gretel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.8.10
+signing_key: 
+specification_version: 3
+summary: Flexible Ruby on Rails breadcrumbs plugin.
+test_files: []
+