quke 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce6e3b1ba8e4ad298fe85c9b8c857ecda9f35ab
-  data.tar.gz: 26f007f5de6c8696d3e12f8021e977887d6ff523
+  metadata.gz: 27be44353121331dc3014432665279b4fe608e67
+  data.tar.gz: bc5a878ce04b08f922b07a9a7095850431c6c01f
 SHA512:
-  metadata.gz: 71014eeafeec42cda3731e9421c398c21e377b889da74458bb91980e543ab85cd306c2bf5a62792c3bd9c023711c6121cbce84687912ed802a8e358539d84e7a
-  data.tar.gz: 044fb0a77767d7429e8a3a2868d99356c217ac090713d44c0039425223082558e790318e700ece6b50da84565e58d479b0677d495daf842ce8de79b819093fc9
+  metadata.gz: 483988fb09729678369293055188026e51e7fb17579681a0a0cbe151b6199e0e985fd017f818796fe3f8e42bd24c976e8af9baf01043915ee5c48fe03c2197a8
+  data.tar.gz: e516dd83556b3a6c0b6da0f2bd4d02f254b766c1b4cf44cae7eab7de85bf69998cbafd9000b27c68c8bb175596ca0b531cbebd1cb860f084af06a9e1e6863e40

data/.config.example.yml

@@ -25,6 +25,37 @@ pause: 1
 # a detailed response.
 stop_on_error: 1
 
+# Capybara will attempt to find an element for a period of time, rather than
+# immediately failing because the element cannot be found. This defaults to 2
+# seconds. However if the site you are working with is slow or features
+# elements that take some time to load you can increase this default.
+max_wait_time: 5
+
+# Anything you place under the 'custom' node in the `.config.yml` file will be
+# available within your steps and page objects by calling
+# `Quke::Quke.config.custom`. So using the example below we could access its
+# values in the following ways
+#
+# Quke::Quke.config.custom["default_org_name"] # = "Testy Ltd"
+# Quke::Quke.config.custom["accounts"]["account2"]["username"] # = "john.doe@example.gov.uk"
+# Quke::Quke.config.custom["urls"]["front_office"] # = "http://myservice.service.gov.uk"
+#
+# As long as what you add is valid YAML (check with a tool like
+# http://www.yamllint.com/) Quke will be able to pick it up and make it
+# available in your tests.
+custom:
+  default_org_name: "Testy Ltd"
+  accounts:
+    account1:
+      username: jane.doe@example.gov.uk
+      password: Av3rystr*ngone
+    account2:
+      username: john.doe@example.gov.uk
+      password: An*th3rstrongone
+  urls:
+    front_office: "http://myservice.service.gov.uk"
+    back_office: "http://admin-myservice.service.gov.uk"
+
 # If you are running Quke behind a proxy you can configure the proxy details
 # here. You'll need either the hostname or IP of the proxy server (don't include
 # the http:// bit) and the port number (typically 8080). Currently proxy
@@ -58,7 +89,7 @@ browserstack:
   project: 'Adding browserstack support'
 
   # Allows you to specify an identifier for the test run.
-  # If you intend to repeat a test this might not be that aplicable, but in the
+  # If you intend to repeat a test this might not be that applicable, but in the
   # case of one off tests it might be useful
   name: 'Testing google search'
 

data/README.md

@@ -66,7 +66,13 @@ Or install it yourself as
 
 ## Configuration
 
-You can use configuration to drive Quke. You can configure Quke using `.config.yml` files. See [.config.example.yml](.config.example.yml) for details of the options to include in your `.config.yml`.
+You can configure Quke using a `.config.yml` file. What can be configured essentially falls into one of 3 groups.
+
+- **Quke configuration** - things like which driver to use, whether to pause between steps, or if Quke should stop in the event of an error
+- **Custom configuration** - add your own custom values using the `custom:` node
+- **Browserstack configuration** - specify exactly how you want your Browserstack session to run, for example which browser and OS to test against, the project name, and your credentials.
+
+See [.config.example.yml](.config.example.yml) for full details of the options you can specify in your `.config.yml`.
 
 ### Multiple configs
 

data/lib/features/support/env.rb

@@ -16,6 +16,11 @@ driver = driver_reg.register(Quke::Quke.config.driver)
 Capybara.default_driver = driver
 Capybara.javascript_driver = driver
 
+# default_max_wait_time is the maximum time Capybara will wait for an element
+# to appear. You may wish to override it if you are having to deal with a slow
+# or unresponsive web site.
+Capybara.default_max_wait_time = Quke::Quke.config.max_wait_time
+
 # By default Capybara will try to boot a rack application automatically. This
 # switches off Capybara's rack server as we are running against a remote
 # application.

data/lib/quke/configuration.rb

@@ -92,6 +92,19 @@ module Quke #:nodoc:
       YAML.load(@data['stop_on_error'])
     end
 
+    # Return the value for +max_wait_time+
+    #
+    # +max_wait_time+ is the time Capybara will spend waiting for an element
+    # to appear. It's default is normally 2 seconds but you may want to increase
+    # this is you are having to deal with a site that is not performant or prone
+    # to delays.
+    #
+    # 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']
+    end
+
     # Return the hash of +browserstack+ options.
     #
     # If you select the browserstack driver, there are a number of options you
@@ -122,6 +135,10 @@ module Quke #:nodoc:
       proxy['host'] == '' ? false : true
     end
 
+    def custom
+      @data['custom']
+    end
+
     # Override to_s to output the contents of Config as a readable string rather
     # than the standard object output you get.
     def to_s
@@ -138,16 +155,22 @@ module Quke #:nodoc:
     end
 
     # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # 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
+        '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,
+        'custom' =>          (data['custom'] || nil)
       )
     end
     # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     # rubocop:disable Metrics/MethodLength
     def browserstack_data(data)

data/lib/quke/version.rb

@@ -1,3 +1,3 @@
 module Quke #:nodoc:
-  VERSION = '0.2.8'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Alan Cruikshanks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber