capybara_minitest_spec 0.1.3 → 0.2.0

data/capybara_minitest_spec.gemspec

@@ -4,7 +4,7 @@ require "capybara_minitest_spec/version"
 
 Gem::Specification.new do |s|
   s.name        = "capybara_minitest_spec"
-  s.version     = CapybaraMinitestSpec::VERSION
+  s.version     = CapybaraMiniTestSpec::VERSION
   s.authors     = ["Jared Ning"]
   s.email       = ["jared@redningja.com"]
   s.homepage    = ""

data/lib/capybara_minitest_spec/matcher.rb

@@ -0,0 +1,125 @@
+module CapybaraMiniTestSpec
+  class Matcher
+
+    attr_reader :name
+
+    def initialize(node_matcher_name)
+      @name = Name.new(node_matcher_name, true)
+    end
+
+    def define_expectations
+      # Define positive expectations.
+      define_expectation
+      # Define negative expectations.
+      @name.negate!
+      define_expectation
+    end
+
+    def undefine_assertions
+      undefine_assertion
+      @name.negate!
+      undefine_assertion
+    end
+
+    # Send page the matcher name with args.
+    # E.g. page.has_css?(*args)
+    def test(page, *args)
+      wrap(page).send(name.original, *args)
+    end
+
+    # Compose failure message.
+    # E.g. Matcher failed: has_css?("expected", {:count => 1})
+    def self.failure_message(assertion_method, matcher_name, *args)
+      if assertion_method == 'assert'
+        message = "Matcher failed: "
+      else
+        message = 'Matcher should have failed: '
+      end
+      message += "#{matcher_name}(#{args.map(&:inspect).join(', ')})"
+    end
+
+    private
+
+    def define_expectation
+      define_assertion
+      infect_assertion
+    end
+
+    # Define an assertion with the matcher name in MiniTest::Assertions.
+    # For example, if the matcher name is has_css?,
+    # the assertion would be called assert_page_has_css.
+    def define_assertion
+      # scope self to be available in the method definition.
+      matcher = self
+      assertion_method = name.positive? ? 'assert' : 'refute'
+      MiniTest::Assertions.send :define_method, name.assertion do |page, *args|
+        message = matcher.class.failure_message(assertion_method, matcher.name.original, *args)
+        send(assertion_method, matcher.test(page, *args), message)
+      end
+    end
+
+    def undefine_assertion
+      MiniTest::Assertions.send :undef_method, @name.assertion
+    end
+
+    def infect_assertion
+      MiniTest::Expectations.infect_an_assertion @name.assertion, @name.expectation, true
+    end
+
+    # Turn a string into a Capybara node if it's not already.
+    # Copied from Capybara::RSpecMatchers::HaveMatcher.
+    def wrap(actual)
+      if actual.respond_to?("has_selector?")
+        actual
+      else
+        Capybara.string(actual.to_s)
+      end
+    end
+
+    # Represents the a matcher name.
+    # Returns different forms of the name depending on whether it is in a positive or negative state.
+    class Name
+
+      attr_reader :original
+
+      def initialize(name, positive)
+        @original = name.to_s
+        @positive = positive
+      end
+
+      def positive?
+        !!@positive
+      end
+
+      def negate!
+        @positive = !positive?
+      end
+
+      def without_question_mark
+        @original.to_s.sub /\?$/, ''
+      end
+
+      def have
+        without_question_mark.sub /has_/, 'have_'
+      end
+
+      def assertion
+        if positive?
+          "assert_page_#{without_question_mark}"
+        else
+          "refute_page_#{without_question_mark}"
+        end
+      end
+
+      def expectation
+        if positive?
+          "must_#{have}"
+        else
+          "wont_#{have}"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/capybara_minitest_spec/version.rb

@@ -1,3 +1,3 @@
-module CapybaraMinitestSpec
-  VERSION = '0.1.3'
+module CapybaraMiniTestSpec
+  VERSION = '0.2.0'
 end

data/lib/capybara_minitest_spec.rb

@@ -1,58 +1,12 @@
 require 'minitest/spec'
+require 'capybara'
+require "capybara_minitest_spec/matcher"
 require "capybara_minitest_spec/version"
 
-# Define assertions for each Capybara node matcher.
-# Then define MiniTest::Spec expectations.
-module MiniTest::Expectations
-
-  Capybara::Node::Matchers.public_instance_methods.each do |matcher_name|
-
-    without_question_mark = matcher_name.to_s.sub /\?$/, ''
-    have = without_question_mark.sub /has_/, 'have_'
-
-    # Define positive assertion.
-    positive_assertion_name = :"assert_page_#{without_question_mark}"
-    define_method positive_assertion_name do |page, *args|
-      assert wrap(page).send(matcher_name, *args), positive_failure_message(matcher_name, *args)
-    end
-
-    # Infect positive assertion.
-    positive_expectation_name = :"must_#{have}"
-    infect_an_assertion positive_assertion_name, positive_expectation_name, true
-
-    # Define negative assertion.
-    negative_assertion_name = :"refute_page_#{without_question_mark}"
-    define_method negative_assertion_name do |page, *args|
-      refute wrap(page).send(matcher_name, *args), negative_failure_message(matcher_name, *args)
-    end
-
-    # Infect negative assertions.
-    negative_expectation_name = :"wont_#{have}"
-    infect_an_assertion negative_assertion_name, negative_expectation_name, true
-
-  end
-
-  private
-
-  # Copied from Capybara::RSpecMatchers::HaveMatcher.
-  def wrap(actual)
-    if actual.respond_to?("has_selector?")
-      actual
-    else
-      Capybara.string(actual.to_s)
-    end
-  end
-
-  def base_failure_message(matcher_name, *args)
-    "#{matcher_name}(#{args.map(&:inspect).join(', ')})"
-  end
-
-  def positive_failure_message(matcher_name, *args)
-    "Matcher failed: #{base_failure_message(matcher_name, *args)}"
-  end
-
-  def negative_failure_message(matcher_name, *args)
-    "Matcher should have failed: #{base_failure_message(matcher_name, *args)}"
-  end
-
+# For each Capybara node matcher,
+# define positive and negative MiniTest::Unit assertions and
+# infect it both assertions to create MiniTest::Spec expectations.
+Capybara::Node::Matchers.public_instance_methods.each do |matcher_name|
+  matcher = CapybaraMiniTestSpec::Matcher.new(matcher_name)
+  matcher.define_expectations
 end

data/test/{matchers_spec.rb → capybara_node_matchers_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe CapybaraMinitestSpec do
+describe CapybaraMiniTestSpec do
   include Capybara::DSL
 
   describe "have_css matcher" do
@@ -13,7 +13,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             "<h1>Text</h1>".must_have_css('h2')
-          end.must_raise(/expected css "h2" to return something/)
+          end.must_raise(MiniTest::Assertion)
         end
 
         it "passes if matched node count equals expected count" do
@@ -23,7 +23,7 @@ describe CapybaraMinitestSpec do
         it "fails if matched node count does not equal expected count" do
           proc do
             "<h1>Text</h1>".must_have_css('h1', :count => 2)
-          end.must_raise(/expected css "h1" to return something/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -35,7 +35,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             "<h1>Text</h1>".wont_have_css('h1')
-          end.must_raise(/expected css "h1" not to return anything/)
+          end.must_raise(MiniTest::Assertion)
         end
 
         it "passes if matched node count does not equal expected count" do
@@ -45,7 +45,7 @@ describe CapybaraMinitestSpec do
         it "fails if matched node count equals expected count" do
           proc do
             "<h1>Text</h1>".wont_have_css('h1', :count => 1)
-          end.must_raise(/expected css "h1" not to return anything/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -63,7 +63,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             page.must_have_css('h1#doesnotexist')
-          end.must_raise(/expected css "h1#doesnotexist" to return something/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -75,7 +75,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             page.wont_have_css('h1')
-          end.must_raise(/expected css "h1" not to return anything/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -91,7 +91,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             "<h1>Text</h1>".must_have_xpath('//h2')
-          end.must_raise(%r(expected xpath "//h2" to return something))
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -103,7 +103,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             "<h1>Text</h1>".wont_have_xpath('//h1')
-          end.must_raise(%r(expected xpath "//h1" not to return anything))
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -121,7 +121,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             page.must_have_xpath("//h1[@id='doesnotexist']")
-          end.must_raise(%r(expected xpath "//h1\[@id='doesnotexist'\]" to return something))
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -133,7 +133,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             page.wont_have_xpath('//h1')
-          end.must_raise(%r(expected xpath "//h1" not to return anything))
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -150,7 +150,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             "<h1>Text</h1>".must_have_selector('//h2')
-          end.must_raise(%r(expected xpath "//h2" to return something))
+          end.must_raise(MiniTest::Assertion)
         end
 
         it "fails with the selector's failure_message if set" do
@@ -160,7 +160,7 @@ describe CapybaraMinitestSpec do
           end
           proc do
             '<h1 id="monkey_paul">Monkey John</h1>'.must_have_selector(:monkey, 14)
-          end.must_raise("Monkey John")
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -172,7 +172,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             "<h1>Text</h1>".wont_have_selector(:css, 'h1')
-          end.must_raise(%r(expected css "h1" not to return anything))
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -190,13 +190,13 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             page.must_have_selector("//h1[@id='doesnotexist']")
-          end.must_raise(%r(expected xpath "//h1\[@id='doesnotexist'\]" to return something))
+          end.must_raise(MiniTest::Assertion)
         end
 
         it "includes text in error message" do
           proc do
             page.must_have_selector("//h1", :text => 'wrong text')
-          end.must_raise(%r(expected xpath "//h1" with text "wrong text" to return something))
+          end.must_raise(MiniTest::Assertion)
         end
 
         it "fails with the selector's failure_message if set" do
@@ -206,7 +206,7 @@ describe CapybaraMinitestSpec do
           end
           proc do
             page.must_have_selector(:monkey, 14)
-          end.must_raise("Monkey John, Monkey Paul")
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -218,7 +218,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             page.wont_have_selector(:css, 'h1', :text => 'test')
-          end.must_raise(%r(expected css "h1" with text "test" not to return anything))
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -235,7 +235,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             "<h1>Text</h1>".must_have_content('No such Text')
-          end.must_raise(/expected there to be content "No such Text" in "Text"/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
 
@@ -247,7 +247,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             "<h1>Text</h1>".wont_have_content('Text')
-          end.must_raise(/expected content "Text" not to return anything/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -265,7 +265,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_css? returns false" do
           proc do
             page.must_have_content('No such Text')
-          end.must_raise(/expected there to be content "No such Text" in "(.*)This is a test(.*)"/)
+          end.must_raise(MiniTest::Assertion)
         end
 
         describe "with default selector CSS" do
@@ -273,7 +273,7 @@ describe CapybaraMinitestSpec do
           it "fails if has_css? returns false" do
             proc do
               page.must_have_content('No such Text')
-            end.must_raise(/expected there to be content "No such Text" in "(.*)This is a test(.*)"/)
+            end.must_raise(MiniTest::Assertion)
           end
           after { Capybara.default_selector = :xpath }
         end
@@ -287,7 +287,7 @@ describe CapybaraMinitestSpec do
         it "fails if has_no_css? returns false" do
           proc do
             page.wont_have_content('This is a test')
-          end.must_raise(/expected content "This is a test" not to return anything/)
+          end.must_raise(MiniTest::Assertion)
         end
       end
     end
@@ -303,7 +303,7 @@ describe CapybaraMinitestSpec do
     it "fails if there is no such button" do
       proc do
         html.must_have_link('No such Link')
-      end.must_raise(/expected link "No such Link"/)
+      end.must_raise(MiniTest::Assertion)
     end
   end
 
@@ -317,7 +317,7 @@ describe CapybaraMinitestSpec do
     it "fails if there is no such button" do
       proc do
         html.must_have_button('No such Button')
-      end.must_raise(/expected button "No such Button"/)
+      end.must_raise(MiniTest::Assertion)
     end
   end
 
@@ -331,7 +331,7 @@ describe CapybaraMinitestSpec do
     it "fails if there is no such field" do
       proc do
         html.must_have_field('No such Field')
-      end.must_raise(/expected field "No such Field"/)
+      end.must_raise(MiniTest::Assertion)
     end
   end
 
@@ -349,13 +349,13 @@ describe CapybaraMinitestSpec do
       it "fails if there is such a field but it is not checked" do
         proc do
           html.must_have_checked_field('unchecked field')
-        end.must_raise(/expected checked_field "unchecked field"/)
+        end.must_raise(MiniTest::Assertion)
       end
 
       it "fails if there is no such field" do
         proc do
           html.must_have_checked_field('no such field')
-        end.must_raise(/expected checked_field "no such field"/)
+        end.must_raise(MiniTest::Assertion)
       end
     end
 
@@ -363,7 +363,7 @@ describe CapybaraMinitestSpec do
       it "fails if there is such a field and it is checked" do
         proc do
           html.wont_have_checked_field('it is checked')
-        end.must_raise(/expected checked_field "it is checked" not to return anything/)
+        end.must_raise(MiniTest::Assertion)
       end
 
       it "passes if there is such a field but it is not checked" do
@@ -390,13 +390,13 @@ describe CapybaraMinitestSpec do
       it "fails if there is such a field but it is checked" do
         proc do
           html.must_have_unchecked_field('it is checked')
-        end.must_raise(/expected unchecked_field "it is checked"/)
+        end.must_raise(MiniTest::Assertion)
       end
 
       it "fails if there is no such field" do
         proc do
           html.must_have_unchecked_field('no such field')
-        end.must_raise(/expected unchecked_field "no such field"/)
+        end.must_raise(MiniTest::Assertion)
       end
     end
 
@@ -404,7 +404,7 @@ describe CapybaraMinitestSpec do
       it "fails if there is such a field and it is not checked" do
         proc do
           html.wont_have_unchecked_field('unchecked field')
-        end.must_raise(/expected unchecked_field "unchecked field" not to return anything/)
+        end.must_raise(MiniTest::Assertion)
       end
 
       it "passes if there is such a field but it is checked" do
@@ -427,7 +427,7 @@ describe CapybaraMinitestSpec do
     it "fails if there is no such select" do
       proc do
         html.must_have_select('No such Select box')
-      end.must_raise(/expected select "No such Select box"/)
+      end.must_raise(MiniTest::Assertion)
     end
   end
 
@@ -441,12 +441,12 @@ describe CapybaraMinitestSpec do
     it "fails if there is no such select" do
       proc do
         html.must_have_table('No such Table')
-      end.must_raise(/expected table "No such Table"/)
+      end.must_raise(MiniTest::Assertion)
     end
   end
 
   describe 'failure message' do
-    it 'shows matcher name and args' do
+    it 'for assert shows matcher name and args' do
       begin
         'actual'.must_have_css('expected', :count => 1)
       rescue MiniTest::Assertion => ex
@@ -456,5 +456,16 @@ describe CapybaraMinitestSpec do
       end
       assert_equal 'Matcher failed: has_css?("expected", {:count=>1})', exception.message
     end
+
+    it 'for refute shows matcher name and args' do
+      begin
+        '<actual/>'.wont_have_css('actual', :count => 1)
+      rescue MiniTest::Assertion => ex
+        exception = ex
+      else
+        flunk 'No exception was raised'
+      end
+      assert_equal 'Matcher should have failed: has_css?("actual", {:count=>1})', exception.message
+    end
   end
 end

data/test/matcher_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe CapybaraMiniTestSpec::Matcher do
+
+  let(:matcher) { CapybaraMiniTestSpec::Matcher.new(:has_css?) }
+
+  it 'should define an assertion' do
+    MiniTest::Assertions.public_instance_methods.must_include(:assert_page_has_css)
+  end
+
+  it 'should define a refutation' do
+    MiniTest::Assertions.public_instance_methods.must_include(:refute_page_has_css)
+  end
+
+  it 'should define positive expectation' do
+    MiniTest::Expectations.public_instance_methods.must_include(:must_have_css)
+  end
+
+  it 'should define negative expectation' do
+    MiniTest::Expectations.public_instance_methods.must_include(:wont_have_css)
+  end
+
+  it 'should wrap the asserted object in a Capybara::Node::Simple' do
+    matcher.send(:wrap, '').must_be_instance_of(Capybara::Node::Simple)
+  end
+
+  it '#test returns true when test passes' do
+    test_result = matcher.test('<h1>Test</h1>', 'h1', {:count => 1})
+  end
+
+  it '#test returns false when test fails' do
+    test_result = matcher.test('<h1>Test</h1>', 'h2', {:count => 1})
+  end
+
+  it "#failure_message with 'assert' arg returns positive assertion failure message" do
+    message = CapybaraMiniTestSpec::Matcher.failure_message('assert', :has_css?, {:option => 1})
+    message.must_equal 'Matcher failed: has_css?({:option=>1})'
+  end
+
+  it "#failure_message with 'refute' arg returns negative assertion failure message" do
+    message = CapybaraMiniTestSpec::Matcher.failure_message('refute', :has_css?, {:option => 1})
+    message.must_equal 'Matcher should have failed: has_css?({:option=>1})'
+  end
+
+end

data/test/spec_helper.rb

@@ -5,12 +5,15 @@ require 'capybara/dsl'
 
 require 'capybara_minitest_spec'
 
+# Make all specs a subclass of MiniTest::Spec.
 MiniTest::Spec.register_spec_type //, MiniTest::Spec
 
+# Setup Rack test app.
 $LOAD_PATH << File.join(__FILE__, '../../test_app')
 require 'test_app'
 Capybara.app = TestApp
 
+# Set Capybara default selector to xpath.
 class MiniTest::Spec
   before :each do
     Capybara.configure do |config|
@@ -18,11 +21,3 @@ class MiniTest::Spec
     end
   end
 end
-
-class Proc
-  include MiniTest::Assertions
-  # TODO: Replace this with a real assertion that checks the message.
-  def must_raise(exception_or_message)
-    exception = assert_raises(MiniTest::Assertion, &self)
-  end
-end

metadata

@@ -2,7 +2,7 @@
 name: capybara_minitest_spec
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jared Ning
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-26 00:00:00 -05:00
+date: 2011-09-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,8 +65,10 @@ files:
 - Rakefile
 - capybara_minitest_spec.gemspec
 - lib/capybara_minitest_spec.rb
+- lib/capybara_minitest_spec/matcher.rb
 - lib/capybara_minitest_spec/version.rb
-- test/matchers_spec.rb
+- test/capybara_node_matchers_spec.rb
+- test/matcher_spec.rb
 - test/spec_helper.rb
 - test_app/driver.rb
 - test_app/fixtures/capybara.jpg
@@ -154,5 +156,6 @@ signing_key:
 specification_version: 3
 summary: MiniTest::Spec expectations for Capybara node matchers.
 test_files: 
-- test/matchers_spec.rb
+- test/capybara_node_matchers_spec.rb
+- test/matcher_spec.rb
 - test/spec_helper.rb