loaf 0.3.0 → 0.4.0

data/lib/loaf/configuration.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
 
 module Loaf
-  module Configuration
-
+  class Configuration
     VALID_ATTRIBUTES = [
       :locales_path,
       :style_classes,
@@ -12,9 +11,9 @@ module Loaf
       :root
     ]
 
-    attr_accessor *VALID_ATTRIBUTES
+    attr_accessor(*VALID_ATTRIBUTES)
 
-    DEFAULT_LOCALES_PATH = "/"
+    DEFAULT_LOCALES_PATH = '/'
 
     DEFAULT_STYLE_CLASSES = 'selected'
 
@@ -26,28 +25,22 @@ module Loaf
 
     DEFAULT_ROOT = true
 
-    # Sets the Loaf configuration options. Best used by passing a block.
+    # Setup this configuration
     #
-    # Loaf.configure do |config|
-    #   config.capitalize = true
-    # end
-    def configure
-      yield self
-    end
-
-    def self.extended(base)
-      base.setup(self)
-    end
-
-    def config
-      VALID_ATTRIBUTES.inject({}) { |hash, k| hash[k] = send(k); hash }
-    end
-
-    def setup(parent)
+    # @api public
+    def initialize
       VALID_ATTRIBUTES.each do |attr|
-        send("#{attr}=", parent.const_get("DEFAULT_#{attr.to_s.upcase}"))
+        send("#{attr}=", self.class.const_get("DEFAULT_#{attr.to_s.upcase}"))
       end
     end
 
+    # Convert all properties into hash
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def to_hash
+      VALID_ATTRIBUTES.reduce({}) { |acc, k| acc[k] = send(k); acc }
+    end
   end # Configuration
 end # Loaf

data/lib/loaf/controller_extensions.rb

@@ -2,7 +2,9 @@
 
 module Loaf
   module ControllerExtensions
-
+    # Module injection
+    #
+    # @api private
     def self.included(base)
       base.extend ClassMethods
       base.send :include, InstanceMethods
@@ -10,14 +12,16 @@ module Loaf
     end
 
     module ClassMethods
-
+      # @param [String]
+      #
+      # @api public
       def breadcrumb(name, url, options = {})
         before_filter(options) do |instance|
           # instance.send(:add_breadcrumb, _normalize_name(name), url)
-          instance.send(:add_breadcrumb, name, url, options)
+          instance.send(:breadcrumb, name, url, options)
         end
       end
-      alias :add_breadcrumb :breadcrumb
+      alias_method :add_breadcrumb, :breadcrumb
 
       private
 
@@ -32,16 +36,14 @@ module Loaf
           name
         end
       end
-
     end # ClassMethods
 
     module InstanceMethods
-
       # Add collection of nested breadcrumbs.
       # * <tt>collection</tt> - required collection of object for iteration
       # * <tt>field</tt> - required object attribute name
       #
-      def add_breadcrumbs(collection, field, options={})
+      def add_breadcrumbs(collection, field, options = {})
         namespace = nil
         item_set = if _check_if_nested collection
            items = collection.pop
@@ -55,15 +57,28 @@ module Loaf
         end
       end
 
-      def breadcrumb(name, url, options={})
-        _breadcrumbs << Loaf::Crumb.new(name, url)
+      # Add breadcrumb
+      #
+      # @param [String] name
+      #
+      # @param [Object] url
+      #
+      # @api public
+      def breadcrumb(name, url, options = {})
+        _breadcrumbs << Loaf::Crumb.new(name, url, options)
       end
-      alias :add_breadcrumb :breadcrumb
+      alias_method :add_breadcrumb, :breadcrumb
 
+      # Collection of breadcrumbs
+      #
+      # @api private
       def _breadcrumbs
         @_breadcrumbs ||= []
       end
 
+      # Remove all current breadcrumbs
+      #
+      # @api public
       def clear_breadcrumbs
         _breadcrumbs.clear
       end
@@ -73,8 +88,6 @@ module Loaf
       def _check_if_nested(collection)
         collection.last.is_a? Array
       end
-
     end # InstanceMethods
-
   end # ControllerExtensions
 end # Loaf

data/lib/loaf/crumb.rb

@@ -2,5 +2,17 @@
 
 module Loaf
   # Basic crumb container
-  Crumb = Struct.new(:name, :url, :styles)
+  class Crumb
+    attr_reader :name
+
+    attr_reader :url
+
+    attr_reader :force
+
+    def initialize(name, url, options = {})
+      @name  = name
+      @url   = url
+      @force = options.fetch(:force) { false }
+    end
+  end
 end # Loaf

data/lib/loaf/crumb_formatter.rb

@@ -1,20 +1,21 @@
+# encoding: utf-8
+
 module Loaf
+  # A mixin for formatting crumb name
   module CrumbFormatter
+    # @param [String] name
+    #   the name to format
+    #
+    # @api public
+    def format_name(name, options = {})
+      return if name.nil?
 
-    def format_name(crumb, options={})
-      if !crumb.name.blank?
-        formatted = crumb.name
-        formatted = crumb.name.capitalize if options[:capitalize]
-        formatted = if options[:crumb_length]
-          truncate(formatted, :length => options[:crumb_length])
-        else
-          formatted
-        end
-        formatted
-      else
-        '[name-error]'
+      formatted = name.to_s.dup
+      formatted = formatted.capitalize if options[:capitalize]
+      if options[:crumb_length]
+        formatted = truncate(formatted, length: options[:crumb_length])
       end
+      formatted
     end
-
   end # CrumbFormatter
 end # Loaf

data/lib/loaf/options_validator.rb

@@ -3,12 +3,20 @@
 require 'loaf/errors'
 
 module Loaf
+  # A mixin to validate configuration options
   module OptionsValidator
+    # Check if options are valid or not
+    #
+    # @param [Hash] options
+    #
+    # @return [Boolean]
+    #
+    # @api public
     def valid?(options)
       valid_options = Loaf::Configuration::VALID_ATTRIBUTES
       options.each_key do |key|
-        if !valid_options.include?(key)
-          raise Loaf::InvalidOptions.new(key, valid_options)
+        unless valid_options.include?(key)
+          fail Loaf::InvalidOptions.new(key, valid_options)
         end
       end
       true

data/lib/loaf/translation.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Loaf
   module Translation
     extend self
@@ -7,17 +9,22 @@ module Loaf
       :breadcrumbs
     end
 
-    # Accepts <tt>:scope</tt> parameter.
-    def breadcrumb_title(title, options={})
+    # Translate breadcrumb title
+    #
+    # @param [String] :title
+    # @param [Hash] options
+    # @option options [String] :scope
+    #   The translation scope
+    # @option options [String] :default
+    #   The default translation
+    #
+    # @api public
+    def breadcrumb_title(title, options = {})
       defaults  = []
-      parts     = title.to_s.split('.', 2)
-      actions   = parts.pop
-      namespace = parts.pop
-
-      defaults << :"#{self.i18n_scope}.#{title}"
+      defaults << :"#{i18n_scope}.#{title}"
       defaults << options.delete(:default) if options[:default]
 
-      options.reverse_merge! :count => 1, :default => defaults
+      options.reverse_merge! count: 1, default: defaults
       I18n.t(title, options)
     end
   end # Translation

data/lib/loaf/version.rb

@@ -1,12 +1,5 @@
 # encoding: utf-8
 
 module Loaf
-  module Version
-    MAJOR = 0
-    MINOR = 3
-    PATCH = 0
-    BUILD = nil
-
-    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
-  end
+  VERSION = '0.4.0'
 end # Loaf

data/lib/loaf/view_extensions.rb

@@ -4,43 +4,70 @@ require 'loaf/crumb_formatter'
 require 'loaf/options_validator'
 
 module Loaf
+  # A mixin to define view extensions
   module ViewExtensions
     include Loaf::CrumbFormatter
     include Loaf::OptionsValidator
 
+    def initialize(*)
+      @_breadcrumbs ||= []
+      super
+    end
+
+    # Checks to see if any breadcrumbs have been added
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def breadcrumbs?
+      _breadcrumbs.present?
+    end
+
     # Adds breadcrumbs inside view.
     #
-    def breadcrumb(name, url)
-      _breadcrumbs.push Loaf::Crumb.new(name, url)
+    # @param [String] name
+    #   the breadcrumb name
+    # @param [Object] url
+    #   the breadcrumb url
+    # @param [Hash] options
+    #   the breadcrumb options
+    #
+    # @api public
+    def breadcrumb(name, url, options = {})
+      _breadcrumbs << Loaf::Crumb.new(name, url, options)
     end
-    alias :add_breadcrumb :breadcrumb
+    alias_method :add_breadcrumb, :breadcrumb
 
     # Renders breadcrumbs inside view.
     #
-    def breadcrumbs(options={}, &block)
-      #builder = Loaf::Builder.new(options)
-      valid? options
-      options = Loaf.config.merge(options)
+    # @param [Hash] options
+    #
+    # @api public
+    def breadcrumbs(options = {}, &block)
+      # builder = Loaf::Builder.new(options)
+      return enum_for(:breadcrumbs) unless block_given?
+      valid?(options)
+      options = Loaf.configuration.to_hash.merge(options)
       _breadcrumbs.each do |crumb|
-        name = format_name crumb, options
-
-        url = url_for _process_url_for(crumb.url)
-
-        styles = current_page?(url) ? "#{options[:style_classes]}" : ''
-
+        name   = format_name(crumb.name, options)
+        url    = url_for(_process_url_for(crumb.url))
+        styles = ''
+        if current_page?(url) || crumb.force
+          styles << "#{options[:style_classes]}"
+        end
         block.call(name, url, styles)
       end
     end
 
     private
 
+    # @api private
     def _process_url_for(url)
       if url.is_a?(String) || url.is_a?(Symbol)
-        return send url
+        return respond_to?(url) ? send(url) : url
       else
         return url
       end
     end
-
   end # ViewExtensions
 end # Loaf

data/loaf.gemspec

@@ -1,28 +1,21 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'loaf/version'
 
 Gem::Specification.new do |s|
-  s.name        = "loaf"
-  s.version     = Loaf::Version::STRING.dup
-  s.authors     = ["Piotr Murach"]
+  s.name        = 'loaf'
+  s.version     = Loaf::VERSION.dup
+  s.authors     = ['Piotr Murach']
   s.email       = [""]
-  s.homepage    = "https://github.com/peter-murach/loaf"
-  s.summary     = %q{Loaf is a breadcrumb managing gem.}
-  s.description = %q{Loaf helps you manage breadcrumbs in your rails app. It aims to handle crumb data through easy dsl and expose it through view helpers without any assumptions about markup.}
-
-  s.rubyforge_project = "tytus"
+  s.homepage    = 'https://github.com/peter-murach/loaf'
+  s.summary     = %q{Loaf manages and displays breadcrumb trails in your Rails application.}
+  s.description = %q{Loaf manages and displays breadcrumb trails in your Rails app. It aims to handle breadcrumb data through easy dsl and expose it through view helpers without any assumptions about markup.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rails'
-
-  s.add_development_dependency 'rails', '~> 3.1'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'capybara'
-  s.add_development_dependency 'bundler'
+  s.add_dependency 'rails', '>= 3.1'
 end

data/spec/integration/configuration_spec.rb

@@ -1,13 +1,12 @@
-require 'spec_helper'
+# encoding: utf-8
 
-describe 'setting configuration options' do
+require 'spec_helper'
 
-  context 'setting default css style for current crumb' do
-    it "contains 'selected' inside the breadcrumb markup" do
-      visit root_path
-      within '#breadcrumbs' do
-        page.should have_selector('.selected')
-      end
+RSpec.describe 'setting configuration options' do
+  it "contains 'selected' inside the breadcrumb markup" do
+    visit posts_path
+    within '#breadcrumbs' do
+      expect(page).to have_selector('.selected')
     end
   end
 end

data/spec/integration/crumbs_routing_spec.rb

@@ -1,43 +1,46 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
-describe "crumbs routing" do
+RSpec.describe "crumbs routing" do
   include ActionView::TestCase::Behavior
 
-  context 'setting home breadcrumb' do
-    it 'should inherit crumb for the root path' do
-      visit root_path
-      within '#breadcrumbs' do
-        page.should have_content("Home")
-      end
+  it "doens't show empty breadcrumbs" do
+    visit root_path
+    expect(page).to_not have_content("breadcrumbs")
+  end
+
+  it "inherits controller breadcrumb and adds index action breadcrumb" do
+    visit posts_path
+    within '#breadcrumbs' do
+      expect(page.html).to include('<a href="/">Home</a>')
+      expect(page.html).to include('<a href="/posts">All Posts</a>')
     end
   end
 
-  context 'inheriting breadcrumbs setup' do
-    it "should inherit root crumb for index action posts#index" do
-      visit posts_path
-      within '#breadcrumbs' do
-        page.should have_content 'Home'
-        page.should have_content 'All Posts'
-        page.should_not have_content 'New Post'
-      end
+  it 'filters out controller breadcrumb and adds new action breadcrumb' do
+    visit new_post_path
+    within '#breadcrumbs' do
+      expect(page).to_not have_content('Home')
+      expect(page).to have_content('New Post')
     end
+  end
 
-    it 'should inherit and add new action specific breadcrumb' do
-      visit new_post_path
-      within '#breadcrumbs' do
-        page.should have_content 'All Posts'
-        page.should have_content 'New Post'
-      end
+  it "adds breadcrumb in view with path variable" do
+    visit post_path(1)
+    within '#breadcrumbs' do
+      expect(page.html).to include('<a href="/posts/1">Show Post in view</a>')
     end
   end
 
-  context 'adding breadcrumbs within view' do
-    it 'should append view specified breadcrumb' do
-      visit posts_path
-      within '#breadcrumbs' do
-        page.should have_content 'All Posts'
-        page.should have_content 'View Post'
-      end
+  it 'should be current when forced' do
+    visit new_post_path
+    click_button "Create"
+
+    expect(page.current_path).to eq(posts_path)
+    within '#breadcrumbs' do
+      expect(page).to have_content('New Post')
+      expect(page).to have_selector('.selected')
     end
   end
 end