aruba 0.9.0 → 0.10.0.pre

data/features/api/{command → text}/unescape_text.feature

@@ -1,11 +1,7 @@
-Feature: Extract text from output
+Feature: Unescape special characters in text
 
-  If you need to strip down some command output to plain text, you can use the
-  `#unescape_text`-method for this.
-
-  You may want to have a look
-  [here](http://www.unixwerk.eu/unix/ansicodes.html) for a good overview for
-  ANSI escape sequences.
+  If have got some text include \n, \t and the like and need them to become
+  special characters again, you can use the `#unescape_text`-method for this.
 
   Background:
     Given I use a fixture named "cli-app"
@@ -16,7 +12,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\ntext'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -36,7 +32,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\etext'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -56,7 +52,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\"text'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -76,7 +72,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\033text'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -96,7 +92,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\017text'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -116,7 +112,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n 'text\016text'
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/unescape_text_spec.rb" with:
     """
     require 'spec_helper'
 

data/features/cli/init.feature

@@ -0,0 +1,79 @@
+Feature: Initialize project with aruba
+
+  To add `aruba` to your project you can use the `aruba init`-command.
+
+  Background:
+    Given I use the fixture "empty-app"
+
+  Scenario: Create files for RSpec
+    When I successfully run `aruba init --test-framework rspec`
+    Then the following files should exist:
+      | spec/spec_helper.rb |
+    And the file "spec/support/aruba.rb" should contain:
+    """
+    require 'aruba/rspec'
+    """
+    And the file "Gemfile" should contain:
+    """
+    gem 'aruba'
+    """
+    When I successfully run `rspec`
+    Then the output should contain:
+    """
+    0 examples, 0 failures
+    """
+
+  Scenario: Create files for Cucumber
+    When I successfully run `aruba init --test-framework cucumber`
+    Then the file "features/support/aruba.rb" should contain:
+    """
+    require 'aruba/cucumber'
+    """
+    And the file "Gemfile" should contain:
+    """
+    gem 'aruba'
+    """
+    When I successfully run `cucumber`
+    Then the output should contain:
+    """
+    0 scenarios
+    0 steps
+    """
+
+  Scenario: Create files for Cucumber (Default)
+    When I successfully run `aruba init`
+    Then the file "features/support/aruba.rb" should contain:
+    """
+    require 'aruba/cucumber'
+    """
+    And the file "Gemfile" should contain:
+    """
+    gem 'aruba'
+    """
+    When I successfully run `cucumber`
+    Then the output should contain:
+    """
+    0 scenarios
+    0 steps
+    """
+
+  Scenario: Create files for Minitest
+    When I successfully run `aruba init --test-framework minitest`
+    Then the following files should exist:
+      | test/test_helper.rb |
+    And the file "Gemfile" should contain:
+    """
+    gem 'aruba'
+    """
+    When I successfully run `ruby -Ilib:test test/use_aruba_with_minitest.rb`
+    Then the output should contain:
+    """
+    0 runs, 0 assertions, 0 failures, 0 errors, 0 skips
+    """
+
+  Scenario: Unknown Test Framework
+    When I run `aruba init --test-framework unknown`
+    Then the output should contain:
+    """
+    got unknown
+    """

data/features/commands/output/all_output.feature

@@ -385,6 +385,7 @@ Feature: All output of commands which were executed
     When I run `cucumber`
     Then the features should all pass
 
+  @requires-aruba-version-1
   Scenario: Detect output from all processes
     Given an executable named "bin/cli1" with:
     """bash

data/features/getting_started/supported_testing_frameworks.feature

@@ -0,0 +1,104 @@
+Feature: Supported Testing Frameworks
+
+  You can use `aruba` with all major testing frameworks from the Ruby World:
+
+    \* Cucumber
+    \* RSpec
+    \* Minitest
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Use "aruba" with "Cucumber"
+    Given a file named "features/support/env.rb" with:
+    """
+    require 'aruba/cucumber'
+    """
+    And a file named "features/use_aruba_with_cucumber.feature" with:
+    """
+    Feature: Cucumber
+      Scenario: First Run
+        Given a file named "file.txt" with:
+        \"\"\"
+        Hello World
+        \"\"\"
+        Then the file "file.txt" should contain:
+        \"\"\"
+        Hello World
+        \"\"\"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Use "aruba" with "RSpec"
+    Given a file named "spec/support/aruba.rb" with:
+    """
+    require 'aruba/rspec'
+    """
+    And a file named "spec/spec_helper.rb" with:
+    """
+    $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
+    """
+    And a file named "spec/use_aruba_with_rspec_spec.rb" with:
+    """
+    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
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+
+  Scenario: Use "aruba" with "Minitest"
+    Given a file named "test/support/aruba.rb" with:
+    """
+    require 'aruba/api'
+    """
+    And a file named "test/test_helper.rb" with:
+    """
+    $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
+    """
+    And a file named "test/use_aruba_with_minitest.rb" with:
+    """
+    $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
+    """
+    When I run `ruby -Ilib:test test/use_aruba_with_minitest.rb`
+    Then the tests should all pass

data/features/output.feature

@@ -7,6 +7,7 @@ Feature: All output of commands which were executed
   Background:
     Given I use a fixture named "cli-app"
 
+  @requires-aruba-version-1
   Scenario: Detect output from all processes normal and interactive ones
     Given an executable named "bin/cli1" with:
     """
@@ -122,9 +123,9 @@ Feature: All output of commands which were executed
     And the stderr from "printf goodbye" should not contain "hello"
 
   Scenario: Detect second output from named source with custom name
-    When I set env variable "ARUBA_TEST_VAR" to "first"
+    When I set the environment variable "ARUBA_TEST_VAR" to "first"
     And I run `bash -c 'printf $ARUBA_TEST_VAR'`
     Then the output from "bash -c 'printf $ARUBA_TEST_VAR'" should contain "first"
-    When I set env variable "ARUBA_TEST_VAR" to "second"
+    When I set the environment variable "ARUBA_TEST_VAR" to "second"
     And I run `bash -c 'printf $ARUBA_TEST_VAR'`
     Then the output from "bash -c 'printf $ARUBA_TEST_VAR'" should contain "second"

data/features/step_definitions/aruba_dev_steps.rb

@@ -18,72 +18,13 @@ When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
 end
 
 Then /^aruba should fail with "([^"]*)"$/ do |error_message|
-  expect(@aruba_exception.message).to include(extract_text(unescape_text(error_message)))
+  expect(@aruba_exception.message).to include sanitize_text(error_message)
 end
 
 Then /^the following step should fail with Spec::Expectations::ExpectationNotMetError:$/ do |multiline_step|
   expect{steps multiline_step.to_s}.to raise_error(RSpec::Expectations::ExpectationNotMetError)
 end
 
-Then /^the feature(?:s)? should( not)?(?: all)? pass$/ do |negated|
-  if negated
-    step 'the output should contain " failed)"'
-    step 'the exit status should be 1'
-  else
-    step 'the output should not contain " failed)"'
-    step 'the output should not contain " undefined)"'
-    step 'the exit status should be 0'
-  end
-end
-
-Then /^the feature(?:s)? should( not)?(?: all)? pass with( regex)?:$/ do |negated, regex, string|
-  if negated
-    step 'the output should contain " failed)"'
-    step 'the exit status should be 1'
-  else
-    step 'the output should not contain " failed)"'
-    step 'the output should not contain " undefined)"'
-    step 'the exit status should be 0'
-  end
-
-  if regex
-    step "the output should match %r<#{string}>"
-  else
-    step 'the output should contain:', string
-  end
-end
-
-Then /^the spec(?:s)? should( not)?(?: all)? pass(?: with (\d+) failures?)?$/ do |negated, count_failures|
-  if negated
-    if count_failures.nil?
-      step 'the output should not contain "0 failures"'
-    else
-      step %(the output should contain "#{count_failures} failures")
-    end
-
-    step 'the exit status should be 1'
-  else
-    step 'the output should contain "0 failures"'
-    step 'the exit status should be 0'
-  end
-end
-
-Then /^the spec(?:s)? should( not)?(?: all)? pass with( regex)?:$/ do |negated, regex, string|
-  if negated
-    step 'the output should contain " failed)"'
-    step 'the exit status should be 1'
-  else
-    step 'the output should not contain " failed)"'
-    step 'the exit status should be 0'
-  end
-
-  if regex
-    step "the output should match %r<#{string}>"
-  else
-    step 'the output should contain:', string
-  end
-end
-
 Given(/^the default executable$/) do
   step 'an executable named "bin/cli" with:', <<-EOS
 #!/usr/bin/env ruby

data/features/step_definitions/hooks.rb

@@ -9,3 +9,9 @@ Before '@requires-ruby-version-193' do
     skip_this_scenario
   end
 end
+
+Before '@requires-aruba-version-1' do
+  next unless Aruba::VERSION > '1'
+
+  skip_this_scenario if Cucumber::VERSION >= '2'
+end

data/fixtures/empty-app/README.md

@@ -1,4 +1,4 @@
-# Simple Cli App
+# Empty Cli App
 
 This is a simple test cli app
 
@@ -22,13 +22,3 @@ Or install it yourself as:
 
 Place files in `lib/cli/app/`. They are loaded automatically. If you need a
 specific load order, use `require` in your files.
-
-### CLI
-
-```
-cli
-```
-
-### Library
-
-You can use `script/console` to load your library.

data/lib/aruba/api.rb

@@ -14,6 +14,7 @@ end
 
 require 'aruba/api/environment'
 require 'aruba/api/filesystem'
+require 'aruba/api/text'
 require 'aruba/api/rvm'
 
 Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
@@ -26,5 +27,6 @@ module Aruba
     include Aruba::Api::Filesystem
     include Aruba::Api::Rvm
     include Aruba::Api::Deprecated
+    include Aruba::Api::Text
   end
 end

data/lib/aruba/api/command.rb

@@ -19,25 +19,6 @@ end
 module Aruba
   module Api
     module Commands
-      # Unescape text
-      #
-      # '\n' => "\n"
-      # '\e' => "\e"
-      # '\033' => "\e"
-      # '\"' => '"'
-      def unescape_text(text)
-        text.gsub('\n', "\n").gsub('\"', '"').gsub('\e', "\e").gsub('\033', "\e").gsub('\016', "\016").gsub('\017', "\017").gsub('\t', "\t")
-      end
-
-      # Remove ansi characters from text
-      def extract_text(text)
-        if Aruba::VERSION < '1'
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '')
-        else
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '').gsub(/\\\[|\\\]/, '').gsub(/\007|\016|\017/, '')
-        end
-      end
-
       # Resolve path for command using the PATH-environment variable
       #
       # @param [#to_s] program

data/lib/aruba/api/deprecated.rb

@@ -133,7 +133,7 @@ module Aruba
       def mod?(file, perms, &block)
         Aruba.platform.deprecated('The use of "#mod?" is deprecated. Use "expect().to have_permissions()" instead')
 
-        expect(Array(file)).to all_objects have_permissions(perms)
+        expect(Array(file)).to Aruba::Matchers.all have_permissions(perms)
       end
 
       # @deprecated
@@ -392,11 +392,13 @@ module Aruba
       def restore_env
         # No output because we need to reset env on each scenario/spec run
         # Aruba.platform.deprecated('The use of "#restore_env" is deprecated. If you use "set_environment_variable" there\'s no need to restore the environment')
-
+        #
         original_env.each do |key, value|
           if value
             ENV[key] = value
+            aruba.environment[key] = value
           else
+            aruba.environment.delete key
             ENV.delete key
           end
         end
@@ -414,6 +416,7 @@ module Aruba
         Aruba.platform.deprecated('The use of "#set_env" is deprecated. Please use "set_environment_variable" instead. But be careful, this method uses a different kind of implementation')
 
         announcer.announce(:environment, key, value)
+        set_environment_variable key, value
         original_env[key] = ENV.delete(key) unless original_env.key? key
         ENV[key] = value
       end
@@ -486,7 +489,7 @@ module Aruba
       # @return
       #   The string stripped from escape sequences
       def unescape(string, keep_ansi = false)
-        Aruba.platform.deprecated('The use of "#unescape" is deprecated. Please use "#unescape_text" and "#extract_text" intead')
+        Aruba.platform.deprecated('The use of "#unescape" is deprecated. Please use "#sanitize_text" intead')
 
         string = unescape_text(string)
         string = extract_text(string) if !keep_ansi || !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences