quke 0.6.0 → 0.7.0

data/spec/quke/driver_registration_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::DriverRegistration do
+  describe "#register" do
+
+    context "A valid driver is passed to the method" do
+      %i[firefox chrome browserstack phantomjs].each do |driver|
+        it "returns the value :#{driver} when that driver is selected" do
+          Quke::Configuration.file_location = data_path(".#{driver}.yml")
+          config = Quke::Configuration.new
+          driver_config = Quke::DriverConfiguration.new(config)
+          driver_reg = Quke::DriverRegistration.new(driver_config, config)
+          driver = driver_reg.register(config.driver)
+          expect(driver).to eq(driver)
+        end
+      end
+    end
+
+    context "An unrecognised driver is passed to the method" do
+      it "returns the default value :phantomjs" do
+        Quke::Configuration.file_location = data_path(".invalid.yml")
+        config = Quke::Configuration.new
+        driver_config = Quke::DriverConfiguration.new(config)
+        driver_reg = Quke::DriverRegistration.new(driver_config, config)
+        driver = driver_reg.register(config.driver)
+        expect(driver).to eq(driver)
+      end
+    end
+  end
+
+end

data/spec/quke/quke_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke do
+  describe ".execute" do
+    %i[firefox chrome browserstack phantomjs].each do |driver|
+      before(:example) do
+        Quke::Configuration.file_location = data_path(".#{driver}.yml")
+        Quke::Quke.config = Quke::Configuration.new
+      end
+
+      it "does not raise an error when called with driver :#{driver}" do
+        expect { Quke::Quke.execute }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Require and run our simplecov initializer as the very first thing we do.
+# This is as per its docs https://github.com/colszowka/simplecov#getting-started
+require "./spec/support/simplecov"
+
+# Support debugging in the tests
+require "byebug"
+
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. However in a small gem like this the increase should be neglible
+Dir[File.join(__dir__, "support", "**", "*.rb")].each { |f| require f }
+
+# Need to require our actual code files
+require "quke"
+
+RSpec.configure do |config|
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Enable the ability to run only selected tests. This means rather than
+  # having to pass the specifics in at the command line we can denote which
+  # tests we want to run in the code.
+  # https://www.relishapp.com/rspec/rspec-core/docs/filtering/inclusion-filters
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  # Makes our helper methods available to all specs
+  config.include Helpers
+end

data/spec/support/helpers.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Helpers methods for use in all rspec tests
+module Helpers
+
+  # Returns the full path to a named file in the 'data' folder, for example
+  #
+  #     data_path('.simple_config.yml') # "/Users/jsmith/freakin/data/.simple_config.yml"
+  #
+  def data_path(path)
+    File.expand_path(path, data_root)
+  end
+
+  # Returns the full path to the 'data' folder in this project, for example
+  #
+  #     "/Users/jsmith/freakin/data"
+  #
+  def data_root
+    File.expand_path("spec/data", Dir.pwd)
+  end
+
+  # Returns a string which contains all the preferences set in an instance of
+  # Selenium::WebDriver::Firefox::Profile.
+  #
+  # Though we can set the properties of an Selenium::WebDriver::Firefox::Profile
+  # it makes it bloody awkward (!) to read them back. For example we can set
+  #
+  #     profile = Selenium::WebDriver::Firefox::Profile.new
+  #     profile.proxy = Selenium::WebDriver::Proxy.new(...)
+  #
+  # Because it has a writer method (+proxy=+). However there is no reader and
+  # this appears to be the case for most of its properties.
+  # https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/firefox/profile.rb
+  #
+  # However having checked how they have written their tests for this class
+  # (https://github.com/SeleniumHQ/selenium/blob/master/rb/spec/integration/selenium/webdriver/firefox/profile_spec.rb)
+  # we were able to find Selenium::WebDriver::Firefox::Profile has a method
+  # called +layout_on_disk+ which writes the profile to files. The Selenium team
+  # use a helper method in their specs which writes the profile to disk and then
+  # reads `user.js` to a string. It then tests the values in the string.
+  #
+  # This helper method is a tweeked version of theirs to allow us to do the same
+  # thing.
+  def read_profile_preferences(profile)
+    dir = profile.layout_on_disk
+    File.read(File.join(dir, "user.js"))
+  end
+end

data/spec/support/simplecov.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+# We start it with the rails param to ensure it includes coverage for all code
+# started by the rails app, and not just the files touched by our unit tests.
+# This gives us the most accurate assessment of our unit test coverage
+# https://github.com/colszowka/simplecov#getting-started
+SimpleCov.start("rails") do
+  # We filter the spec folder, mainly to ensure that any dummy apps don't get
+  # included in the coverage report. However our intent is that nothing in the
+  # spec folder should be included
+  add_filter "/spec/"
+  # We filter the lib/features/support folder because the only way we can test
+  # the code in there is to actually run Cucumber with a feature, something
+  # we're currently trying to avoid in our tests.
+  add_filter "/lib/features/support/"
+  # The version file is simply just that, so we do not feel the need to ensure
+  # we have a test for it
+  add_filter "lib/quke/version"
+
+  # You can make Simplecov ignore sections of code by wrapping them in # :nocov:
+  # tags. However without knowledge of this `nocov` doesn't mean a lot so here
+  # we take advantage of a feature that allows us to use a custom token to do
+  # the same thing `nocov` does. Now in our code any sections we want to exclude
+  # from test coverage stats we wrap in # :simplecov_ignore: tokens.
+  # https://github.com/colszowka/simplecov#ignoringskipping-code
+  nocov_token "simplecov_ignore"
+end

data/spec/support/webmock.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "webmock/rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
-- Alan Cruikshanks
+- Defra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2019-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -16,98 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.53'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.53'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: chromedriver-helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: geckodriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: site_prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -137,103 +151,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: defra_ruby_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.5'
 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
@@ -246,15 +274,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".browserstack.yml"
-- ".codeclimate.yml"
-- ".config.example.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -273,13 +292,22 @@ files:
 - lib/quke/driver_configuration.rb
 - lib/quke/driver_registration.rb
 - lib/quke/version.rb
-- quke.gemspec
-- quke.png
+- spec/quke/browserstack_configuration_spec.rb
+- spec/quke/browserstack_status_reporter_spec.rb
+- spec/quke/configuration_spec.rb
+- spec/quke/cuke_runner_spec.rb
+- spec/quke/driver_configuration_spec.rb
+- spec/quke/driver_registration_spec.rb
+- spec/quke/quke_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/simplecov.rb
+- spec/support/webmock.rb
 homepage: https://github.com/DEFRA/quke
 licenses:
-- Nonstandard
+- The Open Government Licence (OGL) Version 3
 metadata:
-  allowed_push_host: https://rubygems.org/
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -288,7 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -296,8 +324,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A gem to simplify creating acceptance tests using Cucumber
-test_files: []
+test_files:
+- spec/quke/browserstack_configuration_spec.rb
+- spec/quke/quke_spec.rb
+- spec/quke/browserstack_status_reporter_spec.rb
+- spec/quke/driver_registration_spec.rb
+- spec/quke/driver_configuration_spec.rb
+- spec/quke/cuke_runner_spec.rb
+- spec/quke/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/support/simplecov.rb
+- spec/support/helpers.rb
+- spec/support/webmock.rb