aruba 0.7.4 → 0.8.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83f576993314ee79808bc357b48ca134805713e2
-  data.tar.gz: 7ced0b3d46c1f1a2ff1fb7be028a3486e6d47646
+  metadata.gz: 4ec87d782ab5f0a8a1d6edf4343984e6ffc3dd5c
+  data.tar.gz: fcfdff23c0e86bd7dc4d731497ef8cfe8e9ccc4c
 SHA512:
-  metadata.gz: 0b00a83669a581c4b2698e55f9588370f3fd05dce63b1569d11294e022d10e1536073691ad147fdc024b1867c4248af4ceb15e582e648c4a739c6378160eb1cf
-  data.tar.gz: a6f951395e4a31f2d5f47f049d0f58f2b999483dd422d5f00dc237452c35257efb6025136828e0ec12a457d1e4aaa6941a8a1adac2383636fbddae5a933de6aa
+  metadata.gz: 69ff1ae834613808920fb628a982a55438835504362e2bf4aa82955c57597c52e6a5318247e636693b058d9e55a2f64942f424fbb316d845b2295d93544019c4
+  data.tar.gz: f362bb7494704d5f9c331931dc6f29b4258bb46037a6646c38d75d7c104038a187156d0581d87b0b33367edabd17ecf1ae918d66b857d9937ced97f7c4db5acb

data/.gitignore

@@ -21,6 +21,7 @@ tags
 coverage
 rdoc
 pkg
+*.log
 
 ## PROJECT::SPECIFIC
 tmp

data/.nav

@@ -0,0 +1,12 @@
+README.md
+# before_cmd_hooks.feature
+# command_environment_variables.feature
+# configuration-rspec.feature
+# custom_ruby_process.feature
+# exit_statuses.feature
+# file_system_commands.feature
+# flushing.feature
+# interactive.feature
+# no_clobber.feature
+# output.feature
+# utf-8.feature

data/.rspec

@@ -1 +1,2 @@
 --color
+--order random

data/.rubocop.yml

@@ -10,6 +10,8 @@ Style/HashSyntax:
 Metrics/ModuleLength:
   Exclude:
     - lib/aruba/api.rb
+    - lib/aruba/api/*.rb
+    - lib/aruba/platform.rb
 
 Metrics/AbcSize:
   Enabled: false
@@ -35,6 +37,10 @@ Lint/UselessAssignment:
 # Configuration parameters: AllowURI.
 Metrics/LineLength:
   Max: 169
+  Exclude:
+    - lib/aruba/api.rb
+    - lib/aruba/api/deprecated.rb
+    - aruba.gemspec
 
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
@@ -60,6 +66,9 @@ Style/ClassCheck:
 Style/ClassVars:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredMethods.
 Style/CollectionMethods:
@@ -88,6 +97,9 @@ Style/LeadingCommentSpace:
 Style/PercentLiteralDelimiters:
   Enabled: false
 
+Metrics/PerceivedComplexity:
+  Enabled: false
+
 # Configuration parameters: SupportedStyles.
 Style/RaiseArgs:
   # EnforcedStyle: compact

data/.simplecov

@@ -4,6 +4,8 @@ SimpleCov.start unless ENV.key? 'ARUBA_NO_COVERAGE'
 SimpleCov.configure do
   # ignore this file
   add_filter '.simplecov'
+  add_filter 'spec'
+  add_filter 'features'
 
   # Rake tasks aren't tested with rspec
   add_filter 'Rakefile'

data/.travis.yml

@@ -3,15 +3,14 @@ language: ruby
 script: script/test
 install: script/bootstrap --without development debug
 rvm:
-- 2.1.5
-- 2.1.4
-- 2.1.3
-- 2.1.2
-- 2.1.1
-- 2.1.0
+- 2.2.2
+- 2.1.6
 - 2.0.0
+- 1.9.3
+- 1.8.7
 - jruby-20mode
 - jruby-21mode
+- jruby
 - rbx
 matrix:
   allow_failures:

data/Gemfile

@@ -1,40 +1,67 @@
 source 'https://rubygems.org'
 
+# Use dependencies from gemspec
 gemspec
 
-group :development, :test do
-  gem 'simplecov'
-end
-
+# Debug aruba
 group :debug do
-  gem 'pry', '~> 0.10.1 '
-  gem 'byebug', '~> 4.0.5'
-  gem 'pry-byebug', '~> 3.1.0'
-  gem 'pry-stack_explorer', '~> 0.4.9'
-  gem 'pry-doc', '~> 0.6.0'
+  gem 'pry', '~> 0.10.1'
+
+  platform :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    gem 'byebug', '~> 4.0.5'
+    gem 'pry-byebug', '~> 3.1.0'
+  end
+
+  platform :ruby_19 do
+    gem 'debugger', '~> 1.6.8'
+    gem 'pry-debugger', '~> 0.2.3'
+  end
+
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    gem 'pry-stack_explorer', '~> 0.4.9'
+  end
+
+  gem 'pry-doc', '~> 0.8.0'
 end
 
 group :development, :test do
-  gem 'bcat', '>= 0.6.1'
-  gem 'kramdown', '>= 0.14'
-  gem 'rake', '>= 0.9.2'
-  gem 'rspec', '>= 3.0.0'
-  gem 'fuubar', '>= 1.1.1'
-  gem 'cucumber-pro', '~> 0.0'
-  gem 'rubocop', '~> 0.31.0'
-
-  gem 'license_finder', '~> 2.0.4'
+  # Run development tasks
+  gem 'rake', '~> 10.4.2'
+
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    # Reporting
+    gem 'bcat', '~> 0.6.2'
+    gem 'kramdown', '~> 1.7.0'
+  end
+
+  # Code Coverage
+  gem 'simplecov', '~> 0.10'
+
+  # Test api
+  gem 'rspec', '~> 3.3.0'
+  gem 'fuubar', '~> 2.0.0'
+
+  # Make aruba compliant to ruby community guide
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    gem 'rubocop', '~> 0.32.0'
+  end
+
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    gem 'cucumber-pro', '~> 0.0'
+  end
+
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    # License compliance
+    gem 'license_finder', '~> 2.0.4'
+  end
+
+  platform :ruby_19, :ruby_20, :ruby_21, :ruby_22, :jruby, :rbx do
+    # Upload documentation
+    gem 'relish', '~> 0.7.1'
+  end
 end
 
 platforms :rbx do
   gem 'rubysl', '~> 2.0'
   gem 'rubinius-developer_tools'
 end
-
-# Use source from sibling folders (if available) instead of gems
-# %w[cucumber].each do |g|
-#   if File.directory?(File.dirname(__FILE__) + "/../#{g}")
-#     @dependencies.reject!{|dep| dep.name == g}
-#     gem g, :path => "../#{g}"
-#   end
-# end

data/History.md

@@ -1,3 +1,19 @@
+## [v0.8.0](https://github.com/cucumber/aruba/compare/v0.7.4...v0.8.0)
+* Make aruba compatible with "ruby 1.8.7" and "ruby 1.9.3" again (fixes #279)
+* Move more and more documentation to cucumber steps (partly fixes #268)
+* Refactoring of test suits, now rspec tests run randomly
+* Move Aruba constants to configuration class (fixes #271)
+* Added runtime configuration via `aruba.config` which is reset for each test run
+* Refactored hooks: now there are `after()` and `before()`-hooks, old
+  before_cmd-hook is still working, but is deprecated, added new
+  `after(:command)`-hook.
+* Refactored jruby-startup helper
+* Cleanup API by moving deprecated methods to separate class
+* Cleanup Core API - reduced to `cd`, `expand_path`, `setup_aruba` and use expand_path wherever possible (fixes #253)
+* Better isolation for environment variable manipulation - really helpful from 1.0.0 on
+* Move configuration files like `jruby.rb` to `aruba/config/`-directory
+* Change default exit timeout to 15 seconds to work around long running processes on travis
+
 ## [v0.7.4](https://github.com/cucumber/aruba/compare/v0.7.2...v0.7.4)
 * Really Fixed post install message
 
@@ -21,6 +37,7 @@
 * Improve development environment (issue #240)
 * Cleanup process management (issue #257)
 * Make path content available through matchers and api metchods (issue #250)
+* Refactor announcer to support user defined announce channels (fixes #267)
 
 ## [v0.6.2](https://github.com/cucumber/aruba/compare/v0.6.1...v0.6.2)
 * Fixed minor issue #223)

data/LICENSE

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

data/README.md

@@ -1,24 +1,45 @@
-[![Build Status](https://travis-ci.org/cucumber/aruba.png)](http://travis-ci.org/cucumber/aruba)
+[![Build Status](https://travis-ci.org/cucumber/aruba.svg)](http://travis-ci.org/cucumber/aruba)
 [![Gem Version](https://badge.fury.io/rb/aruba.svg)](http://badge.fury.io/rb/aruba)
-[![Dependency Status](https://gemnasium.com/cucumber/aruba.png)](https://gemnasium.com/cucumber/aruba.png)
-[![Code Climate](https://codeclimate.com/github/cucumber/aruba.png)](https://codeclimate.com/github/cucumber/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)
 
-Aruba is Cucumber extension for testing command line applications. Features at a glance:
+`aruba` is an extension for popular TDD and BDD frameworks like "Cucumber" and "RSpec" to make testing of commandline applications meaningful, easy and fun.
 
-* Test any command line application, implemented in any language
-* Manipulate the file system
-* Automatically reset state of file system between scenarios
+Features at a glance:
 
-## Usage
+* Test any command line application, implemented in any programming language - 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
 
-### Cucumber
+## Install
+
+Add this line to your application's `Gemfile`:
+
+    gem 'aruba'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aruba
 
-If you have a `Gemfile`, add `aruba`. Otherwise, install it like this:
+### Release Policy
 
-    gem install aruba
+We try to be compliant to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
 
-Then, `require` the library in one of your ruby files under `features/support` (e.g. `env.rb`)
+### 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.
+
+## Usage
+
+### Cucumber
+
+To use `aruba` with cucumber, `require` the library in one of your ruby files
+under `features/support` (e.g. `env.rb`)
 
 ```ruby
 require 'aruba/cucumber'
@@ -122,22 +143,27 @@ Aruba defines several tags that you can put on on individual scenarios, or on a
 
 To get more information on what Aruba is doing, use these tags:
 
-* `@announce-cmd` - See what command is run
+* `@announce-command` - See what command is run
 * `@announce-stdout` - See the stdout
 * `@announce-stderr` - See the stderr
-* `@announce-dir` - See the current directory
-* `@announce-env` - See environment variables set by Aruba
+* `@announce-output` - See the output of stdout and stderr
+* `@announce-directory` - See the current directory
+* `@announce-environment` - See environment variables set by Aruba
 * `@announce` - Does all of the above
 
 ### Adding Hooks
 
-You can hook into Aruba's lifecycle just before it runs a command:
+You can hook into Aruba's lifecycle just before it runs a command and after it has run the command:
 
 ```ruby
 Aruba.configure do |config|
-  config.before_cmd do |cmd|
+  config.before :command do |cmd|
     puts "About to run '#{cmd}'"
   end
+
+  config.after :command do |cmd|
+    puts "After the run of '#{cmd}'"
+  end
 end
 ```
 
@@ -216,7 +242,7 @@ or setting a hook like this example:
 
 ```ruby
 Aruba.configure do |config|
-  config.before_cmd do |cmd|
+  config.before :command do |cmd|
     set_env('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}") # disable JIT since these processes are so short lived
     set_env('JAVA_OPTS', "-d32 #{ENV['JAVA_OPTS']}") # force jRuby to use client JVM for faster startup times
   end
@@ -287,7 +313,7 @@ expand_path('%/song.mp3')
         let(:path) { expand_path('%/song.mp3') }
 
         before :each do
-          in_current_directory { FileUtils.cp path, 'file.mp3' }
+          cd('.') { FileUtils.cp path, 'file.mp3' }
         end
 
         before :each do

data/Rakefile

@@ -23,8 +23,18 @@ RSpec::Core::RakeTask.new do |spec|
   spec.rspec_opts = ['--color', '--format documentation']
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+if RUBY_VERSION < '1.9'
+  begin
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  rescue LoadError
+    desc 'Stub task to make rake happy'
+    task(:rubocop) {}
+  end
+else
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
 
 desc "Run tests, both RSpec and Cucumber"
 task :test => [ :rubocop, :spec, :cucumber, :cucumber_wip]

data/TODO.md

@@ -0,0 +1,3 @@
+
+* Replace check filesystem permissons through a better rspec matcher
+* Improve documentation for matchers in file

data/aruba.gemspec

@@ -2,23 +2,34 @@
 
 Gem::Specification.new do |s|
   s.name        = 'aruba'
-  s.version     = '0.7.4'
-  s.authors     = ["Aslak Hellesøy", "David Chelimsky", "Mike Sassak", "Matt Wynne"]
-  s.description = 'CLI Steps for Cucumber, hand-crafted for you in Aruba'
+  s.version     = '0.8.0.pre'
+  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" and "RSpec" 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.1.1'
-  s.add_runtime_dependency 'childprocess', '>= 0.3.6'
-  s.add_runtime_dependency 'rspec-expectations', '>= 2.7.0'
+  s.add_runtime_dependency 'cucumber', '~> 1.3.19'
+  s.add_runtime_dependency 'childprocess', '~> 0.5.6'
+  s.add_runtime_dependency 'rspec-expectations', '~> 3.3'
+  s.add_runtime_dependency 'contracts', '~> 0.9'
 
   s.add_development_dependency 'bundler', '~> 1.10.2'
 
   s.rubygems_version = ">= 1.6.1"
-  # s.required_ruby_version = '>= 2.0'
-  s.post_install_message = 'From aruba >= 1.0 ruby 1.9.3-support is discontinued'
+  s.required_ruby_version = '>= 1.8.7'
+  s.post_install_message = <<-EOS
+With aruba >= 1.0
+  * "ruby 1.8.7"-support is discontinued
+  * aruba requires "cucumber 2" for the feature steps. The rest of aruba should be usable by whatever testing framework you are using
+  * Overwriting methods for configuration is discontinued. You need to use `aruba.config.<variable>` or `Aruba.configure { |config| config.<variable>` instead
+  * "aruba/reporting" will be removed. Please use `@debug`-tag + `byebug`, `debugger`, `pry` to troubleshoot your feature tests
+  * Set environment variables will have only effect on `#run` and the like + `#with_environment { }`
+  * The process environment will be fully resetted between tests. Sharing state via ENV['VAR'] = 'shared state' between tests will not be possible anymore. Please make that obvious by using explicit steps or use the aruba API for that.
+  * There will be a major cleanup for command execution. There will be only `run` and `run_simple` left. `run_interactive` is replaced by `run`.
+  * Setting the root directory of aruba via method overwrite or configuration - this should be your project root directory where the test suite is run
+EOS
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")

data/cucumber.yml

@@ -1,7 +1,7 @@
 <%
 java_version = (RUBY_DESCRIPTION.match(/.*?on.*?(1\.[\d]\..*? )/))[1] if defined?(JRUBY_VERSION)
 
-std_opts          = "--color --exclude features/fixtures"
+std_opts          = "--color --exclude features/fixtures --require features"
 java_default_opts = "--tags ~@wip-jruby-java-1.6" if defined?(JRUBY_VERSION) && (java_version < '1.7.0')
 java_wip_opts     = "--tags @wip-jruby-java-1.6:3" if defined?(JRUBY_VERSION) && (java_version < '1.7.0')
 %>

data/features/api/cd.feature

@@ -0,0 +1,119 @@
+Feature: Change current working directory
+
+  If you need to run some code in a different directory you can use the `cd`
+  command. It comes in two flavors:
+
+  \* First can simply use `cd 'some-dir'`
+  \* Second can use the block notation `cd('some-dir') { Dir.getwd }`
+
+  If you chose to use the latter one, the result of your block is returned. The
+  current working directory is only changed for the code inside the block -
+  it's use is side effect free.
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Existing directory
+    Given a file named "spec/cd_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'cd to directory', :type => :aruba do
+      before(:each) do 
+        create_directory 'new_dir.d'
+        cd 'new_dir.d'
+      end
+
+      before(:each) { run_simple 'pwd' }
+
+      it { expect(last_command.output).to include 'new_dir.d' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Non-Existing directory
+    Given a file named "spec/cd_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'cd to directory', :type => :aruba do
+      before(:each) { cd 'new_dir.d' }
+      before(:each) { run_simple 'pwd' }
+
+      it { expect(last_command.output).to include 'new_dir.d' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should not pass
+
+  Scenario: With block in it-block
+    Given a file named "spec/cd_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'cd to directory', :type => :aruba do
+      before(:each) do
+        create_directory 'new_dir.d/subdir.d'
+      end
+
+      it do
+        cd('new_dir.d/subdir.d') { expect(Dir.getwd).to include 'new_dir.d/subdir.d'  }
+      end
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: With block in before-block
+
+    Running `cd` with a block does not change:
+
+    \* The current directory - `Dir.getwd`
+    \* Aruba's current directory
+
+    Given a file named "spec/cd_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'cd to directory', :type => :aruba do
+      before(:each) do
+        create_directory 'new_dir.d/subdir.d'
+      end
+
+      before :each do
+        cd('new_dir.d/subdir.d') do
+          # you code
+        end
+      end
+
+      it { expect(Dir.getwd).not_to include 'new_dir.d/subdir.d' }
+      it { expect(expand_path('.')).not_to include 'new_dir.d/subdir.d' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: The result of the block is returned
+
+    If you need to run some code in a different directory, you can also use the
+    block-notation of `cd`.
+
+    Given a file named "spec/cd_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'cd to directory', :type => :aruba do
+      before(:each) do
+        create_directory 'new_dir.d/subdir.d'
+      end
+
+      before :each do
+        @my_output = cd('new_dir.d/subdir.d') { Dir.getwd }
+      end
+
+      it { expect(@my_output).to include 'new_dir.d/subdir.d' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass