aruba 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abc9ad9b84fa8e51541f65c4fd9182308fa90b4b
-  data.tar.gz: 8c9a74b73102f29b11a0bb3fbc3652f52bd84492
+  metadata.gz: a0eb00c75113997b656ddaf5d3ee303313549120
+  data.tar.gz: 88dd5d4a54be34ef5be25b60f2150043d968f20c
 SHA512:
-  metadata.gz: 2f3fa2197e0e1aa64baa079883c9ea70ceb38df6fe7984f5bc973b15c8c46de8990384bf3cb674bf049c4619ff3484bac8e890a2301bd51e4c7766a48309d060
-  data.tar.gz: d063a1f78058c485fe09ecf31f66761e20104a6746e16baf2a9adce2ace692fa3c5a7d20d90b901c32399df33af78d2c1f1021efe6aa4f91803e67c1282387e3
+  metadata.gz: 9787def343f0714e431f40d00c39d5eecd8be1dce98dd2097c0058de838fe1c06bcf4852d39d4493d0c4e33873e5a5f67ff3e1761e411932e843416ef137af88
+  data.tar.gz: 5a697b03a24370d37a818262b1873f17ec3305bdef959240a4134be79d3e21c068f5d209a270b265a03093cab1ff40f569f61d63437e67db5e18599185ad97a5

data/.gitignore

@@ -31,3 +31,6 @@ cucumber-pro.log
 
 ## Ruby versioniser
 .ruby-version
+
+# Temp files of yar
+.yardoc

data/.rubocop.yml

@@ -1,3 +1,167 @@
-inherit_from:
-  - config/rubocop/include.yml
-  - config/rubocop/exclude.yml
+AllCops:
+  Exclude:
+    - tmp/**/*
+  DisplayCopNames: true
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+Style/HashSyntax:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - lib/aruba/api.rb
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/RescueException:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 169
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AlignParameters:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/CharacterLiteral:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassCheck:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredMethods.
+Style/CollectionMethods:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/LeadingCommentSpace:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Configuration parameters: SupportedStyles.
+Style/RaiseArgs:
+  # EnforcedStyle: compact
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Enabled: false
+
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false
+
+# Configuration parameters: Methods.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceAfterComma:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceAfterControlKeyword:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceAfterNot:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceBeforeComma:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Style/SpaceInsideParens:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,32 @@
+# Run simplecov by default
+SimpleCov.start unless ENV.key? 'ARUBA_NO_COVERAGE'
+
+SimpleCov.configure do
+  # ignore this file
+  add_filter '.simplecov'
+
+  # Rake tasks aren't tested with rspec
+  add_filter 'Rakefile'
+  add_filter 'lib/tasks'
+
+  #
+  # Changed Files in Git Group
+  # @see http://fredwu.me/post/35625566267/simplecov-test-coverage-for-changed-files-only
+  untracked         = `git ls-files --exclude-standard --others`
+  unstaged          = `git diff --name-only`
+  staged            = `git diff --name-only --cached`
+  all               = untracked + unstaged + staged
+  changed_filenames = all.split("\n")
+
+  add_group 'Changed' do |source_file|
+    changed_filenames.select do |changed_filename|
+      source_file.filename.end_with?(changed_filename)
+    end
+  end
+
+  add_group 'Libraries', 'lib'
+
+  # Specs are reported on to ensure that all examples are being run and all
+  # lets, befores, afters, etc are being used.
+  add_group 'Specs', 'spec'
+end

data/.travis.yml

@@ -1,4 +1,7 @@
+sudo: false
 language: ruby
+script: script/test
+install: script/bootstrap --without development debug
 rvm:
 - 2.1.5
 - 2.1.4
@@ -7,8 +10,8 @@ rvm:
 - 2.1.1
 - 2.1.0
 - 2.0.0
-- 1.9.3
-- jruby-19mode
+- jruby-20mode
+- jruby-21mode
 - rbx
 matrix:
   allow_failures:

data/.yardopts

@@ -0,0 +1,8 @@
+--output doc/yard
+--exclude features/
+--verbose
+--markup-provider kramdown
+--markup markdown
+-
+LICENSE
+README.md

data/CONTRIBUTING.md

@@ -25,11 +25,20 @@ This document is a guide for those maintaining Aruba, and others who would like
   bump version in a commit by itself so we can ignore when we merge your change)
 * Send us a pull request.
 
+## Bootstrap environment
+
+To get started with `aruba`, you just need to bootstrap the environment by
+running the following command.
+
+    # Bootstrap environment
+    script/bootstrap
+
 ## Running tests
 
-    gem install bundler
-    bundle install
-    bundle exec rake
+Make sure you bootstrap the environment first.
+
+    # Run the test suite
+    script/test
 
 ## Release Process
 
@@ -51,11 +60,12 @@ Now email cukes@googlegroups.com with details of the new release. Just a copy /
 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
-  * Matt Wynne
-  * Aslak Hellesøy
-  * Tom Brand
+  * 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))
 
 To grant release karma, issue the following command:
 
-    gem owner cucumber --add <NEW OWNER RUBYGEMS EMAIL>
+    gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>

data/Gemfile

@@ -1,6 +1,31 @@
 source 'https://rubygems.org'
+
 gemspec
 
+group :development, :test do
+  gem 'simplecov'
+end
+
+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'
+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'
+end
+
 platforms :rbx do
   gem 'rubysl', '~> 2.0'
   gem 'rubinius-developer_tools'

data/History.md

@@ -1,4 +1,12 @@
 ## [master](https://github.com/cucumber/aruba/compare/v0.6.2...master)
+* Introducing root_directory (issue #232)
+* Introducing fixtures directory (issue #224)
+* Make sure a file/directory does not exist + Cleanup named file/directory steps (issue #234)
+* Make matcher have_permisions public and add documentation (issue #239)
+* Added matcher for file content (issue #238)
+* Add rspec integrator (issue #244)
+* Deprecate _file/_directory in method names (issue #243)
+* Improve development environment (issue #240)
 
 ## [v0.6.2](https://github.com/cucumber/aruba/compare/v0.6.1...v0.6.2)
 * Fixed minor issue #223)

data/README.md

@@ -2,12 +2,13 @@
 [![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)
+[![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 written in any programming language. Features at a glance:
+Aruba is Cucumber extension for testing command line applications. Features at a glance:
 
-* Test any command line application
+* Test any command line application, implemented in any language
 * Manipulate the file system
-* Create great HTML documentation based on your own Cucumber scenarios
+* Automatically reset state of file system between scenarios
 
 ## Usage
 
@@ -35,25 +36,23 @@ well. One might want to use it together with `rspec`.
 1. Create a directory named `spec/support`
 2. Create a file named `spec/support/aruba.rb` with:
 
+  ```ruby
+  require 'aruba/rspec'
   ```
-  require 'aruba/api'
-  require 'aruba/reporting'
 
-  RSpec.configure do |config|
-    config.include Aruba::Api
-
-    config.before(:each) do
-      restore_env
-      clean_current_dir
-    end
-  end
-  ```
 3. Add the following to your `spec/spec_helper.rb`
 
-  ```
+  ```ruby
   Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
   ```
 
+4. Add a type to your specs
+
+  ```ruby
+  RSpec.describe 'My feature', type: :aruba do
+    # [...]
+  end
+  ```
 
 ## API
 
@@ -186,8 +185,8 @@ Then wire it all up in your `features/support/env.rb` file:
 require 'aruba'
 require 'aruba/in_process'
 
-Aruba::InProcess.main_class = MyMain
-Aruba.process = Aruba::InProcess
+Aruba.process = Aruba::Processes::InProcess
+Aruba.process.main_class = MyMain
 ```
 
 That's it! Everything will now run inside the same ruby process, making your suite
@@ -238,6 +237,69 @@ end
 
 Refer to http://blog.headius.com/2010/03/jruby-startup-time-tips.html for other tips on startup time.
 
+## Fixtures
+
+Sometimes your tests need existing files to work - e.g binary data files you
+cannot create programmatically. Since `aruba` >= 0.6.3 includes some basic
+support for fixtures. All you need to do is the following:
+
+1. Create a `fixtures`-directory
+2. Create fixture files in this directory
+
+The `expand_path`-helper will expand `%` to the path of your fixtures
+directory:
+
+```ruby
+expand_path('%/song.mp3')
+# => /home/user/projects/my_project/fixtures/song.mp3
+```
+
+*Example*
+
+1. Create fixtures directory
+
+  ```bash
+  cd project
+  
+  mkdir -p fixtures/
+  # or
+  mkdir -p test/fixtures/
+  # or
+  mkdir -p spec/fixtures/
+  # or
+  mkdir -p features/fixtures/
+  ```
+
+2. Store `song.mp3` in `fixtures`-directory
+
+  ```bash
+  cp song.mp3 fixtures/
+  ```
+
+3. Add fixture to vcs-repository - e.g. `git`, `mercurial`
+
+4. Create test
+
+  ```ruby
+  RSpec.describe 'My Feature' do
+    describe '#read_music_file' do
+      context 'when the file exists' do
+        let(:path) { expand_path('%/song.mp3') }
+
+        before :each do
+          in_current_directory { FileUtils.cp path, 'file.mp3' }
+        end
+
+        before :each do
+          run 'my_command'
+        end
+
+        it { expect(all_stdout).to include('Rate is 128 KB') }
+      end
+    end
+  end
+  ```
+
 ## Reporting
 
 *Important* - you need [Pygments](http://pygments.org/) installed to use this feature.
@@ -248,7 +310,7 @@ Aruba can generate a HTML page for each scenario that contains:
 * The description from the scenario (You can use Markdown here)
 * The command(s) that were run
 * The output from those commands (in colour if the output uses ANSI escapes)
-* The files that were created (syntax highlighted in in colour)
+* The files that were created (syntax highlighted in colour)
 
 In addition to this, it creates an `index.html` file with links to all individual report files.
 Reporting is off by default, but you can enable it by defining the `ARUBA_REPORT_DIR` environment variable, giving it the value