html_matchers 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.svn

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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,25 @@
+HtmlMatchers
+============
+
+This Rails plugin provides a layer of abstraction on top of Rspec for testing
+HTML contents.
+
+It depends on Rspec and Hpricot: rspec, and rspec-rails because enhancing them
+is the whole point of this plugin, and Hpricot because I find it so much more
+capable, and faster than the assert_select that is built into Rails.
+
+Using from Cucumber
+===================
+
+Add require 'cucumber/rails/rspec' to features/support/env.rb.
+
+This is important, so that rspec matchers are in play.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2008 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'spec/rake/spectask'
+# require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run spec tests.'
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  # unless ENV['NO_RCOV']
+  #   t.rcov = true
+  #   t.rcov_dir = 'coverage'
+  #   t.rcov_opts = ['--exclude', 'lib/spec.rb,lib/spec/runner.rb,spec\/spec,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest']
+  # end
+end
+
+desc 'Generate documentation for the html_matchers plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HtmlMatchers'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "html_matchers"
+    gemspec.summary = "HTML entity matchers for RSpec"
+    gemspec.description = "HTML entity matchers for RSpec"
+    gemspec.email = "stephen@bendyworks.com"
+    gemspec.homepage = "http://github.com/bendyworks/html_matchers"
+    gemspec.authors = ["bendycode, helabed, listrophy"] 
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), 'lib', 'html_matchers')

data/install.rb

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

data/lib/.gitignore

@@ -0,0 +1 @@
+.svn

data/lib/html_matchers.rb

@@ -0,0 +1,60 @@
+require 'hpricot'
+
+# %w(check_box_group drop_down radio_group span_text table_body table_header td_link).each do |element|
+  # require File.join(File.dirname(__FILE__), 'matchers', "#{element}_matcher")
+# end
+
+Dir.glob(File.dirname(__FILE__) + '/matchers/*.rb').each do |rb|
+  require rb
+end
+
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+
+      def have_button expected
+        ButtonMatcher.new expected
+      end
+
+      def have_check_box_group target_name, expected
+        CheckBoxGroupMatcher.new target_name, expected
+      end
+
+      def have_dropdown target_id, expected_options
+        DropDownMatcher.new target_id, expected_options
+      end
+
+      def have_image expected_path
+        ImageMatcher.new expected_path
+      end
+
+      def have_options expected_options
+        OptionsMatcher.new expected_options
+      end
+
+      def have_radio_group target_name, expected_radio_choices
+        RadioGroupMatcher.new target_name, expected_radio_choices
+      end
+
+      def have_span_text target_id, expected_text
+        SpanTextMatcher.new target_id, expected_text
+      end
+
+      def have_table table_id_or_expected, expected = nil
+        TableMatcher.new table_id_or_expected, expected
+      end
+
+      def have_table_header table_id_or_expected, expected = nil
+        TableHeaderMatcher.new table_id_or_expected, expected
+      end
+
+      def have_table_body table_id_or_expected, expected = nil
+        TableBodyMatcher.new table_id_or_expected, expected
+      end
+
+      def have_td_link target_id, expected_link, expected_text
+        TdLinkMatcher.new target_id, expected_link, expected_text
+      end
+    end
+  end
+end

data/lib/matchers/.gitignore

@@ -0,0 +1 @@
+.svn

data/lib/matchers/button_matcher.rb

@@ -0,0 +1,33 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class ButtonMatcher
+        def initialize expected_value
+          # @target_id = target_id
+          @expected = expected_value
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong button value.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched button: #{@target_id}, with text: '#{@expected}'\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          # elements = doc.search("//input[@value='#{@expected}' & @type='button|submit']")
+          # elements = doc.search("input[@value~='#{@expected}'][@type]")
+          elements = doc.search("//input[@value='#{@expected}']").select{|e| ['submit', 'button'].include?(e['type'])}
+          elements.map{|n| n['value']}.first
+        end
+      end
+    end
+  end
+end

data/lib/matchers/check_box_group_matcher.rb

@@ -0,0 +1,42 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class CheckBoxGroupMatcher
+
+        def initialize target_name, expected
+          @expected = expected
+          @target_name = target_name
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong check box group contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched check box group: name: #{@target_name}, with: #{@expected.inspect}\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          # elements = doc.search('div input[type="checkbox"]')
+          elements = doc.search('div/input')
+          elements = elements.select{|n| n.elem? && n.get_attribute('type') == 'checkbox' && n.get_attribute('name') == @target_name}
+          elements.map{|n| value = n.get_attribute('value'); [value, find_label(n)]}
+        end
+
+      private
+
+        def find_label node
+          label_node = node.next_sibling
+          label_node.inner_text
+        end
+
+      end
+    end
+  end
+end

data/lib/matchers/drop_down_matcher.rb

@@ -0,0 +1,43 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class DropDownMatcher
+
+        def initialize target_id, expected
+          @target_id = target_id
+          @expected = expected
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          if @found_select
+            "\nWrong '#{@target_id}' drop down contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+          else
+            "\nCould not find a select element with id: '#{@target_id}'\n\n"
+          end
+        end
+
+        def negative_failure_message
+          "\nShould not have matched dropdown with id: #{@target_id}\n\tand contents: #{@expected.inspect}\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          select = doc.search("select##{@target_id}")
+          @found_select = ! select.empty?
+
+          if @found_select
+            select.search("/option").map{|n| n.inner_text.strip}
+          else
+            []
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/matchers/image_matcher.rb

@@ -0,0 +1,32 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class ImageMatcher
+        def initialize expected_path
+          @expected = expected_path
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual =~ /#{@expected}/
+        end
+
+        def failure_message
+          "\nWrong image path.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched image with path: '#{@expected}'\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          elements = doc.search("img[@src*=\"#{@expected}\"]")
+          # elements.each {|e| puts e.inspect}
+          # elements.first.to_html
+          elements.map{|n| n.to_html}.first
+        end
+      end
+    end
+  end
+end

data/lib/matchers/options_matcher.rb

@@ -0,0 +1,29 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class OptionsMatcher
+        def initialize expected
+          @expected = expected
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong option contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched contents: #{@expected.inspect}\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          doc.search("/option").map{|n| n.inner_text.strip}
+        end
+      end
+    end
+  end
+end

data/lib/matchers/radio_group_matcher.rb

@@ -0,0 +1,32 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class RadioGroupMatcher
+        def initialize target_name, expected
+          @expected = expected
+          @target_name = target_name
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong radio group contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched radio group: name: #{@target_name}, with: #{@expected.inspect}\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          elements = doc.search('input')
+          elements = elements.select{|n| n.elem? && n.get_attribute('name') == @target_name}
+          elements.map{|n| n.get_attribute('value')}
+        end
+      end
+    end
+  end
+end

data/lib/matchers/span_text_matcher.rb

@@ -0,0 +1,31 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class SpanTextMatcher
+        def initialize target_id, expected_text
+          @target_id = target_id
+          @expected = expected_text
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong span text contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nShould not have matched span: #{@target_id}, with text: '#{@expected}'\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          elements = doc.search("p span##{@target_id}")
+          elements.map{|n| n.inner_text.strip}.first
+        end
+      end
+    end
+  end
+end

data/lib/matchers/table_body_matcher.rb

@@ -0,0 +1,39 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class TableBodyMatcher
+
+        def initialize table_id_or_expected, expected
+          case table_id_or_expected
+          when String
+            @table_id = table_id_or_expected
+            @expected = expected
+          when Array
+            @expected = table_id_or_expected
+          end
+          raise 'Invalid "expected" argument' if @expected.nil?
+        end
+
+        def matches? response
+          @actual = extract_html_content response.body
+          @actual == @expected
+        end
+
+        def failure_message
+          "\nWrong table body contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nTable body should not have matched: #{@expected.inspect}\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          elements = doc.search("table#{"##{@table_id}" if @table_id} tr").reject{|e| e.search('td').empty? }
+          elements.map{|n| n.search('/td').map{|n| n.inner_text.strip.gsub(/[ \t]*\n[\n \t]*/, "\n")}}
+        end
+
+      end
+    end
+  end
+end