loaf 0.1.1 → 0.2.0

data/lib/loaf/{filters.rb → controller_extensions.rb}

@@ -1,13 +1,20 @@
+# encoding: utf-8
+
 module Loaf
-  module Filters
+  module ControllerExtensions
 
-    Crumb = Struct.new(:name, :url, :styles)
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+      base.send :helper_method, :_breadcrumbs
+    end
 
     module ClassMethods
 
       def add_breadcrumb(name, url, options = {})
         before_filter(options) do |instance|
-          instance.send(:add_breadcrumb, _normalize_name(name), url)
+          # instance.send(:add_breadcrumb, _normalize_name(name), url)
+          instance.send(:add_breadcrumb, name, url, options)
         end
       end
 
@@ -49,8 +56,8 @@ module Loaf
         end
       end
 
-      def add_breadcrumb(name, url)
-        _breadcrumbs << Crumb.new(name, url)
+      def add_breadcrumb(name, url, options={})
+        _breadcrumbs << Loaf::Crumb.new(name, url)
       end
 
       def _breadcrumbs
@@ -69,11 +76,5 @@ module Loaf
 
     end # InstanceMethods
 
-    def self.included(base)
-      base.extend ClassMethods
-      base.send :include, InstanceMethods
-      base.send :helper_method, :_breadcrumbs
-    end
-
-  end # Filters
+  end # ControllerExtensions
 end # Loaf

data/lib/loaf/crumb.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Loaf
+  # Basic crumb container
+  Crumb = Struct.new(:name, :url, :styles)
+end # Loaf

data/lib/loaf/crumb_formatter.rb

@@ -0,0 +1,20 @@
+module Loaf
+  module CrumbFormatter
+
+    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]'
+      end
+    end
+
+  end # CrumbFormatter
+end # Loaf

data/lib/loaf/railtie.rb

@@ -1,19 +1,28 @@
-module Loaf
+# encoding: utf-8
+
+require 'action_controller'
+require 'action_view'
 
+module Loaf
   if defined? Rails::Railtie
     class Railtie < Rails::Railtie
       initializer "loaf.extend_action_controller_base" do |app|
-        ActiveSupport.on_load(:action_controller) do
-          Loaf::Railtie.insert
+        ActiveSupport.on_load :action_controller do
+          Loaf::Railtie.insert_controller
+          Loaf::Railtie.insert_view
         end
       end
     end
   end
 
   class Railtie
-    def self.insert
-      ActionController::Base.send :include, Loaf::Filters 
-      ActionController::Base.helper Loaf::Helpers
+    class << self
+      def insert_view
+        ActionController::Base.helper Loaf::ViewExtensions
+      end
+      def insert_controller
+        ActionController::Base.send :include, Loaf::ControllerExtensions
+      end
     end
   end # Railtie
 

data/lib/loaf/translation.rb

@@ -1,15 +1,24 @@
 module Loaf
   module Translation
-    
-    def set_title!
-      namespace = controller.controller_path.gsub("/", ".")
-      action = controller.action_name
-      
-      i18n_options = {
+    extend self
 
-      }
+    # Returns translation lookup
+    def i18n_scope
+      :breadcrumbs
+    end
+
+    # Accepts <tt>:scope</tt> parameter.
+    def breadcrumb_title(title, options={})
+      defaults  = []
+      parts     = title.to_s.split('.', 2)
+      actions   = parts.pop
+      namespace = parts.pop
+
+      defaults << :"#{self.i18n_scope}.#{title}"
+      defaults << options.delete(:default) if options[:default]
 
-      I18n.t(title, i18n_options)
+      options.reverse_merge! :count => 1, :default => defaults
+      I18n.t(title, options)
     end
-  end
+  end # Translation
 end # Loaf

data/lib/loaf/version.rb

@@ -1,8 +1,10 @@
+# encoding: utf-8
+
 module Loaf
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/lib/loaf/view_extensions.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'loaf/crumb_formatter'
+
+module Loaf
+  module ViewExtensions
+    include Loaf::CrumbFormatter
+
+    # Adds breadcrumbs in a view.
+    #
+    def add_breadcrumb(name, url)
+      _breadcrumbs.push(name, url)
+    end
+
+    # Renders breadcrumbs inside view.
+    #
+    def breadcrumbs(options={}, &block)
+      #builder = Loaf::Builder.new(options)
+      options = Loaf.config.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]}" : ''
+
+        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 # ViewExtensions
+end # Loaf

data/loaf.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'loaf/version'
+
+Gem::Specification.new do |s|
+  s.name        = "loaf"
+  s.version     = Loaf::Version::STRING.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.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'
+end

data/spec/integration/configuration_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'setting configuration options' do
+
+  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
+    end
+  end
+end

data/spec/integration/crumbs_routing_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+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
+    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
+    end
+
+    it 'should' do
+      visit new_post_path
+      within '#breadcrumbs' do
+        page.should have_content 'All Posts'
+        page.should have_content 'New Post'
+      end
+    end
+  end
+end

data/spec/integration/nested_crumbs_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'nested resources' do
+
+end

data/spec/loaf/crumb_formatter_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Loaf::CrumbFormatter do
+
+  let(:formatter) { stub.extend(described_class) }
+  let(:crumb) { Loaf::Crumb.new('some randome name', stub) }
+
+  context '#format_name' do
+    it 'does not capitalize by default' do
+      formatted = formatter.format_name(crumb)
+      formatted.should eql 'some randome name'
+    end
+
+    it 'capitalizes crumb name' do
+      formatted = formatter.format_name(crumb, :capitalize => true)
+      formatted.should eql 'Some randome name'
+    end
+
+    it 'shortens crumb to provided length' do
+      name = 'very long name that is more that 30 characters long'
+      crumb = Loaf::Crumb.new(name, stub)
+      formatter.should_receive(:truncate).with(name, :length => 30).
+        and_return name[0..30]
+      formatter.format_name(crumb, :crumb_length => 30).should eql name[0..30]
+    end
+
+    it 'returns name error if breadcrumb name is nil' do
+      crumb = Loaf::Crumb.new('', stub)
+      formatter.format_name(crumb).should eql '[name-error]'
+    end
+  end
+
+end # Loaf::CrumbFormatter

data/spec/loaf/translation_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Loaf::Translation do
+
+  before do
+    I18n.backend = I18n::Backend::Simple.new
+  end
+
+  it 'translates breadcrumb title' do
+    I18n.backend.store_translations 'en', :breadcrumbs => { :home => 'Home'}
+    described_class.breadcrumb_title('breadcrumbs.home').should eql 'Home'
+  end
+
+  it 'translates breadcrumb name with default scope' do
+    I18n.backend.store_translations 'en', :breadcrumbs => { :home => 'Home'}
+    described_class.breadcrumb_title('home').should eql 'Home'
+  end
+
+  it 'translates breadcrumb name using default option' do
+    described_class.breadcrumb_title('home', :default => 'breadcrumb default name').should eql 'breadcrumb default name'
+  end
+
+end # Loaf::Translation

data/spec/loaf_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Loaf" do
+
+end # Loaf

data/spec/rails_app/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/spec/rails_app/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+RailsApp::Application.load_tasks

data/spec/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/rails_app/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  add_breadcrumb 'Home', 'root_path'
+end

data/spec/rails_app/app/controllers/comments_controller.rb

@@ -0,0 +1,4 @@
+class CommentsController < ApplicationController
+  def index
+  end
+end

data/spec/rails_app/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/rails_app/app/controllers/posts_controller.rb

@@ -0,0 +1,12 @@
+class PostsController < ApplicationController
+
+  add_breadcrumb 'All Posts', :posts_path
+
+  def index
+  end
+
+  def new
+    add_breadcrumb 'New Post', 'new_post_path' 
+  end
+
+end

data/spec/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/rails_app/app/views/home/index.html.erb

@@ -0,0 +1 @@
+<h1>Home page</h1>