aruba 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f0ef8ad9b9057dd75bbeb89727f93f569c84a63
-  data.tar.gz: d81765e3e79d77b131ab9385eab81acb329117fd
+  metadata.gz: abc9ad9b84fa8e51541f65c4fd9182308fa90b4b
+  data.tar.gz: 8c9a74b73102f29b11a0bb3fbc3652f52bd84492
 SHA512:
-  metadata.gz: f4dd1b000f2356f5ba7f4e70a0c513aecdcfafecfdf0f15cb94703ae6ce608d858c43cf078f80c7fd8f2c91cdd800a3f11f6163e34a18389629759e9eea0af0c
-  data.tar.gz: 583fb0214abe43ce3976b1b124646b2ce5139bb439689b4d191458b13d44e6462d935e968c4ff3c5813473e79bd74a9c08f641e6a294f45993f012b3890e1820
+  metadata.gz: 2f3fa2197e0e1aa64baa079883c9ea70ceb38df6fe7984f5bc973b15c8c46de8990384bf3cb674bf049c4619ff3484bac8e890a2301bd51e4c7766a48309d060
+  data.tar.gz: d063a1f78058c485fe09ecf31f66761e20104a6746e16baf2a9adce2ace692fa3c5a7d20d90b901c32399df33af78d2c1f1021efe6aa4f91803e67c1282387e3

data/.gitignore

@@ -10,6 +10,9 @@ tmtags
 \#*
 .\#*
 
+## RUBYMINE
+.idea
+
 ## VIM
 *.swp
 tags
@@ -25,3 +28,6 @@ tmp
 doc
 Gemfile.lock
 cucumber-pro.log
+
+## Ruby versioniser
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - config/rubocop/include.yml
+  - config/rubocop/exclude.yml

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
+- 2.1.5
+- 2.1.4
+- 2.1.3
 - 2.1.2
 - 2.1.1
 - 2.1.0

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 gemspec
 
 platforms :rbx do

data/History.md

@@ -1,6 +1,11 @@
-## [master](https://github.com/cucumber/aruba/compare/v0.6.1...master)
+## [master](https://github.com/cucumber/aruba/compare/v0.6.2...master)
 
-## [master](https://github.com/cucumber/aruba/compare/v0.6.0...v0.6.1)
+## [v0.6.2](https://github.com/cucumber/aruba/compare/v0.6.1...v0.6.2)
+* Fixed minor issue #223)
+* Added support for ruby 2.1.3 -- 2.1.5
+* Added support for comparison to a fixture file
+
+## [v0.6.1](https://github.com/cucumber/aruba/compare/v0.6.0...v0.6.1)
 * Added support for ruby 2.1.2
 * Added support for ~ expansion
 * Added support for with_env

data/README.md

@@ -1,4 +1,7 @@
-[![Build Status](https://travis-ci.org/cucumber/aruba.png)](http://travis-ci.org/cucumber/aruba) [![Code Climate](https://codeclimate.com/github/cucumber/aruba.png)](https://codeclimate.com/github/cucumber/aruba)
+[![Build Status](https://travis-ci.org/cucumber/aruba.png)](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)
 
 Aruba is Cucumber extension for testing command line applications written in any programming language. Features at a glance:
 
@@ -32,21 +35,29 @@ 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:
 
-   ```
-   require 'aruba/api
-   require 'aruba/reporting'
+  ```
+  require 'aruba/api'
+  require 'aruba/reporting'
 
-    RSpec.configure do |c|
-      c.include Aruba::Api
-      c.after(:each) do
-        restore_env
-      end
+  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`
+
+  ```
+  Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+  ```
+
 
 ## API
 
-`aruba` provides a wonderfull api to be used in your tests:
+`aruba` provides a wonderful API to be used in your tests:
 
 * Creating files/directories
 * Deleting files/directories
@@ -54,7 +65,7 @@ well. One might want to use it together with `rspec`.
 * Checking file existence/absence
 * ...
 
-A full documentation of the api can be found [here](http://www.rubydoc.info/github/cucumber/aruba/master/frames).
+A full documentation of the API can be found [here](http://www.rubydoc.info/github/cucumber/aruba/master/frames).
 
 ## Configuration
 
@@ -73,7 +84,7 @@ end
 
 ### Modify the PATH
 
-Aruba will automatically add the `bin` directory of your project to the `PATH` environment variable for 
+Aruba will automatically add the `bin` directory of your project to the `PATH` environment variable for
 the duration of each Cucumber scenario. So if you're developing a Ruby gem with a binary command, you
 can test those commands as though the gem were already installed.
 
@@ -83,7 +94,7 @@ If you need other directories to be added to the `PATH`, you can put the followi
 
 ### Increasing timeouts
 
-A process sometimes takes longer than expected to terminate, and Aruba will kill them off (and fail your scenario) if it is still alive after 3 seconds. If you need more time you can modify the timeout by assigning a different value to `@aruba_timeout_seconds` in a `Before` block: 
+A process sometimes takes longer than expected to terminate, and Aruba will kill them off (and fail your scenario) if it is still alive after 3 seconds. If you need more time you can modify the timeout by assigning a different value to `@aruba_timeout_seconds` in a `Before` block:
 
 ```ruby
 Before do
@@ -262,7 +273,7 @@ Scenario: Make tea
   ## Making tea
   * Get a pot
   * And some hot water
-  
+
   Given...
 ```
 

data/Rakefile

@@ -23,7 +23,10 @@ RSpec::Core::RakeTask.new do |spec|
   spec.rspec_opts = ['--color', '--format documentation']
 end
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
 desc "Run tests, both RSpec and Cucumber"
-task :test => [:spec, :cucumber, :cucumber_wip]
+task :test => [ :rubocop, :spec, :cucumber, :cucumber_wip]
 
 task :default => :test

data/aruba.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'aruba'
-  s.version     = '0.6.1'
+  s.version     = '0.6.2'
   s.authors     = ["Aslak Hellesøy", "David Chelimsky", "Mike Sassak", "Matt Wynne"]
   s.description = 'CLI Steps for Cucumber, hand-crafted for you in Aruba'
   s.summary     = "aruba-#{s.version}"
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '>= 3.0.0'
   s.add_development_dependency 'fuubar', '>= 1.1.1'
   s.add_development_dependency 'cucumber-pro', '~> 0.0'
+  s.add_development_dependency 'rubocop', '~> 0.26.0'
 
   s.rubygems_version = ">= 1.6.1"
   s.files            = `git ls-files`.split("\n")

data/config/rubocop/exclude.yml

@@ -0,0 +1,160 @@
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+Style/HashSyntax:
+  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
+
+# Cop supports --auto-correct.
+Style/Blocks:
+  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
+
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundBody:
+  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
+
+# 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

data/features/file_system_commands.feature

@@ -3,12 +3,12 @@ Feature: file system commands
   In order to specify commands that load files
   As a developer using Cucumber
   I want to create temporary files
-  
+
   Scenario: create a dir
     Given a directory named "foo/bar"
     When I run `file foo/bar`
     Then the stdout should contain "foo/bar: directory"
-  
+
   Scenario: create a file
     Given a file named "foo/bar/example.txt" with:
       """
@@ -33,12 +33,12 @@ Feature: file system commands
     Given a file named "foo/bar/example.txt" with:
       """
       hello world
-      
+
       """
     When I append to "foo/bar/example.txt" with:
       """
       this was appended
-      
+
       """
     When I run `cat foo/bar/example.txt`
     Then the stdout should contain "hello world"
@@ -51,12 +51,12 @@ Feature: file system commands
 
   Scenario: clean up files generated in previous scenario
     Then the file "foo/bar/example.txt" should not exist
-  
+
   Scenario: change to a subdir
     Given a file named "foo/bar/example.txt" with:
       """
       hello world
-      
+
       """
     When I cd to "foo/bar"
     And I run `cat example.txt`
@@ -128,7 +128,7 @@ Feature: file system commands
       Then a directory named "foo/bar" should not exist
       """
 
-  Scenario: Check file contents
+  Scenario: Check file contents with text
     Given a file named "foo" with:
       """
       hello world
@@ -158,6 +158,22 @@ Feature: file system commands
       baz
       """
 
+  Scenario: Check file contents with another file
+    Given a file named "foo" with:
+      """
+      hello world
+      """
+    And a file named "bar" with:
+      """
+      hello world
+      """
+    And a file named "nonbar" with:
+      """
+      hello another world
+      """
+    Then the file "foo" should be equal to file "bar"
+    And the file "foo" should not be equal to file "nonbar"
+
   Scenario: Remove file
     Given a file named "foo" with:
       """

data/features/support/custom_main.rb

@@ -10,7 +10,7 @@ class CustomMain
   end
 
   def execute!
-    @stdout.puts(@argv.map{|arg| arg.reverse}.join(' '))
+    @stdout.puts(@argv.map(&:reverse).join(' '))
   end
 end
 
@@ -21,4 +21,4 @@ end
 
 After('~@in-process') do
   Aruba.process = Aruba::SpawnProcess
-end
+end

data/features/support/env.rb

@@ -2,4 +2,3 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'aruba/cucumber'
 require 'fileutils'
 require 'rspec/expectations'
-

data/features/support/jruby.rb

@@ -1,5 +1,5 @@
 if RUBY_PLATFORM == 'java'
   Before do
-    @aruba_timeout_seconds = 10
+    @aruba_timeout_seconds = 15
   end
 end

data/lib/aruba/api.rb

@@ -10,6 +10,33 @@ module Aruba
   module Api
     include RSpec::Matchers
 
+    # Expand file name
+    #
+    # @param [String] file_name
+    #   Name of file
+    #
+    # @return [String]
+    #   The full path
+    #
+    # @example Single file name
+    #
+    #   # => <path>/tmp/aruba/file
+    #   absolute_path('file')
+    #
+    # @example Single Dot
+    #
+    #   # => <path>/tmp/aruba
+    #   absolute_path('.')
+    #
+    # @example Join and Expand path
+    #
+    #   # => <path>/tmp/aruba/path/file
+    #   absolute_path('path', 'file')
+    #
+    def absolute_path(*args)
+      in_current_dir { File.expand_path File.join(*args) }
+    end
+
     # Execute block in current directory
     #
     # @yield
@@ -48,7 +75,7 @@ module Aruba
     # @return [Array]
     #   The directory path: Each subdirectory is a member of an array
     def dirs
-      @dirs ||= ['tmp', 'aruba']
+      @dirs ||= %w(tmp aruba)
     end
 
     # Create a file with given content
@@ -65,6 +92,21 @@ module Aruba
       _create_file(file_name, file_content, false)
     end
 
+    # Create an empty file
+    #
+    # @param [String] file_name
+    #   The name of the file
+    def touch_file(file_name)
+      in_current_dir do
+        file_name = File.expand_path(file_name)
+        _mkdir(File.dirname(file_name))
+
+        FileUtils.touch file_name
+      end
+
+      self
+    end
+
     # Create a file with the given size
     #
     # The method does not check if file already exists. If the file name is a
@@ -88,6 +130,7 @@ module Aruba
       _create_file(file_name, file_content, true)
     end
 
+    # @private
     def _create_file(file_name, file_content, check_presence)
       in_current_dir do
         file_name = File.expand_path(file_name)
@@ -97,6 +140,8 @@ module Aruba
         _mkdir(File.dirname(file_name))
         File.open(file_name, 'w') { |f| f << file_content }
       end
+
+      self
     end
 
     # Change file system  permissions of file
@@ -119,6 +164,8 @@ module Aruba
       end
     end
 
+    # @private
+    # @deprecated
     def chmod(*args, &block)
       warn('The use of "chmod" is deprecated. Use "filesystem_permissions" instead')
 
@@ -154,12 +201,15 @@ module Aruba
       end
     end
 
+    # @private
+    # @deprecated
     def mod?(*args, &block)
       warn('The use of "mod?" is deprecated. Use "check_filesystem_permissions" instead')
 
       check_filesystem_permissions(*args, &block)
     end
 
+    # @private
     def _create_fixed_size_file(file_name, file_size, check_presence)
       in_current_dir do
         file_name = File.expand_path(file_name)
@@ -206,6 +256,8 @@ module Aruba
       in_current_dir do
         _mkdir(directory_name)
       end
+
+      self
     end
 
     # Remove directory
@@ -227,9 +279,9 @@ module Aruba
     #
     # @param [true,false] expect_presence
     #   Should the given paths be present (true) or absent (false)
-    def check_file_presence(paths, expect_presence)
+    def check_file_presence(paths, expect_presence = true)
       prep_for_fs_check do
-        paths.each do |path|
+        Array(paths).each do |path|
           if path.kind_of? Regexp
             if expect_presence
               expect(Dir.glob('**/*')).to include_regexp(path)
@@ -310,34 +362,57 @@ module Aruba
     # @param [String] file
     #   The file to be checked
     #
-    # @param [String] partial_content
-    #   The content which must/must not be in the file
+    # @param [String, Regexp] content
+    #   The content which must/must not be in the file. If content is
+    #   a String exact match is done, if content is a Regexp then file
+    #   is matched using regular expression
     #
     # @param [true, false] expect_match
     #   Must the content be in the file or not
-    def check_file_content(file, partial_content, expect_match)
-      regexp = regexp(partial_content)
+    def check_file_content(file, content, expect_match = true)
+      match_content =
+        if(Regexp === content)
+          match(content)
+        else
+          eq(content)
+        end
       prep_for_fs_check do
-        file = File.expand_path(file)
-        content = IO.read(file)
-
+        content = IO.read(File.expand_path(file))
         if expect_match
-          expect(content).to match regexp
+          expect(content).to match_content
         else
-          expect(content).not_to match regexp
+          expect(content).not_to match_content
         end
       end
     end
 
-    # Check if the exact content can be found in file
+    # @private
+    # @deprecated
+    def check_exact_file_content(file, exact_content, expect_match = true)
+      warn('The use of "check_exact_file_content" is deprecated. Use "#check_file_content" with a string instead.')
+
+      check_file_content(file, exact_content, expect_match)
+    end
+
+    # Check if the content of file against the content of a reference file
     #
     # @param [String] file
     #   The file to be checked
     #
-    # @param [String] exact_content
-    #   The content of the file
-    def check_exact_file_content(file, exact_content)
-      prep_for_fs_check { expect(IO.read(file)).to eq exact_content }
+    # @param [String] reference_file
+    #   The reference file
+    #
+    # @param [true, false] expect_match
+    #   Must the content be in the file or not
+    def check_binary_file_content(file, reference_file, expect_match = true)
+      prep_for_fs_check do
+        identical = FileUtils.compare_file(file, reference_file)
+        if expect_match
+          expect(identical).to be(true), "The file \"#{file}\" differs from file \"#{reference_file}\""
+        else
+          expect(identical).not_to be(true), "The file \"#{file}\" is identical to file \"#{reference_file}\""
+        end
+      end
     end
 
     # Check presence of a directory
@@ -361,17 +436,20 @@ module Aruba
       end
     end
 
+    # @private
     def prep_for_fs_check(&block)
       stop_processes!
       in_current_dir{ block.call }
     end
 
+    # @private
     def _mkdir(dir_name)
       dir_name = File.expand_path(dir_name)
 
       FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
     end
 
+    # @private
     def _rm_rf(dir_name)
       dir_name = File.expand_path(dir_name)
 
@@ -391,10 +469,6 @@ module Aruba
       string
     end
 
-    def regexp(string_or_regexp)
-      Regexp === string_or_regexp ? string_or_regexp : Regexp.compile(Regexp.escape(string_or_regexp))
-    end
-
     # Fetch output (stdout, stderr) from command
     #
     # @param [String] cmd
@@ -422,40 +496,72 @@ module Aruba
       get_process(cmd).stderr
     end
 
+    # Get stdout of all processes
+    #
+    # @return [String]
+    #   The stdout of all process which have run before
     def all_stdout
       stop_processes!
       only_processes.inject("") { |out, ps| out << ps.stdout }
     end
 
+    # Get stderr of all processes
+    #
+    # @return [String]
+    #   The stderr of all process which have run before
     def all_stderr
       stop_processes!
       only_processes.inject("") { |out, ps| out << ps.stderr }
     end
 
+    # Get stderr and stdout of all processes
+    #
+    # @return [String]
+    #   The stderr and stdout of all process which have run before
     def all_output
       all_stdout << all_stderr
     end
 
+    # Full compare arg1 and arg2
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg1 is exactly the same as arg2 return true, otherwise false
     def assert_exact_output(expected, actual)
       actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
       expect(unescape(actual)).to eq unescape(expected)
     end
 
+    # Partial compare arg1 and arg2
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg2 contains arg1 return true, otherwise false
     def assert_partial_output(expected, actual)
       actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
       expect(unescape(actual)).to include(unescape(expected))
     end
 
+    # Regex Compare arg1 and arg2
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg2 matches arg1 return true, otherwise false
     def assert_matching_output(expected, actual)
       actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
       expect(unescape(actual)).to match /#{unescape(expected)}/m
     end
 
+    # Negative regex compare arg1 and arg2
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg2 does not match arg1 return true, otherwise false
     def assert_not_matching_output(expected, actual)
       actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
-      expect(unescape(actual)).not_to match /#{unescape(expected)}/m
+      expect(unescape(actual)).not_to match(/#{unescape(expected)}/m)
     end
 
+    # Negative partial compare arg1 and arg2
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg2 does not match/include arg1 return true, otherwise false
     def assert_no_partial_output(unexpected, actual)
       actual.force_encoding(unexpected.encoding) if RUBY_VERSION >= "1.9"
       if Regexp === unexpected
@@ -465,24 +571,44 @@ module Aruba
       end
     end
 
+    # Partial compare output of interactive command and arg1
+    #
+    # @return [TrueClass, FalseClass]
+    #   If output of interactive command includes arg1 return true, otherwise false
     def assert_partial_output_interactive(expected)
       unescape(_read_interactive).include?(unescape(expected)) ? true : false
     end
 
+    # Check if command succeeded and if arg1 is included in output
+    #
+    # @return [TrueClass, FalseClass]
+    #   If exit status is 0 and arg1 is included in output return true, otherwise false
     def assert_passing_with(expected)
-      assert_exit_status_and_partial_output(true, expected)
+      assert_success(true)
+      assert_partial_output(expected, all_output)
     end
 
+    # Check if command failed and if arg1 is included in output
+    #
+    # @return [TrueClass, FalseClass]
+    #   If exit status is not equal 0 and arg1 is included in output return true, otherwise false
     def assert_failing_with(expected)
-      assert_exit_status_and_partial_output(false, expected)
+      assert_success(false)
+      assert_partial_output(expected, all_output)
     end
 
+    # @private
+    # @deprecated
     def assert_exit_status_and_partial_output(expect_to_pass, expected)
+      warn('The use of "assert_exit_status_and_partial_output" is deprecated. Use "#assert_access" and "#assert_partial_output" instead.')
+
       assert_success(expect_to_pass)
       assert_partial_output(expected, all_output)
     end
 
     # TODO: Remove this. Call more methods elsewhere instead. Reveals more intent.
+    # @private
+    # @deprecated
     def assert_exit_status_and_output(expect_to_pass, expected_output, expect_exact_output)
       assert_success(expect_to_pass)
       if expect_exact_output
@@ -492,34 +618,45 @@ module Aruba
       end
     end
 
+    # Check exit status of process
+    #
+    # @return [TrueClass, FalseClass]
+    #   If arg1 is true, return true if command was successful
+    #   If arg1 is false, return true if command failed
     def assert_success(success)
       success ? assert_exit_status(0) : assert_not_exit_status(0)
     end
 
+    # @private
     def assert_exit_status(status)
       expect(last_exit_status).to eq(status),
         append_output_to("Exit status was #{last_exit_status} but expected it to be #{status}.")
     end
 
+    # @private
     def assert_not_exit_status(status)
       expect(last_exit_status).not_to eq(status),
         append_output_to("Exit status was #{last_exit_status} which was not expected.")
     end
 
+    # @private
     def append_output_to(message)
       "#{message} Output:\n\n#{all_output}\n"
     end
 
+    # @private
     def processes
       @processes ||= []
     end
 
+    # @private
     def stop_processes!
       processes.each do |_, process|
         stop_process(process)
       end
     end
 
+    # Terminate all running processes
     def terminate_processes!
       processes.each do |_, process|
         terminate_process(process)
@@ -527,16 +664,19 @@ module Aruba
       end
     end
 
+    # @private
     def register_process(name, process)
       processes << [name, process]
     end
 
+    # @private
     def get_process(wanted)
       matching_processes = processes.reverse.find{ |name, _| name == wanted }
       raise ArgumentError.new("No process named '#{wanted}' has been started") unless matching_processes
       matching_processes.last
     end
 
+    # @private
     def only_processes
       processes.collect{ |_, process| process }
     end
@@ -571,17 +711,38 @@ module Aruba
 
     DEFAULT_TIMEOUT_SECONDS = 3
 
+    # Default exit timeout for running commands with aruba
+    #
+    # Overwrite this method if you want a different timeout or set
+    # `@aruba_timeout_seconds`.
     def exit_timeout
       @aruba_timeout_seconds || DEFAULT_TIMEOUT_SECONDS
     end
 
     DEFAULT_IO_WAIT_SECONDS = 0.1
 
+    # Default io wait timeout
+    #
+    # Overwrite this method if you want a different timeout or set
+    # `@aruba_io_wait_seconds
     def io_wait
       @aruba_io_wait_seconds || DEFAULT_IO_WAIT_SECONDS
     end
 
-    def run_simple(cmd, fail_on_error=true, timeout = nil)
+    # Run a command with aruba
+    #
+    # Checks for error during command execution and checks the output to detect
+    # an timeout error.
+    #
+    # @param [String] cmd
+    #   The command to be executed
+    #
+    # @param [TrueClass,FalseClass] fail_on_error
+    #   Should aruba fail on error?
+    #
+    # @param [Integer] timeout
+    #   Timeout for execution
+    def run_simple(cmd, fail_on_error = true, timeout = nil)
       run(cmd, timeout) do |process|
         stop_process(process)
       end
@@ -593,6 +754,8 @@ module Aruba
     #
     # @param [String] cmd
     #   The command to by run
+    #
+    # @see #cmd
     def run_interactive(cmd)
       @interactive = run(cmd)
     end
@@ -611,24 +774,30 @@ module Aruba
       @interactive.stdin.close
     end
 
+    # @deprecated
+    # @private
     def eot
       warn(%{\e[35m    The \"#eot\"-method is deprecated. It will be deleted with the next major version. Please use \"#close_input\"-method instead.\e[0m})
       close_input
     end
 
+    # @private
     def _write_interactive(input)
       @interactive.stdin.write(input)
       @interactive.stdin.flush
     end
 
+    # @private
     def _read_interactive
       @interactive.read_stdout
     end
 
+    # @private
     def _ensure_newline(str)
       str.chomp << "\n"
     end
 
+    # @private
     def announce_or_puts(msg)
       if(@puts)
         Kernel.puts(msg)
@@ -637,6 +806,7 @@ module Aruba
       end
     end
 
+    # @private
     def detect_ruby(cmd)
       if cmd =~ /^ruby\s/
         cmd.gsub(/^ruby\s/, "#{current_ruby} ")
@@ -645,14 +815,21 @@ module Aruba
       end
     end
 
+    # @private
     def current_ruby
       File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
     end
 
+    # Use a clean rvm gemset
+    #
+    # Please make sure that you've got [rvm](http://rvm.io/) installed.
+    #
+    # @param [String] gemset
+    #   The name of the gemset to be used
     def use_clean_gemset(gemset)
       run_simple(%{rvm gemset create "#{gemset}"}, true)
       if all_stdout =~ /'#{gemset}' gemset created \((.*)\)\./
-        gem_home = $1
+        gem_home = Regexp.last_match[1]
         set_env('GEM_HOME', gem_home)
         set_env('GEM_PATH', gem_home)
         set_env('BUNDLE_PATH', gem_home)
@@ -667,6 +844,7 @@ module Aruba
       end
     end
 
+    # Unset variables used by bundler
     def unset_bundler_env_vars
       %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |key|
         set_env(key, nil)
@@ -697,20 +875,29 @@ module Aruba
       end
     end
 
+    # @private
     def original_env
       @original_env ||= {}
     end
 
+    # Run block with environment
+    #
+    # @param [Hash] env
+    #   The variables to be used for block.
+    #
+    # @yield
+    #   The block of code which should be run with the modified environment variables
     def with_env(env = {}, &block)
       env.each do |k,v|
         set_env k, v
-        block.call
-        restore_env
       end
+      block.call
+      restore_env
     end
 
-  # TODO: move some more methods under here!
-  private
+    # TODO: move some more methods under here!
+
+    private
 
     def last_exit_status
       return @last_exit_status if @last_exit_status