loaf 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,36 +1,51 @@
-= loaf
+= Loaf
 
 Breadcrumbs creation library.
 
-* Helps in creating breadcrumbs. 
-* Uses controllers to specify names and routes for parts of breadcrum trails or collections of breadcrumbs. 
-* Stays out of your way when it comes to markup exposing only single helper method to access breadcrumb data.  
+* Helps in creating breadcrumbs.
+* Uses controllers to specify names and routes for parts of breadcrum trails or collections of breadcrumbs.
+* Stays out of your way when it comes to markup exposing only single helper method to access breadcrumb data.
 
 == Installation
 
 Install from source:
-  
+
   gem install loaf
 
 Add to your Gemfile:
-  
+
   gem 'loaf'
 
 == Configuration
 
-There is small set of custom opinionated defaults. However, to override them in your views just pass an option hash.
+There is small set of custom opinionated defaults. However, to override them in your views just pass an option hash. The following options are valid:
+
+  :crumb_length  # integer, default length is 30 characters
+  :root          # boolean, default is true, displays the home crumb
 
 == Usage
 
 In controller:
 
+  class Blog::CategoriesController < ApplicationController
+
+    add_breadcrumb 'Article Categories', 'blog_categories_path', :only => [:show]
+
+    def show
+      add_breadcrumb "#{@category.title}", 'blog_category_path(@category)'
+    end
+  end
+
 You can add breadcrumbs for nested resources, for instance, article categories:
 
 You can add semantic markup in your view to show breadcrumbs
 
     <ul id="breadcrumbs">
-      <%- breadcrumbs :crumb_length => 5 do |name, url, styles| -%>
-        <li class="<%= styles %>"><%= link_to name, url %></li>
+      <%- breadcrumbs :crumb_length => 20 do |name, url, styles| -%>
+        <li class="<%= styles %>">
+          <%= link_to name, url %>
+          <span><%= styles == 'selected' ? '' : '::' %></span>
+        </li>
       <%- end -%>
     </ul>
 
@@ -41,7 +56,7 @@ You can add semantic markup in your view to show breadcrumbs
 * Finish specs
 
 == Contributing to loaf
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/lib/loaf/configuration.rb

@@ -6,13 +6,14 @@ module Loaf
       :style_classes,
       :crumb_length,
       :last_crumb_linked,
-      :capitalize
+      :capitalize,
+      :root
     ]
 
     attr_accessor *VALID_ATTRIBUTES
 
     DEFAULT_LOCALES_PATH = "/"
-    
+
     DEFAULT_STYLE_CLASSES = 'selected'
 
     DEFAULT_CRUMB_LENGTH = 30
@@ -21,6 +22,8 @@ module Loaf
 
     DEFAULT_CAPITALIZE = false
 
+    DEFAULT_ROOT = true
+
     def configure
       yield self
     end
@@ -38,6 +41,6 @@ module Loaf
         send("#{attr}=", parent.const_get("DEFAULT_#{attr.to_s.upcase}"))
       end
     end
-    
+
   end # Configuration
 end # Loaf

data/lib/loaf/filters.rb

@@ -26,21 +26,26 @@ module Loaf
       end
 
       def _process_url(url)
-        
       end
     end
 
     module InstanceMethods
 
       # Add collection of nested breadcrumbs.
-      def add_breadcrumbs(collection=[], options={})
-        return nil unless collection.is_a? Array
-
-        attr = options[:attr].delete
-        prefix = options[:prefix].delete
-
-        collection.each do |item|
-          add_breadcrumb("#{item.send(attr.to_sym)}", prefix + '(' + item + ')' )
+      # * <tt>collection</tt> - required collection of object for iteration
+      # * <tt>field</tt> - required object attribute name
+      #
+      def add_breadcrumbs(collection, field, options={})
+        namespace = nil
+        item_set = if _check_if_nested collection
+           items = collection.pop
+           namespace = collection
+           items
+        else
+          collection
+        end
+        item_set.each do |item|
+          add_breadcrumb item.send(field.to_sym), [ namespace, item ].flatten.compact
         end
       end
 
@@ -56,6 +61,12 @@ module Loaf
         _breadcrumbs.clear
       end
 
+      private
+
+      def _check_if_nested(collection)
+        collection.last.is_a? Array
+      end
+
     end # InstanceMethods
 
     def self.included(base)

data/lib/loaf/helpers.rb

@@ -2,7 +2,7 @@ require 'loaf/configuration'
 
 module Loaf
   module Helpers
-    
+
     class_eval do
       define_method :config do |options|
         Loaf.config
@@ -13,20 +13,37 @@ module Loaf
     def add_breadcrumb(name, url=nil)
       _breadcrumbs.push(name, url)
     end
-    
+
     def breadcrumbs(options={}, &block)
       #builder = Loaf::Builder.new(options)
       options = config.merge(options)
 
       _breadcrumbs.each do |crumb|
-        
-        name = crumb.name ? truncate(crumb.name.upcase, :length => options[:crumb_length]) : ''
-        url  = eval(crumb.url)
+
+        name = if crumb.name
+          formatted = options[:capitalize] ? crumb.name.capitalize : crumb.name
+          truncate(formatted, :length => options[:crumb_length])
+        else
+          '[name-error]'
+        end
+
+        url = url_for _process_url_for(crumb.url)
+
         styles = ( request.request_uri.split('?')[0] == url ? "#{options[:style_classes]}" : '' )
-       
+
         block.call(name, url, styles)
       end
     end
 
+    private
+
+    def _process_url_for(url)
+      if url.is_a?(String) || url.is_a?(Symbol)
+        return send url
+      else
+        return url
+      end
+    end
+
   end # Helpers
 end # Loaf

data/lib/loaf/version.rb

@@ -2,9 +2,9 @@ module Loaf
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
   end
-end
+end # Loaf

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Piotr Murach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-23 00:00:00 +01:00
+date: 2011-11-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency