aruba 0.14.14 → 1.0.0.pre.alpha.1

data/README.md

@@ -1,225 +1,53 @@
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
+[![Docs](https://img.shields.io/badge/docs-build-blue.svg)](https://app.cucumber.pro/projects/aruba)
 [![Gem Version](https://badge.fury.io/rb/aruba.svg)](http://badge.fury.io/rb/aruba)
+[![Dependency Status](https://gemnasium.com/cucumber/aruba.svg)](https://gemnasium.com/cucumber/aruba)
 [![Code Climate](https://codeclimate.com/github/cucumber/aruba.svg)](https://codeclimate.com/github/cucumber/aruba)
 [![Join the chat at https://gitter.im/cucumber/aruba](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/aruba?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Build status:
-
-Linux / OS X  | Windows
-------------- | -------------
-[![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
-
-`aruba` is an extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing of commandline applications meaningful, easy and fun.
-
-Features at a glance:
-
-* Test any command line application, implemented in any [programming
-  language](features/getting_started/supported_programming_languages.feature) -
-  e.g. Bash, Python, Ruby, Java, ...
-* Manipulate the file system and the process environment
-* Automatically reset state of file system and process environment between tests
+**This is the [latest](https://github.com/cucumber/aruba/blob/master/README.md) version of our README.md. If you want to see the one of the last released version of "aruba", please have a look at this [one](https://github.com/cucumber/aruba/blob/still/README.md).**
 
 ## Install
 
 Add this line to your application's `Gemfile`:
 
-    gem 'aruba'
+~~~
+gem 'aruba'
+~~~
 
 And then execute:
 
-    $ bundle
+~~~
+$ bundle
+~~~
 
 Or install it yourself as:
 
-    $ gem install aruba
-
-### Release Policy
-
-We try to be compliant to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
-
-### Supported ruby versions
-
-For an up to date list of all supported ruby versions, please see our [`.travis.yml`](https://github.com/cucumber/aruba/blob/master/.travis.yml). We only test against the latest version of a version branch - most times.
+~~~
+$ gem install aruba
+~~~
 
 ## Usage
 
-Please also see this
-[feature test](https://github.com/cucumber/aruba/blob/master/features/getting_started/supported_testing_frameworks.feature)
-for the most up to date documentation.
-
-### Initialize your project with "aruba"
-
-There's an initializer to make it easier for you to getting started. If you
-prefer to setup `aruba` yourself, please move on to the next section.
-
-1. Go to your project's directory
-
-2. Make sure, it's under version control and all changes are committed to your
-   version control repository
-
-3. Run one of the following commands depending on the tools you use to test your project.
-
-   This assumes, that you use either `rspec`, `cucumber-ruby` or `minitest` to
-   write the tests for your project. Besides that, your tool can be implemented
-   in any programming language you like.
-
-   ~~~bash
-   aruba init --test-framework rspec
-   aruba init --test-framework cucumber
-   aruba init --test-framework minitest
-   ~~~
-
-### Cucumber
-
-1. Create a file named "features/support/env.rb" with:
-
-   ~~~ruby
-   require 'aruba/cucumber'
-   ~~~
-
-2. Create a file named "features/use_aruba_with_cucumber.feature" with:
-
-   ~~~ruby
-   Feature: Cucumber
-     Scenario: First Run
-       Given a file named "file.txt" with:
-       """
-       Hello World
-       """
-       Then the file "file.txt" should contain:
-       """
-       Hello World
-       """
-   ~~~
-
-3. Run `cucumber`
-
-### RSpec
-
-1. Create a file named "spec/support/aruba.rb" with:
-
-   ~~~ruby
-   require 'aruba/rspec'
-   ~~~
-
-2. Create a file named "spec/spec_helper.rb" with:
-
-   ~~~ruby
-   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+### As a user getting started with "aruba"
 
-   if RUBY_VERSION < '1.9.3'
-     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-   else
-     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
-   end
-   ~~~
+Our most current documentation to get started with `aruba`, can be found on [![See our documentation on Cucumber Pro](https://github.com/cucumber-ltd/brand/raw/master/images/png/notm/cucumber-pro-black/cucumber-pro-black-32.png)](https://app.cucumber.pro/projects/aruba). It's based on our feature files describing the use of `aruba`.
 
-3. Create a file named named "spec/use_aruba_with_rspec_spec.rb" with:
-
-   ~~~ruby
-   require 'spec_helper'
-
-   RSpec.describe 'First Run', :type => :aruba do
-     let(:file) { 'file.txt' }
-     let(:content) { 'Hello World' }
-
-     before(:each) { write_file file, content }
-
-     it { expect(read(file)).to eq [content] }
-   end
-   ~~~
-
-4. Run `rspec`
-
-### Minitest
-
-1. Add a file named "test/support/aruba.rb" with:
-
-   ~~~ ruby
-   require 'aruba/api'
-   ~~~
-
-2. Add a file named "test/test_helper.rb" with:
-
-   ~~~ruby
-   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-   if RUBY_VERSION < '1.9.3'
-     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-   else
-     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
-   end
-   ~~~
-
-3. Add a file named "test/use_aruba_with_minitest.rb" with:
-
-   ~~~ruby
-   $LOAD_PATH.unshift File.expand_path('../test', __FILE__)
-
-   require 'test_helper'
-   require 'minitest/autorun'
-
-   class FirstRun < Minitest::Test
-     include Aruba::Api
-
-     def setup
-       aruba_setup
-     end
-
-     def getting_started_with_aruba
-       file = 'file.txt'
-       content = 'Hello World' 
-
-       write_file file, content
-       read(file).must_equal [content]
-     end
-   end
-   ~~~
-
-4. Run your tests
-
-   `ruby -Ilib:test test/use_aruba_with_minitest.rb`
-
-## Documentation
-
-### User Documentation
-
-If you're interested in our steps and API, please browse our [feature
-files](https://github.com/cucumber/aruba/tree/master/features). You can find a
-lot of examples there. A good starting point are [Getting
-Started](https://github.com/cucumber/aruba/tree/master/features/getting_started)
-and [Step
-Overview](https://github.com/cucumber/aruba/blob/master/features/steps/overview.feature).
-A more or less full list of our steps can be found
-[here](https://github.com/cucumber/aruba/tree/master/features/steps). Our API
-is documentated
-[here](https://github.com/cucumber/aruba/tree/master/features/api) and some
-more information about how to configure `aruba`, can be found
-[here](https://github.com/cucumber/aruba/tree/master/features/configuration).
-The "RSpec" matchers provided by `aruba`, are documented
-[here](https://github.com/cucumber/aruba/tree/master/features/matchers).
-
-You can find our documentation on
-[Relish](http://www.relishapp.com/cucumber/aruba/docs) as well. Unfortunately
-"Relish" does not like the way we structered our feature tests. So this
-documentation found there may be not complete.
-
-### Developer Documentation
+### Release Policy
 
-`aruba` provides a wonderful API to be used in your tests:
+We try to be compliant to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
 
-* Creating files/directories
-* Deleting files/directories
-* Checking file size
-* Checking file existence/absence
-* ...
+### Supported ruby versions
 
-A full documentation of the API can be found
-[here](http://www.rubydoc.info/github/cucumber/aruba/master/frames).
+For an up to date list of all supported ruby versions, please see our [`.travis.yml`](https://github.com/cucumber/aruba/blob/master/.travis.yml). We only test against the latest version of a version branch - most times.
 
 ## Contributing
 
 Please see the [CONTRIBUTING](CONTRIBUTING.md) file.
 
-## Copyright
+## Build Status
 
-Copyright (c) 2010-2016 Aslak Hellesøy et al. See [MIT License](LICENSE) for details.
+|Version|Linux / OS X|Windows|
+| ------ | ------ | ------ |
+| master | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)|
+| still | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=still)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/still)

data/Rakefile

@@ -1,49 +1,109 @@
-# encoding: utf-8
-require 'rubygems'
+$LOAD_PATH << File.expand_path('../', __FILE__)
+
+require 'aruba/tasks/docker_helpers'
+require 'aruba/platform'
+
 require 'bundler'
 Bundler.setup
-Bundler::GemHelper.install_tasks
 
-require 'cucumber/rake/task'
+task :default => :test
+
+desc 'Run the whole test suite. Any failure will stop rake going on'
+task :test => %w(lint:travis lint:coding_guidelines lint:licenses test:rspec test:cucumber test:cucumber_wip)
 
-Cucumber::Rake::Task.new do |t|
-  t.cucumber_opts = ""
-  t.cucumber_opts << "--format progress"
+task :cucumber do
+  Aruba.platform.deprecated 'The use of task "cucumber" is deprecated. Please use "test:cucumber"'
+  Rake::Task['test:cucumber'].invoke
 end
 
-Cucumber::Rake::Task.new(:cucumber_wip) do |t|
-  t.cucumber_opts = "-p wip"
+task :cucumber_wip do
+  Aruba.platform.deprecated 'The use of task "cucumber_wip" is deprecated. Please use "test:cucumber_wip"'
+  Rake::Task['test:cucumber_wip'].invoke
 end
 
-require 'rspec/core/rake_task'
-desc "Run RSpec"
-RSpec::Core::RakeTask.new do |spec|
-  spec.rspec_opts = ['--color', '--format progress', '--warnings']
+task :spec do
+  Aruba.platform.deprecated 'The use of task "spec" is deprecated. Please use "test:rspec"'
+  Rake::Task['test:rspec'].invoke
 end
 
-namespace :travis do
-  desc 'Lint travis.yml'
-  task :lint do
+task :rubocop do
+  Aruba.platform.deprecated 'The use of task "rubocop" is deprecated. Please use "lint:coding_guidelines"'
+  Rake::Task['test:coding_guidelines'].invoke
+end
+
+namespace :test do
+  desc 'Run cucumber tests'
+  task :cucumber do
+    sh 'cucumber'
+  end
+
+  desc 'Run cucumber tests which are "WORK IN PROGRESS" and are allowed to fail'
+  task :cucumber_wip do
+    sh 'cucumber -p wip'
+  end
+
+  desc 'Run rspec tests'
+  task :rspec do
+    sh 'rspec'
+  end
+end
+
+namespace :lint do
+  desc 'Lint our .travis.yml'
+  task :travis do
     begin
       require 'travis/yaml'
 
       puts 'Linting .travis.yml ... No output is good!'
       Travis::Yaml.parse! File.read('.travis.yml')
-    rescue LoadError
-      $stderr.puts 'Your ruby is not supported for linting the .travis.yml file'
+    rescue LoadError => e
+      $stderr.puts "You ruby is not supported for linting the .travis.yml: #{e.message}"
     end
   end
-end
 
-task :rubocop do
-  if RUBY_VERSION >= '2'
-    sh 'bundle exec rubocop --fail-level E'
-  else
-    warn 'Your ruby version is not supported for code linting'
+  desc 'Lint our code with "rubocop"'
+  task :coding_guidelines do
+    sh 'rubocop --fail-level E'
+  end
+
+  desc 'Check for relevant licenses in project'
+  task :licenses do
+    sh 'license_finder'
   end
 end
 
-desc "Run tests, both RSpec and Cucumber"
-task :test => [ 'travis:lint', :rubocop, :spec, :cucumber, :cucumber_wip]
+namespace :rubygem do
+  Bundler::GemHelper.install_tasks
+end
 
-task :default => :test
+namespace :docker do
+  desc 'Build docker image'
+  task :build, :cache, :version do |_, args|
+    args.with_defaults(:version => 'latest')
+    args.with_defaults(:cache => true)
+
+    docker_compose_file = Aruba::DockerComposeFile.new(File.expand_path('../docker-compose.yml', __FILE__))
+    docker_run_instance = Aruba::DockerRunInstance.new(docker_compose_file, :base)
+
+    builder = Aruba::DockerBuildCommandLineBuilder.new(
+      docker_run_instance,
+      cache: args[:cache],
+      version: args[:version]
+    )
+
+    sh builder.to_cli
+  end
+
+  desc 'Run docker container'
+  task :run, :command do |_, args|
+    docker_compose_file = Aruba::DockerComposeFile.new(File.expand_path('../docker-compose.yml', __FILE__))
+    docker_run_instance = Aruba::DockerRunInstance.new(docker_compose_file, :base)
+
+    builder = Aruba::DockerRunCommandLineBuilder.new(
+      docker_run_instance,
+      command: args[:command] || docker_run_instance.command,
+    )
+
+    sh builder.to_cli
+  end
+end

data/appveyor.yml

@@ -24,7 +24,6 @@ test_script:
 
 environment:
   matrix:
-    - ruby_version: '18'
     - ruby_version: '19'
     - ruby_version: '20'
     - ruby_version: '21'

data/aruba.gemspec

@@ -3,46 +3,36 @@ lib = ::File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aruba/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'aruba'
-  s.version     = Aruba::VERSION
-  s.authors     = ["Aslak Hellesøy", "David Chelimsky", "Mike Sassak", "Matt Wynne", "Jarl Friis", "Dennis Günnewig"]
-  s.description = 'Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing commandline applications meaningful, easy and fun.'
-  s.summary     = "aruba-#{s.version}"
-  s.license     = 'MIT'
-  s.email       = 'cukes@googlegroups.com'
-  s.homepage    = 'http://github.com/cucumber/aruba'
-
-  s.add_runtime_dependency 'cucumber', '>= 1.3.19'
-  s.add_runtime_dependency 'childprocess', ['>= 0.6.3', '< 4.0.0']
-  s.add_runtime_dependency 'ffi', '~> 1.9'
-  s.add_runtime_dependency 'rspec-expectations', '>= 2.99'
-  s.add_runtime_dependency 'contracts', '~> 0.9'
-  s.add_runtime_dependency 'thor', ['>= 0.19', '< 2.0']
-
-  s.add_development_dependency 'bundler', ['>= 1.7', '< 3.0']
-
-  s.rubygems_version = ">= 1.6.1"
-
-  if Aruba::VERSION >= '1'
-    s.required_ruby_version = '>= 1.9.3'
-  else
-    s.required_ruby_version = '>= 1.8.7'
-
-    s.post_install_message = <<-EOS
-Use on ruby 1.8.7
-* Make sure you add something like that to your `Gemfile`. Otherwise you will
-  get cucumber > 2 and this will fail on ruby 1.8.7
-
-  gem 'cucumber', '~> 1.3.20'
-
-With aruba >= 1.0 there will be breaking changes. Make sure to read https://github.com/cucumber/aruba/blob/master/History.md for 1.0.0
-EOS
+Gem::Specification.new do |spec|
+  spec.name        = 'aruba'
+  spec.version     = Aruba::VERSION
+  spec.author      = "Aslak Hellesøy, Matt Wynne and other Aruba Contributors"
+  spec.description = 'Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing commandline applications meaningful, easy and fun.'
+  spec.summary     = "aruba-#{spec.version}"
+  spec.license     = 'MIT'
+  spec.email       = 'cukes@googlegroups.com'
+  spec.homepage    = 'http://github.com/cucumber/aruba'
+
+  spec.add_runtime_dependency 'cucumber', '~> 2.4', '>= 2.4.0'
+  spec.add_runtime_dependency 'childprocess', '~> 0.5.6'
+  spec.add_runtime_dependency 'ffi', '~> 1.9', '>= 1.9.10'
+  spec.add_runtime_dependency 'rspec-expectations', '~> 3.4', '>= 3.4.0'
+  spec.add_runtime_dependency 'contracts', '~> 0.14'
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.rubygems_version = ">= 1.6.1"
+  spec.required_ruby_version = '>= 1.9.3'
+
+  # spec.post_install_message = <<-EOS
+  # EOS
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
 
-  s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.rdoc_options     = ["--charset=UTF-8"]
-  s.require_path     = "lib"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.rdoc_options  = ["--charset=UTF-8"]
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
 end