breadcrumb 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Marcelo Guilherme Jacobus Jr <marcelo.jacobus@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+= Breadcrumb
+
+= Instalation
+Put the following line in your Gemfile  
+  gem "breadcrumb", :git => "git@github.com:mjacobus/Breadcrumb.git"
+  
+= Usage
+
+Layout:
+  <%= raw breadcrumb %>
+  
+You can add a root path by doing this
+  
+  <%= raw breadcrumb.prepend("Home","/") %>
+  
+In your view (say the uri path is /books/religion/the-holly-bible):
+  <%
+  breadcrumb.add("Books","/books")
+  breadcrumb.add("Religion", books_category_path(@book.category))
+  breadcrumb.add(@book.title)
+  %>
+
+It will render
+  <div class="breadcrumb">
+    <a href="/books">Books</a>
+    <span class="separator"> » </span>
+    <a href="/books/religion">Religion</a>
+    <span class="separator"> » </span>
+    <span>The Holly Bible</span>
+  </div>
+
+You can change the separator
+  breadcrumb.separator = '<span class="separator"> &gt; </span>'
+
+Titleizing
+You can use breadcrumb for creating the page title:
+  <title><%= breadcrumb.titleize %></title>
+  
+which will ouput
+  <title>Books :: Religion :: The Holly Bible</title>
+  
+Titleize accepts block. When using blocks, returning false removes the title part. Returing nil, won't change the behavior. Returning String changes the title part.
+  <title><%= breadcrumb.titleize {|part| "Our Awesome Books" if parts == 'Books' } %></title>
+Ouputs
+  <title>Our Awesome Books :: Religion :: The Holly Bible</title>
+
+Removing the title part
+  <title><%= breadcrumb.titleize {|part| false if part == "Religion" } %></title>
+or
+  <title><%= breadcrumb.titleize {|part, order| false if order == 1 } %></title>
+Outputs
+  <title>Books :: The Holly Bible</title>
+  
+And you can change the title separator:
+  breadcrumb.title_separator = '-'

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Breadcrumb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/breadcrumb/helper.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+module Breadcrumb
+  class Helper
+
+    # get parts
+    def parts
+      @parts ||= []
+    end
+
+    # add breadcrumb
+    def add(label, url = nil)
+      parts << [label, url]
+      self
+    end
+
+    # prepend elements to the breadcrumb
+    def prepend(label, url = nil)
+      parts.prepend([label, url])
+      self
+    end
+
+    # set title separator
+    def separator=(separator)
+      @separator = separator
+      self
+    end
+
+    def separator
+      @separator ||= '<span class="separator"> » </span>'
+    end
+
+    def to_s
+      html = []
+      parts.each do |part|
+        if part == parts.last
+          html << "<span>#{part[0]}</span>"
+        else
+          html << "<a href=\"#{part[1]}\">#{part[0]}</a>"
+        end
+      end
+
+      html.length > 1 ? "<div class=\"breadcrumb\">#{html.join(separator)}</div>" : ""
+    end
+
+    # Given
+    #   add 'Home','/'
+    #   add 'News','/news'
+    #   add 'The Last News','news/the-last-news'
+    #
+    #   titleize 'Home :: News :: The Last News'
+    #
+    # with block given
+    # when block returns not nil, not false, uses return as title part
+    #
+    #   titleize {|part| Example.com if part == 'Home'}  'Example.com :: News :: The Last News'
+    #
+    # when returns nil, uses default title part
+    # when returns false, skips part
+    #   titleize {|part, order| false if order == 0 }  'News :: The Last News'
+    def titleize(&block)
+      title_parts = []
+      order = 0
+      parts.each do |part|
+
+        if block_given?
+          response = yield(part.first,order)
+          if response != false
+            if response == nil
+              title_parts << part.first
+            else
+              title_parts << response
+            end
+          end
+        else
+          title_parts << part.first
+        end
+        order += 1
+      end
+      title_parts.join(title_separator)
+    end
+
+    # set title separator
+    def title_separator=(separator)
+      @title_separator = separator
+      self
+    end
+
+    def title_separator
+      @title_separator ||= ' :: '
+    end
+
+  end # end of class
+end
+

data/lib/breadcrumb/version.rb

@@ -0,0 +1,3 @@
+module Breadcrumb
+  VERSION = "0.0.2"
+end

data/lib/breadcrumb.rb

@@ -0,0 +1,9 @@
+require "breadcrumb/helper"
+
+module Breadcrumb
+  def breadcrumb
+    @breadcrumb_helper ||= Breadcrumb::Helper.new
+  end
+end
+
+ActionView::Base.send :include, Breadcrumb

data/lib/tasks/breadcrumb_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :breadcrumb do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Breadcrumb Helper
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/breadcrumb_tasks.rake
+- lib/breadcrumb.rb
+- lib/breadcrumb/version.rb
+- lib/breadcrumb/helper.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/mjacobus/breadcrumb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Breadcrumb Helper
+test_files: []