rails_breadcrumbs 0.5.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Artem Rufanov
+
+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

@@ -0,0 +1,41 @@
+RailsBreadcrumbs
+===================
+
+RailsBreadcrumbs is a gem that implements breadcrumbs.
+
+* The gem supports ruby 1.9.x & rails 3.x
+* The gem allows to create breadcrumbs based on path
+* The gem allows ...
+
+Quick Start
+=======
+In your Gemfile:
+
+  gem "rails_breadcrumbs", ">= 0.5.3"
+
+In your controller:
+
+  before_filter :add_breadcrumbs_by_path
+
+In your views:
+
+  <%= render_breadcrumbs %>
+
+If you wish:
+
+  -Run ruby script/rails generate rails_breadcrumbs to gen resources such as css, sass and png files.
+  -Use config/initiaizers to configure options for this gem
+
+
+Installation
+=======
+
+* Type 'gem install --local rails_breadcrumbs' with root account if you have installed RubyGems.
+
+
+Example
+=======
+
+Example goes here.
+
+Copyright (c) 2011 arufanov, released under the MIT license.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rails_breadcrumbs plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the rails_breadcrumbs plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsBreadcrumbs'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/changelog

@@ -0,0 +1,23 @@
+Introduction:
+To see the latest list of the change log please visit the Change Log page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Don't put separator for root
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Move separator out of link
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Changed item separator from '>' to ' >'
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Added configuratin parameter to show Home string instead of Home icons
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Changelog, roadmap, knownbugs have been created
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / Use include, extend instead of class_eval
+0.5 { Bug Report } [ RailsBreadcrumbs ] / X / home_controller, home_action has been changed to home_path

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'rails_breadcrumbs'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/knownbugs

@@ -0,0 +1,17 @@
+Introduction:
+To see the latest list of the known bugs please visit the Known bugs page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Bug Report } [ AuxiliaryAddons ] / X / There isn't known bugs

data/lib/generators/rails_breadcrumbs/USAGE

@@ -0,0 +1,3 @@
+Description:
+  The rails_breadcrumbs generator creates an home icons at public/breadcrumbs
+  and rails_breadcrumbs css & cass at public/stylesheets/ directory.

data/lib/generators/rails_breadcrumbs/rails_breadcrumbs_generator.rb

@@ -0,0 +1,13 @@
+module RailsBreadcrumbs
+  module Generators
+    class RailsBreadcrumbsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_rails_breadcrumbs
+        copy_file "home.png", "public/images/breadcrumbs/home.png"
+        copy_file "rails_breadcrumbs.css", "public/stylesheets/rails_breadcrumbs.css"
+        copy_file "rails_breadcrumbs.sass", "public/stylesheets/rails_breadcrumbs.sass"
+      end
+    end
+  end
+end

data/lib/generators/rails_breadcrumbs/templates/rails_breadcrumbs.css

@@ -0,0 +1,22 @@
+/* =Breadcrumbs styles
+ * This section contains breadcrumb's styles for markup
+ * <div id="breadcrumbs">
+ *   <span>You are here:</span> <%= render_breadcrumbs %>
+ * </div>
+ */
+#breadcrumbs {
+  float: left; }
+  #breadcrumbs span {
+    float: left;
+    font-size: 120%; }
+  #breadcrumbs ul.breadcrumbs {
+    float: left; }
+    #breadcrumbs ul.breadcrumbs li {
+      border: 1px;
+      float: left; }
+    #breadcrumbs ul.breadcrumbs li.first_breadcrumb_item {
+      border: 1px; }
+    #breadcrumbs ul.breadcrumbs li.last_breadcrumb_item a {
+      font-weight: bold; }
+    #breadcrumbs ul.breadcrumbs li.last_breadcrumb_item span {
+      font-weight: bold; }

data/lib/generators/rails_breadcrumbs/templates/rails_breadcrumbs.sass

@@ -0,0 +1,23 @@
+/* =Breadcrumbs styles
+ * This section contains breadcrumb's styles for markup
+ * <div id="breadcrumbs">
+ *   <span>You are here:</span> <%= render_breadcrumbs %>
+ * </div>
+ */
+#breadcrumbs
+  float: left
+  span
+    float: left
+    font-size: 120%
+  ul.breadcrumbs
+    float: left
+    li
+      border: 1px
+      float: left
+    li.first_breadcrumb_item
+      border: 1px
+    li.last_breadcrumb_item
+      a
+        font-weight: bold
+      span
+        font-weight: bold

data/lib/rails_breadcrumbs/controller_additions.rb

@@ -0,0 +1,64 @@
+#
+module RailsBreadcrumbs
+  module ControllerAdditions
+    # ::Rails.logger.error("...")
+
+    #
+    def self.add_breadcrumb(name, url, options = {})
+      before_filter options do |controller|
+        controller.send(:add_breadcrumb, name, url)
+      end
+    end
+
+    # Add breadcrumb for page
+    def add_breadcrumb name, url = ''
+      @breadcrumbs ||= []
+      url = eval(url) if url =~ /_path|_url|@/
+      @breadcrumbs << [name, url]
+    end
+
+    #
+    def add_breadcrumbs_by_path(names = {}, options = {})
+      options = ::RailsBreadcrumbs.options.merge(options)
+      path_parts = controller_path.split('/')
+      path_parts.each do |segment|
+        link_name = segment.sub('_', ' ').camelcase
+        link_name = names[segment] if names.has_key?(segment)
+        name = I18n.t options[:locale_root] + segment, :default => link_name
+        if segment != path_parts.last
+          route = nil
+          path_parts.each do |temp|
+            route = (route.nil? ? temp: route +'_'+ temp)
+            break if temp == segment
+          end
+          link = send(route + '_path')
+        else
+          link = request.path
+        end
+        add_breadcrumb(name, link)
+      end
+    end
+
+    #
+    def add_breadcrumbs_with_action_by_path(names = {}, options = {})
+      options = ::RailsBreadcrumbs.options.merge(options)
+      path_parts = controller_path.split('/') << action_name
+      path_parts.each do |segment|
+        link_name = segment.sub('_', ' ').camelcase
+        link_name = names[segment] if names.has_key?(segment)
+        name = I18n.t options[:locale_root] + segment, :default => link_name
+        if segment != path_parts.last
+          route = nil
+          path_parts.each do |temp|
+            route = (route.nil? ? temp: route +'_'+ temp)
+            break if temp == segment
+          end
+          link = send(route + '_path')
+        else
+          link = request.path
+        end
+        add_breadcrumb(name, link)
+      end
+    end
+  end
+end

data/lib/rails_breadcrumbs/model_additions.rb

@@ -0,0 +1,6 @@
+#
+module RailsBreadcrumbs
+  module ModelAdditions
+    # ::Rails.logger.error("...")
+  end
+end

data/lib/rails_breadcrumbs/view_additions.rb

@@ -0,0 +1,72 @@
+#
+module RailsBreadcrumbs
+  module ViewAdditions
+    # ::Rails.logger.error("...")
+
+    #
+    # Renders breadcrumbs
+    #
+    #     <ul>
+    #       <li class="first">
+    #         <%=link_to(image_tag("breadcrumbs/home.png", {:alt => "Home", :title => "Home"}), :controller => "/welcome") %> &gt;
+    #       </li>
+    #       <% if @breadcrumbs %>
+    #         <% @breadcrumbs[0..-2].each do |txt, path| %>
+    #           <li>
+    #             <%= link_to(h(txt), path) %> &gt;
+    #           </li>
+    #         <% end %>
+    #         <li>
+    #           <span><%= link_to(h(@breadcrumbs.last.first), @breadcrumbs.last.second) %> </span>
+    #         </li>
+    #       <% end %>
+    #     </ul>
+    #
+    def render_breadcrumbs(options = {})
+      output = ""
+      options = ::RailsBreadcrumbs.options.merge(options)
+
+      # First item is home
+      if options[:include_home_icon]
+        output << content_tag(:li, {:class => "first_breadcrumb_item"}, false) do
+          link_to(image_tag("breadcrumbs/home.png", {:alt => "Home", :title => "Home"}),options[:home_path]) +
+          (@breadcrumbs && @breadcrumbs.size() > 0 ? raw(options[:item_separator]) : "")
+        end
+      end
+
+      # First item is home
+      if options[:include_home_label]
+        output << content_tag(:li, {:class => "first_breadcrumb_item"}, false) do
+          link_to( h(options[:home_label]), options[:home_path]) +
+          (@breadcrumbs && @breadcrumbs.size() > 0 ? raw(options[:item_separator]) : "")
+        end
+      end
+
+      # Midle items
+      if @breadcrumbs
+        @breadcrumbs[0..-2].each do |txt, path|
+          output << content_tag(:li, {:class => "last_breadcrumb_item"}, false) do
+            link_to( h(txt), path) + raw(options[:item_separator])
+          end
+        end
+      end
+
+      # Last item
+      if @breadcrumbs
+        if options[:make_last_item_as_link]
+          output << content_tag(:li, {:class => "last_breadcrumb_item"}, false) do
+            link_to( h(@breadcrumbs.last.first), @breadcrumbs.last.second)
+          end
+        else
+          output << content_tag(:li, {:class => "last_breadcrumb_item"}, false) do
+            content_tag(:span, h(@breadcrumbs.last.first))
+          end
+        end
+      end
+
+      # Return result
+      content_tag('ul', output, {:class => options[:css_class]}, false)
+    end
+
+  end
+end

data/lib/rails_breadcrumbs.rb

@@ -0,0 +1,43 @@
+# Include
+require 'rubygems'
+require 'active_support'
+require 'rails_breadcrumbs/model_additions'
+require 'rails_breadcrumbs/controller_additions'
+require 'rails_breadcrumbs/view_additions'
+
+# = Rails breadcrumbs
+#
+module RailsBreadcrumbs
+  # ::Rails.logger.error("...")
+
+  # default options that can be overridden on the global level
+  @@options = {
+      :locale_root              => 'navigation.breadcrumbs.', #
+      :home_path                => '/welcome',                #
+      :home_label               => 'Home',                    #
+      :item_separator           => ' >',                   #
+      :css_class                => 'breadcrumbs',             #
+      :fist_item_css_class      => 'first_breadcrumb_item',   #
+      :last_item_css_class      => 'last_breadcrumb_item',    #
+      :make_last_item_as_link   => true,                      #
+      :include_home_icon        => true,                      #
+      :include_home_label       => false,                      #
+  }
+  mattr_reader :options
+
+
+  def self.enable_activerecord
+    ActiveRecord::Base.send :include, RailsBreadcrumbs::ModelAdditions
+  end
+
+  def self.enable_actionpack
+    ActionController::Base.send :include, RailsBreadcrumbs::ControllerAdditions
+
+    ActionView::Base.send :include, RailsBreadcrumbs::ViewAdditions
+  end
+end
+
+if defined? Rails
+  RailsBreadcrumbs.enable_activerecord if defined? ActiveRecord
+  RailsBreadcrumbs.enable_actionpack if defined? ActionController
+end

data/rails_breadcrumbs.gemspec

@@ -0,0 +1,17 @@
+require 'date'
+Gem::Specification.new do |s|
+  s.name = %q{rails_breadcrumbs}
+  s.version = "0.5.3"
+  s.date = Date.today.to_s
+  s.summary = %q{RailsBreadcrumbs is a gem that implements breadcrumbs.}
+  s.description = %q{RailsBreadcrumbs is a gem that implements breadcrumbs.}
+  s.author = %q{Artem Rufanov}
+  s.email = %q{developers@majoron.com}
+  s.homepage = %q{http://www.majoron.com/project/rbundle/rails_breadcrumbs}
+  s.files = Dir.glob('**/*') - Dir.glob('distrib/**/*') - Dir.glob('lib/api/**/*') - Dir.glob('doc/*.xpr')
+  s.bindir = 'bin'
+  s.executables = Dir.glob('bin/*').collect {|f| File.basename(f)}
+  s.require_paths << 'doc' << 'examples' << 'lib' << 'test'
+  s.has_rdoc = true
+  s.required_ruby_version = '>= 1.8.7'
+end

data/roadmap

@@ -0,0 +1,19 @@
+Introduction:
+To see the latest list of the roadmap please visit the Roadmap page at www.majoron.com.
+
+Legend:
+Follow notation is used at change log, roadmap and known bugs. Each bug begins with a version,
+then follow category of the bug inside {}. It can be bug report, feature request and etc.
+Then follow component inside []. After follow bug number at bug tracking system between // signs.
+And then follow a short description of the bug.
+
+Example:
+For example bug: "1.0 { Feature Request } [ AntHill ] / 380 / STLport support required" means
+that bug was created for 1.0 version of the AntHill component, bug is feature request with
+380 number at bug tracking system. And bug requires STLPort support implementation.
+
+ Version 0.5
+ -----------
+0.5 { Feature Request } [ RailsBreadcrumbs ] / X / Add tests
+0.5 { Feature Request } [ RailsBreadcrumbs ] / X / Add RailsTie
+

data/spec/lib/rails_breadcrumbs/controller_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RailsBreadcrumbs::ControllerAdditions do
+  it "should define controller additions" do
+    ::RailsBreadcrumbs::ControllerAdditions.should be
+  end
+end

data/spec/lib/rails_breadcrumbs/model_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RailsBreadcrumbs::ModelAdditions do
+  it "should define model additions" do
+    ::RailsBreadcrumbs::ModelAdditions.should be
+  end
+end

data/spec/lib/rails_breadcrumbs/view_additions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RailsBreadcrumbs::ViewAdditions do
+  it "should define view additions" do
+    ::RailsBreadcrumbs::ViewAdditions.should be
+  end
+end

data/spec/lib/rails_breadcrumbs_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RailsBreadcrumbs do
+  it "should define rails" do
+    ::Rails::VERSION::MAJOR.should be
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+ENV["RAILS_ENV"] = "test"
+require 'rubygems'
+require 'rspec'
+require 'action_controller'
+require 'rails_breadcrumbs'
+
+module Rails
+  module VERSION
+    MAJOR = 3
+  end
+end unless defined? Rails
+
+# RailsBreadcrumbs.root = './'
+RAILS_ROOT = './' unless defined?(RAILS_ROOT)
+RAILS_ENV = 'test' unless defined?(RAILS_ENV)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

data/tasks/rails_breadcrumbs_tasks.rake

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

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rails_breadcrumbs
+version: !ruby/object:Gem::Version
+  version: 0.5.3
+  prerelease: 
+platform: ruby
+authors:
+- Artem Rufanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-16 00:00:00.000000000Z
+dependencies: []
+description: RailsBreadcrumbs is a gem that implements breadcrumbs.
+email: developers@majoron.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- changelog
+- init.rb
+- install.rb
+- knownbugs
+- lib/generators/rails_breadcrumbs/rails_breadcrumbs_generator.rb
+- lib/generators/rails_breadcrumbs/templates/home.png
+- lib/generators/rails_breadcrumbs/templates/rails_breadcrumbs.css
+- lib/generators/rails_breadcrumbs/templates/rails_breadcrumbs.sass
+- lib/generators/rails_breadcrumbs/USAGE
+- lib/rails_breadcrumbs/controller_additions.rb
+- lib/rails_breadcrumbs/model_additions.rb
+- lib/rails_breadcrumbs/view_additions.rb
+- lib/rails_breadcrumbs.rb
+- MIT-LICENSE
+- rails_breadcrumbs.gemspec
+- Rakefile
+- README
+- roadmap
+- spec/lib/rails_breadcrumbs/controller_additions_spec.rb
+- spec/lib/rails_breadcrumbs/model_additions_spec.rb
+- spec/lib/rails_breadcrumbs/view_additions_spec.rb
+- spec/lib/rails_breadcrumbs_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rails_breadcrumbs_tasks.rake
+- uninstall.rb
+homepage: http://www.majoron.com/project/rbundle/rails_breadcrumbs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- doc
+- examples
+- lib
+- test
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: RailsBreadcrumbs is a gem that implements breadcrumbs.
+test_files: []