aruba 0.14.14 → 1.0.0

data/CONTRIBUTING.md

@@ -1,71 +1,273 @@
-## About to create a new Github Issue?
+# Contributing to the Cucumber Aruba Project
 
-We appreciate that. But before you do, please learn our basic rules:
+## Introduction
 
-* This is not a support forum. If you have a question, please go to [The Cukes Google Group](http://groups.google.com/group/cukes).
-* Do you have an idea for a new feature? Then don't expect it to be implemented unless you or someone else sends a [pull request](https://help.github.com/articles/using-pull-requests). You might be better to start a discussion on [the google group](http://groups.google.com/group/cukes).
-* Reporting a bug? Please tell us:
-  * which version of Aruba you're using
-  * which version of Ruby you're using.
-  * How to reproduce it. Bugs with a failing test in a [pull request](https://help.github.com/articles/using-pull-requests) get fixed much quicker. Some bugs may never be fixed.
-* Want to paste some code or output? Put \`\`\` on a line above and below your code/output. See [GFM](https://help.github.com/articles/github-flavored-markdown)'s *Fenced Code Blocks* for details.
-* We love [pull requests](https://help.github.com/articles/using-pull-requests). But if you don't have a test to go with it we probably won't merge it.
+We would love to get help from you as a **user** and a **contributor**.
 
-# Contributing to Aruba
+### As a **User**
 
-This document is a guide for those maintaining Aruba, and others who would like to submit patches.
+* Tell us how "Aruba" works for you
+* Spread the word if you like our work and please tell us if something is (utterly) wrong
+* Encourage people in testing their code and keep communicating their needs
 
-## Note on Patches/Pull Requests
+### As a **Contributor**
+
+* Send us bug fixes
+* Add new features to the code
+* Discuss changes
+* Add missing documentation
+* Improve our test coverage
+
+The rest of this document is a guide for those maintaining Aruba, and others
+who would like to submit patches.
+
+## Contributing to the Aruba project
+
+It would be great if all people who want to contribute to the Aruba project
+— contributors and maintainers — follow the guidelines in this
+section. There are also "Getting started" sections both for
+[contributors](#getting-started-as-a-contributor) and
+[maintainers](#getting-started-as-a-maintainer).
+
+### Issues
+
+About to create a new GitHub Issue? We appreciate that. But before you do,
+please learn our basic rules:
+
+* This is not a support forum. If you have a question, please go to
+  [The Cukes Google Group](http://groups.google.com/group/cukes).
+* Do you have an idea for a new feature? Then don't expect it to be implemented
+  unless you or someone else submits a
+  [pull request](https://help.github.com/articles/using-pull-requests). It
+  might be better to start a discussion on
+  [the Google Group](http://groups.google.com/group/cukes).
+* Reporting a bug? Follow our comments in the Issue Template, which is
+  pre-filled when you create the new GitHub Issue.
+* We love [pull requests](https://help.github.com/articles/using-pull-requests).
+  The same here: Please consider our comments within the pull request template.
+
+### Pull Requests
+
+#### Contributors
+
+Please...
 
 * Fork the project. Make a branch for your change.
-* Make your feature addition or bug fix.
-* Make sure your patch is well covered by tests. We don't accept changes that aren't tested.
-* Please do not change the Rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-  bump version in a commit by itself so we can ignore when we merge your change)
+* Make your feature addition or bug fix — if you're unsure if your
+  addition will be accepted, open a GitHub Issue for discussion first
+* Make sure your patch is well covered by tests. We don't accept changes that
+  aren't tested.
+* Do not change the `Rakefile`, gem version number in `version.rb`, or
+  [`CHANGELOG.md`][].
+  (If you want to have your own version, that is fine but bump version in a
+  separate commit, so that we can ignore that commit when we merge your change.)
+* Make sure your pull request complies with our development style guidelines.
+* Rebase your branch if needed. This reduces clutter in our git history.
+* Make sure you don't break other people's code. On major changes: First
+  deprecate, then bump major version, then make breaking changes,
+* Split up your changes into reviewable git commits which combine all
+  lines/files relevant for a single change.
 * Send us a pull request.
 
-## Bootstrap environment
+#### Maintainers
+
+* Use pull requests for larger or controversial changes made by yourself or
+  changes you might expected to break the build.
+* Commit smaller changes directly to master, e.g. fixing typos, adding tests or
+  adding documentation.
+* Update [`CHANGELOG.md`][] when a pull request is merged.
+* Make sure all tests are green before merging a pull request.
+
+### Development style guidelines
+
+* We try to follow the recommendations in the
+  [Ruby Community Style Guide][] and use
+  [`rubocop`][] to "enforce" it. Please see
+  [.rubocop.yml][] for exceptions.
+* There should be `action` methods and `getter` methods in Aruba. Only the
+  latter should return values. Please expect the first ones to return `nil`.
+* Add documentation — aka acceptance tests — for new features
+  using Aruba's Cucumber steps. Place them somewhere suitable in [features/].
+* Add unit tests where needed to cover edge cases which are not (directly)
+  relevant for users.
+* Add [YARD] developer documentation to all relevant methods added.
+* Format your commit messages following these seven rules — see
+  the ["How to Write a Git Commit Message"] blog post for a well-written
+  explanation about the why.
+  1. Separate subject from body with a blank line
+  2. Limit the subject line to 50 characters
+  3. Capitalize the subject line
+  4. Do not end the subject line with a period
+  5. Use the imperative mood in the subject line
+  6. Wrap the body at 72 characters
+  7. Use the body to explain what and why vs. how (optional if subject is self-explanatory)
+
+## Getting started as a "Contributor"
+
+### Requirements
+
+To get started with Aruba, you only need [Bundler].
+
+Install Aruba's dependencies:
+
+```bash
+bundle install
+```
+
+### Running tests
+
+Run the following command to run the test suite.
+
+```bash
+# Run the test suite
+bin/test
+```
+
+Or use these Rake tasks:
+
+```bash
+# Run the whole test suite
+rake test
+# Run RSpec tests
+rake spec
+# Run Cucumber features
+rake cucumber
+# Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
+rake cucumber:wip
+```
 
-To get started with `aruba`, you just need to bootstrap the environment by
-running the following command.
+If you have problems because our assumptions about your local setup are wrong,
+perhaps you can use this Docker workflow. This requires [Docker] to be
+installed on your local system.
 
-    # Bootstrap environment
-    script/bootstrap
+```bash
+# Build the docker container
+bundle exec rake docker:build
 
-## Running tests
+# Alternative: Build with disabled cache
+bundle exec rake 'docker:build[false]'
 
-Make sure you bootstrap the environment first.
+# Build image with version tag
+bundle exec rake 'docker:build[false, 0.1.0]'
 
-    # Run the test suite
-    script/test
+# Run the whole test suite in "docker"-container
+RUN_IN_DOCKER=1 bin/test
 
-## Release Process
+# Run only selected scenario
+RUN_IN_DOCKER=1 bin/test cucumber features/steps/command/shell.feature:14
+```
 
-* Bump the version number in `aruba.gemspec`
-* Make sure `History.md` is updated with the upcoming version number, and has entries for all fixes.
-* No need to add a `History.md` header at this point - this should be done when a new change is made, later.
+### Installing your own gems used for development
 
-Now release it
+A `Gemfile.local` file can be used, to have your own gems installed to support
+your normal development workflow.
 
-    bundle update
-    bundle exec rake
-    git commit -m "Release X.Y.Z"
-    rake release
+Example `Gemfile.local`:
 
-Now email cukes@googlegroups.com with details of the new release. Just a copy / paste from the History.md file is normally fine.
+```ruby
+gem 'pry'
+gem 'pry-byebug'
+gem 'byebug'
+```
 
-## Gaining Release Karma
+### Running a developer console
 
-To become a release manager, create a pull request adding your name to the list below, and include your Rubygems email address in the ticket. One of the existing Release managers will then add you.
+The interactive Aruba console starts an IRB console with Aruba's API loaded:
+
+```bash
+bin/console
+```
+
+### Linting
+
+Aruba's Rakefile provides the following linting tasks
+
+```bash
+bundle exec rake lint                         # Run all linters
+bundle exec rake lint:coding_guidelines       # Lint our code with "rubocop"
+bundle exec rake lint:licenses                # Check for relevant licenses in project
+```
+
+### Building and installing your local Aruba version
+
+You can use the following Rake tasks to build and install your work-in-progress locally:
+
+```bash
+# Build your copy
+bundle exec rake build
+# Build and install your copy
+bundle exec rake install
+# Build and install your copy without network access
+bundle exec rake install:local
+```
+
+## Getting started as a "Maintainer"
+
+### Release Process
+
+* Bump the version number in `lib/aruba/version.rb`
+* Make sure [`CHANGELOG.md`] is updated with the upcoming version number, and has
+  entries for all fixes.
+* No need to add a [`CHANGELOG.md`] header at this point - this should be done
+  later, when a new change is made.
+* If a major version is released, update the `still` branch, which points to
+  the "old" major version.
+
+Now release it:
+
+```bash
+# update dependencies
+bundle update
+
+# Run test suite
+bin/test
+
+# Release gem
+git commit -m "Version bump"
+bundle exec rake release
+
+# If it's a major relase:
+# Merge changes back to have correct documentation
+git checkout still
+git merge master
+git push
+```
+
+Now send a PR to [cucumber/website] adding an article
+with details of the new release. Then merge it - an aruba maintainer should
+normally be allowed to merge PRs on [cucumber/website]. A copy of an old
+announcement can be used as basis for the new article.
+
+Now, send an email with the link to the article to `cukes@googlegroups.com`.
+
+### Gaining Release Karma
+
+To become a release manager, create a pull request adding your name to the list
+below, and include your Rubygems email address in the ticket. One of the
+existing Release managers will then add you.
 
 Current release managers:
-  * Jarl Friis ([@jarl-dk](https://github.com/jarl-dk))
-  * Matt Wynne ([@mattwynne](http://github.com/mattwynne))
-  * Aslak Hellesøy ([@aslakhellesoy](http://github.com/aslakhellesoy))
-  * Tom Brand ([@tom025](https://github.com/tom025))
-  * Dennis Günnewig ([@maxmeyer](http://github.com/maxmeyer), [@dg-rationdata](http://github.com/dg-rationdata))
+  * Aslak Hellesøy ([@aslakhellesoy](https://github.com/aslakhellesoy))
+  * Matt Wynne ([@mattwynne](https://github.com/mattwynne))
+  * Matijs van Zuijlen ([@mvz](https://github.com/mvz))
 
 To grant release karma, issue the following command:
 
-    gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>
+```bash
+gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>
+```
+
+[`CHANGELOG.md`]: CHANGELOG.md
+[CHANGELOG.md]: CHANGELOG.md
+
+[`rubocop`]: https://github.com/bbatsov/rubocop
+[Ruby Community Style Guide]: https://github.com/bbatsov/ruby-style-guide
+[.rubocop.yml]: .rubocop.yml
+[features/]: features/
+
+[Bundler]: https://bundler.io/
+
+[Docker]: https://docs.docker.com/
+[YARD]: http://yardoc.org/
+["How to Write a Git Commit Message"]: http://chris.beams.io/posts/git-commit/
+[cucumber/website]: https://github.com/cucumber/website

data/Dockerfile

@@ -0,0 +1,67 @@
+FROM ubuntu:14.04
+MAINTAINER Aruba Maintainers <cukes-devs@googlegroups.com>
+
+# Packages needed to install RVM and run Bundler gem commands
+RUN apt-get update -qq \
+  && apt-get -y install ca-certificates curl git-core --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Create guest user early (before rvm) so uid:gid are 1000:000
+RUN useradd -m -s /bin/bash guest
+
+# Temporarily install RVM as root - just for requirements
+RUN gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \
+  && curl -L get.rvm.io | bash -s stable \
+  && bash -l -c 'rvm requirements 2.2.1' \
+  && bash -l -c 'echo yes | rvm implode' \
+
+# Fix locale
+ENV DEBIAN_FRONTEND noninteractive
+RUN dpkg-reconfigure locales && locale-gen en_US.UTF-8 && /usr/sbin/update-locale LANG=en_US.UTF-8 \
+   && echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && locale-gen
+ENV LC_ALL C.UTF-8
+ENV LANG C.UTF-8
+ENV LANGUAGE C.UTF-8
+
+# Zsh (just for the sake of a handful of Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install zsh --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Python (just for the sake of a handful of Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install python --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Java (for javac - also for just a few Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install openjdk-7-jdk --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Cache needed gems - for faster test reruns
+ADD Gemfile Gemfile.lock aruba.gemspec /home/guest/cache/aruba/
+ADD lib/aruba/version.rb /home/guest/cache/aruba/lib/aruba/version.rb
+RUN chown -R guest:guest /home/guest/cache
+
+USER guest
+ENV HOME /home/guest
+WORKDIR /home/guest
+
+# Install RVM as guest
+RUN gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \
+  && /bin/bash -l -c "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc" \
+  && curl -L get.rvm.io | bash -s stable \
+  && /bin/bash -l -c "rvm install 2.3.0 && rvm cleanup all" \
+  && /bin/bash -l -c "gem install bundler --no-ri --no-rdoc" \
+  && echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"' >> ~/.bashrc \
+  && echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"' >> ~/.zshrc
+
+# Download and install aruba + dependencies
+WORKDIR /home/guest/cache/aruba
+RUN bash -l -c "bundle install"
+
+# Default working directory
+RUN mkdir -p /home/guest/aruba
+WORKDIR /home/guest/aruba
+
+CMD ["bundle exec rake test"]

data/Gemfile

@@ -3,119 +3,10 @@ source 'https://rubygems.org'
 # Use dependencies from gemspec
 gemspec
 
-# Debug aruba
-group :debug do
-  unless RUBY_PLATFORM.include?('java')
-    if RUBY_VERSION >= '2.2'
-      gem 'byebug', '~> 10.0'
-      gem 'pry-byebug', '~> 3.4'
-    elsif RUBY_VERSION >= '2'
-      gem 'byebug', '~> 9.0'
-      gem 'pry-byebug', '~> 3.4'
-    elsif RUBY_VERSION > '1.9'
-      gem 'debugger', '~> 1.6.8'
-      gem 'pry-debugger', '~> 0.2.3'
-    end
-  end
+# Load local Gemfile
+load File.expand_path('Gemfile.local', __dir__) if File.file? File.expand_path('Gemfile.local', __dir__)
 
-  if RUBY_VERSION < '2'
-    gem 'pry-doc', '~> 0.8.0'
-  else
-    gem 'pry-doc', '~> 1.0.0'
-  end
-end
-
-# Tools to run during development
-group :development do
-  # License compliance
-  if RUBY_VERSION >= '2.3'
-    gem 'license_finder', '~> 5.0'
-  elsif RUBY_VERSION >= '2.0.0'
-    gem 'license_finder', '~> 2.0.4'
-  end
-end
-
-group :development, :test do
-  # we use this to demonstrate interactive debugging within our feature tests
-  if RUBY_VERSION >= '2'
-    gem 'pry', '~> 0.12.2'
-  else
-    gem 'pry', '~> 0.9.12'
-  end
-
-  # Run development and test tasks
-  if RUBY_VERSION >= '2.0.0'
-    gem 'rake', '~> 12.3'
-  elsif RUBY_VERSION >= '1.9.3'
-    gem 'rake', '~> 12.2.0'
-  else
-    gem 'rake', '~> 10.5.0'
-  end
-
-  if RUBY_VERSION >= '2.0.0'
-    # Lint travis yaml
-    gem 'travis-yaml'
-
-    # Reporting
-    gem 'bcat', '~> 0.6.2'
-  end
-
-  # YARD documentation
-  if RUBY_VERSION >= '2.3.0'
-    gem 'yard', '~> 0.9.11'
-    gem 'kramdown', '~> 2.1'
-  elsif RUBY_VERSION >= '2.0.0'
-    gem 'yard', '~> 0.9.11'
-    gem 'kramdown', '~> 1.7.0'
-  end
-
-  # Code Coverage
-  unless RUBY_PLATFORM.include?('java')
-    gem 'simplecov', '~> 0.10' 
-    if RUBY_VERSION < '2.0.0'
-      gem 'json', '< 2.3.0'
-    end
-  end
-
-
-  # Test api
-  gem 'rspec', '~> 3.4'
-  gem 'fuubar', '~> 2.0'
-
-  # using platform for this make bundler complain about the same gem given
-  # twice
-  if RUBY_VERSION < '1.9.3'
-    gem 'cucumber', '~> 1.3.20'
-  else
-    gem 'cucumber', '~> 2.0'
-  end
-
-  if RUBY_VERSION < '1.9.2'
-    gem 'childprocess', '~> 0.6.3'
-  elsif RUBY_VERSION < '2.3.0'
-    gem 'childprocess', '~> 1.0.1'
-  else
-    gem 'childprocess', ['>= 2.0', '< 4.0']
-  end
-
-  if RUBY_VERSION < '1.9.2'
-    gem 'contracts', '~> 0.15.0'
-  else
-    gem 'contracts', '~> 0.16.0'
-  end
-
-  if RUBY_VERSION >= '2.0.0'
-    # Make aruba compliant to ruby community guide
-    gem 'rubocop', '~> 0.32', '< 0.41.1'
-  end
-
-  if RUBY_VERSION < '2.0.0'
-    gem 'ffi', '< 1.11.0'
-  end
-
-  if RUBY_VERSION < '1.9.3'
-    gem 'minitest', '~> 5.8.0'
-  else
-    gem 'minitest', '~> 5.8'
-  end
+unless RUBY_PLATFORM.include?('java')
+  gem 'byebug', '~> 11.0'
+  gem 'pry-byebug', '~> 3.4'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig
+Copyright (c) 2010-2020 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig and Matijs van Zuijlen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the