loaf 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -0,0 +1,56 @@
+= 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.  
+
+== 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.
+
+== Usage
+
+In controller:
+
+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>
+      <%- end -%>
+    </ul>
+
+== TODO
+
+* Add ability to add breadcrumbs for nested resources
+* Add support for name internationalisation
+* 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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/loaf/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "loaf"
+  gem.homepage = "http://github.com/peter-murach/loaf"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "pmurach@gmail.com"
+  gem.authors = ["Piotr Murach"]
+  gem.version = Loaf::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "loaf #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/loaf/builder.rb

@@ -0,0 +1,38 @@
+module Loaf
+  class Builder
+
+    attr_accessor :crumbs
+
+    def initialize(view_context, collection, options = {})
+
+      @params = default_options.merge(options)
+
+      set_breadcrumbs
+
+      build @params
+    end
+
+  private
+
+    def set_breadcrumbs(breadcrumbs)
+      @params[:breadcrumbs] = breadcrumbs
+    end
+
+    def build
+      @params.each_pair do |option, value|
+
+      end
+    end
+
+    def default_options
+      { 
+        :breadcrumbs => [],
+        :delimiter => " &raquo ",
+        :style_class => 'selected',
+        :crumb_length => '30',
+        :last_crumb_linked => false
+      }
+    end
+
+  end # Builder
+end # Loaf

data/lib/loaf/configuration.rb

@@ -0,0 +1,43 @@
+module Loaf
+  module Configuration
+
+    VALID_ATTRIBUTES = [
+      :locales_path,
+      :style_classes,
+      :crumb_length,
+      :last_crumb_linked,
+      :capitalize
+    ]
+
+    attr_accessor *VALID_ATTRIBUTES
+
+    DEFAULT_LOCALES_PATH = "/"
+    
+    DEFAULT_STYLE_CLASSES = 'selected'
+
+    DEFAULT_CRUMB_LENGTH = 30
+
+    DEFAULT_LAST_CRUMB_LINKED = false
+
+    DEFAULT_CAPITALIZE = false
+
+    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)
+      VALID_ATTRIBUTES.each do |attr|
+        send("#{attr}=", parent.const_get("DEFAULT_#{attr.to_s.upcase}"))
+      end
+    end
+    
+  end # Configuration
+end # Loaf

data/lib/loaf/filters.rb

@@ -0,0 +1,68 @@
+module Loaf
+  module Filters
+
+    Crumb = Struct.new(:name, :url, :styles)
+
+    module ClassMethods
+
+      def add_breadcrumb(name, url, options = {})
+        before_filter(options) do |instance|
+          instance.send(:add_breadcrumb, _normalize_name(name), url)
+        end
+      end
+
+      private
+
+      def _normalize_name(name=nil)
+        case name
+        when NilClass
+        when Proc
+          name.call
+        when Symbol
+          name.to_s
+        else
+          name
+        end
+      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 + ')' )
+        end
+      end
+
+      def add_breadcrumb(name, url)
+        _breadcrumbs << Crumb.new(name, url)
+      end
+
+      def _breadcrumbs
+        @_breadcrumbs ||= []
+      end
+
+      def clear_crumbs
+        _breadcrumbs.clear
+      end
+
+    end # InstanceMethods
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+      base.send :helper_method, :_breadcrumbs
+    end
+
+  end # Filters
+end # Loaf

data/lib/loaf/helpers.rb

@@ -0,0 +1,32 @@
+require 'loaf/configuration'
+
+module Loaf
+  module Helpers
+    
+    class_eval do
+      define_method :config do |options|
+        Loaf.config
+      end
+    end
+
+    # Adds breadcrumbs in a view
+    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)
+        styles = ( request.request_uri.split('?')[0] == url ? "#{options[:style_classes]}" : '' )
+       
+        block.call(name, url, styles)
+      end
+    end
+
+  end # Helpers
+end # Loaf

data/lib/loaf/railtie.rb

@@ -0,0 +1,20 @@
+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
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActionController::Base.send :include, Loaf::Filters 
+      ActionController::Base.helper Loaf::Helpers
+    end
+  end # Railtie
+
+end # Loaf

data/lib/loaf/translation.rb

@@ -0,0 +1,15 @@
+module Loaf
+  module Translation
+    
+    def set_title!
+      namespace = controller.controller_path.gsub("/", ".")
+      action = controller.action_name
+      
+      i18n_options = {
+
+      }
+
+      I18n.t(title, i18n_options)
+    end
+  end
+end # Loaf

data/lib/loaf/version.rb

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

data/lib/loaf.rb

@@ -0,0 +1,16 @@
+require 'action_controller'
+require 'loaf/configuration'
+
+module Loaf
+  if defined? Rails::Railtie
+    require 'loaf/railtie'
+  else
+    autoload :Filters, 'loaf/filters'
+    autoload :Helpers, 'loaf/helpers'
+
+    ::ActionController::Base.send :include, Loaf::Filters
+    ::ActionController::Base.helper Loaf::Helpers
+  end
+
+  extend Configuration
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: loaf
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  version_requirements: *id006
+description: 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.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/loaf/builder.rb
+- lib/loaf/configuration.rb
+- lib/loaf/filters.rb
+- lib/loaf/helpers.rb
+- lib/loaf/railtie.rb
+- lib/loaf/translation.rb
+- lib/loaf/version.rb
+- lib/loaf.rb
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/peter-murach/loaf
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Loaf is a breadcrumb managing gem.
+test_files: []
+