capybara-extensions 0.2.0 → 0.3.0

data/lib/capybara-extensions/matchers.rb

@@ -0,0 +1,74 @@
+require_relative 'locators'
+
+module CapybaraExtensions::Matchers
+  include CapybaraExtensions::Locators
+  CapybaraExtensions::ExtensionMethods.concat [:has_field_value?, :has_no_field_value?, :has_image?, :has_no_image?, :has_meta_tag?, :has_no_meta_tag?]
+
+  # Checks that the current node has an image with the given src or alt.
+  #
+  # @param options [Hash] must pass a hash containing src and/or alt to match against.
+  # @return [Boolean] true if the image matches.
+  #
+  def has_image?(options = {})
+    raise "Must pass a hash containing 'src' or 'alt'" unless options.is_a?(Hash) && (options.has_key?(:src) || options.has_key?(:alt))
+    has_selector?(:xpath, "//img#{image_locator(options)}")
+  end
+
+  # Checks that the current node does not have an image with the given src or alt.
+  #
+  # @param options [Hash] must pass a hash containing src and/or alt to match against.
+  # @return [Boolean] true if the image does not match.
+  #
+  def has_no_image?(options = {})
+    raise "Must pass a hash with 'alt' or 'src'" unless options.is_a?(Hash) and (options.has_key?(:alt) or options.has_key?(:src))
+    has_no_selector?(:xpath, "//img#{image_locator(options)}")
+  end
+
+  # Checks that the value of a field matches a given value. Typically, you'll want to scope this to a form.
+  #
+  # @param locator [String] the label, name, or id of the field.
+  # @param text [String] the text to match against the field value.
+  # @return [Boolean] true if the field value matches.
+  #
+  def has_field_value?(locator, text)
+    if find_field(locator).value == text
+      true
+    else
+      raise Capybara::ExpectationNotMet, "expected to find field #{locator} with a value of #{text}."
+    end
+  end
+
+  # Checks that the value of a field does not match a given value. Typically, you'll want to scope this to a form.
+  #
+  # @param locator [String] the label, name, or id of the field.
+  # @param text [String] the text to match against the field value.
+  # @return [Boolean] true if the field value does not match.
+  #
+  def has_no_field_value?(locator, text)
+    if find_field(locator).value != text
+      true
+    else
+      raise Capybara::ExpectationNotMet, "expected to not find field #{locator} with a value of #{text}."
+    end
+  end
+
+  # Checks the that the content of a meta tag matches a given value.
+  #
+  # @param name [String] the name attribute of the meta tag.
+  # @param content [String] the value of the content attribute to match against.
+  # @return [Boolean] true if the meta tag content matches the name.
+  #
+  def has_meta_tag?(name, content)
+    has_selector?(:xpath, "/html/head/meta#{meta_tag_locator(name, content)}", visible: false)
+  end
+
+  # Checks the that the content of a meta tag does not match a given value.
+  #
+  # @param name [String] the name attribute of the meta tag.
+  # @param content [String] the value of the content attribute to match against.
+  # @return [Boolean] true if the meta tag content does not match the name.
+  #
+  def has_no_meta_tag?(name, content)
+    has_no_selector?(:xpath, "/html/head/meta#{meta_tag_locator(name, content)}", visible: false)
+  end
+end

data/lib/capybara-extensions/version.rb

@@ -0,0 +1,3 @@
+module CapybaraExtensions
+  VERSION = "0.3.0"
+end

data/lib/capybara-extensions.rb

@@ -1,12 +1,30 @@
-require 'rubygems'
 require 'capybara'
+require 'capybara_minitest_spec'
 
-module Capybara
-  module Node
-    module Finders
-      def parent
-        find(:xpath, '..')
-      end
+module CapybaraExtensions
+  ExtensionMethods = []
+end
+
+require 'capybara-extensions/finders'
+require 'capybara-extensions/matchers'
+
+module Capybara::DSL
+  CapybaraExtensions::ExtensionMethods.each do |method|
+    define_method method do |*args, &block|
+      page.send method, *args, &block
+    end
+  end
+end
+
+class Capybara::Session
+  CapybaraExtensions::ExtensionMethods.each do |method|
+    define_method method do |*args, &block|
+      current_scope.send method, *args, &block
     end
   end
 end
+
+Capybara::Node::Base.send(:include, CapybaraExtensions::Finders)
+Capybara::Node::Base.send(:include, CapybaraExtensions::Matchers)
+Capybara::Node::Simple.send(:include, CapybaraExtensions::Matchers)
+Capybara::Node::Simple.send(:include, CapybaraExtensions::Finders)

data/test/finders_test.rb

@@ -0,0 +1,353 @@
+require 'test_helper'
+
+describe '.string' do
+  let(:post) { Post.new(3) }
+  let(:string) { Capybara.string TestString }
+  let(:unique) { 'John Doe' }
+  let(:multiple) { 'Jane Doe' }
+
+  # Finders
+  # article
+  #
+  describe '#find_article' do
+    it 'finds the article when passed a unique string' do
+      string.find_article(unique).text.must_have_content unique
+      string.find_article(unique).text.wont_have_content multiple
+      string.article(unique).text.must_have_content unique
+      string.article(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the article when passed an instance' do
+      string.find_article(post).text.must_have_content unique
+      string.find_article(post).text.wont_have_content multiple
+      string.article(post).text.must_have_content unique
+      string.article(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_article' do
+    it 'finds the first article when passed a non-unique string' do
+      string.first_article(multiple).text.must_have_content multiple
+      string.first_article(multiple).text.wont_have_content unique
+    end
+  end
+
+
+  # li
+  #
+  describe '#find_list_item' do
+    it 'finds the list item when passed a unique string' do
+      string.find_list_item('foo').text.must_have_content 'foo'
+      string.find_list_item('foo').text.wont_have_content 'bar'
+      string.list_item('foo').text.must_have_content 'foo'
+      string.list_item('foo').text.wont_have_content 'bar'
+    end
+
+    it 'finds the list item when passed an instance' do
+      string.find_list_item(post).text.must_have_content 'foo'
+      string.find_list_item(post).text.wont_have_content 'bar'
+      string.list_item(post).text.must_have_content 'foo'
+      string.list_item(post).text.wont_have_content 'bar'
+    end
+  end
+
+  describe '#list_item_number' do
+    it 'return the list item of the number passed in to an ol' do
+      string.find_unordered_list('foo').list_item_number(2).must_have_content 'bar'
+      string.find_unordered_list('foo').list_item_number(2).wont_have_content 'foo'
+    end
+  end
+
+  # ol
+  #
+  describe '#find_ordered_list' do
+    it 'finds the ordered list when passed a unique string' do
+      string.find_ordered_list(unique).text.must_have_content unique
+      string.find_ordered_list(unique).text.wont_have_content multiple
+      string.ordered_list(unique).text.must_have_content unique
+      string.ordered_list(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the ordered list when passed an instance' do
+      string.find_ordered_list(post).text.must_have_content unique
+      string.find_ordered_list(post).text.wont_have_content multiple
+      string.ordered_list(post).text.must_have_content unique
+      string.ordered_list(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_ordered_list' do
+    it 'finds the first ordered list when passed a non-unique string' do
+      string.first_ordered_list(multiple).text.must_have_content multiple
+      string.first_ordered_list(multiple).text.wont_have_content unique
+    end
+  end
+
+  # ul
+  #
+  describe '#find_unordered_list' do
+    it 'finds the unordered list when passed a unique string' do
+      string.find_unordered_list(unique).text.must_have_content unique
+      string.find_unordered_list(unique).text.wont_have_content multiple
+      string.unordered_list(unique).text.must_have_content unique
+      string.unordered_list(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the unordered list when passed an instance' do
+      string.find_unordered_list(post).text.must_have_content unique
+      string.find_unordered_list(post).text.wont_have_content multiple
+      string.unordered_list(post).text.must_have_content unique
+      string.unordered_list(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_unordered_list' do
+    it 'finds the first unordered list when passed a non-unique string' do
+      string.first_unordered_list(multiple).text.must_have_content multiple
+      string.first_unordered_list(multiple).text.wont_have_content unique
+    end
+  end
+
+  # tr
+  #
+  describe '#find_row' do
+    it 'finds the row when passed a unique string' do
+      string.find_row(unique).text.must_have_content unique
+      string.find_row(unique).text.wont_have_content multiple
+      string.row(unique).text.must_have_content unique
+      string.row(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the row when passed an instance' do
+      string.find_row(post).text.must_have_content unique
+      string.find_row(post).text.wont_have_content multiple
+      string.row(post).text.must_have_content unique
+      string.row(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_row' do
+    it 'finds the first nav when passed a non-unique string' do
+      string.first_row(multiple).text.must_have_content multiple
+      string.first_row(multiple).text.wont_have_content unique
+    end
+  end
+
+  describe '#row_number' do
+    it 'returns the row of the number passed in when scoped to a table' do
+      string.find_table('Jane Doe').row_number(1).text.must_have_content 'The first post title'
+      string.find_table('Jane Doe').row_number(1).text.wont_have_content 'The second post title'
+      string.find_table('Jane Doe').row_number(2).text.must_have_content 'The second post title'
+      string.find_table('Jane Doe').row_number(2).text.wont_have_content 'The first post title'
+    end
+  end
+
+  # paragraph
+  #
+  describe '#find_paragraph' do
+    it 'finds the paragraph when passed a unique string' do
+      string.find_paragraph(unique).text.must_have_content unique
+      string.find_paragraph(unique).text.wont_have_content multiple
+      string.paragraph(unique).text.must_have_content unique
+      string.paragraph(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the paragraph when passed an instance' do
+      string.find_paragraph(post).text.must_have_content unique
+      string.find_paragraph(post).text.wont_have_content multiple
+      string.paragraph(post).text.must_have_content unique
+      string.paragraph(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_paragraph' do
+    it 'finds the first paragraph containing a string' do
+      string.first_paragraph(multiple).text.must_have_content multiple
+      string.first_paragraph(multiple).text.wont_have_content unique
+    end
+  end
+
+  # table
+  #
+  describe '#find_table' do
+    it 'finds the table when passed a unique string' do
+      string.find_table(unique).text.must_have_content unique
+      string.find_table(unique).text.wont_have_content multiple
+      string.table(unique).text.must_have_content unique
+      string.table(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the table when passed a non-unique string' do
+      string.find_table(multiple).text.must_have_content multiple
+      string.find_table(multiple).text.wont_have_content unique
+    end
+
+    it 'finds the table when passed an instance object' do
+      string.find_table(post).text.must_have_content unique
+      string.find_table(post).text.wont_have_content multiple
+    end
+  end
+
+  describe '#first_table' do
+    it 'finds the first table when passed a non-unique string' do
+      string.first_table(multiple).text.must_have_content multiple
+      string.first_table(multiple).text.wont_have_content unique
+    end
+  end
+
+
+  # navigation
+  #
+  describe '#navigation' do
+    it 'finds the navigation when passed a unique string' do
+      string.find_navigation(unique).text.must_have_content unique
+      string.find_navigation(unique).text.wont_have_content multiple
+      string.navigation(unique).text.must_have_content unique
+      string.navigation(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the nav when passed an instance' do
+      string.find_navigation(post).text.must_have_content multiple
+      string.find_navigation(post).text.wont_have_content unique
+      string.navigation(post).text.must_have_content multiple
+      string.find_navigation(post).text.wont_have_content unique
+    end
+  end
+
+  describe '#first_navigation' do
+    it 'finds the first navigation when passed a non-unique string' do
+      string.first_navigation(multiple).text.must_have_content multiple
+      string.first_navigation(multiple).text.wont_have_content unique
+    end
+  end
+
+  # section
+  #
+  describe '#section' do
+    it 'finds a section when passed a unique string' do
+      string.find_section(unique).text.must_have_content unique
+      string.find_section(unique).text.wont_have_content multiple
+      string.section(unique).text.must_have_content unique
+      string.section(unique).text.wont_have_content multiple
+    end
+
+    it 'finds a section when passed an instance' do
+      string.find_section(post).text.must_have_content unique
+      string.find_section(post).text.wont_have_content multiple
+      string.section(post).text.must_have_content unique
+      string.section(post).text.wont_have_content multiple
+    end
+  end
+
+  # header
+  #
+  describe '#header' do
+    it 'finds the header when passed a unique string' do
+      string.find_header(unique).text.must_have_content unique
+      string.find_header(unique).text.wont_have_content multiple
+      string.header(unique).text.must_have_content unique
+      string.header(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the header when passed an instance' do
+      string.find_header(post).text.must_have_content multiple
+      string.find_header(post).text.wont_have_content unique
+      string.header(post).text.must_have_content multiple
+      string.find_header(post).text.wont_have_content unique
+    end
+  end
+
+  describe '#first_header' do
+    it 'finds the first header when passed a non-unique string' do
+      string.first_header(multiple).text.must_have_content multiple
+      string.first_header(multiple).text.wont_have_content unique
+    end
+  end
+
+  # footer
+  #
+  describe '#footer' do
+    it 'finds the footer when passed a unique string' do
+      string.find_footer(unique).text.must_have_content unique
+      string.find_footer(unique).text.wont_have_content multiple
+      string.footer(unique).text.must_have_content unique
+      string.footer(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the footer when passed an instance' do
+      string.find_footer(post).text.must_have_content multiple
+      string.find_footer(post).text.wont_have_content unique
+      string.footer(post).text.must_have_content multiple
+      string.find_footer(post).text.wont_have_content unique
+    end
+  end
+
+  describe '#first_footer' do
+    it 'finds the first footer when passed a non-unique string' do
+      string.first_footer(multiple).text.must_have_content multiple
+      string.first_footer(multiple).text.wont_have_content unique
+    end
+  end
+
+  # aside
+  #
+  describe '#aside' do
+    it 'finds the aside when passed a unique string' do
+      string.find_aside(unique).text.must_have_content unique
+      string.find_aside(unique).text.wont_have_content multiple
+      string.aside(unique).text.must_have_content unique
+      string.aside(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the aside when passed an instance' do
+      string.find_aside(post).text.must_have_content multiple
+      string.find_aside(post).text.wont_have_content unique
+      string.aside(post).text.must_have_content multiple
+      string.find_aside(post).text.wont_have_content unique
+    end
+  end
+
+  describe '#first_aside' do
+    it 'finds the first aside when passed a non-unique string' do
+      string.first_aside(multiple).text.must_have_content multiple
+      string.first_aside(multiple).text.wont_have_content unique
+    end
+  end
+
+  # form
+  #
+  describe '#form' do
+    it 'finds the form when passed a unique string' do
+      string.find_form(unique).text.must_have_content unique
+      string.find_form(unique).text.wont_have_content multiple
+      string.form(unique).text.must_have_content unique
+      string.form(unique).text.wont_have_content multiple
+    end
+
+    it 'finds the form when passed an instance' do
+      string.find_form(post).text.must_have_content multiple
+      string.find_form(post).text.wont_have_content unique
+      string.form(post).text.must_have_content multiple
+      string.find_form(post).text.wont_have_content unique
+    end
+  end
+
+  describe '#first_form' do
+    it 'finds the first form when passed a non-unique string' do
+      string.first_form(multiple).text.must_have_content multiple
+      string.first_form(multiple).text.wont_have_content unique
+    end
+  end
+
+  # image
+  #
+  describe '#find_image' do
+    let(:image) { 'http://example.com/johndoe' }
+
+    it 'finds an image when passed src and alt' do
+      string.find_image(src: 'http://example.com/johndoe', alt: 'John Doe').native.attributes['src'].value.must_equal image
+      string.find_image(src: 'http://example.com/johndoe').native.attributes['src'].value.must_equal image
+      string.find_image(alt: 'John Doe').native.attributes['src'].value.must_equal image
+    end
+  end
+end

data/test/matchers_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+describe '.string' do
+  let(:post) { Post.new(3) }
+  let(:string) { Capybara.string TestString }
+  let(:unique) { 'John Doe' }
+  let(:multiple) { 'Jane Doe' }
+
+  # images
+  describe '#has_image?' do
+    it 'returns true if the image has an alt with the argument' do
+      string.has_image?(alt: unique).must_equal true
+    end
+
+    it 'returns false if the image does not have an alt with the argument' do
+      string.has_image?(alt: multiple).must_equal false
+    end
+
+    it 'returns true if the image has an src with the argument' do
+      string.has_image?(src: 'http://example.com/johndoe').must_equal true
+    end
+
+    it 'returns false if the image does not have an src with the argument' do
+      string.has_image?(src: 'http://example.com/johndoh').must_equal false
+    end
+
+    it 'returns true if the image has an alt and an src with the arguments' do
+      string.has_image?(alt: unique, src: 'http://example.com/johndoe').must_equal true
+    end
+
+    it 'returns false if the image does not have an alt and an src with the arguments' do
+      string.has_image?(alt: unique, src: 'http://example.com/johndoh').must_equal false
+    end
+  end
+
+  describe '#has_no_image?' do
+    it 'returns true if there is no image with the alt' do
+      string.has_no_image?(alt: multiple).must_equal true
+    end
+
+    it 'returns false if there is an image with the alt' do
+      string.has_no_image?(alt: unique).must_equal false
+    end
+
+    it 'returns true if there is no image with the src' do
+      string.has_no_image?(src: 'http://example.com/johndoh').must_equal true
+    end
+
+    it 'returns false if there is an image with the src' do
+      string.has_no_image?(src: 'http://example.com/johndoe').must_equal false
+    end
+
+    it 'returns true if there is no image with an alt and a src with the arguments' do
+      string.has_no_image?(alt: unique, src: 'http://example.com/johndoh').must_equal true
+    end
+  end
+
+  # field_values
+  describe '#has_field_value?' do
+    it 'returns true when the field has the passed in value' do
+      string.find_form(unique).has_field_value?('name', unique).must_equal true
+    end
+
+    it 'fails if has_field_value? returns false' do
+      assert_raises(Capybara::ExpectationNotMet) do
+        string.find_form(unique).has_field_value?(:name, multiple)
+      end.must_have_content 'expected to find field name with a value of Jane Doe.'
+    end
+  end
+
+  describe '#has_no_field_value?' do
+    it 'returns true if the field does not have the passed in value' do
+      string.find_form(unique).has_no_field_value?('name', 'John Doh').must_equal true
+    end
+
+    it 'fails if has_no_field_value? returns false' do
+      assert_raises(Capybara::ExpectationNotMet) do
+        string.find_form(unique).has_no_field_value?('name', unique)
+      end.must_have_content 'expected to not find field name with a value of John Doe.'
+    end
+  end
+
+  # meta tags
+  describe '#has_meta_tag?' do
+    it 'returns true when the meta tag name and content are present' do
+      string.has_meta_tag?('title', 'CapybaraExtensions!').must_equal true
+    end
+
+    it 'returns false when the meta tag name is not present' do
+      string.has_meta_tag?('nonexistent_name', 'CapybaraExtensions!').must_equal false
+    end
+
+    it 'returns false when the meta tag content is not present' do
+      string.has_meta_tag?('title', 'Nonexistent content').must_equal false
+    end
+  end
+
+  describe '#has_no_meta_tag?' do
+    it 'returns true when the meta tag name and content are not present' do
+      string.has_no_meta_tag?('title', 'foo').must_equal true
+    end
+
+    it 'returns true when the meta tag name is not present' do
+      string.has_no_meta_tag?('nonexistent_name', 'CapybaraExtensions!').must_equal true
+    end
+
+    it 'returns true when the meta tag content is not present' do
+      string.has_no_meta_tag?('title', 'Nonexistent content').must_equal true
+    end
+
+    it 'returns false when the meta tag name and content are present' do
+      string.has_no_meta_tag?('title', 'CapybaraExtensions!').must_equal false
+    end
+  end
+end