aruba 0.8.0 → 0.8.1

data/features/fixtures/empty-app/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cli/app"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/features/fixtures/empty-app/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'cli/app'
+
+if RUBY_VERSION < '1.9.'
+  ::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

data/features/integration/rspec/getting_started.feature

@@ -0,0 +1,148 @@
+Feature: Getting started with RSpec and aruba
+
+  Background:
+    Given I use the fixture "empty-app"
+
+  Scenario: Simple Integration
+
+    To use the simple integration just require `aruba/rspec` in your
+    `spec_helper.rb`. After that you only need to flag your tests with `type:
+    :aruba` and some things are set up for.
+
+    The simple integration adds some `before(:each)`-hooks for you:
+
+      \* Setup Aruba Test directory
+      \* Clear environment (ENV)
+      \* Make HOME-variable configarable via `arub.config.home_directory`
+      \* Configure `aruba` via `RSpec`-metadata
+      \* Activate announcers based on `RSpec`-metadata
+
+    Be careful, if you are going to use a `before(:all)`-hook to set up
+    files/directories. Those will be deleted by the `setup_aruba`-call within
+    the `before(:each)`-hook. Look for some custom integration further down the
+    documentation for a solution.
+
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require 'aruba/rspec'
+    """
+    And a file named "spec/getting_started_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Integrate Aruba into RSpec', :type => :aruba do
+      context 'when to be or not be...' do
+        it { expect(aruba).to be }
+      end
+
+      context 'when write file' do
+        let(:file) { 'file.txt' }
+
+        before(:each) { write_file file, 'Hello World' }
+
+        it { expect(file).to be_an_existing_file }
+        it { expect([file]).to include an_existing_file }
+      end
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Simple Custom Integration
+
+    There might be some use cases where you want to build an aruba integration
+    of your own. You need to include the API and make sure, that you run
+
+      \* `restore_env` (only for aruba < 1.0.0)
+      \* `setup_aruba`
+
+    before any method of aruba is used.
+
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require 'aruba/api'
+
+    RSpec.configure do |config|
+      config.include Aruba::Api
+    end
+    """
+    And a file named "spec/getting_started_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Custom Integration of aruba' do
+      let(:file) { 'file.txt' }
+
+      before(:each) { setup_aruba }
+      before(:each) { write_file file, 'Hello World' }
+
+      it { expect(file).to be_an_existing_file }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Custom Integration using before(:all)-hook
+
+    You can even use `aruba` within a `before(:all)`-hook. But again, make sure
+    that `setup_aruba` is run before you use any method of `aruba`. Using
+    `setup_aruba` both in `before(:all)`- and `before(:each)`-hook is not
+    possible and therefor not supported:
+
+    Running `setup_aruba` removes `tmp/aruba`, creates a new one `tmp/aruba`
+    and make it the working directory. Running it within a `before(:all)`-hook,
+    run some `aruba`-method and then run `setup_arub` again within a
+    `before(:each)`-hook, will remove the files/directories created within the
+    `before(:all)`-hook.
+
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require 'aruba/api'
+
+    RSpec.configure do |config|
+      config.include Aruba::Api
+    end
+    """
+    And a file named "spec/getting_started_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Custom Integration of aruba' do
+      before(:all) { setup_aruba }
+      before(:all) { write_file 'file.txt', 'Hello World' }
+
+      it { expect('file.txt').to be_an_existing_file }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Fail-safe use if "setup_aruba" is not used
+
+    If you forgot to run `setup_aruba` before the first method of aruba is
+    used, you might see an error. Although we did our best to prevent this.
+
+    Make sure that you run `setup_aruba` before any method of aruba is used. At
+    best before each and every test.
+
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require 'aruba/api'
+
+    RSpec.configure do |config|
+      config.include Aruba::Api
+    end
+    """
+    And a file named "spec/getting_started_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Custom Integration of aruba' do
+      let(:file) { 'file.txt' }
+
+      it { expect { write_file file, 'Hello World' }.not_to raise_error }
+      it { expect(aruba.current_directory.directory?).to be true }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/step_definitions/aruba_dev_steps.rb

@@ -51,9 +51,14 @@ Then /^the feature(?:s)? should( not)?(?: all)? pass with:$/ do |negated, string
   step 'the output should contain:', string if string
 end
 
-Then /^the spec(?:s)? should( not)?(?: all)? pass$/ do |negated|
+Then /^the spec(?:s)? should( not)?(?: all)? pass(?: with (\d+) failures?)?$/ do |negated, count_failures|
   if negated
-    step 'the output should not contain "0 failures"'
+    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"'
@@ -87,10 +92,6 @@ Given(/^the default feature-test$/) do
   )
 end
 
-Before do
-  aruba.config.exit_timeout = 15
-end
-
 Given(/^(?:an|the) executable(?: named)? "([^"]*)" with:$/) do |file_name, file_content|
   step %(a file named "#{file_name}" with mode "0755" and with:), file_content
 end

data/features/steps/environment/home_variable.feature

@@ -25,10 +25,7 @@ Feature: Mock the HOME variable
       Scenario: Run command
         Given a mocked home directory
         When I run `cli`
-        Then the output should contain:
-        \"\"\"
-        tmp/aruba
-        \"\"\"
+        Then the output should match %r<HOME:.*tmp/aruba$>
     """
     When I run `cucumber`
     Then the features should all pass
@@ -40,10 +37,26 @@ Feature: Mock the HOME variable
       @mocked-home-directory
       Scenario: Run command
         When I run `cli`
-        Then the output should contain:
-        \"\"\"
-        tmp/aruba
-        \"\"\"
+        Then the output should match %r<HOME:.*tmp/aruba$>
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Redefine home directory by using the aruba configuration
+    Given a file named "features/support/home_variable.rb" with:
+    """
+    require 'aruba/cucumber'
+
+    Aruba.configure do |config|
+      config.home_directory = File.join(config.root_directory, config.working_directory)
+    end
+    """
+    Given a file named "features/home_variable.feature" with:
+    """
+    Feature: Home Variable
+      Scenario: Run command
+        When I run `cli`
+        Then the output should match %r<HOME:.*tmp/aruba$>
     """
     When I run `cucumber`
     Then the features should all pass

data/features/support/aruba.rb

@@ -1,5 +1,6 @@
 require 'aruba/cucumber'
 
 Aruba.configure do |config|
-  config.exit_timeout = 5
+  config.exit_timeout    = 120
+  config.io_wait_timeout = 2
 end

data/lib/aruba/announcer.rb

@@ -52,7 +52,7 @@ module Aruba
 
     private
 
-    attr_reader :announcers, :default_announcer, :announcer, :channels, :format_strings
+    attr_reader :announcers, :default_announcer, :announcer, :channels, :output_formats
 
     public
 
@@ -65,19 +65,23 @@ module Aruba
       @default_announcer = @announcers.last
       @announcer         = @announcers.first
       @channels          = {}
-      @format_strings    = {}
+      @output_formats    = {}
 
       @options           = options
 
       after_init
     end
 
+    private
+
     # rubocop:disable Metrics/MethodLength
     def after_init
-      format_string :directory, '$ cd %s'
-      format_string :command, '$ %s'
-      format_string :environment, '$ export %s=%s"'
-      format_string :timeout, '# %s-timeout: %s seconds'
+      output_format :directory, '$ cd %s'
+      output_format :command, '$ %s'
+      output_format :environment, '$ export %s=%s"'
+      output_format :modified_environment, '$ export %s=%s"'
+      output_format :full_environment, proc { |h| environment_table(h) }
+      output_format :timeout, '# %s-timeout: %s seconds'
 
       # rubocop:disable Metrics/LineLength
       if @options[:stdout]
@@ -97,66 +101,126 @@ module Aruba
         activate :command
       end
       if @options[:env]
-        warn('The use of "@announce_env-instance" variable and "options[:env] = true" for Announcer.new is deprecated. Please use "announcer.activate(:environment)" instead.')
-        activate :enviroment
+        warn('The use of "@announce_env-instance" variable and "options[:env] = true" for Announcer.new is deprecated. Please use "announcer.activate(:modified_environment)" instead.')
+        activate :modified_enviroment
       end
       # rubocop:enable Metrics/LineLength
     end
     # rubocop:enable Metrics/MethodLength
 
+    def output_format(channel, string = '%s', &block)
+      if block_given?
+        output_formats[channel.to_sym] = block
+      elsif  string.is_a?(Proc)
+        output_formats[channel.to_sym] = string
+      else
+        output_formats[channel.to_sym] = proc { |*args| format(string, *args) }
+      end
+
+      self
+    end
+
+    def environment_table(h)
+      name_size = h.keys.max_by(&:length).length
+      value_size = h.values.max_by(&:length).length
+
+      result = []
+
+      h.each do |k,v|
+        result << format('%s => %s', k + ' ' * (name_size - k.to_s.size), v + ' ' * (value_size - v.to_s.size))
+      end
+
+      result
+    end
+
+    public
+
+    # Reset announcer
     def reset
       @default_announcer = @announcers.last
       @announcer         = @announcers.first
     end
 
-    def format_string(channel, string)
-      format_strings[channel] = string
+    # Change mode of announcer
+    #
+    # @param [Symbol] m
+    #   The mode to set
+    def mode=(m)
+      @announcer = @announcers.find { |a| f.mode? m.to_sym }
 
       self
     end
 
-    def mode=(m)
-      @announcer = @announcers.find { |a| f.mode? m }
-
-      self
+    # Check if channel is activated
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to check
+    def activated?(channel)
+      channels[channel.to_sym] == true
     end
 
+    # Activate a channel
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to activate
     def activate(channel)
-      channels[channel] = true
+      channels[channel.to_sym] = true
 
       self
     end
 
+    # Announce information to channel
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to check
+    #
+    # @param [Array] args
+    #   Arguments
     def announce(channel, *args)
-      message = format(format_strings.fetch(channel, '%s'), *args)
-      announcer.announce(message) if @channels[channel]
+      channel = channel.to_sym
+
+      the_output_format = if output_formats.key? channel
+                            output_formats[channel]
+                          else
+                            proc { |v| format('%s', v) }
+                          end
+
+      message = the_output_format.call(*args)
+
+      announcer.announce(message) if channels[channel]
 
       default_announcer.announce message
     end
 
+    # @deprecated
     def stdout(content)
       warn('The announcer now has a new api to activate channels. Please use this one: announce(:stdout, message)')
       announce :stdout, content
     end
 
+    # @deprecated
     def stderr(content)
       warn('The announcer now has a new api to activate channels. Please use this one: announce(:stderr, message)')
       announce :stderr, content
     end
 
+    # @deprecated
     def dir(dir)
       warn('The announcer now has a new api to activate channels. Please use this one announce(:directory, message)')
       announce :directory, dir
     end
 
+    # @deprecated
     def cmd(cmd)
       warn('The announcer now has a new api to activate channels. Please use this one announce(:command, message)')
       announce :command, cmd
     end
 
+    # @deprecated
     def env(key, value)
-      warn('The announcer now has a new api to activate channels. Please use this one: announce(:environment, key, value)')
-      announce :environment, key, value
+      warn('The announcer now has a new api to activate channels. Please use this one: announce(:modified_environment, key, value)')
+
+      announce :modified_environment, key, value
     end
   end
 end

data/lib/aruba/api.rb

@@ -1,12 +1,17 @@
 require 'rspec/expectations'
 require 'shellwords'
 
+require 'aruba/version'
 require 'aruba/extensions/string/strip'
 
 require 'aruba/platform'
 require 'aruba/api/core'
 require 'aruba/api/command'
-require 'aruba/api/deprecated'
+
+if Aruba::VERSION <= '1.0.0'
+  require 'aruba/api/deprecated'
+end
+
 require 'aruba/api/environment'
 require 'aruba/api/filesystem'
 require 'aruba/api/rvm'