capybara_minitest_spec 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "xpath"]
+	path = xpath
+	url = https://github.com/jnicklas/xpath.git

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p0@capybara_minispec

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capybara_minitest_spec.gemspec
+gemspec
+
+#@dependencies.delete_if {|d| d.name == "xpath" }
+#gem 'xpath', :path => 'xpath'

data/README.md

@@ -0,0 +1,31 @@
+Capybara MiniTest Spec
+======================
+
+Define MiniTest::Spec expectations for Capybara node matchers.
+
+Description
+-----------
+
+If you like using Capybara and RSpec, you're used to matchers like:
+
+    page.should have_content('Title')
+
+Now you can have similar functionality while using MiniTest::Spec:
+
+    page.must_have_content('Title')
+
+Compatibility
+-------------
+
+In theory, this should work with any version of Capybara, so the runtime dependency is not version specific. At the time of this writing, it was tested with Capybara 1.1.1.
+
+TODO
+----
+
+* Better failure messages.
+
+Testing
+-------
+
+This gem was tested by copying the Capybara spec located in 'spec/rspec/matchers_spec.rb' and altering the test to run with MiniTest.
+Capybara uses xpath as a submodule of the git repository. When adding this gem to gemtesters (http://test.rubygems.org/gems/capybara_minitest_spec), it sounded like too much trouble to check out the submodule, so I just used the regular gem.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_spec.rb'
+end
+
+task :default => :test

data/capybara_minitest_spec.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capybara_minitest_spec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capybara_minitest_spec"
+  s.version     = CapybaraMinitestSpec::VERSION
+  s.authors     = ["Jared Ning"]
+  s.email       = ["jared@redningja.com"]
+  s.homepage    = ""
+  s.summary     = %q{MiniTest::Spec expectations for Capybara node matchers.}
+  s.description = %q{MiniTest::Spec expectations for Capybara node matchers.}
+
+  s.rubyforge_project = "capybara_minitest_spec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'capybara'
+  s.add_runtime_dependency 'minitest', '~> 2.0'
+
+  s.add_development_dependency 'sinatra', '>= 0.9.4'
+end

data/lib/capybara_minitest_spec/version.rb

@@ -0,0 +1,3 @@
+module CapybaraMinitestSpec
+  VERSION = '0.1.0'
+end

data/lib/capybara_minitest_spec.rb

@@ -0,0 +1,45 @@
+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), "Matcher #{without_question_mark} failed"
+    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), "Matcher #{without_question_mark} should have failed"
+    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
+
+end

data/test/matchers_spec.rb

@@ -0,0 +1,447 @@
+require 'spec_helper'
+
+describe CapybaraMinitestSpec do
+  include Capybara::DSL
+
+  describe "have_css matcher" do
+    describe "on a string" do
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          "<h1>Text</h1>".must_have_css('h1')
+        end
+
+        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
+
+        it "passes if matched node count equals expected count" do
+          "<h1>Text</h1>".must_have_css('h1', :count => 1)
+        end
+
+        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
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          "<h1>Text</h1>".wont_have_css('h2')
+        end
+
+        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
+
+        it "passes if matched node count does not equal expected count" do
+          "<h1>Text</h1>".wont_have_css('h1', :count => 2)
+        end
+
+        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
+      end
+    end
+
+    describe "on a page or node" do
+      before do
+        visit('/with_html')
+      end
+
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          page.must_have_css('h1')
+        end
+
+        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
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          page.wont_have_css('h1#doesnotexist')
+        end
+
+        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
+      end
+    end
+  end
+
+  describe "have_xpath matcher" do
+    describe "on a string" do
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          "<h1>Text</h1>".must_have_xpath('//h1')
+        end
+
+        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
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          "<h1>Text</h1>".wont_have_xpath('//h2')
+        end
+
+        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
+      end
+    end
+
+    describe "on a page or node" do
+      before do
+        visit('/with_html')
+      end
+
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          page.must_have_xpath('//h1')
+        end
+
+        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
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          page.wont_have_xpath('//h1[@id="doesnotexist"]')
+        end
+
+        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
+      end
+    end
+  end
+
+  describe "have_selector matcher" do
+    describe "on a string" do
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          assert Capybara.string("<h1>Text</h1>").has_selector?('//h1')
+          "<h1>Text</h1>".must_have_selector('//h1')
+        end
+
+        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
+
+        it "fails with the selector's failure_message if set" do
+          Capybara.add_selector(:monkey) do
+            xpath { |num| ".//*[contains(@id, 'monkey')][#{num}]" }
+            failure_message { |node, selector| node.all(".//*[contains(@id, 'monkey')]").map { |node| node.text }.sort.join(', ') }
+          end
+          proc do
+            '<h1 id="monkey_paul">Monkey John</h1>'.must_have_selector(:monkey, 14)
+          end.must_raise("Monkey John")
+        end
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          "<h1>Text</h1>".wont_have_selector(:css, 'h2')
+        end
+
+        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
+      end
+    end
+
+    describe "on a page or node" do
+      before do
+        visit('/with_html')
+      end
+
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          page.must_have_selector('//h1', :text => 'test')
+        end
+
+        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
+
+        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
+
+        it "fails with the selector's failure_message if set" do
+          Capybara.add_selector(:monkey) do
+            xpath { |num| ".//*[contains(@id, 'monkey')][#{num}]" }
+            failure_message { |node, selector| node.all(".//*[contains(@id, 'monkey')]").map { |node| node.text }.sort.join(', ') }
+          end
+          proc do
+            page.must_have_selector(:monkey, 14)
+          end.must_raise("Monkey John, Monkey Paul")
+        end
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          page.wont_have_selector(:css, 'h1#doesnotexist')
+        end
+
+        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
+      end
+    end
+  end
+
+  describe "have_content matcher" do
+
+    describe "on a string" do
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          "<h1>Text</h1>".must_have_content('Text')
+        end
+
+        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
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          "<h1>Text</h1>".wont_have_content('No such Text')
+        end
+
+        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
+      end
+    end
+
+    describe "on a page or node" do
+      before do
+        visit('/with_html')
+      end
+
+      describe "with should" do
+        it "passes if has_css? returns true" do
+          page.must_have_content('This is a test')
+        end
+
+        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
+
+        describe "with default selector CSS" do
+          before { Capybara.default_selector = :css }
+          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
+          after { Capybara.default_selector = :xpath }
+        end
+      end
+
+      describe "with should_not" do
+        it "passes if has_no_css? returns true" do
+          page.wont_have_content('No such Text')
+        end
+
+        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
+      end
+    end
+  end
+
+  describe "have_link matcher" do
+    let(:html) { '<a href="#">Just a link</a>' }
+
+    it "passes if there is such a button" do
+      html.must_have_link('Just a link')
+    end
+
+    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
+  end
+
+  describe "have_button matcher" do
+    let(:html) { '<button>A button</button><input type="submit" value="Another button"/>' }
+
+    it "passes if there is such a button" do
+      html.must_have_button('A button')
+    end
+
+    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
+  end
+
+  describe "have_field matcher" do
+    let(:html) { '<p><label>Text field<input type="text"/></label></p>' }
+
+    it "passes if there is such a field" do
+      html.must_have_field('Text field')
+    end
+
+    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
+  end
+
+  describe "have_checked_field matcher" do
+    let(:html) do
+      '<label>it is checked<input type="checkbox" checked="checked"/></label>
+      <label>unchecked field<input type="checkbox"/></label>'
+    end
+
+    describe "with should" do
+      it "passes if there is such a field and it is checked" do
+        html.must_have_checked_field('it is checked')
+      end
+
+      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
+
+      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
+    end
+
+    describe "with must_not" 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
+
+      it "passes if there is such a field but it is not checked" do
+        html.wont_have_checked_field('unchecked field')
+      end
+
+      it "passes if there is no such field" do
+        html.wont_have_checked_field('no such field')
+      end
+    end
+  end
+
+  describe "have_unchecked_field matcher" do
+    let(:html) do
+      '<label>it is checked<input type="checkbox" checked="checked"/></label>
+      <label>unchecked field<input type="checkbox"/></label>'
+    end
+
+    describe "with should" do
+      it "passes if there is such a field and it is not checked" do
+        html.must_have_unchecked_field('unchecked field')
+      end
+
+      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
+
+      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
+    end
+
+    describe "with must_not" 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
+
+      it "passes if there is such a field but it is checked" do
+        html.wont_have_unchecked_field('it is checked')
+      end
+
+      it "passes if there is no such field" do
+        html.wont_have_unchecked_field('no such field')
+      end
+    end
+  end
+
+  describe "have_select matcher" do
+    let(:html) { '<label>Select Box<select></select></label>' }
+
+    it "passes if there is such a select" do
+      html.must_have_select('Select Box')
+    end
+
+    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
+  end
+
+  describe "have_table matcher" do
+    let(:html) { '<table><caption>Lovely table</caption></table>' }
+
+    it "passes if there is such a select" do
+      html.must_have_table('Lovely table')
+    end
+
+    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
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+
+require 'minitest/autorun'
+require 'capybara/dsl'
+
+require 'capybara_minitest_spec'
+
+MiniTest::Spec.register_spec_type //, MiniTest::Spec
+
+$LOAD_PATH << File.join(__FILE__, '../../test_app')
+require 'test_app'
+Capybara.app = TestApp
+
+class MiniTest::Spec
+  before :each do
+    Capybara.configure do |config|
+      config.default_selector = :xpath
+    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)
+    assert_raises(MiniTest::Assertion, &self)
+  end
+end