howitzer 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3377af22722ffdd00c6ec6067a03d035550efa2
-  data.tar.gz: 1ddd61bd420afbd578e960f8056e1ccdd3efb261
+  metadata.gz: d0462470e4e9b727be8229a5a30f4d677daacd06
+  data.tar.gz: 50f292514b58d7bf57b52f6dc2cc7f0dda26c2d8
 SHA512:
-  metadata.gz: f38792fab666d6b97c8b638214901522d2c2f75862619ef0afa64dc8d73df4dc85403b1366c7921eaf5f31c9048091f00d25b734fd619aa4d77d405fb357362f
-  data.tar.gz: 5f5a2b10f02da32f4d618f1192ce380a246998a2fa4cdd8692d12830ef2d2f62e6fea36b0a1d63c80c0cb905a3d80ae46a10fd4ba7b46ffd4971c72546afba28
+  metadata.gz: 6efa7374c1460bca6a650c42267525a4f2f6d1362e95cac070dc4dab101d7d3c9652a93bd898f933a0655da25856c2e281b6d2542101015329aa93a9c60d51dd
+  data.tar.gz: 91f1a0ec11ab2fdc23d744773bb3802aefe18fff33f465e185824002f4cfa6f8c07be9722b2c967f3228bcea0952457f44061cef13bf941f545a563fddc9d61c

data/.rubocop.yml

@@ -30,3 +30,6 @@ Style/FrozenStringLiteralComment:
 
 Metrics/ModuleLength:
   Max: 150
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,9 +1,29 @@
-## [In git](https://github.com/strongqa/howitzer/compare/v2.0.0...master)
+## [In git](https://github.com/strongqa/howitzer/compare/v2.0.1...master)
 
 ### New Features
 
 ### Bugfixes
 
+## [v2.0.1](https://github.com/strongqa/howitzer/compare/v2.0.0...v2.0.1)
+
+### New Features
+- New rubocop changes supporting
+- Add custom page url processor supporting
+- Limited Selenium to v2.x
+- Add ability to use instance variables and methods from outer cotext in page dsl
+- Add wait time dsl method for particular email
+- Implement wait_for_xxx_element method for sync
+- Implement within_xxx_element method like Capybara.within
+
+### Bugfixes
+- [#188](https://github.com/strongqa/howitzer/issues/188) Page validation by element presence does not work properly
+- [#191](https://github.com/strongqa/howitzer/issues/191) Generated project is broken
+- [#195](https://github.com/strongqa/howitzer/issues/195) Incorrect parameters passing in lambda locators
+- [#200](https://github.com/strongqa/howitzer/issues/200) capybara-screenshot does not work
+- [#205](https://github.com/strongqa/howitzer/issues/205) Fix incorrect page identification on failed test
+- Fix issue for IE in configs
+- Fix issue found in generated prerequisites
+
 ## [v2.0.0](https://github.com/strongqa/howitzer/compare/v1.1.1...v2.0.0)
 
 ### New Features

data/features/cli_new.feature

@@ -141,6 +141,7 @@ Feature: Howitzer CLI New Project Creation
       * Cucumber integration to the framework ...
           Added 'features/step_definitions/common_steps.rb' file
           Added 'features/support/env.rb' file
+          Added 'features/support/hooks.rb' file
           Added 'features/support/transformers.rb' file
           Added 'features/example.feature' file
           Added 'tasks/cucumber.rake' file

data/features/cli_update.feature

@@ -107,6 +107,7 @@ Feature: Howitzer CLI Update Existing Project
       * Cucumber integration to the framework ...
           Identical 'features/step_definitions/common_steps.rb' file
           Identical 'features/support/env.rb' file
+          Identical 'features/support/hooks.rb' file
           Identical 'features/support/transformers.rb' file
           Identical 'features/example.feature' file
           Identical 'tasks/cucumber.rake' file

data/generators/base_generator.rb

@@ -67,7 +67,9 @@ module Howitzer
       end
     end
 
-    def manifest; end
+    def manifest
+      []
+    end
 
     protected
 

data/generators/config/templates/capybara.rb

@@ -153,4 +153,4 @@ Capybara::Screenshot.append_timestamp = false
 Capybara::Screenshot.register_filename_prefix_formatter(:default) do
   "capybara-screenshot-#{Gen.serial}"
 end
-Capybara::Screenshot.prune_strategy = :keep_last_run
+Capybara::Screenshot.prune_strategy = :keep_all

data/generators/config/templates/default.yml

@@ -12,6 +12,7 @@
 
  app_api_token:
  app_api_end_point: "api/v1"
+ app_api_protocol: http
 
 ###########################################################
 # TEST ENVIRONMENTS SETTINGS                              #
@@ -59,7 +60,6 @@
  cloud_bstack_resolution: '1024x768'
  cloud_bstack_project: 'Howitzer Example'
  cloud_bstack_build: 'v1'
- cloud_bstack_resolution: '1024x768'
  cloud_bstack_mobile_device:
 
 ###########################################################
@@ -81,7 +81,9 @@
 # MAIL SETTINGS                                           #
 ###########################################################
  mail_adapter: mailgun
+ mail_wait_time: 60
+
+# -Mailgun- (http://www.mailgun.com/)
  mailgun_key: mailgun_account_private_key
  mailgun_domain: mailgun_domain_with_stored_method
- mailgun_idle_timeout: 60
  mailgun_sleep_time: 3

data/generators/cucumber/cucumber_generator.rb

@@ -8,6 +8,7 @@ module Howitzer
         [
           { source: 'common_steps.rb', destination: 'features/step_definitions/common_steps.rb' },
           { source: 'env.rb', destination: 'features/support/env.rb' },
+          { 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' }

data/generators/cucumber/templates/common_steps.rb

@@ -2,7 +2,7 @@
 #                      PREREQUISITES                        #
 #############################################################
 
-Given /^I have entered (.*) into the calculator$/ do |_input_|
+Given /^I have entered (.*) into the calculator$/ do |_input|
   pending
 end
 

data/generators/cucumber/templates/env.rb

@@ -10,31 +10,3 @@ FileUtils.mkdir_p(Howitzer.log_dir)
 Howitzer::Log.settings_as_formatted_text
 Howitzer::Cache.store(:cloud, :start_time, Time.now.utc)
 Howitzer::Cache.store(:cloud, :status, true)
-
-Before do |scenario|
-  Capybara.use_default_driver
-  Howitzer::Log.print_feature_name(scenario.feature.name)
-  Howitzer::Log.print_scenario_name(scenario.name)
-  @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
-end
-
-After do |scenario|
-  if CapybaraHelpers.cloud_driver?
-    Howitzer::Cache.store(:cloud, :status, false) if scenario.failed?
-    session_end = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
-    Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end}" \
-             " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
-  elsif CapybaraHelpers.ie_browser?
-    Howitzer::Log.info 'IE reset session'
-    page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
-  end
-  Howitzer::Cache.clear_all_ns
-  Capybara.reset_sessions!
-end
-
-at_exit do
-  if CapybaraHelpers.cloud_driver?
-    Howitzer::Log.info "CLOUD SERVER LOG URL: #{CapybaraHelpers.cloud_resource_path(:server_log)}"
-    CapybaraHelpers.update_cloud_job_status(passed: Howitzer::Cache.extract(:cloud, :status))
-  end
-end

data/generators/cucumber/templates/hooks.rb

@@ -0,0 +1,29 @@
+Before do |scenario|
+  Capybara.use_default_driver
+  Howitzer::Log.print_feature_name(scenario.feature.name)
+  Howitzer::Log.print_scenario_name(scenario.name)
+  @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
+end
+
+After do |scenario|
+  if CapybaraHelpers.cloud_driver?
+    Howitzer::Cache.store(:cloud, :status, false) if scenario.failed?
+    session_end = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
+    Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end}" \
+             " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
+  elsif CapybaraHelpers.ie_browser?
+    Howitzer::Log.info 'IE reset session'
+    Capybara.current_session.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
+  end
+  Howitzer::Cache.clear_all_ns
+  Capybara.reset_sessions!
+end
+
+at_exit do
+  if CapybaraHelpers.cloud_driver?
+    Howitzer::Log.info "CLOUD SERVER LOG URL: #{CapybaraHelpers.cloud_resource_path(:server_log)}"
+    CapybaraHelpers.update_cloud_job_status(passed: Howitzer::Cache.extract(:cloud, :status))
+  end
+end
+
+require 'capybara-screenshot/cucumber'

data/generators/prerequisites/templates/user.rb

@@ -1,6 +1,8 @@
 require_relative 'base'
 # Example User Model
 class User < Base
+  attr_accessor :email, :name, :password, :password_confirmation
+
   def self.default
     where(email: Howitzer.app_test_user).first
   end

data/generators/prerequisites/templates/users.rb

@@ -1,7 +1,7 @@
 FactoryGirl.define do
   factory :user do
-    email { "u#{serial}@#{Howitzer.mailgun_domain}" }
-    name { "FirstName LastName #{serial}" }
+    email { "u#{Gen.serial}@#{Howitzer.mailgun_domain}" }
+    name { "FirstName LastName #{Gen.serial}" }
     password { Howitzer.app_test_pass }
     password_confirmation { Howitzer.app_test_pass }
 

data/generators/root/templates/Gemfile.erb

@@ -8,7 +8,7 @@ source 'https://rubygems.org'
 gem 'howitzer'
 # Uncomment it if you are going to use 'poltergeist' driver. PhantomJS should be installed.
 # See https://github.com/jnicklas/capybara#poltergeist
-# gem 'poltergeist', github: 'teampoltergeist/poltergeist', branch: :master
+# gem 'poltergeist', git: 'https://github.com/teampoltergeist/poltergeist.git', branch: :master
 gem 'rest-client'
 gem 'repeater'
 gem 'factory_girl'

data/generators/rspec/templates/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'capybara-screenshot/rspec'
 require 'capybara/rspec/features'
 require_relative '../config/boot'
 require_relative '../config/capybara'
@@ -35,7 +34,7 @@ RSpec.configure do |config|
                " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
     elsif CapybaraHelpers.ie_browser?
       Howitzer::Log.info 'IE reset session'
-      page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
+      Capybara.current_session.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
     end
     Capybara.reset_sessions!
     Capybara.use_default_driver
@@ -55,3 +54,11 @@ RSpec.configure do |config|
     end
   end
 end
+
+# We include Capybara::DSL in Howitzer::Web::Page, but capybara-screenshot hooks rely on this mixin.
+RSpec::Core::ExampleGroup.instance_eval do
+  def include?(value)
+    value == Capybara::DSL ? true : super
+  end
+end
+require 'capybara-screenshot/rspec'

data/generators/turnip/templates/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'capybara-screenshot/rspec'
 require_relative '../config/boot'
 require_relative '../config/capybara'
 
@@ -34,7 +33,7 @@ RSpec.configure do |config|
                " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
     elsif CapybaraHelpers.ie_browser?
       Howitzer::Log.info 'IE reset session'
-      page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
+      Capybara.current_session.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
     end
     Capybara.reset_sessions!
     Capybara.use_default_driver
@@ -54,3 +53,11 @@ RSpec.configure do |config|
     end
   end
 end
+
+# We include Capybara::DSL in Howitzer::Web::Page, but capybara-screenshot hooks rely on this mixin.
+RSpec::Core::ExampleGroup.instance_eval do
+  def include?(value)
+    value == Capybara::DSL ? true : super
+  end
+end
+require 'capybara-screenshot/rspec'

data/generators/web/templates/example_page.rb

@@ -1,4 +1,3 @@
-require_relative 'example_menu'
 # This class is example of web page
 class ExamplePage < Howitzer::Web::Page
   path '/'

data/howitzer.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require File.expand_path('../lib/howitzer/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -28,7 +26,7 @@ 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'
+  gem.add_runtime_dependency 'selenium-webdriver', '< 3'
   gem.add_runtime_dependency 'sexy_settings'
 
   gem.add_development_dependency('aruba')

data/lib/howitzer.rb

@@ -19,6 +19,13 @@ module Howitzer
       define_method(key) { value }
     end
 
+    # @deprecated
+
+    def mailgun_idle_timeout
+      puts "WARNING! 'mailgun_idle_timeout' setting is deprecated. Please replace with 'mail_wait_time' setting."
+      ::SexySettings::Base.instance.all['mailgun_idle_timeout']
+    end
+
     attr_accessor :current_rake_task
   end
 

data/lib/howitzer/cache.rb

@@ -4,7 +4,7 @@ module Howitzer
   # Data can be stored in memory using this class
   #
   module Cache
-    SPECIAL_NS_LIST = [:cloud].freeze
+    SPECIAL_NS_LIST = [:cloud].freeze #:nodoc:
     @data ||= {}
 
     class << self

data/lib/howitzer/capybara_helpers.rb

@@ -4,7 +4,7 @@ require 'howitzer/exceptions'
 module Howitzer
   # This module holds capybara helpers methods
   module CapybaraHelpers
-    CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze
+    CHECK_YOUR_SETTINGS_MSG = 'Please check your settings'.freeze #:nodoc:
 
     # @return [Boolean] true if current driver related with SauceLab,
     #   Testingbot or Browserstack cloud service
@@ -60,7 +60,7 @@ module Howitzer
 
     # Updates a job status on the job cloud
     # @note SauceLabs is currently supported only
-    # @param json_data [String] (for example, {passed: true})
+    # @param json_data [Hash] for example, (passed: true)
 
     def update_cloud_job_status(json_data = {})
       case Howitzer.driver.to_sym

data/lib/howitzer/email.rb

@@ -32,10 +32,27 @@ module Howitzer
       # @!visibility public
 
       def subject(value)
-        @subject = value
+        define_singleton_method(:subject_value) { value }
+        private_class_method :subject_value
+      end
+
+      # DSL method to specify a custom wait email time directly in an email class
+      # @param value [Integer] an wait time for a particular email.
+      #   If it is ommitted, default Howitzer.mail_wait_time will be used.
+      # @example
+      #   class WelcomeEmail < Howitzer::Email
+      #     wait_time 10.minutes
+      #   end
+      # @!visibility public
+
+      def wait_time(value)
+        define_singleton_method(:wait_time_value) { value }
+        private_class_method :wait_time_value
       end
     end
 
+    wait_time Howitzer.try(:mail_wait_time)
+
     # Specifies a mail adapter
     # @param adapter_name [String, Symbol] an email adapter name
     # @raise [NoMailAdapterError] when the adapter name is not String or Symbol
@@ -52,17 +69,19 @@ module Howitzer
     end
 
     # Searches a mail by a recepient
-    # @param recepient [String] recepient's email address
+    # @param recipient [String] recepient's email address
     # @param params [Hash] placeholders with appropriate values
     # @raise [NoEmailSubjectError] when a subject is not specified for the email class
     # @return [Email] an instance of the email message
     # @see .subject
 
     def self.find_by_recipient(recipient, params = {})
-      raise Howitzer::NoEmailSubjectError, "Please specify email subject. For example:\n" \
-                                  "class SomeEmail < Howitzer::Email\n" \
-                                  "  subject ‘some subject text’\nend" if @subject.nil?
-      new(adapter.find(recipient, expand_subject(params)))
+      if defined?(subject_value).nil? || subject_value.nil?
+        raise Howitzer::NoEmailSubjectError, "Please specify email subject. For example:\n" \
+                                    "class SomeEmail < Howitzer::Email\n" \
+                                    "  subject ‘some subject text’\nend"
+      end
+      new(adapter.find(recipient, expand_subject(params), wait: wait_time_value))
     end
 
     def initialize(message)
@@ -118,8 +137,7 @@ module Howitzer
     end
 
     def self.expand_subject(params)
-      params.each { |k, v| @subject.sub!(":#{k}", v.to_s) }
-      @subject
+      params.inject(subject_value.dup) { |a, (k, v)| a.sub(":#{k}", v.to_s) }
     end
     private_class_method :expand_subject
   end

data/lib/howitzer/exceptions.rb

@@ -1,22 +1,22 @@
 # This module holds all custom howitzer exceptions
 module Howitzer
-  CommunicationError = Class.new(StandardError)
-  ParseError = Class.new(StandardError)
-  InvalidApiKeyError = Class.new(StandardError)
-  BadElementParamsError = Class.new(StandardError)
-  NoValidationError = Class.new(StandardError)
-  UnknownValidationError = Class.new(StandardError)
-  EmailNotFoundError = Class.new(StandardError)
-  NoAttachmentsError = Class.new(StandardError)
-  DriverNotSpecifiedError = Class.new(StandardError)
-  UnknownDriverError = Class.new(StandardError)
-  CloudBrowserNotSpecifiedError = Class.new(StandardError)
-  SelBrowserNotSpecifiedError = Class.new(StandardError)
-  UnknownBrowserError = Class.new(StandardError)
-  IncorrectPageError = Class.new(StandardError)
-  AmbiguousPageMatchingError = Class.new(StandardError)
-  NoMailAdapterError = Class.new(StandardError)
-  NoPathForPageError = Class.new(StandardError)
-  NoEmailSubjectError = Class.new(StandardError)
-  NoDataError = Class.new(StandardError)
+  CommunicationError = Class.new(StandardError) #:nodoc:
+  ParseError = Class.new(StandardError) #:nodoc:
+  InvalidApiKeyError = Class.new(StandardError) #:nodoc:
+  BadElementParamsError = Class.new(StandardError) #:nodoc:
+  NoValidationError = Class.new(StandardError) #:nodoc:
+  UnknownValidationError = Class.new(StandardError) #:nodoc:
+  EmailNotFoundError = Class.new(StandardError) #:nodoc:
+  NoAttachmentsError = Class.new(StandardError) #:nodoc:
+  DriverNotSpecifiedError = Class.new(StandardError) #:nodoc:
+  UnknownDriverError = Class.new(StandardError) #:nodoc:
+  CloudBrowserNotSpecifiedError = Class.new(StandardError) #:nodoc:
+  SelBrowserNotSpecifiedError = Class.new(StandardError) #:nodoc:
+  UnknownBrowserError = Class.new(StandardError) #:nodoc:
+  IncorrectPageError = Class.new(StandardError) #:nodoc:
+  AmbiguousPageMatchingError = Class.new(StandardError) #:nodoc:
+  NoMailAdapterError = Class.new(StandardError) #:nodoc:
+  NoPathForPageError = Class.new(StandardError) #:nodoc:
+  NoEmailSubjectError = Class.new(StandardError) #:nodoc:
+  NoDataError = Class.new(StandardError) #:nodoc:
 end