html_matchers 0.0.1

data/lib/matchers/table_header_matcher.rb

@@ -0,0 +1,43 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class TableHeaderMatcher
+        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 header contents.\nexpected: #{@expected.inspect}\n   found: #{@actual.inspect}\n\n"
+        end
+
+        def negative_failure_message
+          "\nTable header should not have matched: #{@expected.inspect}\n"
+        end
+
+        def extract_html_content html
+          html = html.gsub(/[ \t]*<br *\/>[ \t]*/, "\n")
+          doc = Hpricot.XML(html)
+          elements = doc.search("table#{"##{@table_id}" if @table_id} tr")
+          elements = elements.reject{|e| e.search('th').empty? }
+          elements.map do |node|
+            node.search('/th').map do |n|
+              n.inner_text.strip.gsub(/[ \t]*\n[\n \t]*/, "\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/matchers/table_matcher.rb

@@ -0,0 +1,57 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class TableMatcher
+
+        def initialize table_selector_or_expected, expected
+          case table_selector_or_expected
+          when String
+            @table_selector = table_selector_or_expected
+            @expected = expected
+          when Array
+            @expected = table_selector_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 contents.\nexpected: #{@expected.inspect.gsub('], [', "],\n[")}\n   found: #{@actual.inspect.gsub('], [', "],\n[")}\n\n"
+        end
+
+       def negative_failure_message
+          "\nTable should not have matched: #{@expected.inspect}\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+
+          rows = doc.search("table#{"#{@table_selector}" if @table_selector} tr")
+          header_elements = rows.reject{|e| e.search('th').empty? }
+          header_content = header_elements.map do |header_element|
+            header_element.search('/th').map do |n|
+              stripped = n.inner_html.gsub(/<script.*<\/script>/m, '')
+              temp_node = Hpricot.XML("<temp-node>#{stripped}</temp-node>")
+              temp_node.inner_text.strip.gsub(/[ \t]*\n[\n \t]*/, "\n")
+            end
+          end
+
+          body_elements = rows.reject{|e| e.search('td').empty? }
+          body_content = body_elements.map do |body_element|
+            body_element.search('/td').map do |n|
+              stripped = n.inner_html.gsub(/<script.*<\/script>/m, '')
+              temp_node = Hpricot.XML("<temp-node>#{stripped}</temp-node>")
+              temp_node.inner_text.strip.gsub(/[ \t]*\n[\n \t]*/, "\n")
+            end
+          end
+
+          header_content + body_content
+        end
+      end
+    end
+  end
+end

data/lib/matchers/td_link_matcher.rb

@@ -0,0 +1,30 @@
+module Spec # :nodoc:
+  module Rails
+    module Matchers
+      class TdLinkMatcher
+
+        def initialize target_id, expected_text, expected_link
+          @xpath = "td##{target_id}"
+          @expected_link = expected_link
+          @expected_text = expected_text
+        end
+
+        def matches? response
+          @actual_text = extract_html_content response.body
+          @actual_text == @expected_text
+        end
+
+        def failure_message
+          "\nWrong #{@element_name} contents.\nexpected: #{@expected_text.inspect}\n   found: #{@actual_text.inspect}\n\n"
+        end
+
+        def extract_html_content html
+          doc = Hpricot.XML(html)
+          elements = doc.search(@xpath)
+          elements.map{|n| n.inner_text.strip}.first
+        end
+
+      end
+    end
+  end
+end

data/spec/button_matcher_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'span_text_matcher' do
+  FORM_WITH_SUBMIT_INPUT = %Q{<form><div><input value="Approve" type="submit"></div></form>}
+  FORM_WITH_BUTTON_INPUT = %Q{<form><div><input value="Approve" type="button"></div></form>}
+  FORM_WITH_RADIO_INPUT = %Q{<form><div><input value="Approve" type="radio"></div></form>}
+  FORM_WITH_BUTTON_INPUT_WITH_SPACES = %Q{<form><div><input value="Mark as spam" type="button"></div></form>}
+
+  it 'should find matching submit input' do
+    response = mock_model(Object, :body => FORM_WITH_SUBMIT_INPUT)
+    response.should have_button('Approve')
+  end
+
+  it 'should find matching button input' do
+    response = mock_model(Object, :body => FORM_WITH_BUTTON_INPUT)
+    response.should have_button('Approve')
+  end
+
+  it 'should find matching button input with spaces' do
+    response = mock_model(Object, :body => FORM_WITH_BUTTON_INPUT_WITH_SPACES)
+    response.should have_button('Mark as spam')
+  end
+
+  it 'should not find matching radio input' do
+    response = mock_model(Object, :body => FORM_WITH_RADIO_INPUT)
+    response.should_not have_button('Approve')
+  end
+
+  # describe 'passed wrong id' do
+  #   it 'should not match' do
+  #     response = mock_model(Object, :body => '<p><span id="span_id">My Text</span></p>')
+  #     response.should_not have_span_text('wrong_id', 'My Text')
+  #   end
+  # end
+  # 
+  # describe 'with non-matching expected' do
+  #   it 'should not match' do
+  #     response = mock_model(Object, :body => '<p><span id="span_id">My Text</span></p>')
+  #     response.should_not have_span_text('span_id', 'Some Other Text')
+  #   end
+  # end
+  # 
+  # describe 'with normal failure' do
+  #   it 'should raise ExpectationNotMetError with correct message' do
+  #     response = mock_model Object, :body => 'Some non-matching HTML'
+  #     lambda do
+  #       response.should have_span_text('span_id', 'My Text')
+  #     end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong span text contents.\nexpected: \"My Text\"\n   found: nil\n\n")
+  #   end
+  # end
+  # 
+  # describe 'with negative failure' do
+  #   it 'should raise ExpectationNotMetError' do
+  #     response = mock_model Object, :body => '<p><span id="span_id">My Text</span></p>'
+  #     lambda{response.should_not have_span_text('span_id', 'My Text')}.should raise_error(Spec::Expectations::ExpectationNotMetError,
+  #       "\nShould not have matched span: span_id, with text: 'My Text'\n\n")
+  #   end
+  # end
+end

data/spec/check_box_group_matcher_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'check_box_group_matcher' do
+  it 'should find matching check box group' do
+    response = mock_model(Object, :body => check_box_html)
+    response.should have_check_box_group('user[genre_ids][]', [['1', 'Rock/Pop General'], ['2', 'Modern "Alternative"'], ['4', 'Metal']])
+  end
+
+  describe 'passed wrong target name' do
+    it 'should not match' do
+      response = mock_model(Object, :body => check_box_html)
+      response.should_not have_check_box_group('wrong name', [['1', 'Rock/Pop General'], ['2', 'Modern "Alternative"'], ['4', 'Metal']])
+    end
+  end
+
+  describe 'passed non-matching expected' do
+    it 'should not match' do
+      response = mock_model(Object, :body => check_box_html)
+      response.should_not have_check_box_group('user[genre_ids][]', [['1', 'Rock/Pop New Wave'], ['2', 'Modern "Alternative"'], ['4', 'Metal']])
+    end
+  end
+
+  describe 'with normal failure' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => 'Some non-matching HTML'
+      lambda do
+        response.should have_check_box_group('user[genre_ids][]', [['1', 'Rock/Pop General'], ['2', 'Modern "Alternative"'], ['4', 'Metal']])
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong check box group contents.\nexpected: [[\"1\", \"Rock/Pop General\"], [\"2\", \"Modern \\\"Alternative\\\"\"], [\"4\", \"Metal\"]]\n   found: []\n\n")
+    end
+  end
+
+  describe 'with negative failure' do
+    it 'should raise ExpectationNotMetError' do
+      response = mock_model Object, :body => check_box_html
+      lambda{response.should_not have_check_box_group('user[genre_ids][]', [['1', 'Rock/Pop General'], ['2', 'Modern "Alternative"'], ['4', 'Metal']])}.should raise_error(Spec::Expectations::ExpectationNotMetError,
+        "\nShould not have matched check box group: name: user[genre_ids][], with: [[\"1\", \"Rock/Pop General\"], [\"2\", \"Modern \\\"Alternative\\\"\"], [\"4\", \"Metal\"]]\n\n")
+    end
+  end
+
+  private
+
+  def check_box_html
+    %{<div>
+      <input id="genre_1" name="user[genre_ids][]" type="checkbox" value="1" />
+      <label for="genre_1">Rock/Pop General</label>
+    </div>
+
+    <div>
+      <input id="genre_2" name="user[genre_ids][]" type="checkbox" value="2" />
+      <label for="genre_2">Modern "Alternative"</label>
+    </div>
+
+    <div>
+      <input id="genre_4" name="user[genre_ids][]" type="checkbox" value="4" />
+      <label for="genre_4">Metal</label>
+    </div>}
+  end
+end

data/spec/drop_down_matcher_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'drop_down_matcher' do
+  it 'should find matching dropdown' do
+    response = mock_model(Object, :body => '<select id="choice"><option value="val1">Choice 1</option><option value="val2">Choice 2</option></select>')
+    response.should have_dropdown('choice', ['Choice 1', 'Choice 2'])
+  end
+
+  describe 'passed wrong id' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<select id="choice"><option value="val1">Choice 1</option><option value="val2">Choice 2</option></select>')
+      response.should_not have_dropdown('wrong_id', ['Choice 1', 'Choice 2'])
+    end
+  end
+
+  describe 'with non-matching expected' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<select id="choice"><option value="val1">Choice 1</option><option value="val2">Choice 2</option></select>')
+      response.should_not have_dropdown('choice', ['Not A Match 1', 'Not A Match 2'])
+    end
+  end
+
+  describe 'without matching select element' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => 'Some non-matching HTML'
+      lambda do
+        response.should have_dropdown('choice', [['Choice 1', 'Choice 2']])
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nCould not find a select element with id: 'choice'\n\n")
+    end
+  end
+
+  describe 'with wrong contents in correct select element' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => '<select id="choice"><option value="no_match">No Match</option></select>'
+      lambda do
+        response.should have_dropdown('choice', [['Choice 1', 'Choice 2']])
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong 'choice' drop down contents.\nexpected: [[\"Choice 1\", \"Choice 2\"]]\n   found: [\"No Match\"]\n\n")
+    end
+  end
+
+  describe 'with negative failure' do
+    it 'should raise ExpectationNotMetError' do
+      response = mock_model Object, :body => '<select id="choice"><option value="val1">Choice 1</option><option value="val2">Choice 2</option></select>'
+      lambda{response.should_not have_dropdown('choice', ['Choice 1', 'Choice 2'])}.should raise_error(Spec::Expectations::ExpectationNotMetError,
+        "\nShould not have matched dropdown with id: choice\n\tand contents: [\"Choice 1\", \"Choice 2\"]\n\n")
+    end
+  end
+end

data/spec/image_matcher_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'image_matcher' do
+  it 'should find matching image' do
+    response = mock_model(Object, :body => '<p><img id="image_id" src="/images/my_photo.jpg?1233455"/></p>')
+    response.should have_image('my_photo.jpg')
+  end
+  
+  describe 'with non-matching expected' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<p><img id="image_id" src="/images/my_photo.jpg?1233455"/></p>')
+      response.should_not have_image('my_other_photo.gif')
+    end
+  end
+  
+  describe 'with normal failure' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => 'Some non-matching HTML'
+      lambda do
+        response.should have_image('my_photo.jpg')
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong image path.\nexpected: \"my_photo.jpg\"\n   found: nil\n\n")
+    end
+  end
+
+  describe 'with negative failure' do
+    it 'should raise ExpectationNotMetError' do
+      response = mock_model Object, :body => '<p><img id="image_id" src="/images/my_photo.jpg?1233455"/></p>'
+      lambda do
+        response.should_not have_image('my_photo.jpg')
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError,
+        "\nShould not have matched image with path: 'my_photo.jpg'\n\n")
+    end
+  end
+end

data/spec/radio_group_matcher_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'radio_group_matcher' do
+  it 'should find matching radio group' do
+    response = mock_model(Object, :body => '<p><b>Gender</b><br/>M <input id="athlete_gender_m" name="athlete[gender]" type="radio" value="M" /><br/>F <input id="athlete_gender_f" name="athlete[gender]" type="radio" value="F" /></p>')
+    response.should have_radio_group('athlete[gender]', ['M', 'F'])
+  end
+
+  describe 'passed wrong id' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<p><b>Gender</b><br/>M <input id="athlete_gender_m" name="athlete[gender]" type="radio" value="M" /><br/>F <input id="athlete_gender_f" name="athlete[gender]" type="radio" value="F" /></p>')
+      response.should_not have_radio_group('wrong_id', ['M', 'F'])
+    end
+  end
+
+  describe 'with non-matching expected' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<p><b>Gender</b><br/>M <input id="athlete_gender_m" name="athlete[gender]" type="radio" value="M" /><br/>F <input id="athlete_gender_f" name="athlete[gender]" type="radio" value="F" /></p>')
+      response.should_not have_radio_group('athlete[gender]', ['M', 'O'])
+    end
+  end
+
+  describe 'with normal failure' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => 'Some non-matching HTML'
+      lambda do
+        response.should have_radio_group('athlete[gender]', ['M', 'F'])
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong radio group contents.\nexpected: [\"M\", \"F\"]\n   found: []\n\n")
+    end
+  end
+
+  describe 'with negative failure' do
+    it 'should raise ExpectationNotMetError' do
+      response = mock_model Object, :body => '<p><b>Gender</b><br/>M <input id="athlete_gender_m" name="athlete[gender]" type="radio" value="M" /><br/>F <input id="athlete_gender_f" name="athlete[gender]" type="radio" value="F" /></p>'
+      lambda{response.should_not have_radio_group('athlete[gender]', ['M', 'F'])}.should raise_error(Spec::Expectations::ExpectationNotMetError,
+        "\nShould not have matched radio group: name: athlete[gender], with: [\"M\", \"F\"]\n\n")
+    end
+  end
+end

data/spec/span_text_matcher_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'span_text_matcher' do
+  it 'should find matching span' do
+    response = mock_model(Object, :body => '<p><span id="span_id">My Text</span></p>')
+    response.should have_span_text('span_id', 'My Text')
+  end
+
+  describe 'passed wrong id' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<p><span id="span_id">My Text</span></p>')
+      response.should_not have_span_text('wrong_id', 'My Text')
+    end
+  end
+
+  describe 'with non-matching expected' do
+    it 'should not match' do
+      response = mock_model(Object, :body => '<p><span id="span_id">My Text</span></p>')
+      response.should_not have_span_text('span_id', 'Some Other Text')
+    end
+  end
+
+  describe 'with normal failure' do
+    it 'should raise ExpectationNotMetError with correct message' do
+      response = mock_model Object, :body => 'Some non-matching HTML'
+      lambda do
+        response.should have_span_text('span_id', 'My Text')
+      end.should raise_error(Spec::Expectations::ExpectationNotMetError, "\nWrong span text contents.\nexpected: \"My Text\"\n   found: nil\n\n")
+    end
+  end
+
+  describe 'with negative failure' do
+    it 'should raise ExpectationNotMetError' do
+      response = mock_model Object, :body => '<p><span id="span_id">My Text</span></p>'
+      lambda{response.should_not have_span_text('span_id', 'My Text')}.should raise_error(Spec::Expectations::ExpectationNotMetError,
+        "\nShould not have matched span: span_id, with text: 'My Text'\n\n")
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--timeout 20

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+# This file is copied from the spec Rails plugin
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require 'spec'
+require 'spec/rails'
+
+Spec::Runner.configure do |config|
+  # If you're not using ActiveRecord you should remove these
+  # lines, delete config/database.yml and disable :active_record
+  # in your config/boot.rb
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+  config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+  # == Fixtures
+  #
+  # You can declare fixtures for each example_group like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so right here. Just uncomment the next line and replace the fixture
+  # names with your fixtures.
+  #
+  # config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+  #
+  # You can also declare which fixtures to use (for example fixtures for test/fixtures):
+  #
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+  #
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  #
+  # == Notes
+  # 
+  # For more information take a look at Spec::Example::Configuration and Spec::Runner
+ end