hermes 0.2.1 → 0.3.0

data/README.rdoc

@@ -2,6 +2,10 @@
 
 A few testing facilities built on top of Capybara and ActiveSupport::TestCase
 
+== TODO
+
+* Improve this README mentioning each module and how to configure it to work with Rspec and/or Rails.
+
 == Bugs and Features
 
 If you discover any bugs or add any features, please let us know using GitHub's tracker.

data/lib/hermes.rb

@@ -1,2 +1,8 @@
 module Hermes
-end
+  autoload :Context, 'hermes/context'
+  autoload :IntegrationCase, 'hermes/integration_case'
+  autoload :Actions, 'hermes/actions'
+  autoload :Builders, 'hermes/builders'
+  autoload :Scopes, 'hermes/scopes'
+  autoload :Assertions, 'hermes/assertions'
+end

data/lib/hermes/actions.rb

@@ -0,0 +1,81 @@
+module Hermes
+  # A few actions built on top of Capybara.
+  module Actions
+
+    POSTFIXES = {
+      :year   => '1i',
+      :month  => '2i',
+      :day    => '3i',
+      :hour   => '4i',
+      :minute => '5i'
+    }.freeze
+
+    def select_datetime(datetime, options={})
+      select_prefix = select_prefix_from_options(options)
+
+      select_time(datetime, :id_prefix => select_prefix)
+      select_date(datetime, :id_prefix => select_prefix)
+    end
+
+    def select_time(time, options={})
+      select_prefix = select_prefix_from_options(options)
+
+      find_and_select_option(select_prefix,
+                             POSTFIXES[:hour],
+                             string_with_double_digits(time.hour))
+
+      find_and_select_option(select_prefix,
+                             POSTFIXES[:minute],
+                             string_with_double_digits(time.min))
+    end
+
+    def select_date(date, options={})
+      select_prefix = select_prefix_from_options(options)
+
+      find_and_select_option(select_prefix,
+                             POSTFIXES[:year],
+                             date.year)
+
+      find_and_select_option(select_prefix,
+                             POSTFIXES[:month],
+                             date.month)
+
+      find_and_select_option(select_prefix,
+                             POSTFIXES[:day],
+                             string_with_double_digits(date.day))
+    end
+
+    private
+
+    def find_and_select_option(select_prefix, postfix, value)
+      no_select_msg = "cannot select option, no select box with id prefix '#{select_prefix}' found"
+      no_option_msg = "cannot select option, no option with text '#{value}' in select box '#{select_prefix}'"
+
+      select = find(:css, "##{select_prefix}_#{postfix}", :message => no_select_msg)
+      select.find(:xpath, ".//option[contains(./@value, '#{value}')]", :message => no_option_msg).select_option
+    end
+
+    def string_with_double_digits(number)
+      "%.2d" % number
+    end
+
+    def select_prefix_from_options(options)
+      if options.slice(:id_prefix, :from).values.blank?
+        raise(ArgumentError, 'You must supply either :from or :id_prefix option')
+      end
+
+      select_prefix   = options[:id_prefix]
+      select_prefix ||= find_prefix_by_label(options[:from])
+
+      select_prefix
+    end
+
+    def find_prefix_by_label(label)
+      message = "cannot select option, select with label '#{label}' not found"
+      find(:xpath,
+           "//label[contains(normalize-space(string(.)), '#{label}')]/@for",
+           :message => message
+          ).text
+    end
+  end
+end

data/lib/hermes/assertions.rb

@@ -1,25 +1,37 @@
 module Hermes
   # A few assertions built on top of Capybara.
   module Assertions
+
+    METHODS = {
+      'xpath' => 'no_xpath',
+      'css' => 'no_css',
+      'link' => 'no_link',
+      'select' => 'no_select',
+      'field' => 'no_field',
+      'button' => 'no_button',
+      'checked_field' => 'unchecked_field',
+      'selector' => 'no_selector',
+      'table' => 'no_table'
+    }.freeze
+
     def assert_current_path(expected)
       assert_equal expected, current_path
     end
 
     def assert_difference_on_click_button(button, *args)
-      assert_difference *args do
+      assert_difference(*args) do
         click_button button
       end
     end
 
     def assert_difference_on_click_link(link, *args)
-      assert_difference *args do
+      assert_difference(*args) do
         click_link link
       end
     end
 
     def assert_content(content)
-      boolean = has_content?(content)
-      if boolean
+      if has_content?(content)
         assert_block("assert_content") { true }
       else
         assert_block("#{body_inner_text}\nExpected to have #{content}"){ false }
@@ -29,29 +41,29 @@ module Hermes
     def assert_no_content(content)
       boolean = has_content?(content)
       if boolean
-        assert_block("#{body_inner_text}\nDid not expect to have content #{content}"){ false }
+        assert_block("#{body_inner_text}\nExpected to have no content #{content}"){ false }
       else
         assert_block("assert_no_content") { true }
       end
     end
 
-    %w(xpath css link select field button checked_field unchecked_field selector table).each do |method|
+    METHODS.each do |inclusion_method, rejection_method|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def assert_#{method}(*args, &block)
-          boolean = has_#{method}?(*args, &block)
-          if boolean
-            assert_block("assert_#{method}") { true }
+        def assert_#{inclusion_method}(*args, &block)
+          match = has_#{inclusion_method}?(*args, &block)
+          if match
+            assert_block("assert_#{inclusion_method}") { true }
           else
-            assert_block("\#{page.body}\nExpected to have #{method} \#{args.inspect}"){ false }
+            assert_block("\#{page.body}\nExpected to have #{inclusion_method.gsub('_', ' ')} \#{args.inspect}"){ false }
           end
         end
 
-        def assert_no_#{method}(*args, &block)
-          boolean = has_#{method}?(*args, &block)
-          if boolean
-            assert_block("\#{page.body}\nDid not expect to have #{method} \#{args.inspect}"){ false }
+        def assert_#{rejection_method}(*args, &block)
+          match = has_#{rejection_method}?(*args, &block)
+          if match
+            assert_block("assert_#{rejection_method}") { true }
           else
-            assert_block("assert_no_#{method}") { true }
+            assert_block("\#{page.body}\Expected to have #{rejection_method.gsub('_', ' ')} \#{args.inspect}"){ false }
           end
         end
       RUBY
@@ -61,13 +73,11 @@ module Hermes
       assert_difference("ActionMailer::Base.deliveries.size", many){ yield }
     end
 
-    def assert_link_to(url, options)
-      assert_css "a[href='%s']" % url, options
-    end
-
-    def within(scope, prefix=nil)
-      scope = '#' << ActionController::RecordIdentifier.dom_id(scope, prefix) if scope.is_a?(ActiveRecord::Base)
-      super(scope)
+    def assert_link_to(url, options={})
+      msg = "#{page.body}\nExpected to have link to #{url}"
+      assert_block(msg) do
+        has_css? "a[href*='%s']" % url, options
+      end
     end
 
     protected
@@ -75,10 +85,5 @@ module Hermes
     def body_inner_text
       Nokogiri::HTML(page.body).inner_text.gsub(/^\s*$/, "").squeeze("\n")
     end
-
-    # Provide a shortcut to show body inner text. It helps debugging.
-    def pbit
-      puts body_inner_text
-    end
   end
-end
+end

data/lib/hermes/builders.rb

@@ -1,6 +1,6 @@
 # Rails developers have had bad experience with fixtures since a long time
 # due to several reasons, including misuse.
-# 
+#
 # This misuse of fixtures is often characterized by a huge ammount of
 # fixtures, causing a lot of data to maintain and dependence between tests.
 # In my experience working (and rescueing) different applications, 80% of
@@ -11,7 +11,7 @@
 # we need a huge amount of data in this test which we usually don't need in
 # order tests.
 #
-# For such scenarios, factories are a fine solution. They won't cluster
+# For such scenarios, factories are a fine solution. They won't clutter
 # all your database since they are created for these specific tests and they
 # are also easier to maintain.
 #
@@ -69,7 +69,7 @@
 # a DSL on top of it, it allows us to use Ruby in case we need to do
 # something more complex, like supporting sequences.
 #
-#   module Builders
+#   module Hermes::Builders
 #     @@sequence = 0
 #
 #     def sequence
@@ -79,40 +79,67 @@
 #
 module Hermes
   module Builders
+    ATTRIBUTES_REGEX = /valid_(.*?)_attributes$/
+    BUILDER_REGEX = /(create|new)_(.*?)(!)?$/
+
     @@builders = ActiveSupport::OrderedHash.new
 
-    def self.build(name, options={}, &block)
-      klass = options[:as] || name.to_s.classify.constantize
+    class << self
 
-      builder = if options[:like]
-        lambda { send(name.to_s.pluralize, options[:like]).attributes.merge(block.call) }
-      else
-        block
+      def build(name, options={}, &block)
+        klass = options[:class] || name.to_s.classify.constantize
+
+        builder = if options[:like]
+          load_attributes_from_fixture(name.to_s.pluralize, options[:like], block)
+        else
+          block
+        end
+
+        @@builders[name] = [klass, builder]
       end
 
-      @@builders[name] = [klass, builder]
+      def retrieve(scope, name, method, options)
+        if builder = @@builders[name.to_sym]
+          klass, block = builder
+
+          hash = block ? block.bind(scope).call : {}
+          hash.symbolize_keys!
+          hash.merge!(options || {})
+          hash.delete(:id)
+
+          [klass, hash]
+        else
+          raise NoMethodError, "No builder #{name.inspect} for `#{method}'"
+        end
+      end
+
+      private
+
+      def load_attributes_from_fixture(fixture_type, fixture_name, block)
+        lambda { send(fixture_type, fixture_name).attributes.symbolize_keys.merge!(block ? block.call : {}) }
+      end
     end
 
-    def self.retrieve(scope, name, method, options)
-      if builder = @@builders[name.to_sym]
-        klass, block = builder
-        hash = block.bind(scope).call.merge(options || {})
-        hash.delete("id")
-        [klass, hash]
+    def respond_to?(method)
+      case method.to_s
+      when BUILDER_REGEX
+        true
+      when ATTRIBUTES_REGEX
+        true
       else
-        raise NoMethodError, "No builder #{name.inspect} for `#{method}'"
+        super
       end
     end
 
     def method_missing(method, *args, &block)
       case method.to_s
-      when /(create|new)_(.*?)(!)?$/
+      when BUILDER_REGEX
         klass, hash = Builders.retrieve(self, $2, method, args.first)
         object = klass.new
         object.send("attributes=", hash, false)
         object.send("save#{$3}") if $1 == "create"
         object
-      when /valid_(.*?)_attributes$/
+      when ATTRIBUTES_REGEX
         Builders.retrieve(self, $1, method, args.first)[1]
       else
         super
@@ -120,5 +147,3 @@ module Hermes
     end
   end
 end
-
-ActiveSupport::TestCase.send :include, Hermes::Builders

data/lib/hermes/context.rb

@@ -33,5 +33,3 @@ module Hermes
     end
   end
 end
-
-ActiveSupport::TestCase.extend Hermes::Context

data/lib/hermes/integration_case.rb

@@ -1,11 +1,15 @@
-require 'hermes/assertions'
-
 class Hermes::IntegrationCase < ActiveSupport::TestCase
   include Capybara
   include ActionController::RecordIdentifier
   include Rails.application.routes.url_helpers
+
+  extend Hermes::Context
+
   include Hermes::Assertions
+  include Hermes::Actions
+  include Hermes::Scopes
+  include Hermes::Builders
 
   teardown { Capybara.reset_sessions! }
   class << self; alias :scenario :test; end
-end
+end

data/lib/hermes/rails.rb

@@ -0,0 +1,4 @@
+ActiveSupport::TestCase.class_eval do
+  include Hermes::Builders
+  extend Hermes::Context
+end

data/lib/hermes/scopes.rb

@@ -0,0 +1,32 @@
+module Hermes
+  module Scopes
+    def within(*args)
+      object = args[0]
+      prefix = args[1]
+
+      scope = if object.is_a?(ActiveRecord::Base)
+        ['#' + ActionController::RecordIdentifier.dom_id(object, prefix)]
+      else
+        args
+      end
+      super(*scope)
+    end
+
+    def click_link_within(scope, link)
+      within(scope) { click_link(link) }
+    end
+
+    %w(check uncheck).each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args)
+          if args[0].is_a?(ActiveRecord::Base)
+            scope = ActionController::RecordIdentifier.dom_id(args[0], args[1])
+            super(scope)
+          else
+            super
+          end
+        end
+      RUBY
+    end
+  end
+end

data/lib/hermes/version.rb

@@ -1,3 +1,3 @@
 module Hermes
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 end

data/test/builders.rb

@@ -0,0 +1,13 @@
+
+module Hermes::Builders
+  @@sequence = 0
+  build :user, :like => :the_user do
+    {:name => "The Super User", :counter => (@@sequence += 1) }
+  end
+
+  build :another_user, :class => User do
+    {:name => 'Another user', :active_at => Time.parse("Thu, 03 Mar 2011 18:11:26 UTC +00:00") }
+  end
+
+  build :blockless_user, :class => User
+end

data/test/fixtures/users.yml

@@ -0,0 +1,4 @@
+the_user:
+  name: The User
+  active_at: Thu, 03 Mar 2011 18:11:26 UTC +00:00
+

data/test/hermes/actions_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+
+class ActionsTest < Hermes::IntegrationCase
+
+  test "select date and time should raise error when id_prefix is not supplied" do
+    visit '/users/new'
+    assert_raise ArgumentError do
+      select_datetime(Time.current, {})
+    end
+  end
+
+  test "select date and time using id_prefix" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+    visit '/users/new?datetime=true'
+
+    within '#datetime' do
+      select_datetime(date, :id_prefix => 'user_active_at')
+
+      assert find_selected_option('user[active_at(1i)]', '2011')
+      assert find_selected_option('user[active_at(2i)]', '2')
+      assert find_selected_option('user[active_at(3i)]', '28')
+      assert find_selected_option('user[active_at(4i)]', '16')
+      assert find_selected_option('user[active_at(5i)]', '00')
+    end
+  end
+
+  test "select date and time using from as label" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+    visit '/users/new?datetime=true'
+
+    within '#datetime' do
+      select_datetime(date, :from => 'Active at')
+
+      assert find_selected_option('user[active_at(1i)]', '2011')
+      assert find_selected_option('user[active_at(2i)]', '2')
+      assert find_selected_option('user[active_at(3i)]', '28')
+      assert find_selected_option('user[active_at(4i)]', '16')
+      assert find_selected_option('user[active_at(5i)]', '00')
+    end
+  end
+
+  test "select time using id_prefix" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+
+    visit '/users/new?time=true'
+
+    within '#time' do
+      select_time(date, :id_prefix => 'user_active_at')
+
+      assert find_selected_option('user[active_at(4i)]', '16')
+      assert find_selected_option('user[active_at(5i)]', '00')
+    end
+  end
+
+  test "select time using label" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+
+    visit '/users/new?time=true'
+
+    within '#time' do
+      select_time(date, :from => 'Active at')
+
+      assert find_selected_option('user[active_at(4i)]', '16')
+      assert find_selected_option('user[active_at(5i)]', '00')
+    end
+  end
+
+  test "select date using id_prefix" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+
+    visit '/users/new?date=true'
+
+    within '#date' do
+      select_date(date, :id_prefix => 'user_active_at')
+
+      assert find_selected_option('user[active_at(1i)]', '2011')
+      assert find_selected_option('user[active_at(2i)]', '2')
+      assert find_selected_option('user[active_at(3i)]', '28')
+    end
+  end
+
+  test "select date using label" do
+    date = DateTime.new(2011, 2, 28, 16, 0)
+
+    visit '/users/new?date=true'
+
+    within '#date' do
+      select_date(date, :from => 'Active at')
+
+      assert find_selected_option('user[active_at(1i)]', '2011')
+      assert find_selected_option('user[active_at(2i)]', '2')
+      assert find_selected_option('user[active_at(3i)]', '28')
+    end
+  end
+
+
+  test "select date and time didn't find the label" do
+    msg = "cannot select option, select with label 'Unexistant' not found"
+    visit '/users/new'
+    assert_raise_with_message Capybara::ElementNotFound, msg do
+      select_datetime(Time.current, :from => 'Unexistant')
+    end
+  end
+
+  test "select date and time didn't find the id prefix" do
+    msg = "cannot select option, no select box with id prefix 'unexistant' found"
+    visit '/users/new'
+    assert_raise_with_message Capybara::ElementNotFound, msg do
+      select_datetime(Time.current, :id_prefix => 'unexistant')
+    end
+  end
+
+  private
+
+  def find_selected_option(select_name, value)
+    find("select[name='#{select_name}'] > option[selected][value='#{value}']")
+  end
+end