crumby 1.1.0

data/lib/crumby/helper/view.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Crumby::Helper
+  # view helper
+  module ViewHelper
+    # render breadcrumb
+    # @see Crumby::Trail#render
+    # @see Crumby::Renderer::Base
+    # @overload crumby(options)
+    #   @param [Hash] options
+    #   @param [Hash] options passthrough to renderer
+    # @overload crumby(scope, options)
+    #   @param [Symbol, String] scope scope of breadcrumb
+    #   @param [Hash] options passthrough to renderer
+    def crumby(*args)
+      options = args.extract_options!
+      scope = args.first || :default
+      crumby_trail(scope).render(self, options)
+    end
+  end
+end

data/lib/crumby/renderer.rb

@@ -0,0 +1,11 @@
+# renderer package
+module Crumby::Renderer
+  autoload :Base, 'crumby/renderer/base'
+  autoload :Haml, 'crumby/renderer/haml'
+
+  # Returns the default renderer
+  # @return [Crumby::Renderer::Base]
+  def self.default_renderer
+    Crumby.renderer
+  end
+end

data/lib/crumby/renderer/base.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Crumby::Renderer
+  # base for renderer
+  # @abstract
+  class Base
+    attr_reader :view, :trail, :options
+
+    def initialize(trail, view, options)
+      @trail = trail
+      @view = view
+      @options = default_options.merge options
+    end
+
+    # render trail
+    # @return [String] rendered trail
+    def render
+      render_list do
+        trail.entries.each do |entry|
+          render_entry(entry)
+        end
+      end
+    end
+
+    # empty default options
+    # @abstract
+    def default_options
+      {}
+    end
+
+    # @abstract
+    def render_list(&block)
+      raise NotImplementedError
+    end
+
+    # @abstract
+    def render_entry(entry)
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/crumby/renderer/haml.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Crumby::Renderer
+  # haml renderer
+  class Haml < Base
+
+    # @return [Hash] default options for this renderer
+    def default_options
+      {
+        divider: "/",
+        link_last: false,
+        link_first: true
+      }
+    end
+
+    # render list by block
+    # the block call render_entry for each entry
+    def render_list(&block)
+      view.capture_haml do
+        view.haml_tag :ul, class: "breadcrumb" do
+          yield
+        end
+      end
+    end
+
+    # render entry
+    # @param [Crumby::Entry] entry that will be rendered
+    def render_entry(entry)
+      view.haml_tag :li, class: (entry.last? ? 'active' : nil) do
+        if entry.route.nil? or (entry.last? and not options[:link_last]) or (entry.first? and not options[:link_first])
+          view.haml_concat entry.label
+        else
+          view.haml_concat view.link_to(entry.label, entry.route)
+        end
+        view.haml_tag "span.divider", options[:divider] unless entry.last?
+      end
+    end
+
+  end
+end

data/lib/crumby/trail.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+module Crumby
+
+  # it represent on breadcrumb trail
+  class Trail
+    attr_reader :entries
+
+    def initialize
+      @entries = []
+    end
+
+    # Returns total entries
+    # @return [Fixnum] total entries
+    def count
+      entries.count
+    end
+
+    # add a new entry
+    # @example
+    #   add :books
+    #   add @book
+    #   add [:admin, @book]
+    #   add "Books", :admin_books
+    #   add "Books", [:admin,:books]
+    #   add "Book", [:admin, @book]
+    #   add "Google", "http://google.de"
+    # @overload render(combined)
+    #   @param [Object] combined
+    # @overload render(label, route)
+    #   @param [String] label the label passthrough to link_to
+    #   @param [Symbol, Array, String] route route passthrough to link_to
+    #
+    # @return [Crumby::Entry] builded entry
+    def add(*args)
+      # extract options
+      options = args.extract_options!
+
+      # call without any arguments
+      raise ArgumentError, "Need arguments." if args.empty?
+
+      # process arguments
+      if args.count == 1
+        value = args.first
+        if value.is_a? String
+          label = value
+        elsif value.is_a? Symbol
+          label = value.to_s.humanize
+          route = value
+        elsif value.respond_to? :model_name
+          label = value.model_name.human
+          route = value
+        elsif value.kind_of? Array
+          if value.last.respond_to? :model_name
+            label = value.last.model_name.human
+          else
+            label = value.last.to_s.humanize
+          end
+          route = value
+        else
+          label = value.to_s.humanize
+        end
+      else
+        label = args.first
+        route = args.second
+      end
+
+      entry = Entry.new(self, count, label, route, options)
+      @entries << entry
+      entry
+    end
+
+    # render the trail by a renderer
+    # @overload render(view, options)
+    #   @param [ActionView::Base] view
+    #   @param [Hash] options passthrough to renderer
+    #   @option options [Class] :renderer overwrite default renderer
+    #
+    # @return [String] rendered trail
+    def render(*args)
+      options = args.extract_options!
+      renderer_class = options[:renderer] || Crumby::Renderer.default_renderer
+      raise ArgumentError if not renderer_class.class == Class or not renderer_class.ancestors.include? Crumby::Renderer::Base
+      view = args.first
+      renderer_class.new(self, view, options).render
+    end
+
+    # build a title of trail e.g. for page title
+    # @example
+    #   title
+    #   title "The Site"
+    #   title "The Site", divider: " - "
+    # @overload title(suffix, options)
+    #   @param [String] suffix last item.
+    #   @param [Hash] options
+    #   @option options [String] :divider The divider. default is " » "
+    #   @option options [Boolean] :reverse reverse the title building. default is true
+    #   @option options [Boolean] :skip_first remove first entry. it is usefull
+    #
+    # @return [String] build title. e.g New Book » Books » Admin
+    def title(*args)
+      options = args.extract_options!
+      suffix = args.first
+
+      default_options = {
+        divider: " » ",
+        reverse: true,
+        skip_first: true
+      }
+      options = default_options.merge args.extract_options!
+
+      title_entries = entries
+      title_entries = title_entries[1..-1] if options[:skip_first]
+
+      title = title_entries.reverse.collect{ |e| e[:label] }
+      title += [suffix] if suffix.present?
+      title.join(options[:divider])
+    end
+
+  end
+
+end

data/spec/crumby/entry_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Crumby::Entry do
+
+  context "#new" do
+    let(:entry_label) { "TestLabel" }
+    let(:entry_route) { :test }
+    let(:entry_options) { { test: true } }
+    let(:trail) { stub :trail }
+
+    subject { Crumby::Entry.new(trail, 1, entry_label, entry_route, entry_options) }
+
+    its(:trail) { should equal trail }
+    its(:position) { should eq 1 }
+    its(:label) { should eq entry_label }
+    its(:route) { should eq entry_route }
+    its(:options) { should eq entry_options }
+  end
+
+  context "on trail with 10 breadcrumb" do
+    let(:trail) { trail = stub :trail, count: 10 }
+
+    context "any breadcrumb" do
+      subject { Crumby::Entry.new trail, 0, "Test" }
+      its(:total) { should eq 10 }
+    end
+
+    context "first breadcrumb" do
+      subject { Crumby::Entry.new trail, 0, "Test" }
+      its(:first?) { should be_true }
+      its(:last?) { should_not be_true }
+    end
+
+    context "last breadcrumb" do
+      subject { Crumby::Entry.new trail, 9, "Test" }
+      its(:first?) { should_not be_true }
+      its(:last?) { should be_true }
+    end
+
+  end
+
+end

data/spec/crumby/helper_spec.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "active_support/all"
+
+# class DummyController
+#   include Crumby::Helper
+# end
+
+# describe Crumby::Helper do
+#   let(:controller) { DummyController.new }
+#   let(:options) { { the_options: true, the_options2: true } }
+
+#   describe "#crumby_trail" do
+
+#     let! (:default_trail) { controller.crumby_trail(:default) }
+#     let! (:different_trail) { controller.crumby_trail(:different) }
+
+#     it "should match default scope with \":default\"" do
+#       controller.crumby_trail(:default).should equal default_trail
+#     end
+
+#     it "should match default scope with \"default\"" do
+#       controller.crumby_trail("default").should equal default_trail
+#     end
+
+#     it "should match diffrent scope with \":diffrent\"" do
+#       controller.crumby_trail(:different).should equal different_trail
+#     end
+
+#     it "should not match default or diffrent scope with \":other\"" do
+#       controller.crumby_trail(:other).should_not equal default_trail
+#       controller.crumby_trail(:other).should_not equal different_trail
+#     end
+
+#   end
+
+#   describe "#add_crumby" do
+
+#     let(:label) { "Name" }
+#     let(:route) { :route }
+
+#     subject { controller.crumby_trail }
+
+#     it "should receive all arguments" do
+#       controller.crumby_trail.should_receive(:add).with(label, route, options)
+#       controller.add_crumby(label, route, options)
+#     end
+
+#     context "with a diffrent scope" do
+#       let(:scope) { :a_different }
+#       subject { controller.crumby_trail(scope) }
+
+#       it "should receive all arguments" do
+#         subject.should_receive(:add).with(label, route, kind_of(Hash))
+#         controller.add_crumby(label, route, scope: scope)
+#       end
+#     end
+#   end
+
+#   describe "#crumby_title" do
+#     let (:trail) { stub :trail, title: stub }
+
+#     before { controller.stub(:crumby_trail).and_return(trail) }
+
+#     context "with default scope" do
+#       context "without suffix" do
+#         after { controller.crumby_title }
+
+#         it "should load default trail" do
+#           controller.should_receive(:crumby_trail).with(:default)
+#         end
+
+#         it "should load title without suffix" do
+#           trail.should_receive(:title).with(kind_of(Hash))
+#         end
+#       end
+
+#       context "with suffix" do
+#         let(:suffix) { "test" }
+#         after { controller.crumby_title suffix }
+
+#         it "should load title with suffix" do
+#           trail.should_receive(:title).with(suffix, kind_of(Hash))
+#         end
+#       end
+
+#       context "with options" do
+#         after { controller.crumby_title options }
+
+#         it "should load title with options" do
+#           trail.should_receive(:title).with(options)
+#         end
+#       end
+
+
+#     end
+
+#     context "with different scope" do
+#       after { controller.crumby_title scope: :test}
+#       it "should load different trail" do
+#         controller.should_receive(:crumby_trail).with(:test)
+#       end
+#     end
+
+#     # it "should call title on trail" do
+#     #   controller.crumby_trail.should_receive(:title).with(options)
+#     #   controller.crumby_title options
+#     # end
+
+#     # context "with a diffrent scope" do
+#     #   let(:scope) { :a_different }
+#     #   subject { controller.crumby_trail(scope) }
+
+#     #   it "should call title on trail" do
+#     #     subject.should_receive(:title).with(any_args, kind_of(Hash))
+#     #     controller.crumby_title(scope, {})
+#     #   end
+#     # end
+
+#   end
+
+#   describe "#crumby" do
+#     let (:renderer) { stub :renderer, render: stub }
+#     let (:trail) { stub :trail, renderer: renderer }
+#     before { controller.stub(:crumby_trail).and_return(trail) }
+
+#     context "with default scope" do
+#       after { controller.crumby }
+
+#       it "should load crumb" do
+#         controller.should_receive(:crumby_trail).with(:default)
+#       end
+#     end
+
+#     context "with :test scope" do
+#       after { controller.crumby :test }
+
+#       it "should load crumb" do
+#         controller.should_receive(:crumby_trail).with(:test)
+#       end
+#     end
+
+#     context "with default renderer" do
+#       after { controller.crumby }
+
+#       it "should call renderer" do
+#         trail.should_receive(:renderer).with(nil)
+#       end
+
+#       it "should call render on renderer with options" do
+#         renderer.should_receive(:render).with(kind_of Hash)
+#       end
+#     end
+
+#     context "with custom renderer" do
+#       after { controller.crumby renderer: renderer, option: true }
+
+#       it "should call renderer" do
+#         trail.should_receive(:renderer).with(renderer)
+#       end
+
+#       it "should call render on renderer with options" do
+#         renderer.should_receive(:render).with(hash_including(option: true))
+#       end
+#     end
+#   end
+
+# end