quke 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b1912f6775017bdec69bd6e8b15f15b95829a6593910a0c27f0330fdb0f66774
-  data.tar.gz: 88777a66fabbd0fa786b47dd45d56a6c7a24d797f6289dd2803abc9ae058f6a2
+SHA1:
+  metadata.gz: 8861cc9092349b180b66c0cc650d29012a7eae69
+  data.tar.gz: 189b186c7b0606373a89b419c430933352b2799f
 SHA512:
-  metadata.gz: 836c1c82284d6960b2dab3ecfecfe4c6053ad2361576ff891146ace43dd2188d168a5573ca4abeb11891a574a001617a775a97fc619f46f9e7c5dfd70d7a0b57
-  data.tar.gz: 8c906791e4c8d0b54115de9684606dd9363eb4bf7cc92708ef7445aa0e5f9ab3dc097774f5803dd60ef7f02540c033f9af0cd606760798380b611a1b5b598332
+  metadata.gz: 6990b5aebeb9c93a8623f6f97b0fe4f7d637c96bc76b9f887bdb950ecd2541242e69b9d012d8ad60b745bfc1e07054bbd7035752211d84c649cd51555226ea4d
+  data.tar.gz: 9d43a939c2c6d746c25077c68e955baf27f5e24902cb9c0ae5312763eb801e18f071315eb9311b46fb2e9270a0cfb6bbf9fe135ba072ec925818ed9f1271af31

data/README.md

@@ -1,11 +1,11 @@
-<img src="/quke.png" alt="Git flow" />
+<img src="/quke.png" alt="Quke logo" />
 
 [![Build Status](https://travis-ci.org/DEFRA/quke.svg?branch=master)](https://travis-ci.org/DEFRA/quke)
-[![Code Climate](https://codeclimate.com/github/DEFRA/quke/badges/gpa.svg)](https://codeclimate.com/github/DEFRA/quke)
-[![Test Coverage](https://codeclimate.com/github/DEFRA/quke/badges/coverage.svg)](https://codeclimate.com/github/DEFRA/quke/coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/34f915556feb193d7d82/maintainability)](https://codeclimate.com/github/DEFRA/quke/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/34f915556feb193d7d82/test_coverage)](https://codeclimate.com/github/DEFRA/quke/test_coverage)
 [![security](https://hakiri.io/github/DEFRA/quke/master.svg)](https://hakiri.io/github/DEFRA/quke/master)
-[![Dependency Status](https://dependencyci.com/github/DEFRA/quke/badge)](https://dependencyci.com/github/DEFRA/quke)
 [![Gem Version](https://badge.fury.io/rb/quke.svg)](https://badge.fury.io/rb/quke)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
 Quke is a gem that helps you to build a suite of [Cucumber](https://cucumber.io/) acceptance tests.
 

data/Rakefile

@@ -1,15 +1,17 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rdoc/task'
-require 'github_changelog_generator/task'
+# frozen_string_literal: true
 
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rdoc/task"
+require "github_changelog_generator/task"
+
+task default: :spec
 
 RSpec::Core::RakeTask.new(:spec)
 
 RDoc::Task.new do |doc|
-  doc.main   = 'README.md'
-  doc.title  = 'Quke'
+  doc.main   = "README.md"
+  doc.title  = "Quke"
   doc.rdoc_files = FileList.new %w[README.md lib LICENSE]
 end
 

data/exe/quke

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LeadingCommentSpace
 #!/usr/bin/env ruby
+# rubocop:enable Layout/LeadingCommentSpace
 
-require 'quke'
-require 'quke/configuration'
+require "quke"
+require "quke/configuration"
 
 Quke::Quke.config = Quke::Configuration.new
 Quke::Quke.execute(ARGV)

data/lib/features/support/after_hook.rb

@@ -1,11 +1,15 @@
-require 'quke/configuration'
+# frozen_string_literal: true
 
-After('~@nonweb') do |scenario|
+require "quke/configuration"
+
+# Because of the way cucumber works everthing is made global. This also means
+# any variables we set also need to be made global so they can be accessed
+# across the scenarios.
+# rubocop:disable Style/GlobalVars
+After("not @nonweb") do |scenario|
   $fail_count ||= 0
 
-  if Quke::Quke.config.browserstack.using_browserstack?
-    $session_id = page.driver.browser.session_id
-  end
+  $session_id = page.driver.browser.session_id if Quke::Quke.config.browserstack.using_browserstack?
 
   if scenario.failed?
     $fail_count = $fail_count + 1
@@ -31,9 +35,10 @@ After('~@nonweb') do |scenario|
         # handle e
         puts "FAILED: #{scenario.name}"
         puts "FAILED: URL of the page with the failure #{page.current_path}"
-        puts ''
+        puts ""
         puts page.html
       end
     end
   end
 end
+# rubocop:enable Style/GlobalVars

data/lib/features/support/after_step_hook.rb

@@ -1,4 +1,6 @@
-require 'quke/configuration'
+# frozen_string_literal: true
+
+require "quke/configuration"
 
 # We use cucumber's AfterStep hook to insert our pause between pages if
 # one was set

data/lib/features/support/before_hook.rb

@@ -1,6 +1,8 @@
-require 'quke/configuration'
+# frozen_string_literal: true
 
-Before('~@nonweb') do
+require "quke/configuration"
+
+Before("not @nonweb") do
   # We have to make a special case for phantomjs when it comes to implementing
   # the ability to override the user agent. Unlike the selinium backed drivers
   # specifying the user agent is not part of the arguments we pass in when
@@ -12,10 +14,10 @@ Before('~@nonweb') do
   # test is running. Once a test finishes, the changes are lost.
   # Hence the only way we can ensure its set across all tests is by making use
   # of the Before hook, and adding the User-Agent header each time.
-  if Quke::Quke.config.driver == 'phantomjs'
+  if Quke::Quke.config.driver == "phantomjs"
     unless Quke::Quke.config.user_agent.empty?
       page.driver.add_header(
-        'User-Agent',
+        "User-Agent",
         Quke::Quke.config.user_agent,
         permanent: true
       )

data/lib/features/support/env.rb

@@ -1,15 +1,15 @@
-require 'rspec/expectations'
-require 'capybara/cucumber'
-require 'site_prism'
-require 'quke/configuration'
-require 'quke/driver_configuration'
-require 'quke/driver_registration'
-require 'browserstack/local'
-require 'quke/browserstack_status_reporter'
+# frozen_string_literal: true
 
-unless Quke::Quke.config.app_host.empty?
-  Capybara.app_host = Quke::Quke.config.app_host
-end
+require "rspec/expectations"
+require "capybara/cucumber"
+require "site_prism"
+require "quke/configuration"
+require "quke/driver_configuration"
+require "quke/driver_registration"
+require "browserstack/local"
+require "quke/browserstack_status_reporter"
+
+Capybara.app_host = Quke::Quke.config.app_host unless Quke::Quke.config.app_host.empty?
 
 driver_config = Quke::DriverConfiguration.new(Quke::Quke.config)
 driver_reg = Quke::DriverRegistration.new(driver_config, Quke::Quke.config)
@@ -39,15 +39,7 @@ Capybara.run_server = false
 # automatically in the event of an error when using the selenium driver.
 # Not setting this leads to Capybara saving the file to the root of the project
 # which can mess up your project structure.
-Capybara.save_path = 'tmp/'
-
-# By default, SitePrism element and section methods do not utilize Capybara's
-# implicit wait methodology and will return immediately if the element or
-# section requested is not found on the page. Adding the following code
-# enables Capybara's implicit wait methodology to pass through
-SitePrism.configure do |config|
-  config.use_implicit_waits = true
-end
+Capybara.save_path = "tmp/"
 
 # There aren't specific hooks we can attach to that only get called once before
 # and after all tests have run in Cucumber. Therefore the next best thing is to
@@ -71,6 +63,10 @@ end
 # used for final cleanup, we make use of it to kill our browserstack local
 # testing binary, and update the status of the session in browserstack
 at_exit do
+  # Because of the way cucumber works everthing is made global. This also means
+  # any variables we set also need to be made global so they can be accessed
+  # across the scenarios.
+  # rubocop:disable Style/GlobalVars
   if $fail_count && Quke::Quke.config.browserstack.using_browserstack?
     reporter = Quke::BrowserstackStatusReporter.new(Quke::Quke.config.browserstack)
     begin
@@ -83,6 +79,7 @@ at_exit do
       puts err
     end
   end
+  # rubocop:enable Style/GlobalVars
   if bs_local && Quke::Quke.config.browserstack.test_locally?
     # stop the local instance
     bs_local.stop

data/lib/quke.rb

@@ -1,10 +1,15 @@
-require 'quke/version'
-require 'quke/browserstack_configuration'
-require 'quke/browserstack_status_reporter'
-require 'quke/configuration'
-require 'quke/cuke_runner'
-require 'quke/driver_registration'
-require 'quke/driver_configuration'
+# frozen_string_literal: true
+
+require "selenium/webdriver"
+require "chromedriver-helper"
+
+require "quke/version"
+require "quke/browserstack_configuration"
+require "quke/browserstack_status_reporter"
+require "quke/configuration"
+require "quke/cuke_runner"
+require "quke/driver_registration"
+require "quke/driver_configuration"
 
 module Quke #:nodoc:
 

data/lib/quke/browserstack_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Quke #:nodoc:
 
   # Determines the configuration for browserstack, when selected as the driver
@@ -43,20 +45,18 @@ module Quke #:nodoc:
     # Initialize's the instance based in the +Quke::Configuration+ instance
     # passed in.
     #--
-    # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
     #++
     def initialize(configuration)
-      @using_browserstack = configuration.data['driver'] == 'browserstack'
+      @using_browserstack = configuration.data["driver"] == "browserstack"
       data = validate_input_data(configuration.data)
-      @username = ENV['BROWSERSTACK_USERNAME'] || data['username'] || ''
-      @auth_key = ENV['BROWSERSTACK_AUTH_KEY'] || data['auth_key'] || ''
-      @local_key = ENV['BROWSERSTACK_LOCAL_KEY'] || data['local_key'] || ''
-      @capabilities = data['capabilities'] || {}
+      @username = ENV["BROWSERSTACK_USERNAME"] || data["username"] || ""
+      @auth_key = ENV["BROWSERSTACK_AUTH_KEY"] || data["auth_key"] || ""
+      @local_key = ENV["BROWSERSTACK_LOCAL_KEY"] || data["local_key"] || ""
+      @capabilities = data["capabilities"] || {}
       determine_local_testing_args(configuration)
     end
-    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
 
@@ -66,7 +66,7 @@ module Quke #:nodoc:
     # It is used when determing whether to start and stop the binary
     # Browserstack provides to support local testing.
     def test_locally?
-      @capabilities['browserstack.local'] == true && using_browserstack?
+      @capabilities["browserstack.local"] == true && using_browserstack?
     end
 
     # Returns true if the driver was set +browserstack+, else false.
@@ -110,35 +110,36 @@ module Quke #:nodoc:
     #     )
     #
     def url
-      return "http://#{@username}:#{@auth_key}@hub.browserstack.com/wd/hub" unless @username == ''
+      return "http://#{@username}:#{@auth_key}@hub.browserstack.com/wd/hub" unless @username == ""
     end
 
     private
 
     def validate_input_data(data)
       return {} if data.nil?
-      return {} unless data['browserstack']
-      data['browserstack']
+      return {} unless data["browserstack"]
+
+      data["browserstack"]
     end
 
     def determine_local_testing_args(configuration)
       @local_testing_args = {
         # Key is the only required arg. Everything else is optional
-        'key' => @local_key,
+        "key" => @local_key,
         # Always kill other running Browserstack Local instances
-        'force' => 'true',
+        "force" => "true",
         # We only want to enable local testing for automate
-        'onlyAutomate' => 'true',
+        "onlyAutomate" => "true",
         # Enable verbose logging. It's of no consequence to the tests, but it
         # could help in the event of errors
-        'v' => 'true',
+        "v" => "true",
         # Rather than
-        'logfile' => File.join(Dir.pwd, '/tmp/bowerstack_local_log.txt')
+        "logfile" => File.join(Dir.pwd, "/tmp/bowerstack_local_log.txt")
       }
       return unless configuration.use_proxy?
 
-      @local_testing_args['proxyHost'] = configuration.proxy['host']
-      @local_testing_args['proxyPort'] = configuration.proxy['port'].to_s
+      @local_testing_args["proxyHost"] = configuration.proxy["host"]
+      @local_testing_args["proxyPort"] = configuration.proxy["port"].to_s
     end
 
   end

data/lib/quke/browserstack_status_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Quke #:nodoc:
 
   # Used to update the status of a session in Browserstack to mark it as passed
@@ -30,7 +32,7 @@ module Quke #:nodoc:
     # It returns a string which can be used as a message for output confirming
     # the action.
     def passed(session_id)
-      check_before_update(session_id, status: 'passed')
+      check_before_update(session_id, status: "passed")
       "Browserstack session #{session_id} status set to \e[32mpassed\e[0m 😀"
     end
 
@@ -40,14 +42,14 @@ module Quke #:nodoc:
     # It returns a string which can be used as a message for output confirming
     # the action.
     def failed(session_id)
-      check_before_update(session_id, status: 'failed')
+      check_before_update(session_id, status: "failed")
       "Browserstack session #{session_id} status set to \e[31mfailed\e[0m 😢"
     end
 
     private
 
     def check_before_update(session_id, body)
-      raise(ArgumentError, 'Need a session ID to update browserstack status') if session_id.nil?
+      raise(ArgumentError, "Need a session ID to update browserstack status") if session_id.nil?
 
       uri = URI("https://www.browserstack.com/automate/sessions/#{session_id}.json")
       set_status(uri, body)
@@ -56,7 +58,7 @@ module Quke #:nodoc:
     def set_status(uri, body)
       request = Net::HTTP::Put.new(uri)
       request.basic_auth @username, @auth_key
-      request.content_type = 'application/json'
+      request.content_type = "application/json"
       request.body = body.to_json
 
       response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|

data/lib/quke/configuration.rb

@@ -1,4 +1,6 @@
-require 'yaml'
+# frozen_string_literal: true
+
+require "yaml"
 
 module Quke #:nodoc:
 
@@ -35,7 +37,7 @@ module Quke #:nodoc:
     # Return the file name for the config file, either as set by the user in
     # an environment variable called `QCONFIG` or the default of +.config.yml+.
     def self.file_name
-      ENV['QUKE_CONFIG'] || '.config.yml'
+      ENV["QUKE_CONFIG"] || ".config.yml"
     end
 
     # When an instance is initialized it will automatically populate itself by
@@ -51,7 +53,7 @@ module Quke #:nodoc:
     # tells Cucumber where the main features folder which contains the tests is
     # located. If not set in the +.config.yml+ file it defaults to 'features'.
     def features_folder
-      @data['features_folder']
+      @data["features_folder"]
     end
 
     # Returns the value set for +app_host+.
@@ -66,7 +68,7 @@ module Quke #:nodoc:
     #
     # This saves you from having to repeat the full url each time.
     def app_host
-      @data['app_host']
+      @data["app_host"]
     end
 
     # Returns the value set for +driver+.
@@ -74,7 +76,7 @@ module Quke #:nodoc:
     # Tells Quke which browser to use for testing. Choices are firefox,
     # chrome browserstack and phantomjs, with the default being phantomjs.
     def driver
-      @data['driver']
+      @data["driver"]
     end
 
     # Return the value set for +pause+.
@@ -83,7 +85,7 @@ module Quke #:nodoc:
     # browser is responding. Only useful if using a non-headless browser. The
     # default is 0.
     def pause
-      @data['pause']
+      @data["pause"]
     end
 
     # Return the value set for +stop_on_error+.
@@ -94,7 +96,9 @@ module Quke #:nodoc:
     def stop_on_error
       # This use of Yaml.load to convert a string to a boolean comes from
       # http://stackoverflow.com/a/21804027/6117745
-      YAML.load(@data['stop_on_error'])
+      # rubocop:disable Security/YAMLLoad
+      YAML.load(@data["stop_on_error"])
+      # rubocop:enable Security/YAMLLoad
     end
 
     # Return the value for +max_wait_time+
@@ -107,7 +111,7 @@ module Quke #:nodoc:
     # If the value is not set in config file, it will default to whatever is the
     # current Capybara value for default_max_wait_time.
     def max_wait_time
-      @data['max_wait_time']
+      @data["max_wait_time"]
     end
 
     # Return the value set for +user_agent+.
@@ -118,7 +122,7 @@ module Quke #:nodoc:
     # you want to pretend to be another kind of browser, because the one you
     # have is not supported by the site.
     def user_agent
-      @data['user_agent']
+      @data["user_agent"]
     end
 
     # Return the value set for +javascript_errors+.
@@ -131,7 +135,7 @@ module Quke #:nodoc:
     # are out of your scope. You still want to test other aspects of the site
     # but not let these errors prevent you from using phantomjs.
     def javascript_errors
-      @data['javascript_errors']
+      @data["javascript_errors"]
     end
 
     # Return the hash of +proxy+ server settings
@@ -140,7 +144,7 @@ module Quke #:nodoc:
     # configure Quke to use it by setting the +host+ and +port+ in your config
     # file.
     def proxy
-      @data['proxy']
+      @data["proxy"]
     end
 
     # Return true if the +proxy: host+ value has been set in the +.config.yml+
@@ -149,7 +153,7 @@ module Quke #:nodoc:
     # It is mainly used when determining whether to apply proxy server settings
     # to the different drivers when registering them with Capybara.
     def use_proxy?
-      proxy['host'] != ''
+      proxy["host"] != ""
     end
 
     # Return the hash of +custom+ server settings
@@ -165,14 +169,14 @@ module Quke #:nodoc:
     # http://www.yamllint.com/) Quke will be able to pick it up and make it
     # available in your tests.
     def custom
-      @data['custom']
+      @data["custom"]
     end
 
     private
 
     def load_data
       data = default_data!(load_yml_data)
-      data['proxy'] = proxy_data(data['proxy'])
+      data["proxy"] = proxy_data(data["proxy"])
       data
     end
 
@@ -181,13 +185,13 @@ module Quke #:nodoc:
     # rubocop:disable Metrics/PerceivedComplexity
     def default_data!(data)
       data.merge(
-        'features_folder' =>   (data['features'] || 'features').downcase.strip,
-        'app_host' =>          (data['app_host'] || '').downcase.strip,
-        'driver' =>            (data['driver'] || 'phantomjs').downcase.strip,
-        'pause' =>             (data['pause'] || '0').to_s.downcase.strip.to_i,
-        'stop_on_error' =>     (data['stop_on_error'] || 'false').to_s.downcase.strip,
-        'max_wait_time' =>     (data['max_wait_time'] || Capybara.default_max_wait_time).to_s.downcase.strip.to_i,
-        'user_agent' =>        (data['user_agent'] || '').strip,
+        "features_folder" => (data["features"] || "features").downcase.strip,
+        "app_host" => (data["app_host"] || "").downcase.strip,
+        "driver" => (data["driver"] || "phantomjs").downcase.strip,
+        "pause" => (data["pause"] || "0").to_s.downcase.strip.to_i,
+        "stop_on_error" => (data["stop_on_error"] || "false").to_s.downcase.strip,
+        "max_wait_time" => (data["max_wait_time"] || Capybara.default_max_wait_time).to_s.downcase.strip.to_i,
+        "user_agent" => (data["user_agent"] || "").strip,
         # Because we want to default to 'true', but allow users to override it
         # with 'false' it causes us to mess with the logic. Essentially if the
         # user does enter false (either as a string or as a boolean) the result
@@ -195,9 +199,9 @@ module Quke #:nodoc:
         # Else the condition fails and we get 'false', which when flipped gives
         # us 'true', which is what we want the default value to be
         # rubocop:disable Style/InverseMethods
-        'javascript_errors' => !(data['javascript_errors'].to_s.downcase.strip == 'false'),
+        "javascript_errors" => !(data["javascript_errors"].to_s.downcase.strip == "false"),
         # rubocop:enable Style/InverseMethods
-        'custom' =>            (data['custom'] || nil)
+        "custom" => (data["custom"] || nil)
       )
     end
     # rubocop:enable Metrics/AbcSize
@@ -207,9 +211,9 @@ module Quke #:nodoc:
     def proxy_data(data)
       data = {} if data.nil?
       data.merge(
-        'host' => (data['host'] || '').downcase.strip,
-        'port' => (data['port'] || '0').to_s.downcase.strip.to_i,
-        'no_proxy' => (data['no_proxy'] || '').downcase.strip
+        "host" => (data["host"] || "").downcase.strip,
+        "port" => (data["port"] || "0").to_s.downcase.strip.to_i,
+        "no_proxy" => (data["no_proxy"] || "").downcase.strip
       )
     end