quke 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 473715c033cd96a2b29d82d54f0340404ac366bd
+  data.tar.gz: 69cfc1b788076ae263170bce1efa958d2091fefc
+SHA512:
+  metadata.gz: 5089913eba66efa6a73e69b12a7133cb234834887a5b03e3f7c013a814f11977a56e8c0b8524424a5d5f34a0818d643d07ec8ddcd787c5be89a1e700cd09fa77
+  data.tar.gz: 1f216d61570ac77bd55ec241e923b6bd139acca45d1682dfe344ab1c9ed8b5e8421836588531b5925ee2e43d4c2acf72cf29e0fac9eb6c8fcaca28fdaf3bd371

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  reek:
+    enabled: true
+ratings:
+  paths:
+  - "**.module"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.config.example.yml

@@ -0,0 +1,88 @@
+# The standard place to add your features and step_definitions is in a folder
+# named 'features' at the root of the project. However if you'd like to name
+# this folder something else, you can tell Quke what the new name is here.
+# The default is features
+features_folder: 'cukes'
+
+# Normally Capybara expects to be testing an in-process Rack application, but
+# we're using it to talk to a remote host. Users of Quke can set what this
+# will be by simply setting `app_host`. You can then use it directly using
+# Capybara `visit('/Main_Page')` or `visit('/')` rather than having to repeat
+# the full url each time
+app_host: 'https://en.wikipedia.org/wiki'
+
+# Tells Quke which browser to use for testing. Choices are firefox, chrome
+# browserstack and phantomjs, with the default being phantomjs
+driver: chrome
+
+# Add a pause (in seconds) between steps so you can visually track how the
+# browser is responding. Only useful if using a non-headless browser. The
+# default is 0
+pause: 1
+
+# If you select the browserstack driver, there are a number of options you
+# can pass through to setup your browserstack tests, username and auth_key
+# being the critical ones.
+# Please see https://www.browserstack.com/automate/capabilities for more details
+browserstack:
+  # To run your tests with browserstack you must provide a username and auth_key
+  # as a minimum
+  username: jdoe
+  auth_key: 123456789ABCDE
+
+  # Keep track of all your automated tests using the build and project
+  # capabilities. Group your tests into builds, and builds further into projects
+  build: 'Version 1'
+  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
+  # case of one off tests it might be useful
+  name: 'Testing google search'
+
+  # MOBILE testing
+  # The docs are a little confusing but essentially if you want to test against
+  # mobile devices you need to define 1 set of capabilities, and if desktop
+  # another
+  # -----
+  # OS you want to test. Accepted values are MAC, WIN8, XP, WINDOWS, ANY, ANDROID
+  # Browserstack default is ANY
+  platform: MAC
+  # Browser you want to test. Accepted values firefox, chrome, internet explorer,
+  # safari, opera, iPad, iPhone, android. Browserstack default is chrome
+  browserName: iPhone
+  # Browser version you want to test. See the docs for the full list of available
+  # versions. Browserstack default is latest stable version of browser selected
+  version: '49'
+  # Device you want to test on. See the docs for the full list of available.
+  device: 'iPhone 5'
+
+  # DESKTOP testing
+  # -----
+  # OS you want to test. Accepted values are WINDOWS, OS X. If both OS and
+  # platform are set, OS will take precedence
+  os: WINDOWS
+  # OS version you want to test. Accepted values are
+  # Windows: XP, 7, 8, 8.1 and 10
+  # OS X: Snow Leopard, Lion, Mountain Lion, Mavericks, Yosemite, El Capitan
+  os_version: '8.1'
+  # Browser you want to test. Accepted values are Firefox, Safari, IE, Chrome,
+  # Opera
+  browser: chrome
+  # Browser version you want to test. See the docs for the full list of
+  # available versions
+  browser_version: '49'
+  # Set the resolution of VM before beginning of your test.
+  # See docs https://www.browserstack.com/automate/capabilities for full list of
+  # accepted values, as it is also OS dependent
+  resolution: '1024x768'
+
+  # To avoid invalid certificate errors while testing set acceptSslCerts to true
+  acceptSslCerts: true
+
+  # Required if you want to generate screenshots at various steps in your test.
+  # Browserstack default is false
+  debug: true
+  # Required if you want to enable video recording during your test.
+  # Browserstack default is true
+  video: true

data/.gitignore

@@ -0,0 +1,57 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+vendor/overcommit_bundle
+
+# Ignore ruby_mine folder
+/.idea
+
+# Symbol tags (e.g. generated by Atom Editor)
+/tags
+
+*~
+.DS_Store
+.svn
+.*.swp
+___*
+chromedriver.log
+
+# Ignore all logfiles and tempfiles.
+*.log
+/log/*
+!/log/.keep
+/tmp/
+
+# Ruby debugger related files
+.byebug_history
+
+# Capybara related artifacts
+capybara-*.html
+output.html
+
+# Ignore bundler config.
+/.bundle/
+
+# We ignore the Gemfile.lock in a gem
+/Gemfile.lock
+
+# When the gem is built it goes here, but we don't want to include this in
+# the source code repo
+/pkg/
+*.gem
+
+# Ignore folders related to documentation output
+/.yardoc
+/_yardoc/
+/html/
+/doc/
+
+# Ignore folders related to test output
+/coverage/
+/spec/reports/
+
+# Ignore your project specific .config.yml config files
+*.config.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  Exclude:
+    # Bin contains standard files created when gem is initialised and therefore
+    # they should be left as is
+    - 'bin/**/*'
+    # Exe contains standard files created when gem is initialised and therefore
+    # they should be left as is
+    - 'exe/**/*'
+    # Rakefile is generated when gem is initialised and therefore should be
+    # left as is
+    - 'Rakefile'
+    # Gemfile is generated when gem is initialised and therefore should be
+    # left as is
+    - 'Gemfile'
+  # Cop names are not displayed in offense messages by default. We find it
+  # useful to include this information so we can use it to investigate what the
+  # fix may be.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Again we
+  # find it useful to go straight to the documentation for a rule when
+  # investigating what the fix may be.
+  DisplayStyleGuide: true
+
+# Disable this rubocop style because we want to make the arguments passed into
+# Freakin available to anywhere when the code is executed
+Style/GlobalVars:
+  Enabled: false
+
+# It is our opinion that classes are easier to read if a white space is
+# permitted between the class declaration and the first statement. Ditto the
+# last statement and the closing tag.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# It is our opinion that modules are easier to read if a white space is
+# permitted between the module declaration and the first statement. Ditto the
+# last statement and the closing tag.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,40 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+
+# Travis CI clones repositories to a depth of 50 commits, which is only really
+# useful if you are performing git operations.
+# https://docs.travis-ci.com/user/customizing-the-build/#Git-Clone-Depth
+git:
+  depth: 3
+
+# enable Bundler caching
+# https://docs.travis-ci.com/user/languages/ruby#Caching-Bundler
+cache: bundler
+
+# This section was added as per https://docs.travis-ci.com/user/code-climate/
+# To protect our codeclimate stats rather than adding the Codeclimate API key for ea-area_lookup
+# in the open we used this guide https://docs.travis-ci.com/user/encryption-keys/ to encryt the
+# value. Essentially install travis gem, then run `travis encrypt <my_code_climate_api_key>`
+addons:
+  code_climate:
+    repo_token:
+      secure: "Fa+J+1mLtiQpg9BSwiuZ7Oi9azCMkRaydRkgZe5zN1qt0aMEOhq3bLeNvnmcB8X1024jKWHozweMxE4BZ3lbL2o+QGksg9Sc56j88cTbNr35gdtbFvR/EFbNO0Y8ncmDuovw0lLJa0IwZKQ7E5WexyWhdsQ5ksKPUKr2e5kr/uJKm6B74nffL+W7wP
+GkTEzfFOYgTJcLzCtSeMuiZy5jnbPca9iiLM5fq0sDZ6RoUfrv8BXLtOAF5hSwKYzhtthNlDVFYGylDB3zmWnhTtqJkUR4+jjQep/SXvOktgYJPXXxK5XV2QnqRUWlpTuOVvnJQKgZAMXlZ9gdQJMWNtL81llBsp65D8ymD8+JyqDunX+WN2aZYbOkN4geKag2ZAB
+gd5GSvj5ZnEXR+YdxkmPHdeFVmeV3AhlwsX4dtXUV2g6icRmBE1cE/Q+VvS1w4t8xoeiLX12oJSpVGoSAC9Mx1fMtkcjrRmposwS4LMqtIJkEMnbDAo3eCrT2rToFBb/sVgLkuxVuO/nLmfeGoYFVRL3Rhe7rEg5euVYSDFLB/S9FrhTgrmTpGoFNzAKmF/V3+wBf
+MlNYWWRLGKnQuy8+UUMFjOXP5kWF+pkdK6fB8yz/Jn9wI5OY4bd03V1gcmOxNhaNFIxh6k2x0m4Da3rgIu4bQSXeMtJSKz/OvN8eRZs="
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "mrNfo3ZlO4wtr7fp751jltjKZcWeFXLCxxVDHqJVnkdAKpDcbo99Phlq9+fh5Q/o8gIJ4jKQybvr/Zu5t8mrWYJKKLlsUi3UThJG5hOg64ynJKy3jqtU45uCGOc33oBhQAqHTfDI+DZxQTGs2TepoqdyxsSzki
+s9TRj+qyeE2HSO+yz5Qyjwql6o5k9xP82uBFaQI0WKqKdTtdNFv5LZ3EZaRWtyM/jGsunaNAYscDOl3cYN1sXlq+wfCTRvjMGmcppdbsaczQNQdIkXBPZEkydO7FdnSwUFuwm30BP0OBks5myB7oHWbbe0p/YRsUbjLF0dVfn
+AlSERSwhkpMOU1BpK4/vwPBoR8yzgfZG4UZAZQ6hCMtRj+2usKWcI4buryeD+iPDrkVX9FjziOC3OFSbMzo/ojYlkLjvvXuUcTAmWZr0V/VP1x7RAiHNA+Y7EqYRJFJcEE5Av7Yn+hgi8fUtLyiSDLOb4bGJ2fe9R3YeZQ1ge
+pvnarjriXfNZul3K1tP21/oVeXwCRuOjPMxwUmEsPCCjdIu/44U5CvGRbaqJXAqYJm71u+Y96RfkjytRnLmAc13nIBiFCUqUyoab4GIsy9AZ4TzE9ROGwLTC3y05gMVlYVJk4GTtVCjJwqNB2LWRXo/PseWaDdRZYmnNTr5wI
+kB5wbWRtEYUdIOb70c="
+  gem: quke
+  on:
+    tags: true
+    repo: EnvironmentAgency/quke

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quke.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2014 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,138 @@
+<img src="/quke.png" alt="Git flow" />
+
+[![Build Status](https://travis-ci.org/EnvironmentAgency/quke.svg?branch=master)](https://travis-ci.org/EnvironmentAgency/quke)
+[![security](https://hakiri.io/github/EnvironmentAgency/quke/master.svg)](https://hakiri.io/github/EnvironmentAgency/quke/master)
+[![Code Climate](https://codeclimate.com/github/EnvironmentAgency/quke/badges/gpa.svg)](https://codeclimate.com/github/EnvironmentAgency/quke)
+[![Test Coverage](https://codeclimate.com/github/EnvironmentAgency/quke/badges/coverage.svg)](https://codeclimate.com/github/EnvironmentAgency/quke/coverage)
+[![Dependency Status](https://dependencyci.com/github/EnvironmentAgency/quke/badge)](https://dependencyci.com/github/EnvironmentAgency/quke)
+
+Quke is a gem that helps you to build a suite of [Cucumber](https://cucumber.io/) acceptance tests.
+
+Quke tries to simplify the process of writing and running these tests by setting up **Cucumber** for you. It handles the config to allow you to run them in [Firefox](https://www.mozilla.org/en-GB/firefox/new/) (via Selenium) and [Chrome](https://www.google.co.uk/chrome/browser/desktop/) (via [Selenium](https://github.com/SeleniumHQ/selenium/tree/master/rb)), or the headless browser [PhantomJS](http://phantomjs.org/) (via [Poltergeist](https://github.com/teampoltergeist/poltergeist)). It also has out of the box support for using [Browserstack automate](https://www.browserstack.com). This leaves you to focus on just your tests.
+
+It was born out of trying to make the process for team members without a development background as simple as possible, and to get them involved in writing and building acceptance tests that they then manage.
+
+It also includes the ability to run those tests using **Browserstack**. **Browserstack** gives you the ability to test your application with different combinations of platform, OS, and browser all in the cloud.
+
+## Pre-requisites
+
+You'll need [Ruby](https://www.ruby-lang.org/en/) installed (ideally the latest version available) plus the [Bundler](http://bundler.io/) gem.
+
+The only other dependency this project has is the browsers you intend to use it with. It is currently setup to work with
+
+- [PhantomJS](http://phantomjs.org/) (via [Poltergeist](https://github.com/teampoltergeist/poltergeist))
+- [Chrome](https://www.google.co.uk/chrome/browser/desktop/) (via [Selenium](https://github.com/SeleniumHQ/selenium/tree/master/rb))
+- [Firefox](https://www.mozilla.org/en-GB/firefox/new/) (via Selenium)
+
+The one you may not have heard of is **PhantomJS**. It is a [headless browser](https://en.wikipedia.org/wiki/Headless_browser).
+
+> A headless browser is a web browser without a graphical user interface
+
+Quke uses **PhantomJS** as its default browser. Using a headless browser the tests will run much faster and means Quke can also be used as part of your [CI build](https://en.wikipedia.org/wiki/Build_automation).
+
+It is assumed you know what **Chrome** and **Firefox** are and how to install them.
+
+### Install PhantomJS
+
+#### Mac
+
+We highly recommend using [Homebrew](http://brew.sh/) if you are using a **Mac** for installing packages like PhantomJS.
+
+Once installed run `brew install phantomjs`
+
+#### Linux
+
+You'll need to
+
+- Download either the 32bit or 64bit binary from <http://phantomjs.org/download.html>
+- Extract the content and add the `bin/phantomjs` directory to your `PATH`
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'quke'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as
+
+    $ gem install quke
+
+## 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`.
+
+### Multiple configs
+
+When Quke runs it will default to looking for `.config.yml`. However you can override this and tell Quke which one to use. This allows you to create multiple config files.
+
+You do this using an environment variable. The most flexible way is to set the variable as part of your command.
+
+```bash
+QUKE_CONFIG='chrome.config.yml' bundle exec quke
+```
+
+The use case is to allow you to have different configs setup ready to go, and enable you to switch between them. For example when testing with Chrome and Firefox you set a 1 second delay between steps so you can observe the tests as they run through, but in your default `.config.yml` you want no pauses and use **phantomjs**.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Behaviours
+
+You should be aware of some default behaviours included in Quke.
+
+### Displaying web pages on fail
+
+Capybara includes the ability to save the source of the current page at any point. Quke has been configured so that if you are not using the headless browser and a step should fail it will save the source to file and then use a tool called [Launchy](https://github.com/copiousfreetime/launchy) to open it in your default browser.
+
+### Early fail for CI
+
+When running using the default PhantomJS headless browser, as soon as there is a failure Quke will exit. This is because it is assumed when used in headless mode the key thing to know is *are there any failures*, to ensure fast feedback from your CI build server.
+
+### Quit on 5 failures
+
+If you are running using Chrome or Firefox after the 5th failure Quke will automatically stop. This is to prevent scores of tabs being opened in the browser when an error is found, which may just be the result of an error in the test code.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running
+
+Whilst just developing a gem like Quke you can execute it with
+
+    $ ruby -Ilib ./exe/quke
+
+and pass in arguments as well
+
+    $ ruby -Ilib ./exe/quke --tags @wip
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'quke'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/quke

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'quke'
+require 'quke/configuration'
+
+Quke::Quke.config = Quke::Configuration.new
+Quke::Quke.execute(ARGV)

data/lib/features/support/after_hook.rb

@@ -0,0 +1,36 @@
+require 'quke/configuration'
+
+After('~@nonweb') do |scenario|
+  if scenario.failed?
+
+    $fail_count ||= 0
+    $fail_count = $fail_count + 1
+
+    # Tell Cucumber to quit after first failing scenario when phantomjs is
+    # used. The expectation is that you are using phantomjs as part of your
+    # CI and therefore a fast response is better than a detailed response.
+    # Experience has shown that should a major element of your service go
+    # down all your tests will start failing which means you can be swamped
+    # with output from `save_and_open_page`. Using a global count of the
+    # number of fails, if it hits 5 it will cause cucumber to close.
+    if Quke::Quke.config.driver == :phantomjs || $fail_count >= 5
+      Cucumber.wants_to_quit = true
+    else
+      # If we're not using poltergiest and the scenario has failed, we want
+      # to save a copy of the page and open it automatically using Launchy.
+      # We wrap this in a begin/rescue in case of any issues in which case
+      # it defaults to outputting the source to STDOUT.
+      begin
+        # rubocop:disable Lint/Debugger
+        save_and_open_page
+        # rubocop:enable Lint/Debugger
+      rescue StandardError
+        # handle e
+        puts "FAILED: #{scenario.name}"
+        puts "FAILED: URL of the page with the failure #{page.current_path}"
+        puts ''
+        puts page.html
+      end
+    end
+  end
+end

data/lib/features/support/after_step_hook.rb

@@ -0,0 +1,7 @@
+require 'quke/configuration'
+
+# We use cucumber's AfterStep hook to insert our pause between pages if
+# one was set
+AfterStep do
+  sleep(Quke::Quke.config.pause)
+end

data/lib/features/support/env.rb

@@ -0,0 +1,33 @@
+require 'rspec/expectations'
+require 'capybara/cucumber'
+require 'site_prism'
+require 'quke/driver_registration'
+require 'quke/configuration'
+
+Capybara.app_host =
+  Quke::Quke.config.app_host unless Quke::Quke.config.app_host.empty?
+
+driver = Quke::DriverRegistration.new(Quke::Quke.config).register
+
+Capybara.default_driver = driver
+Capybara.javascript_driver = driver
+
+# 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.
+Capybara.run_server = false
+
+# When calling save_and_open_page the current html page is saved to file for
+# debug purposes. This can be done directly within a step or happens
+# 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

data/lib/quke.rb

@@ -0,0 +1,24 @@
+require 'quke/version'
+require 'quke/configuration'
+require 'quke/cuke_runner'
+require 'quke/driver_registration'
+
+module Quke #:nodoc:
+
+  # The main Quke class. It is not intended to be instantiated and instead
+  # just need to call its +execute+ method.
+  class Quke
+
+    class << self
+      attr_accessor :config
+    end
+
+    # The entry point for Quke, it is the one call made by +exe/quke+.
+    def self.execute(args = [])
+      cuke = CukeRunner.new(@config.features_folder, args)
+      cuke.run
+    end
+
+  end
+
+end

data/lib/quke/configuration.rb

@@ -0,0 +1,166 @@
+require 'yaml'
+
+module Quke #:nodoc:
+
+  # Manages all configuration for Quke.
+  class Configuration
+
+    attr_reader :file_location, :data
+
+    class << self
+      attr_writer :file_location
+    end
+
+    # Returns the expected root location of where Quke expects to find the
+    # the config file.
+    def self.file_location
+      @file_location ||= File.expand_path(
+        "../../#{file_name}",
+        File.dirname(__FILE__)
+      )
+    end
+
+    # 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'
+    end
+
+    # When an instance is initialized it will automatically populate itself by
+    # calling a private method +load_data()+.
+    def initialize
+      @data = load_data
+    end
+
+    def features_folder
+      @data['features_folder']
+    end
+
+    # Returns the value set for +app_host+.
+    #
+    # Normally Capybara expects to be testing an in-process Rack application,
+    # but Quke is designed to talk to a remote host. Users of Quke can set
+    # what this will be by setting +app_host+ in their +.config.yml+ file.
+    # Capybara will then combine this with links you provide.
+    #
+    #     visit('/Main_Page')
+    #     visit('/')
+    #
+    # This saves you from having to repeat the full url each time.
+    def app_host
+      @data['app_host']
+    end
+
+    # Returns the value set for +driver+.
+    #
+    # Tells Quke which browser to use for testing. Choices are firefox,
+    # chrome browserstack and phantomjs, with the default being phantomjs.
+    def driver
+      @data['driver']
+    end
+
+    # Return the value set for +pause+.
+    #
+    # Add a pause (in seconds) between steps so you can visually track how the
+    # browser is responding. Only useful if using a non-headless browser. The
+    # default is 0.
+    def pause
+      @data['pause']
+    end
+
+    # Return the hash of +browserstack+ options.
+    #
+    # If you select the browserstack driver, there are a number of options you
+    # can pass through to setup your browserstack tests, username and auth_key
+    # being the critical ones.
+    #
+    # Please see https://www.browserstack.com/automate/capabilities for more
+    # details.
+    def browserstack
+      @data['browserstack']
+    end
+
+    # The hash returned from this method is intended to used in a call to
+    # Capybara::Poltergeist::Driver.new(app, options).
+    #
+    # There are a number of options for how to configure poltergeist which
+    # drives PhantomJS, and it includes options passed to phantomjs to
+    # configure how it runs.
+    def poltergeist_options
+      {
+        # Javascript errors will get re-raised in our tests causing them to fail
+        js_errors: true,
+        # How long in seconds we'll wait for response when communicating with
+        # Phantomjs
+        timeout: 30,
+        # When true debug output will be logged to STDERR (a terminal thing!)
+        debug: false,
+        # Poltergeist can pass on options for configuring phantomjs
+        phantomjs_options: phantomjs_options,
+        inspector: true
+      }
+    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
+      @data.to_s
+    end
+
+    private
+
+    def phantomjs_options
+      # Don't load images to help speed up the tests,
+      [
+        '--load-images=no',
+        '--disk-cache=false',
+        '--ignore-ssl-errors=yes'
+      ]
+    end
+
+    def load_data
+      data = default_data!(load_yml_data)
+      data['browserstack'] = browserstack_data(data['browserstack'])
+      data
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    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
+      )
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # rubocop:disable Metrics/MethodLength
+    def browserstack_data(data)
+      data = {} if data.nil?
+      data.merge(
+        'username' => (ENV['BROWSERSTACK_USERNAME'] ||
+                       data['username'] ||
+                       ''
+                      ),
+        'auth_key' => (ENV['BROWSERSTACK_AUTH_KEY'] ||
+                       data['auth_key'] ||
+                       ''
+                      )
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def load_yml_data
+      if File.exist? self.class.file_location
+        # YAML.load_file returns false if the file exists but is empty. So
+        # added the || {} to ensure we always return a hash from this method
+        YAML.load_file(self.class.file_location) || {}
+      else
+        {}
+      end
+    end
+
+  end
+
+end

data/lib/quke/cuke_runner.rb

@@ -0,0 +1,49 @@
+require 'cucumber'
+
+module Quke #:nodoc:
+
+  # Handles executing Cucumber, including sorting the arguments we pass to it
+  class CukeRunner
+
+    attr_reader :args
+
+    # When an instance of CukeRunner is initialized it will take the arguments
+    # passed in and combine them with its own default args.
+    #
+    # The default args add the following to the parameters passed to Cucumber
+    #
+    #     [my_features_folder, '-r', 'lib/features', '-r', my_features_folder]
+    #
+    # Its these args that pass our features directory to cucumber along with
+    # the user's. So to break it down
+    #   - +my_features_folder+, first arg tells Cucumber where the feature files
+    #       are located
+    #   - +-r 'lib/features'+, tells Cucumber to require our features folder.
+    #       This is how we get it to use our +env.rb+ which handles all the
+    #       setup on behalf of the user (the point of Quke) to do things like
+    #       use Browserstack, or switch between running against Chrom or firefox
+    #       locally
+    #   - +-r my_features_folder+, if you specify a different folder for
+    #       or wish to test just specific features, you are required by Cucumber
+    #       to also require the folder which contains your steps
+    # features directory contains the +env.rb+
+    def initialize(features_folder, args = [])
+      @args = [
+        features_folder,
+        '-r', 'lib/features',
+        '-r', features_folder
+      ] + args
+    end
+
+    # Executes Cucumber, passing in the arguments hash set when the instance of
+    # CukeRunner was created.
+    def run
+      Cucumber::Cli::Main.new(@args).execute!
+    rescue SystemExit => e
+      # Cucumber calls @kernel.exit() killing your script unless you rescue
+      raise StandardError, 'Cucumber exited in a failed state' unless e.success?
+    end
+
+  end
+
+end

data/lib/quke/driver_registration.rb

@@ -0,0 +1,138 @@
+require 'quke/configuration'
+require 'capybara/poltergeist'
+require 'selenium/webdriver'
+
+module Quke #:nodoc:
+
+  # Helper class that contains all methods related to registering drivers with
+  # Capybara.
+  class DriverRegistration
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def register
+      case @config.driver
+      when 'firefox'
+        firefox
+      when 'chrome'
+        chrome
+      when 'browserstack'
+        browserstack(@config.browserstack)
+      else
+        phantomjs(@config.poltergeist_options)
+      end
+    end
+
+    private
+
+    # Register the poltergeist driver with capybara.
+    #
+    # By default poltergeist is setup to work with phantomjs hence we refer to
+    # it as :phantomjs. There are a number of options for how to configure
+    # poltergeist, and we can even pass on options to phantomjs to configure how
+    # it runs.
+    def phantomjs(options = {})
+      Capybara.register_driver :phantomjs do |app|
+        # We ignore the next line (and those like it in the subsequent methods)
+        # from code coverage because we never actually execute them from Quke.
+        # Capybara.register_driver takes a name and a &block, and holds it in a
+        # hash. It executes the block from within Capybara when Cucumber is
+        # called, all we're doing here is telling it what block (code) to
+        # execute at that time.
+        # :simplecov_ignore:
+        Capybara::Poltergeist::Driver.new(app, options)
+        # :simplecov_ignore:
+      end
+      :phantomjs
+    end
+
+    # Register the selenium driver with capybara. By default selinium is setup
+    # to work with firefox hence we refer to it as :firefox
+    #
+    # N.B. options is not currently used but maybe in the future.
+    def firefox(_options = {})
+      Capybara.register_driver :firefox do |app|
+        # :simplecov_ignore:
+        Capybara::Selenium::Driver.new(app)
+        # :simplecov_ignore:
+      end
+      :firefox
+    end
+
+    # Register the selenium driver again, only this time we are configuring it
+    # to work with chrome.
+    #
+    # N.B. options is not currently used but maybe in the future.
+    def chrome(_options = {})
+      Capybara.register_driver :chrome do |app|
+        # :simplecov_ignore:
+        Capybara::Selenium::Driver.new(app, browser: :chrome)
+        # :simplecov_ignore:
+      end
+      :chrome
+    end
+
+    # Register a browserstack driver. Essentially this the selenium driver but
+    # configured to run remotely using the Browserstack automate service.
+    # As a minimum the options must contain a username and key in order to
+    # authenticate with Browserstack.
+    # rubocop:disable Metrics/MethodLength
+    def browserstack(options = {})
+      Capybara.register_driver :browserstack do |app|
+        # :simplecov_ignore:
+        username = options['username']
+        key = options['auth_key']
+        url = "http://#{username}:#{key}@hub.browserstack.com/wd/hub"
+
+        Capybara::Selenium::Driver.new(
+          app,
+          browser: :remote,
+          url: url,
+          desired_capabilities: browserstack_capabilities(options)
+        )
+        # :simplecov_ignore:
+      end
+      :browserstack
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def browserstack_capabilities(options = {})
+      capabilities = Selenium::WebDriver::Remote::Capabilities.new
+
+      capabilities['build'] = options['build']
+      capabilities['project'] = options['project']
+      capabilities['name'] = options['name']
+
+      # This and the following section are essentially diametric; you set one
+      # or the other but not both. Some examples seen put logic in place to
+      # test the options passed in and then set the capabilities accordingly,
+      # however Browserstack handles this and has what will happen documented
+      # https://www.browserstack.com/automate/capabilities#capabilities-parameter-override
+      capabilities['platform'] = options['platform']
+      capabilities['browserName'] = options['browserName']
+      capabilities['version'] = options['version']
+
+      capabilities['os'] = options['os']
+      capabilities['os_version'] = options['os_version']
+      capabilities['browser'] = options['browser']
+      capabilities['browser_version'] = options['browser_version']
+      # -----
+
+      capabilities['browserstack.debug'] = options['debug']
+      capabilities['browserstack.video'] = options['video']
+
+      # At this point Quke does not support local testing so we specifically
+      # tell Browserstack we're not doing this
+      capabilities['browserstack.local'] = 'false'
+      capabilities
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+  end
+
+end

data/lib/quke/version.rb

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

data/quke.gemspec

@@ -0,0 +1,101 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quke'
+  spec.version       = Quke::VERSION
+  spec.authors       = ['Alan Cruikshanks']
+  spec.email         = ['alan.cruikshanks@environment-agency.gov.uk']
+
+  spec.summary       = 'A gem to simplify creating acceptance tests using /
+                        Cucumber'
+  spec.description   = 'Quke tries to simplify the process of writing and /
+                        running acceptance tests by setting up Cucumber for /
+                        you. /
+                        It handles the config to allow you to run your tests /
+                        in Firefox and Chrome, or the headless browser /
+                        PhantomJS. It also has out of the box setup for /
+                        using Browserstack automate. /
+                        This leaves you to focus on just your features and
+                        / steps.'
+  spec.homepage      = 'https://github.com/environmentagency/quke'
+  spec.license       = 'Nonstandard'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect /
+           against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9'
+
+  # We need the cucumber gem to use cucumber, obviously!
+  spec.add_dependency 'cucumber', '~> 2.4'
+
+  # We use capybara to drive whichever browser we are using, and by drive we
+  # mean things like fill_in x, click_on y etc. Capybara makes it much easier to
+  # do this, though if you're willing to go a level lower you can write your own
+  # code to tell selenium how to interact with a web page
+  spec.add_dependency 'capybara', '~> 2.9'
+
+  # We bring in rspec-expectations to simplify how to actually test if a page is
+  # correct. For example you can test you are on the right page in a step using
+  # expect(page).to have_text 'Welcome to test nirvana!'
+  spec.add_dependency 'rspec-expectations', '~> 3.4'
+
+  # This is the first of our web drivers i.e. the bits that allow capybara to
+  # to drive an actual browser. Poltergeist is used with a headless browser
+  # called phantomjs, which is superfast and great for using on CI servers
+  # as it has no other dependencies
+  spec.add_dependency 'poltergeist', '~> 1.10'
+
+  # selenium-webdriver is used to drive real browsers that may be installed,
+  # for example Firefox, Chrome and Internet Explorer. The benefit of selenium
+  # is you can actually see the tests interacting with the browser, the downside
+  # is they run slower and isn't best suited to a CI environment.
+  spec.add_dependency 'selenium-webdriver', '~> 2.53'
+
+  # Needed when wishing to use Chrome for selenium tests. We could have chosen
+  # to install the chromedriver separately (and it seems more recent tutorials
+  # do it in that way). However in an effort to make using this gem as simple
+  # as possible we have gone with using the chromedriver-helper. To quote
+  # from it "Easy installation and use of chromedriver, the Chromium project's
+  # selenium webdriver adapter."
+  spec.add_dependency 'chromedriver-helper', '~> 1.0'
+
+  # Experience has shown that keeping tests dry helps make them more
+  # maintainable over time. One practice that helps is the use of the
+  # page object pattern. A page object wraps up all functionality for describing
+  # and interacting with a page into a single object. This object can then be
+  # referred to in the steps, rather than risk duplicating the logic in
+  # different steps. Site_Prism provides a page object framework, and we build
+  # it into the gem so users of Quke don't have to add and setup this dependency
+  # themselves
+  spec.add_dependency 'site_prism', '~> 2.9'
+
+  # Capybara includes a method called save_and_open_page. Without Launchy it
+  # will still save to file a copy of the source html of the page in question
+  # at that time. However simply adding this line into the gemfile means it
+  # will instead open in the default browser instead.
+  spec.add_dependency 'launchy', '~> 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rdoc', '~> 4.2'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+end

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification
+name: quke
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alan Cruikshanks
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.53'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.53'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: site_prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: |-
+  Quke tries to simplify the process of writing and /
+                          running acceptance tests by setting up Cucumber for /
+                          you. /
+                          It handles the config to allow you to run your tests /
+                          in Firefox and Chrome, or the headless browser /
+                          PhantomJS. It also has out of the box setup for /
+                          using Browserstack automate. /
+                          This leaves you to focus on just your features and
+                          / steps.
+email:
+- alan.cruikshanks@environment-agency.gov.uk
+executables:
+- quke
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".config.example.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/quke
+- lib/features/support/after_hook.rb
+- lib/features/support/after_step_hook.rb
+- lib/features/support/env.rb
+- lib/quke.rb
+- lib/quke/configuration.rb
+- lib/quke/cuke_runner.rb
+- lib/quke/driver_registration.rb
+- lib/quke/version.rb
+- quke.gemspec
+- quke.png
+homepage: https://github.com/environmentagency/quke
+licenses:
+- Nonstandard
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to simplify creating acceptance tests using / Cucumber
+test_files: []