breadcrumbs_on_rails_microdata_builder 0.0.1

data/lib/breadcrumbs_on_rails_microdata_builder/railtie.rb

@@ -0,0 +1,20 @@
+#--
+# Breadcrumbs On Rails
+#
+# A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.
+#
+# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+#++
+
+module BreadcrumbsOnRailsMicrodataBuilder
+
+  class Railtie < Rails::Railtie
+    initializer "breadcrumbs_on_rails_microdata_builder.initialize" do
+    end
+  end
+
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include BreadcrumbsOnRails::ActionController
+end

data/lib/breadcrumbs_on_rails_microdata_builder/version.rb

@@ -0,0 +1,22 @@
+#--
+# Breadcrumbs On Rails
+#
+# A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.
+#
+# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+#++
+
+module BreadcrumbsOnRailsMicrodataBuilder
+
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+
+  VERSION = Version::STRING
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'mocha'
+
+ENV["RAILS_ENV"] = "test"
+
+require "active_support"
+require "action_controller"
+require "rails/railtie"
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'breadcrumbs_on_rails'
+
+ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
+
+BreadcrumbsOnRails::Routes = ActionDispatch::Routing::RouteSet.new
+BreadcrumbsOnRails::Routes.draw do
+  match ':controller(/:action(/:id))'
+end
+
+ActionController::Base.send :include, BreadcrumbsOnRails::Routes.url_helpers

data/test/unit/builder_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+class BuilderTest < ActionView::TestCase
+
+  def setup
+    @template = self
+  end
+
+
+  def test_initialize_should_require_context_and_elements
+    assert_raise(ArgumentError) { BreadcrumbsOnRails::Breadcrumbs::Builder.new }
+    assert_raise(ArgumentError) { BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template) }
+    assert_nothing_raised { BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, []) }
+  end
+
+  def test_initialize_should_allow_options
+    assert_nothing_raised { BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [], {}) }
+  end
+
+  def test_initialize_should_set_context
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    assert_equal(@template, builder.instance_variable_get(:'@context'))
+  end
+
+  def test_initialize_should_set_elements
+    builder= BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [1, 2])
+    assert_equal([1, 2], builder.instance_variable_get(:'@elements'))
+  end
+
+
+  def test_compute_name_with_symbol
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(:method_for_name, nil)
+
+    assert_equal("name from symbol", builder.send(:compute_name, element))
+  end
+
+  def test_compute_name_with_proc
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(proc { |template| template.send(:proc_for_name) }, nil)
+
+    assert_equal("name from proc", builder.send(:compute_name, element))
+  end
+
+  def test_compute_name_with_string
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new("name from string", nil)
+
+    assert_equal("name from string", builder.send(:compute_name, element))
+  end
+
+
+  def test_compute_path_with_symbol
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, :method_for_path)
+
+    assert_equal("http://localhost/#symbol", builder.send(:compute_path, element))
+  end
+
+  def test_compute_path_with_proc
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, proc { |template| template.send(:proc_for_path) })
+
+    assert_equal("http://localhost/#proc", builder.send(:compute_path, element))
+  end
+
+  def test_compute_path_with_hash
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, { :foo => "bar" })
+
+    assert_equal("http://localhost?foo=bar", builder.send(:compute_path, element))
+  end
+
+  def test_compute_path_with_string
+    builder = BreadcrumbsOnRails::Breadcrumbs::Builder.new(@template, [])
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, "http://localhost/#string")
+
+    assert_equal("http://localhost/#string", builder.send(:compute_path, element))
+  end
+
+
+
+  def url_for(params)
+    "http://localhost?" + params.to_param
+  end
+
+  protected
+
+  def method_for_name
+    "name from symbol"
+  end
+
+  def proc_for_name
+    "name from proc"
+  end
+
+  def method_for_path
+    "http://localhost/#symbol"
+  end
+
+  def proc_for_path
+    "http://localhost/#proc"
+  end
+
+end

data/test/unit/element_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class ElementTest < ActiveSupport::TestCase
+
+  def test_initialize_should_require_name_and_path
+    assert_raise(ArgumentError) { BreadcrumbsOnRails::Breadcrumbs::Element.new }
+    assert_raise(ArgumentError) { BreadcrumbsOnRails::Breadcrumbs::Element.new(nil) }
+    assert_nothing_raised { BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, nil) }
+  end
+
+  def test_initialize_should_set_name
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(:homepage, nil)
+    assert_equal :homepage, element.name
+  end
+
+  def test_initialize_should_set_path
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, "/")
+    assert_equal "/", element.path
+  end
+
+  def test_initialize_should_allow_options
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(:homepage, "/", :title => "Go to the Homepage")
+    assert_equal({ :title => "Go to the Homepage" }, element.options)
+  end
+
+
+  def test_name
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, nil)
+    element.name = :the_name
+    assert_equal :the_name, element.name
+  end
+
+  def test_path
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, nil)
+    element.path = { :controller => "index", :action => "index" }
+    assert_equal({ :controller => "index", :action => "index" }, element.path)
+  end
+
+  def test_options
+    element = BreadcrumbsOnRails::Breadcrumbs::Element.new(nil, nil)
+    element.options = { :title => "Go to the Homepage" }
+    assert_equal({ :title => "Go to the Homepage" }, element.options)
+  end
+
+end

data/test/unit/simple_builder_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class SimpleBuilderTest < ActionView::TestCase
+
+  def setup
+    @template = self
+  end
+
+
+  def test_render_should_be_implemented
+    assert_nothing_raised { simplebuilder(@template, []).render }
+  end
+
+
+  def test_render_with_0_elements
+    assert_equal("", simplebuilder(@template, []).render)
+  end
+
+  def test_render_with_0_elements_and_separator
+    assert_equal("", simplebuilder(@template, [], :separator => "-").render)
+  end
+
+
+  def test_render_with_1_element
+    @template.expects(:current_page?).times(1).returns(false)
+    assert_dom_equal("<a href=\"/element/1\">Element 1</a>",
+                     simplebuilder(@template, generate_elements(1)).render)
+  end
+
+  def test_render_with_1_element_and_separator
+    @template.expects(:current_page?).times(1).returns(false)
+    assert_dom_equal("<a href=\"/element/1\">Element 1</a>",
+                     simplebuilder(@template, generate_elements(1), :separator => "-").render)
+  end
+
+
+  def test_render
+    @template.expects(:current_page?).times(2).returns(false)
+    assert_dom_equal("<a href=\"/element/1\">Element 1</a> &raquo; <a href=\"/element/2\">Element 2</a>",
+                     simplebuilder(@template, generate_elements(2)).render)
+  end
+
+  def test_render_with_separator
+    @template.expects(:current_page?).times(2).returns(false)
+    assert_dom_equal("<a href=\"/element/1\">Element 1</a> - <a href=\"/element/2\">Element 2</a>",
+                     simplebuilder(@template, generate_elements(2), :separator => " - ").render)
+  end
+
+  def test_render_with_current_page
+    @template.expects(:current_page?).times(2).returns(false, true)
+    assert_dom_equal("<a href=\"/element/1\">Element 1</a> &raquo; Element 2",
+                     simplebuilder(@template, generate_elements(2)).render)
+  end
+
+
+  protected
+
+  def simplebuilder(*args)
+    BreadcrumbsOnRails::Breadcrumbs::SimpleBuilder.new(*args)
+  end
+
+  def generate_elements(number)
+    (1..number).collect do |index|
+      BreadcrumbsOnRails::Breadcrumbs::Element.new("Element #{index}", "/element/#{index}")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumbs_on_rails_microdata_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simone Carletti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-03 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: BreadcrumbsOnRails is a simple Ruby on Rails plugin for creating and
+  managing a breadcrumb navigation for a Rails project.
+email: weppos@weppos.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- breadcrumbs_on_rails_microdata_builder.gemspec
+- gemfiles/3.0.gemfile
+- gemfiles/3.0.gemfile.lock
+- gemfiles/3.1.gemfile
+- gemfiles/3.1.gemfile.lock
+- gemfiles/3.2.gemfile
+- gemfiles/3.2.gemfile.lock
+- init.rb
+- lib/breadcrumbs_on_rails_microdata_builder.rb
+- lib/breadcrumbs_on_rails_microdata_builder/action_controller.rb
+- lib/breadcrumbs_on_rails_microdata_builder/breadcrumbs.rb
+- lib/breadcrumbs_on_rails_microdata_builder/railtie.rb
+- lib/breadcrumbs_on_rails_microdata_builder/version.rb
+- test/test_helper.rb
+- test/unit/builder_test.rb
+- test/unit/element_test.rb
+- test/unit/simple_builder_test.rb
+homepage: http://www.simonecarletti.com/code/breadcrumbs_on_rails
+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: A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.
+test_files:
+- test/test_helper.rb
+- test/unit/builder_test.rb
+- test/unit/element_test.rb
+- test/unit/simple_builder_test.rb