RubyGems - test-unit-capybara - Versions diffs - 1.0.0 → 1.0.1 - Mend

test-unit-capybara 1.0.0 → 1.0.1

Files changed (14) hide show

data/Gemfile +29 -0
data/README.textile +87 -0
data/Rakefile +67 -19
data/doc/text/news.textile +15 -0
data/lib/test/unit/capybara.rb +448 -26
data/lib/test/unit/capybara/version.rb +25 -0
data/test/run-test.rb +30 -0
data/test/test-assertions.rb +278 -0
data/test/test-unit-capybara-test-utils.rb +28 -0
data/test/test-wrapper.rb +96 -0
metadata +117 -103
data/History.txt +0 -5
data/Manifest.txt +0 -6
data/README.txt +0 -30

data/Gemfile ADDED

@@ -0,0 +1,29 @@
+# -*- coding: utf-8; mode: ruby -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+gem "test-unit", ">= 2.4.4"
+gem "capybara", ">= 1.1.3"
+gem "json"
+group :development, :test do
+  gem "rake"
+  gem "jeweler"
+  gem "yard"
+  gem "packnga"
+  gem "test-unit-notify"
+end

data/README.textile ADDED

@@ -0,0 +1,87 @@
+h1. test-unit-capybara
+"Web site":http://test-unit.rubyforge.org/#test-unit-capybara
+h2. Description
+test-unit-capybara is a Capybara adapter for test-unit 2. You can get "Capybara":https://rubygems.org/gems/capybara integrated Test::Unit::TestCase. It also provides useful assertions for Capybara.
+h2. Install
+<pre>
+% sudo gem install test-unit-capybara
+</pre>
+h2. Usage
+<pre>
+require 'test/unit/capybara'
+class MyRackApplication
+  def call(env)
+    html = <<-HTML
+<html>
+  <head>
+    <title>Welcome! - my site</title>
+  </head>
+  <body>
+    <h1>Welcome!</h1>
+    <div class="header">
+      <p>No navigation.</p>
+    </div>
+  </body>
+</html>
+HTML
+   [200, {"Content-Type" => "text/html"}, [html]]
+  end
+end
+class TestMyRackApplication < Test::Unit::TestCase
+  include Capybara::DSL
+  def setup
+    Capybara.app = MyRackApplication.new
+  end
+  def test_title
+    visit("/")
+    within("h1") do
+      assert_equal("Welcome!", text)
+    end
+  end
+  def test_no_sidebar
+    visit("/")
+    within("body") do
+      assert_not_find(".sidebar")
+    end
+  end
+  def test_header_content
+    visit("/")
+    within(".header") do
+      find("ol.navi")
+      # This fails with the following message:
+      #
+      # <"ol.navi">(:css) expected to find a element in
+      # <<div class="header">
+      #       <p>No navigation.</p>
+      #     </div>>
+      #
+      # This messages shows the current context. You don't need to
+      # entire HTML. You just see the current context moved by "within".
+      # It helps you debug a problem without save_and_open_page.
+    end
+  end
+end
+</pre>
+h2. License
+LGPLv2.1 or later.
+(Kouhei Sutou has a right to change the license including contributed patches.)
+h2. Authors
+* Kouhei Sutou

data/Rakefile CHANGED

@@ -1,33 +1,81 @@
 # -*- ruby -*-
+#
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-require 'pathname'
+require './lib/test/unit/capybara/version'
-base_dir = Pathname(__FILE__).dirname.expand_path
-test_unit_dir = (base_dir.parent + "test-unit").expand_path
-test_unit_lib_dir = test_unit_dir + "lib"
-lib_dir = base_dir + "lib"
+require 'rubygems'
+require 'rubygems/package_task'
+require 'yard'
+require 'jeweler'
+require 'packnga'
-$LOAD_PATH.unshift(test_unit_lib_dir.to_s)
-$LOAD_PATH.unshift(lib_dir.to_s)
+def cleanup_white_space(entry)
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
-require 'test/unit/capybara'
+ENV["VERSION"] ||= Test::Unit::Capybara::VERSION
+version = ENV["VERSION"].dup
+spec = nil
+Jeweler::Tasks.new do |_spec|
+  spec = _spec
+  spec.name = "test-unit-capybara"
+  spec.version = version
+  spec.rubyforge_project = "test-unit"
+  spec.homepage = "http://test-unit.rubyforge.org/#test-unit-capybara"
+  spec.authors = ["Kouhei Sutou"]
+  spec.email = ["kou@clear-code.com"]
+  entries = File.read("README.textile").split(/^h2\.\s(.*)$/)
+  description = cleanup_white_space(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "LGPLv2 or later"
+  spec.files = FileList["lib/**/*.rb",
+                        "bin/*",
+                        "doc/text/*",
+                        "README.textile",
+                        "COPYING",
+                        "Rakefile",
+                        "Gemfile"]
+  spec.test_files = FileList["test/**/*.rb"]
+end
-require 'rubygems'
-require 'hoe'
+Rake::Task["release"].prerequisites.clear
+Jeweler::RubygemsDotOrgTasks.new do
+end
-Test::Unit.run = true
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz = true
+end
-version = Test::Unit::Capybara::VERSION
-ENV["VERSION"] = version
-Hoe.spec('test-unit-capybara') do
-  self.version = version
-  self.rubyforge_name = "test-unit"
+document_task = Packnga::DocumentTask.new(spec) do
+end
-  developer('Kouhei Sutou', 'kou@clear-code.com')
+Packnga::ReleaseTask.new(spec) do |task|
+end
-  extra_deps << ["test-unit", ">= 2.1.2"]
-  extra_deps << ["capybara"]
+# XXX: Workaround. This should be fixed in packnga.
+task :htaccess do
+  htaccess = "doc/html/test-unit-capybara/.htaccess"
+  htaccess_content = File.read(htaccess)
+  File.open(htaccess, "w") do |htaccess_file|
+    htaccess_file.print(htaccess_content.gsub(/#test-unit-capybara/, ""))
+  end
 end
+task "release:reference:publish" => :htaccess
 desc "Tag the current revision."
 task :tag do

data/doc/text/news.textile ADDED

@@ -0,0 +1,15 @@
+h1. News
+h2(#1-0-1). 1.0.1 - 2012-01-16
+A Capybara integration improvement release.
+h3. Improvments
+  * Added {Test::Unit::Capybara::Assertions#assert_all}.
+  * Added {Test::Unit::Capybara::Assertions#assert_not_find}.
+  * Supported Capybara::ElementNotFound as a failure.
+h2(#1-0-0). 1.0.0 - 2011-05-01
+The first release!!!

data/lib/test/unit/capybara.rb CHANGED

@@ -1,25 +1,37 @@
-#--
+# -*- ruby -*-
 #
-# Author:: Kouhei Sutou
-# Copyright::
-#   * Copyright (c) 2011 Kouhei Sutou <kou@clear-code.com>
-# License:: LGPLv2+
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+require "test/unit/capybara/version"
 require 'capybara'
 require 'capybara/dsl'
+require "json"
 require 'test/unit'
 module Test::Unit
   module Capybara
-    VERSION = "1.0.0"
     module Adapter
       class << self
         def included(mod)
           mod.module_eval do
             setup :before => :prepend
             def setup_capybara
-              return unless self.class.include?(::Capybara)
+              return unless self.class.include?(::Capybara::DSL)
               extend(Assertions)
               if self[:js]
                 ::Capybara.current_driver = ::Capybara.javascript_driver
@@ -30,7 +42,7 @@ module Test::Unit
             teardown :after => :append
             def teardown_capybara
-              return unless self.class.include?(::Capybara)
+              return unless self.class.include?(::Capybara::DSL)
               ::Capybara.reset_sessions!
               ::Capybara.use_default_driver
             end
@@ -39,33 +51,443 @@ module Test::Unit
       end
     end
+    # @private
+    class ElementNotFound < ::Capybara::ElementNotFound
+      attr_reader :node, :query
+      def initialize(node, query)
+        @node = node
+        @query = query
+        super(@query.failure_message(:find, @node))
+      end
+    end
+    # @private
+    module FindError
+      class << self
+        def included(base)
+          base.module_eval do
+            alias_method :raise_find_error_original, :raise_find_error
+            alias_method :raise_find_error, :raise_find_error_for_test_unit
+          end
+        end
+      end
+      def raise_find_error_for_test_unit(*args)
+        query = ::Capybara::Query.new(*args)
+        raise ElementNotFound.new(self, query)
+      end
+    end
+    # @private
+    class ::Capybara::Node::Base
+      include FindError
+    end
+    # @private
+    module ElementNotFoundHandler
+      class << self
+        def included(base)
+          base.exception_handler(:handle_capybara_element_not_found)
+        end
+      end
+      private
+      def handle_capybara_element_not_found(exception)
+        return false unless exception.is_a?(ElementNotFound)
+        return false unless respond_to?(:flunk_find)
+        query = exception.query
+        begin
+          flunk_find(exception.node,
+                     :kind => query.selector.name,
+                     :locator => query.locator)
+        rescue AssertionFailedError => assertion_failed_error
+          assertion_failed_error.backtrace.replace(exception.backtrace)
+          handle_exception(assertion_failed_error)
+        end
+      end
+    end
+    # @private
+    class NodeInspector
+      Inspector = ::Test::Unit::Assertions::AssertionMessage::Inspector
+      Inspector.register_inspector_class(self)
+      class << self
+        def target?(object)
+          object.is_a?(::Capybara::Node::Base)
+        end
+        def source(node)
+          if node.base.respond_to?(:source)
+            node.base.source
+          else
+            node.base.native.to_s
+          end
+        end
+      end
+      def initialize(node, inspected_objects)
+        @node = node
+        @inspected_objects = inspected_objects
+      end
+      def inspect
+        @node.inspect.gsub(/>\z/, " #{self.class.source(@node)}>")
+      end
+      def pretty_print(q)
+        q.text(@node.inspect.gsub(/>\z/, ""))
+        q.breakable
+        q.text("#{self.class.source(@node)}>")
+      end
+    end
     module Assertions
-      def assert_body(expected, options={})
+      # @private
+      AssertionMessage = ::Test::Unit::Assertions::AssertionMessage
+      # Passes if @expected@ == @source@. @source@ is a
+      # method provided by Capybara::DSL.
+      #
+      # @source@ may be parsed depended on response
+      # Content-Type before comparing. Here are parsed
+      # Content-Types:
+      #
+      # - @"application/json"@ := It's parsed by @JSON.parse@.
+      #
+      # @param [Object] expected the expected body
+      #   content. The actual body may be parsed. It
+      #   depends on @:content_type@ option.
+      #
+      # @option options [String] :content_type (nil)
+      #   the expected Content-Type. If this value is @nil@,
+      #   Content-Type will not be compared.
+      #
+      #   This value can be specified by abbreviated. Here
+      #   are abbreviations:
+      #
+      #   - @:json@ := @"application/json"@
+      #
+      # @yield [expected_response, actual_response] the
+      #   optional compared responses normalizer.
+      # @yieldparam [Hash] expected_response the expected
+      #   response constructed in the method.
+      # @yieldparam [Hash] actual_response the actual
+      #   response constructed in the method.
+      # @yieldreturn [expected_response, actual_response] the
+      #   normalized compared responses.
+      #
+      # @example Pass case
+      #   # Actual response:
+      #   #   Content-Type: application/json
+      #   #   Body: {"status": true}
+      #   assert_body({"status" => true}, :content_type => :json)
+      #
+      # @example Failure case
+      #   # Actual response:
+      #   #   Content-Type: text/html
+      #   #   Body: <html><body>Hello</body></html>
+      #   assert_body("<html><body>World</body></html>")
+      def assert_body(expected, options={}, &block)
         content_type = options[:content_type]
-        case content_type
-        when :json
-          assert_equal({
-                         :content_type => "application/json",
-                         :body => expected,
-                       },
-                       {
-                         :content_type => page.response_headers["Content-Type"],
-                         :body => JSON.parse(body),
-                       })
+        actual_response = {
+          :content_type => page_content_type,
+          :body => parsed_page_body,
+        }
+        expected_response = {:body => expected}
+        if content_type
+          expected_response[:content_type] = normalize_content_type(content_type)
+        else
+          actual_response.delete(:content_type)
+        end
+        if block_given?
+          expected_response, actual_response = yield(expected_response,
+                                                     actual_response)
+	end
+        assert_equal(expected_response, actual_response)
+      end
+      # @param [...] args (see {::Capybara::Node::Finders#all})
+      # @return [Array<::Capybara::Element>] The found elements.
+      #
+      # @see Capybara::Node::Finders#all
+      #
+      # @overload assert_all(*args)
+      #   Passes if the selector finds one or more elements
+      #   from the current node.
+      #
+      #   @example Pass case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     h2_elements = assert_page_all("h2")
+      #     p h2_elements
+      #       # => [#<Capybara::Element tag="h2" path="/html/body/h2">,
+      #       #     #<Capybara::Element tag="h2" path="/html/body/div/h2">]
+      #
+      #   @example Failure case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     assert_page_all("h3")
+      #
+      # @overload assert_all(node, *args)
+      #   Passes if the selector finds one or more elements
+      #   from @node@.
+      #
+      #   @param [::Capybara::Node::Base] node The target node.
+      #
+      #   @example Pass case (simple)
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     section = assert_find("div.section")
+      #     p section
+      #       # => #<Capybara::Element tag="h2" path="/html/body/div">
+      #     h2_elements = assert_all(section, "h2")
+      #     p h2_elements
+      #       # => [#<Capybara::Element tag="h2" path="/html/body/div/h2">]
+      def assert_all(*args)
+        node = nil
+        node = args.shift if args[0].is_a?(::Capybara::Node::Base)
+        args = normalize_page_finder_arguments(args)
+        format = <<-EOT
+<?>(?) expected to find one or more elements in
+<?>
+EOT
+        current_context = node || page.send(:current_node)
+        current_context_source = node_source(current_context)
+        source_in_message = AssertionMessage.literal(current_context_source)
+        full_message = build_message(args[:message],
+                                     format,
+                                     args[:locator],
+                                     args[:kind],
+                                     source_in_message)
+        if node
+          elements = node.all(*args[:finder_arguments])
+        else
+          elements = all(*args[:finder_arguments])
+        end
+        assert_block(full_message) do
+          not elements.empty?
+        end
+        elements
+      end
+      # @param [...] args (see {::Capybara::Node::Finders#find})
+      #
+      # @see ::Capybara::Node::Finders#find
+      #
+      # @overload assert_not_find(*args, &block)
+      #   Passes if the selector doesn't find any elements
+      #   from the current node.
+      #
+      #   @example Pass case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     assert_not_find("h3")
+      #
+      #   @example Failure case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     assert_not_find("h1")
+      #
+      # @overload assert_not_find(node, *args, &block)
+      #   Passes if the selector doesn't find any element from @node@.
+      #
+      #   @param [::Capybara::Node::Base] node The target node.
+      #
+      #   @example Pass case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     section = assert_find("section")
+      #     p section
+      #       # => #<Capybara::Element tag="h2" path="/html/body/div">
+      #     assert_not_find(section, "h1")
+      #
+      #   @example Failure case
+      #     # Actual response:
+      #     #   <html>
+      #     #     <body>
+      #     #       <h1>Hello</h1>
+      #     #       <h2>Yay!</h2>
+      #     #       <div class="section">
+      #     #         <h2>World</h2>
+      #     #       </div>
+      #     #     </body>
+      #     #   </html>
+      #     section = assert_find("section")
+      #     p section
+      #       # => #<Capybara::Element tag="h2" path="/html/body/div">
+      #     assert_not_find(section, "h2")
+      def assert_not_find(*args, &block)
+        node = nil
+        node = args.shift if args[0].is_a?(::Capybara::Node::Base)
+        args = normalize_page_finder_arguments(args)
+        if node
+          element = node.first(*args[:finder_arguments])
+        else
+          element = first(*args[:finder_arguments])
+        end
+        format = <<-EOT
+<?>(?) expected to not find a element but was
+<?> in
+<?>
+EOT
+        element_source = nil
+        element_source = node_source(element) if element
+        current_context = node || page.send(:current_node)
+        current_context_source = node_source(current_context)
+        source_in_message = AssertionMessage.literal(current_context_source)
+        full_message = build_message(args[:message],
+                                     format,
+                                     args[:locator],
+                                     args[:kind],
+                                     AssertionMessage.literal(element_source),
+                                     source_in_message)
+        assert_block(full_message) do
+          element.nil?
+        end
+      end
+      # Fails always with {::Capybara::Node::Element} is not
+      # found message.
+      #
+      # @param [::Capybara::Node::Element] base_node The
+      #   node used as search target.
+      # @option options [String] :message The user custom
+      #   message added to failure message.
+      # @option options [String] :locator The query used to
+      #   find a node.
+      #
+      #   It should be specified for useful failure message.
+      # @option options [String] :kind The kind of query.
+      #
+      #   It should be specified for useful failure message.
+      def flunk_find(base_node, options={})
+        format = <<-EOT
+<?>(?) expected to find a element in
+<?>
+EOT
+        base_html = AssertionMessage.literal(node_source(base_node))
+        full_message = build_message(options[:message],
+                                     format,
+                                     options[:locator],
+                                     options[:kind],
+                                     base_html)
+        assert_block(full_message) do
+          false
+        end
+      end
+      private
+      def page_content_type
+        page.response_headers["Content-Type"]
+      end
+      def parsed_page_body
+        case page_content_type
+        when "application/json"
+          ::JSON.parse(source)
+        else
+          source
+        end
+      end
+      def normalize_page_finder_arguments(args)
+        args = args.dup
+        options = {}
+        options = args.pop if args.last.is_a?(Hash)
+        if args.size == 1
+          locator = args[0]
+          if locator[0, 1] == "/"
+            kind = :xpath
+            args.unshift(kind)
+          else
+            kind = ::Capybara.default_selector
+          end
         else
-          format = "unsupported content type: <?>\n" +
-            "expected: <?>\n" +
-            " options: <?>"
-          arguments = [content_type, expected, options]
-          assert_block(build_message(nil, format, *arguments)) do
-            false
+          kind, locator, = args
+        end
+        args << options
+        {
+          :kind => kind,
+          :locator => locator,
+          :message => options.delete(:message),
+          :finder_arguments => args,
+        }
+      end
+      def node_source(node)
+        if node
+          if node.base.respond_to?(:source)
+            node.base.source
+          else
+            node.base.native.to_s
           end
+        else
+          source
         end
       end
+      # @private
+      CONTENT_TYPE_SHORTCUTS = {
+        :json => "application/json",
+      }
+      def normalize_content_type(content_type)
+        CONTENT_TYPE_SHORTCUTS[content_type] || content_type
+      end
     end
   end
   class TestCase
     include Capybara::Adapter
+    include Capybara::ElementNotFoundHandler
   end
 end