gretel-erb 1.0.8

data/lib/generators/gretel/initializer_generator.rb

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

data/lib/generators/gretel/new_generator.rb

@@ -0,0 +1,13 @@
+module Gretel
+  module Generators
+    class NewGenerator < Rails::Generators::NamedBase
+
+      # this generator simply runs our two other generators (wrapping what
+      # would otherwise be 2 invocations into 1)
+      def run_all
+        generate("gretel:initializer", file_name)
+        generate("gretel:partial")
+      end
+    end
+  end
+end

data/lib/generators/gretel/partial_generator.rb

@@ -0,0 +1,17 @@
+module Gretel
+  module Generators
+    class PartialGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_partial
+        copy_file "_gretel_breadcrumb.html.erb", "app/views/common/_gretel_breadcrumb.html.erb"
+      end
+
+      def copy_assets
+        copy_file "breadcrumb.css.erb", "app/assets/stylesheets/common/breadcrumb.css.erb"
+        copy_file "images/breadcrumb_bg.png", "app/assets/images/common/breadcrumb/breadcrumb_bg.png"
+        copy_file "images/breadcrumb_separator.png", "app/assets/images/common/breadcrumb/breadcrumb_separator.png"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+Gretel::Crumbs.layout do
+  
+  # Remember to restart your application after editing this file.
+
+  # Declare the path to your custom breadcrumb partial template (optional):
+  # template 'common/gretel_breadcrumb.html.erb'
+  
+  # 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-erb.rb

@@ -0,0 +1,7 @@
+require 'gretel-erb/crumb'
+require 'gretel-erb/crumbs'
+require 'gretel-erb/helper_methods'
+require 'gretel-erb/link'
+require 'gretel-erb/parent'
+
+ActionController::Base.send :include, Gretel::HelperMethods

data/lib/gretel-erb/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-erb/crumbs.rb

@@ -0,0 +1,66 @@
+module Gretel
+  class Crumbs
+    #holds the path (as a string) for the partial that will be used
+    #to render the breadcrumb (should the user set it).
+    #note: the template name should be prefixed with an underscore, and the provided path
+    #should not include this underscore (in accordance with rails' convention for naming and rendering partials)
+    @@template = 'common/gretel_breadcrumb.html.erb' #...the default breadcrumb template
+    class << self
+      def controller # hack because Rails.application.routes.url_helpers needs a controller method
+      end
+      
+      def layout(&block)
+        # needs to be done here because Rails.application isn't set when this file is required
+        self.class.send :include, Rails.application.routes.url_helpers
+        self.class.send :include, ActionView::Helpers::UrlHelper
+        
+        instance_eval &block
+      end
+
+      #functions both as an accessor for the class' template and also
+      #as a setter.  If you want to associate a template with your breadcrumb,
+      #we suggest you add a call to this method in the block you pass to the layout method (above)
+      #and pass it the path (as a string) to the partial you want used for rendering the breadcrumb.
+      def template(*template)
+        @@template = template[0] if template.length > 0
+        @@template
+      end
+      
+      def all
+        @crumbs ||= {}
+      end
+
+      def crumb(name, &block)
+        all[name] = block
+      end
+      
+      def get_crumb(name, *params)
+        raise "Crumb '#{name}' not found." unless all[name]
+        
+        @params = params # share the params so we can call it from link() and parent()
+        @link = nil
+        @parent = nil
+        
+        all[name].call(*params)
+        Gretel::Crumb.new(@link, @parent)
+      end
+      
+      def link(text, url, options = {})
+        text = text.call(*@params) if text.is_a?(Proc)
+        url = url.call(*@params) if url.is_a?(Proc)
+        
+        @link = Gretel::Link.new(text, url, options)
+      end
+      
+      def parent(name, *params)
+        name = name.call(*@params) if name.is_a?(Proc)
+
+        params.each_with_index do |param, i|
+          params[i] = param.call(&@params) if param.is_a?(Proc)
+        end
+
+        @parent = Gretel::Parent.new(name, *params)
+      end
+    end
+  end
+end

data/lib/gretel-erb/helper_methods.rb

@@ -0,0 +1,53 @@
+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, params = args[0], args[1..-1]
+
+        options[:link_last] ||= false
+
+        if name
+          @_breadcrumb_name = name
+          @_breadcrumb_params = params
+          crumbs = breadcrumb_for(@_breadcrumb_name, *@_breadcrumb_params, options)
+        else
+          if @_breadcrumb_name
+            crumbs = breadcrumb_for(@_breadcrumb_name, *@_breadcrumb_params, options)
+          elsif options[:show_root_alone]
+            crumbs = breadcrumb_for(:root, options)
+          end
+        end
+        render_to_string(:partial => Crumbs.template, :locals => {:crumbs => crumbs.reverse, :options => options }, :layout => false).html_safe
+    end
+
+    def breadcrumb_for(*args)
+      options = args.extract_options!
+
+      name, params = args[0], args[1..-1]
+
+      crumb = Crumbs.get_crumb(name, *params)
+      out = [crumb]
+
+      while parent = crumb.parent
+        last_parent = parent.name
+        crumb = Crumbs.get_crumb(parent.name, *parent.params)
+        out << crumb
+      end
+
+      # TODO: Refactor this
+      if options[:autoroot] && name != :root && last_parent != :root
+        crumb = Crumbs.get_crumb(:root)
+        out << crumb
+      end
+      out
+    end
+  end
+end

data/lib/gretel-erb/link.rb

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

data/lib/gretel-erb/parent.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: gretel-erb
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+  prerelease: 
+platform: ruby
+authors:
+- nzaillian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies: []
+description: EOS This is a significant fork of Lasse Bunk's rails gem 'gretel' (http://github.com/lassebunk/gretel)
+  that retains the convenient page hierarchy specification DSL of the original gem,
+  but does all rendering using a user-specifiable partial template.
+email: nzaillian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/gretel/initializer_generator.rb
+- lib/generators/gretel/new_generator.rb
+- lib/generators/gretel/partial_generator.rb
+- lib/generators/gretel/templates/initializer.rb
+- lib/gretel-erb/crumb.rb
+- lib/gretel-erb/crumbs.rb
+- lib/gretel-erb/helper_methods.rb
+- lib/gretel-erb/link.rb
+- lib/gretel-erb/parent.rb
+- lib/gretel-erb.rb
+homepage: http://github.com/nzaillian/gretel-erb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Lasse Bunk's 'gretel' (http://github.com/lassebunk/gretel), but with erb
+  templates for breadcrumb rendering!
+test_files: []