navigation_builder 1.0.0.beta6 → 2.0.0.beta1

data/Gemfile

@@ -9,6 +9,7 @@ end
 group :test do
   gem 'redgreen', '~> 1.2.2'
   gem "shoulda", "~> 2.11.3"
-  gem 'activesupport', '~> 2.3.11'
-  gem 'actionpack', '~> 2.3.11'
+  gem "nokogiri-diff"
+  gem 'activesupport', '~> 3.0.10'
+  gem 'actionpack', '~> 3.0.10'
 end

data/Gemfile.lock

@@ -1,29 +1,56 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (2.3.11)
-      activesupport (= 2.3.11)
-      rack (~> 1.1.0)
-    activesupport (2.3.11)
+    abstract (1.0.0)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.11)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
     git (1.2.5)
+    i18n (0.5.0)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    rack (1.1.2)
+    nokogiri (1.4.7)
+    nokogiri-diff (0.1.0)
+      nokogiri (~> 1.4.1)
+      tdiff (~> 0.3.2)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
     rake (0.9.0)
     rcov (0.9.9)
     redgreen (1.2.2)
     shoulda (2.11.3)
+    tdiff (0.3.2)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 2.3.11)
-  activesupport (~> 2.3.11)
+  actionpack (~> 3.0.10)
+  activesupport (~> 3.0.10)
   bundler (~> 1.0.0)
   jeweler (~> 1.6.0)
+  nokogiri-diff
   rcov
   redgreen (~> 1.2.2)
   shoulda (~> 2.11.3)

data/VERSION

@@ -1 +1 @@
-1.0.0.beta6
+2.0.0.beta1

data/lib/action_view/helpers/navigation_builder.rb

@@ -116,8 +116,10 @@ module ActionView
         set_selected_link( name, html_options, 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)
+        link_html = @template.link_to(options, html_options, &link_block)
+        @template.concat(link_html)
         @template.concat( "</#{@options[:nav_item_tag]}>".html_safe ) if @options[:nav_item_tag]
+        nil # have to return nil here so that the generated HTML is not added twice
       end
 
       def link_to_in_html( name, options, html_options )

data/navigation_builder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{navigation_builder}
-  s.version = "1.0.0.beta6"
+  s.version = "2.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-09-16}
+  s.date = %q{2012-01-05}
   s.description = %q{NavigationBuilder makes creating navigational links in a Rails application a breeze.}
   s.email = %q{dlindahl@customink.com}
   s.extra_rdoc_files = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/customink/navigation_builder}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.0}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Just like a Rails FormBuilder, but for Navigation}
 
   if s.respond_to? :specification_version then

data/test/helper.rb

@@ -8,18 +8,47 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+require 'ostruct'
+
 require 'test/unit'
 require 'redgreen'
 require 'shoulda'
 
 # require 'active_support/deprecation' # For Rails 3
-require 'action_pack'
+require 'action_controller'
 require 'action_view'
-require 'action_controller' # For Rails 2
+require 'action_view/test_case'
+require 'action_pack/version'
+require 'nokogiri/diff'
+
+
+
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'navigation_builder'
 
-class Test::Unit::TestCase
+module CustomAssertions
+  def assert_generated_markup
+    test_inputs = OpenStruct.new(:tempate => "", :expected => "")
+    yield test_inputs
+    render :inline => test_inputs.template
+
+    expected_dom = Nokogiri::XML(test_inputs.expected)
+    rendered_dom = Nokogiri::XML(rendered)
+
+    different = expected_dom.diff(rendered_dom).any? do |change, node|
+      # we are looking for anything that's an actual difference (change will be
+      # + or -) and the content of the difference is more than just whitespace
+      change != " " && node.content.strip != ""
+    end
+
+    assert !different, <<-EOS
+      generated and expected HTML differ
+      ======== Generated ========
+      #{rendered}
+      ======== Expected  ========
+      #{test_inputs.expected}
+      EOS
+  end
 end

data/test/test_navigation_builder.rb

@@ -6,6 +6,8 @@ require 'action_view/test_case'
 
 class TestNavigationBuilder < ActionView::TestCase
 
+  include CustomAssertions
+
   tests ActionView::Helpers::NavigationBuilderHelper
 
   should "set the default NavigationBuilder" do
@@ -13,232 +15,288 @@ class TestNavigationBuilder < ActionView::TestCase
   end
 
   should "generate HTML that contains navigation" do
-    navigation_for :main do |nav|
-      concat nav.link_to( 'Foo', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main do |nav| %>
+          <%= nav.link_to 'Foo', '#' %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+        <ul>
+          <li>
+            <a href=\"#\">Foo</a>
+          </li>
+        </ul>
+      EOS
     end
-
-    expected = [
-      "<ul>",
-        "<li>",
-          "<a href=\"#\">Foo</a>",
-        "</li>",
-      "</ul>"
-    ].join('')
-
-    assert_dom_equal expected, output_buffer
   end
 
   should "know how many links have been rendered" do
-    count = 0
-    navigation_for :main do |nav|
-      concat nav.link_to( 'Foo', '#' )
-      concat nav.link_to( 'Bar', '#' )
-      count = nav.item_count
-    end
-
-    assert_equal 2, count
+    render :inline => <<-EOS
+      <% navigation_for :main do |nav| %>
+        <%= nav.link_to( 'Foo', '#' ) %>
+        <%= nav.link_to( 'Bar', '#' ) %>
+        <%= nav.item_count %> links
+      <% end %>
+    EOS
+
+    assert_match /2 links/, rendered
   end
 
   should "generate HTML with custom wrapper tag name" do
-    navigation_for :main, :wrapper_tag => :ol do |nav|
-      concat nav.link_to( 'Foo', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main, :wrapper_tag => :ol do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ol>
+         <li>
+           <a href="#">Foo</a>
+         </li>
+       </ol>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main, :wrapper_tag => false do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <li>
+         <a href="#">Foo</a>
+       </li>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main, :nav_item_tag => 'div' do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <div>
+         <a href="#">Foo</a>
+       </div>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main, :nav_item_tag => false do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+        <a href="#">Foo</a>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main, :html => { :class => 'bar', 'data-more' => 'baz' } do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul class="bar" data-more="baz">
+         <li>
+           <a href="#">Foo</a>
+         </li>
+       </ul>
+      EOS
     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_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main do |nav| %>
+          <% nav.link_to( '#' ) do %>
+            <span>Foo</span>
+          <% end %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li>
+           <a href="#"><span>Foo</span></a>
+         </li>
+       </ul>
+      EOS
 
-    assert_dom_equal expected, output_buffer
+    end
   end
 
   should "generate HTML with links that contain user-defined classes" do
-    navigation_for :main do |nav|
-      concat nav.link_to( 'Foo', '#', :class => 'bar' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main do |nav| %>
+          <%= nav.link_to( 'Foo', '#', :class => 'bar' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li>
+           <a href="#" class="bar">Foo</a>
+         </li>
+       </ul>
+      EOS
     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' } )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_for :main do |nav| %>
+          <%= nav.link_to( 'Foo', '#', :item_html => { :class => 'bar' } ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li class="bar">
+           <a href="#">Foo</a>
+         </li>
+       </ul>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_select 'Foo', :in => :main %>
+        <% navigation_for :main do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li class="selected">
+           <a href="#">Foo</a>
+         </li>
+       </ul>
+      EOS
     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', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_select 'Foo', :in => :main %>
+        <% navigation_for :main, :selected_class => 'current-page' do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li class="current-page">
+           <a href="#">Foo</a>
+         </li>
+       </ul>
+      EOS
     end
-
-    expected = [
-      "<ul>",
-        "<li class=\"current-page\">",
-          "<a href=\"#\">Foo</a>",
-        "</li>",
-      "</ul>"
-    ].join('')
-
-    assert_dom_equal expected, output_buffer
   end
 
   should "generate HTML that highlights the currently selected navigation link even where there is no item tag" do
-    navigation_select 'Foo', :in => :main
-
-    navigation_for :main, :nav_item_tag => false do |nav|
-      concat nav.link_to( 'Foo', '#' )
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_select 'Foo', :in => :main %>
+        <% navigation_for :main, :nav_item_tag => false do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <a href="#" class="selected">Foo</a>
+      EOS
     end
-
-    expected = [
-      "<a href=\"#\" class=\"selected\">Foo</a>"
-    ].join('')
-
-    assert_dom_equal expected, output_buffer
   end
 
   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
+    assert_generated_markup do |test|
+      test.template = <<-EOS
+        <% navigation_select /Foo/, :in => :main %>
+        <% navigation_for :main do |nav| %>
+          <% nav.link_to( '#' ) do %>
+            <span>Foo</span>
+          <% end %>
+        <% end %>
+      EOS
+
+      test.expected = <<-EOS
+       <ul>
+         <li class="selected">
+           <a href="#"><span>Foo</span></a>
+         </li>
+       </ul>
+      EOS
+    end
   end
 
   should "raise an exception if a link is selected AFTER the navigation has been rendered" do
-    assert_raises RuntimeError do
-      navigation_for :main do |nav|
-        concat nav.link_to( 'Foo', '#' )
+    assert_raises ActionView::Template::Error do
+      render :inline => <<-EOS
+        <% navigation_for :main do |nav| %>
+          <%= nav.link_to( 'Foo', '#' ) %>
+        <% end %>
+        <% navigation_select 'Foo', :in => :main %>
+      EOS
+    end
+  end
+
+  if ::ActionPack::VERSION::MAJOR >= 3
+    should "correctly render a template when there is a yield" do
+      assert_generated_markup do |test|
+        test.template = <<-EOS
+          <% content_for :head do %>
+            this is the top
+          <% end %>
+
+          this is some text
+          <% yield :head %>
+
+          <% navigation_for :main do |nav| %>
+            <% nav.link_to '#' do %>
+              <span>Foo</span> 
+            <% end %>
+          <% end %>
+        EOS
+
+        test.expected = <<-EOS
+          this is some text
+          this is the top
+
+         <ul>
+           <li>
+             <a href="#"><span>Foo</span></a>
+           </li>
+         </ul>
+        EOS
       end
-      navigation_select 'Foo', :in => :main
     end
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: navigation_builder
 version: !ruby/object:Gem::Version 
-  hash: 62196367
+  hash: 62196449
   prerelease: 6
   segments: 
-  - 1
+  - 2
   - 0
   - 0
   - beta
-  - 6
-  version: 1.0.0.beta6
+  - 1
+  version: 2.0.0.beta1
 platform: ruby
 authors: 
 - Derek Lindahl
@@ -17,12 +17,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-16 00:00:00 -04:00
+date: 2012-01-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,12 +33,12 @@ dependencies:
         - 6
         - 0
         version: 1.6.0
-  type: :development
   name: jeweler
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *id001
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,12 +49,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  type: :development
   name: bundler
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *id002
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,9 +63,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   name: rcov
-  requirement: *id003
+  version_requirements: *id003
+  prerelease: false
 description: NavigationBuilder makes creating navigational links in a Rails application a breeze.
 email: dlindahl@customink.com
 executables: []
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Just like a Rails FormBuilder, but for Navigation