navigation_builder 1.0.0.beta1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+group :development do
+  gem "jeweler", "~> 1.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem 'redgreen', '~> 1.2.2'
+  gem "shoulda", "~> 2.11.3"
+  gem 'activesupport', '~> 2.3.11'
+  gem 'actionpack', '~> 2.3.11'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.11)
+      activesupport (= 2.3.11)
+      rack (~> 1.1.0)
+    activesupport (2.3.11)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.2)
+    rake (0.9.0)
+    rcov (0.9.9)
+    redgreen (1.2.2)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.11)
+  activesupport (~> 2.3.11)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  rcov
+  redgreen (~> 1.2.2)
+  shoulda (~> 2.11.3)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 CustomInk, LLC
+
+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.md

@@ -0,0 +1,11 @@
+Navigation Builder
+==================
+
+
+
+TODOs
+=====
+
+* Rails 3 support
+* Add test for "selected" class when there is no item tag
+* Add test for thrown exception when setting a selected link after a nav block has already been rendered.

data/Rakefile

@@ -0,0 +1,53 @@
+# 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'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "navigation_builder"
+  gem.homepage = "http://github.com/customink/navigation_builder"
+  gem.license = "MIT"
+  gem.summary = %Q{Just like a Rails FormBuilder, but for Navigation}
+  gem.description = %Q{NavigationBuilder makes creating navigational links in a Rails application a breeze.}
+  gem.email = "dlindahl@customink.com"
+  gem.authors = ["Derek Lindahl"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "navigation_builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.beta1

data/lib/action_view/helpers/navigation_builder.rb

@@ -0,0 +1,126 @@
+module ActionView
+  module Helpers
+
+    module NavigationBuilderHelper
+
+      def navigation_builder
+        @navigation_builder ||= { :main => nil }
+      end
+
+      # <% navigation_for :popup do |n| %>
+      #   <%= nav_to 'Design', :action => :design %>
+      # <% end %>
+      # 
+      # <%= navigation_select 'Design', :in => :popup %>
+      def navigation_for( nav_name, options = {}, &block )
+        raise ArgumentError, "Missing block" unless block_given?
+
+        builder = options[:builder] || ActionView::Base.default_navigation_builder
+
+        options.reverse_merge!(
+          :wrapper_tag => :ul,
+          :nav_item_tag => :li,
+          :selected_class => 'selected',
+          :html => {}
+        )
+
+        concat( tag(options[:wrapper_tag], options[:html], true) ) if navigation_has_wrapper?( options )
+        yield builder.new(self, nav_name, options, block)
+        concat("</#{options[:wrapper_tag]}>".html_safe) if navigation_has_wrapper?( options )
+      end
+
+      def navigation_select( link_name, options = {} )
+        options.reverse_merge!( :in => :main )
+        navigation_builder[options[:in]] = link_name
+      end
+
+    private
+
+      def navigation_has_wrapper?( options )
+        options[:wrapper_tag] and options[:nav_item_tag].to_s == 'li'
+      end
+
+    end
+
+    class NavigationBuilder
+
+      def initialize( template, nav_name, options, proc )
+        @template, @nav_name, @options, @proc = template, nav_name, options, proc
+      end
+
+      def link_to( *args, &link_block )
+        if block_given?
+          name         = @template.capture(&link_block)
+          options      = args.first || {}
+          html_options = args.second
+
+          link_to_in_block( name, options, html_options, &link_block )
+        else
+          name         = args[0]
+          options      = args[1] || {}
+          html_options = args[2]
+
+          link_to_in_html( name, options, html_options )
+        end
+      end
+
+    private
+
+      def link_to_in_block( name, options, html_options, &link_block )
+        item_html_options = extract_item_options!( html_options )
+
+        set_selected_link( name, item_html_options ) if is_selected?( name )
+
+        @template.concat( @template.tag( @options[:nav_item_tag], item_html_options, true) ) if @options[:nav_item_tag]
+        @template.link_to(options, html_options, &link_block)
+        @template.concat( "</#{@options[:nav_item_tag]}>".html_safe ) if @options[:nav_item_tag]
+      end
+
+      def link_to_in_html( name, options, html_options )
+        item_html_options = extract_item_options!( html_options )
+
+        set_selected_link( name, item_html_options ) if is_selected?( name )
+
+        link_html = @template.link_to(name, options, html_options)
+
+        if @options[:nav_item_tag]
+          @template.content_tag(@options[:nav_item_tag], link_html, item_html_options )
+        else
+          link_html
+        end
+      end
+
+      def extract_item_options!( options )
+        options.try(:delete, :item_html) || {}
+      end
+
+      def set_selected_link( name, item_html_options )
+        ((item_html_options[:class] ||= '') << " #{@options[:selected_class]}").strip!
+      end
+
+      def is_selected?( name )
+        if @template.navigation_builder[@nav_name].is_a? String
+          name == @template.navigation_builder[@nav_name]
+        else
+          name =~ @template.navigation_builder[@nav_name]
+        end
+      end
+
+    end
+
+  end
+
+  class Base
+    cattr_accessor :default_navigation_builder
+    self.default_navigation_builder = ::ActionView::Helpers::NavigationBuilder
+  end
+
+end
+
+# For Rails 3?
+# ActiveSupport.on_load(:action_view) do
+#   class ActionView::Base
+#     cattr_accessor :default_navigation_builder
+#     @@default_navigation_builder = ::ActionView::Helpers::NavigationBuilder
+#   end
+# end

data/lib/navigation_builder.rb

@@ -0,0 +1,9 @@
+if defined?(Rails) && Rails.version.to_i == 3
+  # TODO: Rails 3 Support
+else
+  class ActionView::Base
+    autoload :NavigationBuilderHelper, 'action_view/helpers/navigation_builder'
+
+    include NavigationBuilderHelper
+  end
+end

data/navigation_builder.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{navigation_builder}
+  s.version = "1.0.0.beta1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Derek Lindahl"]
+  s.date = %q{2011-05-23}
+  s.description = %q{NavigationBuilder makes creating navigational links in a Rails application a breeze.}
+  s.email = %q{dlindahl@customink.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/action_view/helpers/navigation_builder.rb",
+    "lib/navigation_builder.rb",
+    "navigation_builder.gemspec",
+    "test/helper.rb",
+    "test/test_navigation_builder.rb"
+  ]
+  s.homepage = %q{http://github.com/customink/navigation_builder}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.0}
+  s.summary = %q{Just like a Rails FormBuilder, but for Navigation}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'redgreen'
+require 'shoulda'
+
+# require 'active_support/deprecation' # For Rails 3
+require 'action_pack'
+require 'action_view'
+require 'action_controller' # For Rails 2
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'navigation_builder'
+
+class Test::Unit::TestCase
+end

data/test/test_navigation_builder.rb

@@ -0,0 +1,214 @@
+require File.dirname(__FILE__) + '/helper'
+
+require 'action_view'
+require 'action_view/template'
+require 'action_view/test_case'
+
+class TestNavigationBuilder < ActionView::TestCase
+
+  tests ActionView::Helpers::NavigationBuilderHelper
+
+  should "set the default NavigationBuilder" do
+    assert_equal ActionView::Helpers::NavigationBuilder, ActionView::Base.default_navigation_builder
+  end
+
+  should "generate HTML that contains navigation" do
+    navigation_for :main do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<ul>",
+        "<li>",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with custom wrapper tag name" do
+    navigation_for :main, :wrapper_tag => :ol do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<ol>",
+        "<li>",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ol>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with no wrapper" do
+    navigation_for :main, :wrapper_tag => false do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<li>",
+        "<a href=\"#\">Foo</a>",
+      "</li>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with no wrapper and a custom nav item tag name" do
+    navigation_for :main, :nav_item_tag => 'div' do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<div>",
+        "<a href=\"#\">Foo</a>",
+      "</div>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with no wrapper and a no nav item tag" do
+    navigation_for :main, :nav_item_tag => false do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<a href=\"#\">Foo</a>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML that contains user-defined attributes" do
+    navigation_for :main, :html => { :class => 'bar', 'data-more' => 'baz' } do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<ul class=\"bar\" data-more=\"baz\">",
+        "<li>",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with links that were created with blocks" do
+    # lambda {
+      navigation_for :main do |nav|
+        # concat nav.link_to( '#' ) { "<span>Foo</span>".html_safe } # For Rails 3?
+        nav.link_to( '#' ) { "<span>Foo</span>".html_safe }
+      end
+    # }.call(ActionView::Base.new) # For Rails 3: Scoped call so that the capture call works inside the Builder
+
+    expected = [
+      "<ul>",
+        "<li>",
+          "<a href=\"#\"><span>Foo</span></a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with links that contain user-defined classes" do
+    navigation_for :main do |nav|
+      concat nav.link_to( 'Foo', '#', :class => 'bar' )
+    end
+
+    expected = [
+      "<ul>",
+        "<li>",
+          "<a href=\"#\" class=\"bar\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML with links that contain user-defined classes on the container items" do
+    navigation_for :main do |nav|
+      concat nav.link_to( 'Foo', '#', :item_html => { :class => 'bar' } )
+    end
+
+    expected = [
+      "<ul>",
+        "<li class=\"bar\">",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML that highlights the currently selected navigation link" do
+    navigation_select 'Foo', :in => :main
+
+    navigation_for :main do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<ul>",
+        "<li class=\"selected\">",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  should "generate HTML that highlights the currently selected navigation link with a custom class name" do
+    navigation_select 'Foo', :in => :main
+
+    navigation_for :main, :selected_class => 'current-page' do |nav|
+      concat nav.link_to( 'Foo', '#' )
+    end
+
+    expected = [
+      "<ul>",
+        "<li class=\"current-page\">",
+          "<a href=\"#\">Foo</a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+
+# TODO: Add test for "selected" class when there is no item tag
+
+  should "generate HTML that highlights the currently selected navigation link by using a Regular Expression" do
+    navigation_select /Foo/, :in => :main
+
+    # lambda {
+      navigation_for :main do |nav|
+        # concat nav.link_to( '#' ) { "<span>Foo</span>".html_safe } # For Rails 3?
+        nav.link_to( '#' ) { "<span>Foo</span>".html_safe }
+      end
+    # }.call(ActionView::Base.new) # For Rails 3: Scoped call so that the capture call works inside the Builder
+
+    expected = [
+      "<ul>",
+        "<li class=\"selected\">",
+          "<a href=\"#\"><span>Foo</span></a>",
+        "</li>",
+      "</ul>"
+    ].join('')
+
+    assert_dom_equal expected, output_buffer
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: navigation_builder
+version: !ruby/object:Gem::Version 
+  hash: 62196353
+  prerelease: 6
+  segments: 
+  - 1
+  - 0
+  - 0
+  - beta
+  - 1
+  version: 1.0.0.beta1
+platform: ruby
+authors: 
+- Derek Lindahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id001
+  prerelease: false
+  name: jeweler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rcov
+  type: :development
+description: NavigationBuilder makes creating navigational links in a Rails application a breeze.
+email: dlindahl@customink.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/action_view/helpers/navigation_builder.rb
+- lib/navigation_builder.rb
+- navigation_builder.gemspec
+- test/helper.rb
+- test/test_navigation_builder.rb
+has_rdoc: true
+homepage: http://github.com/customink/navigation_builder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.0
+signing_key: 
+specification_version: 3
+summary: Just like a Rails FormBuilder, but for Navigation
+test_files: []
+