howitzer 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0462470e4e9b727be8229a5a30f4d677daacd06
-  data.tar.gz: 50f292514b58d7bf57b52f6dc2cc7f0dda26c2d8
+  metadata.gz: d72a5c40224b791c09af55a7f96a85783dd9bbec
+  data.tar.gz: 5c06f66b976b7fe0d389ebd516aa99b7ec60b7a5
 SHA512:
-  metadata.gz: 6efa7374c1460bca6a650c42267525a4f2f6d1362e95cac070dc4dab101d7d3c9652a93bd898f933a0655da25856c2e281b6d2542101015329aa93a9c60d51dd
-  data.tar.gz: 91f1a0ec11ab2fdc23d744773bb3802aefe18fff33f465e185824002f4cfa6f8c07be9722b2c967f3228bcea0952457f44061cef13bf941f545a563fddc9d61c
+  metadata.gz: e6540a619b0d5d157703116803ed3e3a032ce4570367c1e2dff77fcf97daf516c81fa2220c27cd2ec4a3e788768b2001cf7409d28508b6d5085e26b246652722
+  data.tar.gz: 46d599bfd49cb004da4b7ddb3fe79d8b765df77ae9e4ac4a4c42eb7c02aae385b1b712c22d565cb002e2742b1bc4be33b0418c4d29850ea7a620d16c070f65f0

data/.rubocop.yml

@@ -3,6 +3,7 @@
 
 AllCops:
   TargetRubyVersion: 2.3
+  DisplayCopNames: true
 
 LineLength:
   Max: 120
@@ -33,3 +34,8 @@ Metrics/ModuleLength:
 
 Metrics/BlockLength:
   Enabled: false
+
+Style/MixinGrouping:
+  EnforcedStyle: separated
+  Exclude:
+    - '**/*_steps.rb'

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 before_install:
   - gem install bundler
-rvm:  
-  - 2.2.5
-  - 2.3.1
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0

data/CHANGELOG.md

@@ -1,9 +1,26 @@
-## [In git](https://github.com/strongqa/howitzer/compare/v2.0.1...master)
+## [In git](https://github.com/strongqa/howitzer/compare/v2.0.2...master)
 
 ### New Features
 
 ### Bugfixes
 
+## [v2.0.2](https://github.com/strongqa/howitzer/compare/v2.0.1...v2.0.2)
+
+### New Features
+- Integrate rspec-wait gem
+- Support Ruby 2.4.0
+- Support Selenium 3
+- Integrate cuke-sniffer gem
+- Activate rspec disable_monkey_patching! mode by default
+- Support capybara frame options
+- Add element_presence argument validation
+- Review and improve tests quality
+
+### Bugfixes
+- Fix element capybara options merging
+- [#211](https://github.com/strongqa/howitzer/issues/211) Validation for iframe does not operate as intended
+- [#210](https://github.com/strongqa/howitzer/issues/210) Options like "wait" can not be used with iframe methods
+
 ## [v2.0.1](https://github.com/strongqa/howitzer/compare/v2.0.0...v2.0.1)
 
 ### New Features

data/Gemfile

@@ -2,9 +2,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in howitzer.gemspec
 group :test do
   gem 'coveralls', require: false
-  gem 'simplecov', require: false
   gem 'repeater', require: false
   gem 'rest-client', require: false
+  gem 'simplecov', require: false
 end
 gemspec
 

data/README.md

@@ -44,7 +44,9 @@ You can also find the Rdoc documentation on [Rubygems](https://rubygems.org/gems
 * [Ruby](https://www.ruby-lang.org/en/downloads/) 2.2.2+
 * [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit#installation-instructions) (For **Windows** only)
 * [PhantomJS](http://phantomjs.org/download.html) (For **phantomjs** and **poltergeist** drivers only)
-* [ChromeDriver](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver)
+* [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/) (For **chrome** selenium browser)
+* [GeckoDriver](https://github.com/mozilla/geckodriver/releases) (For **firefox** selenium browser)
+* [SafariDriver](https://webkit.org/blog/6900/webdriver-support-in-safari-10/) (For **safari** selenium browser)
 * [QT](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit) (For **webkit** driver only)
 
 ## Setup

data/Rakefile

@@ -19,4 +19,4 @@ YARD::Rake::YardocTask.new { |_t| }
 
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec, :cucumber]
+task default: %i(rubocop spec cucumber)

data/bin/howitzer

@@ -13,13 +13,13 @@ module HowitzerCli
   arg_name '<PROJECT NAME>'
   command :new do |c|
     c.desc 'Integrate Cucumber'
-    c.switch [:c, :cucumber], negatable: false
+    c.switch %i(c cucumber), negatable: false
 
     c.desc 'Integrate Rspec'
-    c.switch [:r, :rspec], negatable: false
+    c.switch %i(r rspec), negatable: false
 
     c.desc 'Integrate Turnip'
-    c.switch [:t, :turnip], negatable: false
+    c.switch %i(t turnip), negatable: false
 
     c.action do |_global_options, options, args|
       if !args.empty?

data/features/cli_new.feature

@@ -145,6 +145,7 @@ Feature: Howitzer CLI New Project Creation
           Added 'features/support/transformers.rb' file
           Added 'features/example.feature' file
           Added 'tasks/cucumber.rake' file
+          Added 'tasks/cuke_sniffer.rake' file
 
     """
     Then a directory named "test_automation" should exist
@@ -166,6 +167,7 @@ Feature: Howitzer CLI New Project Creation
       | test_automation/prerequisites/models/user.rb              |
       | test_automation/tasks/common.rake                         |
       | test_automation/tasks/cucumber.rake                       |
+      | test_automation/tasks/cuke_sniffer.rake                   |
       | test_automation/Gemfile                                   |
       | test_automation/Rakefile                                  |
       | test_automation/.gitignore                                |

data/generators/config/templates/capybara.rb

@@ -1,13 +1,13 @@
-HOWITZER_KNOWN_DRIVERS = [
-  :selenium,
-  :selenium_grid,
-  :webkit,
-  :poltergeist,
-  :phantomjs,
-  :sauce,
-  :testingbot,
-  :browserstack
-].freeze
+HOWITZER_KNOWN_DRIVERS = %i(
+  selenium
+  selenium_grid
+  webkit
+  poltergeist
+  phantomjs
+  sauce
+  testingbot
+  browserstack
+).freeze
 
 unless HOWITZER_KNOWN_DRIVERS.include?(Howitzer.driver.to_s.to_sym)
   raise Howitzer::UnknownDriverError, "Unknown '#{Howitzer.driver}' driver." \
@@ -83,7 +83,9 @@ Capybara.register_driver :phantomjs do |app|
          desired_capabilities: {
            javascript_enabled: !Howitzer.phantom_ignore_js_errors
          },
-         args: ["--ignore-ssl-errors=#{Howitzer.phantom_ignore_ssl_errors ? 'yes' : 'no'}"]
+         driver_opts: {
+           args: ["--ignore-ssl-errors=#{Howitzer.phantom_ignore_ssl_errors ? 'yes' : 'no'}"]
+         }
   )
 end
 

data/generators/config/templates/default.yml

@@ -36,6 +36,8 @@
  phantom_ignore_js_errors: false
  phantom_ignore_ssl_errors: true
 
+ rspec_wait_timeout: 10
+
 ###########################################################
 # Cloud-based Cross-browser Services                      #
 ###########################################################

data/generators/cucumber/cucumber_generator.rb

@@ -11,7 +11,8 @@ module Howitzer
           { source: 'hooks.rb', destination: 'features/support/hooks.rb' },
           { source: 'transformers.rb', destination: 'features/support/transformers.rb' },
           { source: 'example.feature', destination: 'features/example.feature' },
-          { source: 'cucumber.rake', destination: 'tasks/cucumber.rake' }
+          { source: 'cucumber.rake', destination: 'tasks/cucumber.rake' },
+          { source: 'cuke_sniffer.rake', destination: 'tasks/cuke_sniffer.rake' }
         ] }
     end
 

data/generators/cucumber/templates/cuke_sniffer.rake

@@ -0,0 +1,21 @@
+require 'cuke_sniffer'
+
+def path_to_features
+  @_path_to_features ||= File.expand_path(File.join(__dir__, '..', 'features'))
+end
+
+def cuke_sniffer
+  @_cuke_sniffer ||= CukeSniffer::CLI.new(
+    features_location: path_to_features,
+    step_definitions_location: File.join(path_to_features, 'step_definitions'),
+    hooks_location: File.join(path_to_features, 'support'),
+    no_catalog: false
+  )
+end
+
+desc 'Generate cuke_sniffer reports'
+task :cuke_sniffer do
+  FileUtils.mkdir_p(Howitzer.log_dir)
+  cuke_sniffer.output_html("#{Howitzer.log_dir}/cuke_sniffer_results.html")
+  cuke_sniffer.output_min_html("#{Howitzer.log_dir}/min_cuke_sniffer_results.html")
+end

data/generators/cucumber/templates/env.rb

@@ -4,6 +4,12 @@ require_relative '../../config/boot'
 require_relative '../../config/capybara'
 
 World(FactoryGirl::Syntax::Methods)
+World(RSpec::Wait)
+
+RSpec.configure do |config|
+  config.wait_timeout = Howitzer.rspec_wait_timeout
+  config.disable_monkey_patching!
+end
 
 FileUtils.mkdir_p(Howitzer.log_dir)
 

data/generators/root/templates/Gemfile.erb

@@ -16,6 +16,7 @@ gem 'capybara-screenshot'
 <% if cucumber %>
 gem 'syntax'
 gem 'cucumber', '~>2.0'
+gem 'cuke_sniffer', require: false
 <% elsif rspec %>
 gem 'rspec', '~>3.2'
 <% elsif turnip %>

data/generators/rspec/templates/spec_helper.rb

@@ -12,8 +12,9 @@ RSpec.configure do |config|
 
   config.include FactoryGirl::Syntax::Methods
 
-  config.disable_monkey_patching = true
+  config.disable_monkey_patching!
   config.color = true
+  config.wait_timeout = Howitzer.rspec_wait_timeout
 
   config.before(:each) do
     scenario_name =

data/generators/turnip/templates/spec_helper.rb

@@ -11,8 +11,9 @@ RSpec.configure do |config|
 
   config.include FactoryGirl::Syntax::Methods
 
-  config.disable_monkey_patching = true
+  config.disable_monkey_patching!
   config.color = true
+  config.wait_timeout = Howitzer.rspec_wait_timeout
 
   config.before(:each) do
     scenario_name =

data/howitzer.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'nokogiri', '~> 1.6' if gem.platform.to_s =~ /mswin|mingw/
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'rspec', '~>3.2'
-  gem.add_runtime_dependency 'selenium-webdriver', '< 3'
+  gem.add_runtime_dependency 'rspec-wait'
+  gem.add_runtime_dependency 'selenium-webdriver', '< 4.0'
   gem.add_runtime_dependency 'sexy_settings'
 
   gem.add_development_dependency('aruba')

data/lib/howitzer.rb

@@ -1,6 +1,7 @@
 require 'selenium-webdriver'
 require 'capybara'
 require 'sexy_settings'
+require 'rspec/wait'
 
 SexySettings.configure do |config|
   config.path_to_default_settings = File.expand_path('config/default.yml', Dir.pwd)

data/lib/howitzer/capybara_helpers.rb

@@ -10,7 +10,7 @@ module Howitzer
     #   Testingbot or Browserstack cloud service
 
     def cloud_driver?
-      [:sauce, :testingbot, :browserstack].include?(Howitzer.driver.to_sym)
+      %i(sauce testingbot browserstack).include?(Howitzer.driver.to_sym)
     end
 
     # @return [Boolean] whether or not current browser is

data/lib/howitzer/exceptions.rb

@@ -19,4 +19,5 @@ module Howitzer
   NoPathForPageError = Class.new(StandardError) #:nodoc:
   NoEmailSubjectError = Class.new(StandardError) #:nodoc:
   NoDataError = Class.new(StandardError) #:nodoc:
+  UndefinedElementError = Class.new(StandardError) #:nodoc:
 end

data/lib/howitzer/version.rb

@@ -1,4 +1,4 @@
 # This module holds howitzer version
 module Howitzer
-  VERSION = '2.0.1'.freeze #:nodoc:
+  VERSION = '2.0.2'.freeze #:nodoc:
 end

data/lib/howitzer/web/capybara_methods_proxy.rb

@@ -1,12 +1,37 @@
 require 'capybara'
 
+# Remove this monkey patch after fixing the bugs in selenium-webdriver / capybara
+#:nocov:
+class Capybara::Selenium::Driver # rubocop:disable Style/ClassAndModuleChildren
+  #
+  # https://github.com/teamcapybara/capybara/issues/1845
+  def title
+    return browser.title unless within_frame?
+    find_xpath('/html/head/title').map { |n| n[:text] }.first.to_s
+  end
+
+  # Known issue, works differently for phantomjs and real browsers
+  # https://github.com/seleniumhq/selenium/issues/1727
+  def current_url
+    return browser.current_url unless within_frame?
+    execute_script('return document.location.href')
+  end
+
+  private
+
+  def within_frame?
+    !(@frame_handles.empty? || @frame_handles[browser.window_handle].empty?)
+  end
+end
+#:nocov:
+
 module Howitzer
   module Web
     # This module proxies required original capybara methods to recipient
     module CapybaraMethodsProxy
       PROXIED_CAPYBARA_METHODS = Capybara::Session::SESSION_METHODS + #:nodoc:
                                  Capybara::Session::MODAL_METHODS +
-                                 [:driver, :text]
+                                 %i(driver text)
 
       # Capybara form dsl methods are not compatible with page object pattern and Howitzer gem.
       # Instead of including Capybara::DSL module, we proxy most interesting Capybara methods and

data/lib/howitzer/web/element_dsl.rb

@@ -12,15 +12,28 @@ module Howitzer
       private
 
       def convert_arguments(args, params)
-        hash = params.deep_dup.pop if params.last.is_a?(Hash)
+        args, params, options = merge_element_options(args, params)
         args = args.map do |el|
           next(el) unless el.is_a?(Proc)
           el.call(*params.shift(el.arity))
         end
-        args << hash unless hash.nil?
+        args << options unless options.blank?
         args
       end
 
+      def merge_element_options(args, params)
+        new_args, args_hash = extract_element_options(args)
+        new_params, params_hash = extract_element_options(params)
+        [new_args, new_params, args_hash.merge(params_hash)]
+      end
+
+      def extract_element_options(args)
+        new_args = args.deep_dup
+        args_hash = {}
+        args_hash = new_args.pop if new_args.last.is_a?(Hash)
+        [new_args, args_hash]
+      end
+
       # This module holds element dsl methods methods
       module ClassMethods
         protected
@@ -42,7 +55,7 @@ module Howitzer
         #
         #   <b>has_no_<em>element_name</em>_element?</b> - equals capybara #has_no_selector(...) method
         # @param name [Symbol, String] an unique element name
-        # @param args [Array] original Capybara arguments. For details, see `Capybara::Node::Finders#all.
+        # @param args [Array] original Capybara arguments. For details, see `Capybara::Node::Finders#all`.
         # @example Using in a page class
         #   class HomePage < Howitzer::Web::Page
         #     element :top_panel, '.top'

data/lib/howitzer/web/iframe_dsl.rb

@@ -11,8 +11,24 @@ module Howitzer
 
       private
 
-      def iframe_element_selector(selector)
-        selector.is_a?(Integer) ? ["iframe:nth-of-type(#{selector + 1})"] : [:frame, selector]
+      def iframe_element_selector(args, params)
+        args = convert_iframe_arguments(args, params)
+        case args[0]
+        when String, Hash
+          [:frame, *args]
+        when Integer
+          idx = args.shift
+          ["iframe:nth-of-type(#{idx + 1})", *args]
+        else
+          args
+        end
+      end
+
+      def convert_iframe_arguments(args, params)
+        new_args = args.deep_dup
+        hash = new_args.pop.merge(params) if new_args.last.is_a?(Hash)
+        new_args << hash if hash.present?
+        new_args
       end
 
       # This module holds frame dsl class methods
@@ -28,7 +44,7 @@ module Howitzer
         #
         #   <b>has_no_<em>frame_name</em>_iframe?</b> - equals capybara #has_no_selector(...) method
         # @param name [Symbol, String] an unique iframe name
-        # @param selector [Integer, String] frame name/id or index. Possible to specify id as #some_id
+        # @param args [Array] original Capybara arguments. For details, see `Capybara::Session#within_frame`.
         # @example Using in a page class
         #   class FbPage < Howitzer::Web::Page
         #     element :like, :xpath, ".//*[text()='Like']"
@@ -54,33 +70,34 @@ module Howitzer
         #   HomePage.on { is_expected.to have_fb_iframe }
         # @!visibility public
 
-        def iframe(name, selector)
+        def iframe(name, *args)
+          raise ArgumentError, 'iframe selector arguments must be specified' if args.blank?
           klass = "#{name}_page".classify.constantize
-          define_iframe(klass, name, selector)
-          define_has_iframe(name, selector)
-          define_has_no_iframe(name, selector)
+          define_iframe(klass, name, args)
+          define_has_iframe(name, args)
+          define_has_no_iframe(name, args)
         end
 
         private
 
-        def define_iframe(klass, name, selector)
-          define_method "#{name}_iframe" do |&block|
-            iframe_selector = selector.is_a?(Integer) ? selector : selector.split('#').last
-            capybara_context.within_frame(iframe_selector) do
+        def define_iframe(klass, name, args)
+          define_method "#{name}_iframe" do |**params, &block|
+            capybara_context.within_frame(*convert_iframe_arguments(args, params)) do
+              klass.displayed?
               block.call klass.instance
             end
           end
         end
 
-        def define_has_iframe(name, selector)
-          define_method("has_#{name}_iframe?") do
-            capybara_context.has_selector?(*iframe_element_selector(selector))
+        def define_has_iframe(name, args)
+          define_method("has_#{name}_iframe?") do |**params|
+            capybara_context.has_selector?(*iframe_element_selector(args, params))
           end
         end
 
-        def define_has_no_iframe(name, selector)
-          define_method("has_no_#{name}_iframe?") do
-            capybara_context.has_no_selector?(*iframe_element_selector(selector))
+        def define_has_no_iframe(name, args)
+          define_method("has_no_#{name}_iframe?") do |**params|
+            capybara_context.has_no_selector?(*iframe_element_selector(args, params))
           end
         end
       end