unobtainium-cucumber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e548c830ba46d389e732d11a3cee4e48c00a31b
+  data.tar.gz: f939dffce9e566047ed81b0ebdef13dfe48b2202
+SHA512:
+  metadata.gz: c53e8436432b1a60edcb2ec8e2beed3e8756ab9c1e368773c86d12561229e1357b3ba84f07753eefbe84132d236b8cdf84cff3f0ce5643f31c330ec437c19b7f
+  data.tar.gz: c6f3ba4a52a937b58b7e4c30510b486b4925e13d0922ac2a40d798d4525955be40e72bd8deff612f8e2668d89ff989a24981e05371b86063de77f8bb17924d3c

data/.codeclimate.yml

@@ -0,0 +1,34 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    exclude_fingerprints:
+      - d85d6f12c93d79ccd43868b8315d8816
+      - a8e2b4ccb258f16eda697c5f98e21823
+      - 442a316695836b4f4693fe3786cd3396
+      - 1c24bb5da72323796b645814cc006684
+      - 4ff1112a73f7be30ecefa7bd90fdbf5a
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Editor files
+.*.sw*
+
+# Cucumber
+C:\\nppdf32Log\\debuglog.txt
+config/*-local.yml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+# Metrics
+
+Metrics/LineLength:
+  Max: 83
+  Details: >-
+    Line length of 80 is ideal for readability and compatibility; we'll accept
+    an extra 3 for minor edge cases.
+
+Metrics/MethodLength:
+  Max: 35
+
+Metrics/BlockNesting:
+  Max: 5
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 300
+
+# Style
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/SpaceAfterNot:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+script:
+  - bundle exec rake
+  - bundle exec codeclimate-test-reporter
+addons:
+  code_climate:
+    repo_token: 2341a8db591ce8112bd9a012ff0e3cfa20dce5705e69e3a89fda6829caf4f7fd

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unobtainium-cucumber.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    unobtainium-cucumber (0.1.0)
+      cucumber (~> 2.0)
+      unobtainium (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appium_lib (8.2.1)
+      awesome_print (~> 1.6)
+      json (~> 1.8)
+      nokogiri (~> 1.6.6)
+      selenium-webdriver (~> 2.50)
+      tomlrb (~> 1.1)
+    archive-zip (0.7.0)
+      io-like (~> 0.3.0)
+    ast (2.3.0)
+    awesome_print (1.7.0)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.0.0)
+      archive-zip (~> 0.7.0)
+      nokogiri (~> 1.6)
+    codeclimate-test-reporter (1.0.3)
+      simplecov
+    collapsium (0.8.2)
+    collapsium-config (0.4.3)
+      collapsium (~> 0.7)
+    cucumber (2.4.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 4.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.14)
+    gherkin (4.0.0)
+    io-like (0.3.0)
+    json (1.8.3)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    phantomjs (2.1.1.0)
+    powerpack (0.1.1)
+    ptools (1.3.3)
+    rainbow (2.1.0)
+    rake (11.3.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    rubyzip (1.2.0)
+    selenium-webdriver (2.53.4)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sys-proctable (1.1.3)
+    tomlrb (1.2.3)
+    unicode-display_width (1.1.1)
+    unobtainium (0.10.0)
+      collapsium (~> 0.8)
+      collapsium-config (~> 0.4)
+      ptools (~> 1.3)
+      sys-proctable (~> 1.1)
+    websocket (1.2.3)
+    yard (0.9.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appium_lib
+  bundler (~> 1.12)
+  chromedriver-helper
+  codeclimate-test-reporter
+  phantomjs
+  rake (~> 11.2)
+  rubocop (~> 0.46)
+  selenium-webdriver
+  simplecov (~> 0.12)
+  unobtainium-cucumber!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) Jens Finkhaeuser (http://finkhaeuser.de/) and other
+unobtainium-cucumber contributors. All rights not covered below are reserved.
+
+The MIT +no-false-attribs License (MITNFA)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# unobtainium-cucumber
+*Cucumber specific extensions to unobtainium.*
+
+Instead of requiring [unobtainium](https://github.com/jfinkhaeuser/unobtainium)
+in your [cucumber](https://cucumber.io/) project, just require this gem. It'll
+automatically some cucumber specific features to your project:
+
+- Reset the driver after each scenario.
+- Take screenshots on failures.
+
+Of course, each of these can be configured.
+
+[![Gem Version](https://badge.fury.io/rb/unobtainium-cucumber.svg)](https://badge.fury.io/rb/unobtainium-cucumber)
+[![Build status](https://travis-ci.org/jfinkhaeuser/unobtainium-cucumber.svg?branch=master)](https://travis-ci.org/jfinkhaeuser/unobtainium-cucumber)
+[![Code Climate](https://codeclimate.com/github/jfinkhaeuser/unobtainium-cucumber/badges/gpa.svg)](https://codeclimate.com/github/jfinkhaeuser/unobtainium-cucumber)
+[![Test Coverage](https://codeclimate.com/github/jfinkhaeuser/unobtainium-cucumber/badges/coverage.svg)](https://codeclimate.com/github/jfinkhaeuser/unobtainium-cucumber/coverage)
+
+# Usage
+
+The project's own *cucumber*-based test suite demonstrates most of the details.
+
+In brief, all the setup happens in the `features/support/env.rb` file:
+
+```ruby
+require "unobtainium-cucumber"
+```
+
+And that's it.
+
+## Configuration
+
+All configuration for this gem happens in the `config.yml` read in by
+*unobtainium*. All configuration keys respected in this gem live under the
+top-level `cucumber` key, i.e.:
+
+```yaml
+# config.yaml
+cucumber:
+  # this gem's keys go here
+```
+
+## Driver Reset
+
+By default, the driver's `#reset` function is called after each scenario for
+drivers that respond to such a function.
+
+You can switch this off with the `cucumber.driver_reset` flag:
+
+```yaml
+# config.yaml
+cucumber:
+  driver_reset: false
+```
+
+- If the flag is `false`, driver reset is switched off.
+- If the flag is undefined (i.e. `nil`) or any other value, driver reset is
+  switched on. The recommended value to switch it on explicitly is, of course,
+  `true`.
+
+## Status Actions
+
+One of the convenient features of this gem is that it allows you to cleanly
+define callbacks for a particular scenario status.
+
+It's an extension of the [After hook](https://github.com/cucumber/cucumber/wiki/Hooks)
+that allows you to specify whether your callback is invoked after a `Scenario`
+or `Scenario Outline` (or both), and only it has `#passed?` or is `#failed?`
+(or both). Status actions thus are actions triggered by a scenario status.
+
+Status actions can be any function or block that takes two arguments, the
+cucumber [World](https://github.com/cucumber/cucumber/wiki/A-Whole-New-World)
+object, and the scenario itself (for further querying).
+
+You can register them by including the `StatusActions` module in `World`, and
+then calling `#register_action`:
+
+```ruby
+
+World(StatusActions)
+
+# ...
+
+Given(/I foo/) do
+  # Registers #some_func for passed scenarios and outlines
+  register_action(:passed?, method(:some_func))
+
+  # Limits registration to outlines
+  register_action(:failed?, method(:some_func), type: :outline)
+
+  # Registers a block
+  register_action(:failed?) do |world, scenario|
+    # ...
+  end
+end
+```
+
+There are a number of other methods in the `StatusActions` module that you
+can use, but this is by far the most important.
+
+### Configuration
+
+Of course, the above is for programmatically adding actions. But `unobtainium`
+is configuration driven, so it makes sense to configure status actions in this
+gem:
+
+```yaml
+# config.yaml
+cucumber:
+  status_actions:
+    passed?:
+      - global_action
+    failed?:
+      outline:
+        - dummy_action
+      scenario:
+        - method_from_own_extension
+```
+
+Note how you can either provide an `Array` of method names to a status key,
+or further divide the status key into individual lists for outlines and
+scenarios.
+
+### Builtin Status Actions
+
+There are not many status actions built into this gem, although that number
+may rise. Currently, there is:
+
+- `#store_screenshot` writes a browser screenshot to the `screenshots`
+  directory.
+- `#store_content` writes a dump of the page content to the `content`
+  directory.
+
+File names are timestamped, and include the scenario name. That should
+make debugging a failed scenario easier.
+
+If you do not configure any actions, the default is to take screenshots after
+any failure.
+
+### Custom Actions
+
+As demonstrated earlier, custom actions are easy to define. If they are
+resolvable before a scenario starts (i.e. files are appropriately required),
+then you can configure them as string names in the configuration.
+
+You can specify any method of the `World` object, so any from your own
+exentsions to `World`. Alternatively, any function that is resolvable works.
+You might have to use fully qualified names.
+
+Custom actions have limited support facilities in the `Action::Support` module.
+Check it out if you write your own.

data/Rakefile

@@ -0,0 +1,29 @@
+# Rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+# Cucumber
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cuke) do |t|
+  t.cucumber_opts = "--fail-fast --format=pretty --expand "\
+                    "--order=random --backtrace"
+end
+
+# Documentation
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['-m', 'markdown']
+  t.stats_options = ['--list-undoc']
+end
+
+# Combined test task
+desc "Test all the things!"
+task :test do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:cuke].invoke
+end
+
+# Default is the test task
+task default: :test

data/config/config.yml

@@ -0,0 +1,28 @@
+# coding: utf-8
+#
+# unobtainium-cucumber
+# https://github.com/jfinkhaeuser/unobtainium-cucumber
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium-cucumber
+# contributors. All rights reserved.
+#
+
+driver: headless
+
+cucumber:
+
+# The following configuration options may be used to change the behaviour of
+# the test suite.
+#
+#   driver_reset: false
+
+# The following options are expected by the test suite. Changing them may
+# make the test suite fail. Proceed with caution!
+  status_actions:
+    passed?:
+      - global_action
+    failed?:
+      outline:
+        - dummy_action
+      scenario:
+        - method_from_own_extension

data/features/action.feature

@@ -0,0 +1,12 @@
+Feature:
+  Action functions
+
+  Scenario: Screenshot taking
+    Given I take a screenshot
+    Then I expect there to be a matching screenshot file
+
+
+  Scenario: Content capture
+    Given I navigate to the best site in the world
+    When I capture the page content
+    Then I expect there to be a matching content file

data/features/action_support.feature

@@ -0,0 +1,17 @@
+Feature:
+  Action support functions
+
+  Scenario Outline: Filename from scenario
+    Given I have a scenario named <name>
+    And I provide a tag <tag>
+    And the timestamp is <timestamp>
+    Then I expect the filename to match <filename>
+
+    Examples:
+      # Note:
+      #   - all caps NIL becomes Ruby nil.
+      #   - the filename will be interpreted as a regular expression as much
+      #     as possible.
+      | name          | tag     | timestamp            | filename                               |
+      | some scenario | NIL     | 2016-11-25T15:48:13Z | 2016_11_25T15_48_13Z-some_scenario     |
+      | some \| pipe  | the_tag | 2016-11-25T15:48:13Z | 2016_11_25T15_48_13Z-the_tag-some_pipe |

data/features/driver_reset.feature

@@ -0,0 +1,17 @@
+Feature:
+  Drivers should be automatically reset after each scenario
+
+  Background:
+    Given I remove any reset functions
+
+  Scenario: Reset driver by default
+    Given I run a scenario to test driver reset
+    Then the driver should be reset at the end
+
+  Scenario: Skip if driver does not define reset
+    Given I run a scenario with a driver that knowns no reset
+    Then the driver should not be reset at the end
+
+  Scenario: Skip if driver reset is switched off
+    Given I run a scenario with driver reset switched off
+    Then the driver should not be reset at the end

data/features/extensions.feature

@@ -0,0 +1,7 @@
+Feature:
+  User-defined extensions should work with this gem
+
+  Scenario: World contains user-defined extensions
+    Given I register an extension with cucumber's World
+    Then I expect this extension to be used
+