aruba 0.11.0.pre → 0.11.0.pre2

data/lib/aruba/events.rb

@@ -0,0 +1,39 @@
+# Aruba
+module Aruba
+  # Events
+  module Events
+    # Basic event
+    #
+    # This is not meant for direct use - BasicEvent.new - by users. It is inherited by normal events
+    #
+    # @private
+    class BasicEvent
+      attr_reader :entity
+
+      def initialize(entity)
+        @entity = entity
+      end
+    end
+
+    # Command was stopped
+    class CommandStopped < BasicEvent; end
+
+    # Command was started
+    class CommandStarted < BasicEvent; end
+
+    # An environment variable was changed
+    class ChangedEnvironmentVariable < BasicEvent; end
+
+    # An environment variable was added
+    class AddedEnvironmentVariable < BasicEvent; end
+
+    # An environment variable was deleted
+    class DeletedEnvironmentVariable < BasicEvent; end
+
+    # The working directory has changed
+    class ChangedWorkingDirectory < BasicEvent; end
+
+    # The configuration was changed
+    class ChangedConfiguration < BasicEvent; end
+  end
+end

data/lib/aruba/extensions/string/strip.rb

@@ -1,3 +1,4 @@
+# String
 class String
   # Strips indentation in heredocs.
   #

data/lib/aruba/file_size.rb

@@ -1,6 +1,8 @@
 require 'delegate'
 
+# Aruba
 module Aruba
+  # File Size
   class FileSize
     include Comparable
 
@@ -10,41 +12,50 @@ module Aruba
 
     public
 
+    # Create file size object
     def initialize(bytes)
       @bytes   = bytes
       @divisor = 1024
     end
 
+    # Convert to bytes
     def to_byte
       bytes
     end
     alias_method :to_i, :to_byte
 
+    # Convert to float
     def to_f
       to_i.to_f
     end
 
+    # Convert to string
     def to_s
       to_i.to_s
     end
     alias_method :inspect, :to_s
 
+    # Move to other
     def coerce(other)
       [bytes, other]
     end
 
+    # Convert to kibi byte
     def to_kibi_byte
       to_byte.to_f / divisor
     end
 
+    # Convert to mebi byte
     def to_mebi_byte
       to_kibi_byte.to_f / divisor
     end
 
+    # Convert to gibi byte
     def to_gibi_byte
       to_mebi_byte.to_f / divisor
     end
 
+    # Compare size with other size
     def <=>(other)
       to_i <=> other.to_i
     end

data/lib/aruba/hooks.rb

@@ -1,3 +1,4 @@
+# Aruba
 module Aruba
   # Aruba Hooks
   class Hooks
@@ -7,6 +8,7 @@ module Aruba
 
     public
 
+    # Create store
     def initialize
       @store = {}
     end

data/lib/aruba/in_config_wrapper.rb

@@ -0,0 +1,24 @@
+# Aruba
+module Aruba
+  # In config wrapper
+  #
+  # Used to make the configuration read only if one needs to access an
+  # configuration option from with `Aruba::Config`.
+  #
+  # @private
+  class InConfigWrapper
+    attr_reader :config
+    private :config
+
+    def initialize(config)
+      @config = config.dup
+    end
+
+    def method_missing(name, *args)
+      fail ArgumentError, 'Options take no argument' if args.count > 0
+      fail UnknownOptionError, %(Option "#{name}" is unknown. Please use only earlier defined options) unless config.key? name
+
+      config[name]
+    end
+  end
+end

data/lib/aruba/in_process.rb

@@ -1,7 +1,9 @@
 require 'aruba/processes/in_process'
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # @deprecated
   class InProcess < Aruba::Processes::InProcess
     def initialize(*args)
       Aruba.platform.deprecated('The use of "Aruba::InProcess" is deprecated. Use "Aruba::Processes::InProcess" instead.')

data/lib/aruba/initializer.rb

@@ -1,11 +1,19 @@
 require 'thor/group'
 require 'thor/actions'
 
+# Aruba
 module Aruba
+  # Initializers
+  #
+  # Initialize project with aruba configuration files
   module Initializers
+    # Common initializer
+    #
+    # @private
     class CommonInitializer < Thor::Group
       include Thor::Actions
 
+      # Add gem to gemfile
       def add_gem
         file = 'Gemfile'
         creator = if File.exist? file
@@ -25,8 +33,15 @@ module Aruba
   end
 end
 
+# Aruba
 module Aruba
+  # Initializers
   module Initializers
+    # Default Initializer
+    #
+    # This handles invalid values for initializer.
+    #
+    # @private
     class FailingInitializer
       class << self
         def match?(*)
@@ -41,8 +56,13 @@ module Aruba
   end
 end
 
+# Aruba
 module Aruba
+  # Initializer
   module Initializers
+    # Add aruba + rspec to project
+    #
+    # @private
     class RSpecInitializer < Thor::Group
       include Thor::Actions
 
@@ -82,8 +102,13 @@ EOS
   end
 end
 
+# Aruba
 module Aruba
+  # Initializer
   module Initializers
+    # Add aruba + aruba to project
+    #
+    # @private
     class CucumberInitializer < Thor::Group
       include Thor::Actions
 
@@ -102,8 +127,13 @@ EOS
   end
 end
 
+# Aruba
 module Aruba
+  # Initializer
   module Initializers
+    # Add aruba + minitest to project
+    #
+    # @private
     class MiniTestInitializer < Thor::Group
       include Thor::Actions
 
@@ -155,7 +185,13 @@ EOS
   end
 end
 
+# Aruba
 module Aruba
+  # The whole initializer
+  #
+  # This one uses the specific initializers to generate the needed files.
+  #
+  # @private
   class Initializer
     private
 
@@ -171,6 +207,7 @@ module Aruba
       @initializers << Initializers::FailingInitializer
     end
 
+    # Create files etc.
     def call(test_framework)
       begin
         initializers.find { |i| i.match? test_framework }.start [], {}

data/lib/aruba/matchers/base/base_matcher.rb

@@ -1,6 +1,8 @@
 require 'aruba/matchers/base/object_formatter'
 
+# Aruba
 module Aruba
+  # Matchers
   module Matchers
     # Base Matcher
     class BaseMatcher

data/lib/aruba/matchers/base/object_formatter.rb

@@ -1,7 +1,11 @@
+# Aruba
 module Aruba
+  # Matchers
   module Matchers
     # Provide additional output details beyond what `inspect` provides when
     # printing Time, DateTime, or BigDecimal
+    #
+    # @private
     module ObjectFormatter
       # @api private
       def self.format(object)

data/lib/aruba/matchers/collection/all.rb

@@ -1,6 +1,8 @@
 require 'rspec/expectations'
 
+# Aruba
 module Aruba
+  # Matchers
   module Matchers
     include ::RSpec::Matchers
 

data/lib/aruba/matchers/collection/include_an_object.rb

@@ -1,6 +1,8 @@
 require 'aruba/matchers/base/base_matcher'
 
+# Aruba
 module Aruba
+  # Matchers
   module Matchers
     # @api private
     # Provides the implementation for `include_an_object`.

data/lib/aruba/matchers/command/have_exit_status.rb

@@ -20,7 +20,7 @@ RSpec::Matchers.define :have_exit_status do |expected|
   match do |actual|
     @old_actual = actual
 
-    @old_actual.stop(announcer) unless @old_actual.stopped?
+    @old_actual.stop
     @actual = actual.exit_status
 
     next false unless @old_actual.respond_to? :exit_status

data/lib/aruba/matchers/command/have_finished_in_time.rb

@@ -26,16 +26,7 @@ RSpec::Matchers.define :have_finished_in_time do
 
     next false unless @old_actual.respond_to? :timed_out?
 
-    @announcer ||= Aruba::Announcer.new(
-      self,
-      :stdout => @announce_stdout,
-      :stderr => @announce_stderr,
-      :dir    => @announce_dir,
-      :cmd    => @announce_cmd,
-      :env    => @announce_env
-    )
-
-    @old_actual.stop(@announcer) unless @old_actual.stopped?
+    @old_actual.stop
 
     @old_actual.timed_out? == false
   end

data/lib/aruba/matchers/command/have_output.rb

@@ -19,16 +19,7 @@ RSpec::Matchers.define :have_output do |expected|
 
     next false unless @old_actual.respond_to? :output
 
-    @announcer ||= Aruba::Announcer.new(
-      self,
-      :stdout => @announce_stdout,
-      :stderr => @announce_stderr,
-      :dir    => @announce_dir,
-      :cmd    => @announce_cmd,
-      :env    => @announce_env
-    )
-
-    @old_actual.stop(@announcer)
+    @old_actual.stop
 
     @actual = sanitize_text(actual.output)
 

data/lib/aruba/matchers/command/have_output_on_stderr.rb

@@ -19,16 +19,7 @@ RSpec::Matchers.define :have_output_on_stderr do |expected|
 
     next false unless @old_actual.respond_to? :stderr
 
-    @announcer ||= Aruba::Announcer.new(
-      self,
-      :stdout => @announce_stdout,
-      :stderr => @announce_stderr,
-      :dir    => @announce_dir,
-      :cmd    => @announce_cmd,
-      :env    => @announce_env
-    )
-
-    @old_actual.stop(@announcer) unless @old_actual.stopped?
+    @old_actual.stop
 
     @actual = sanitize_text(actual.stderr)
 

data/lib/aruba/matchers/command/have_output_on_stdout.rb

@@ -19,16 +19,7 @@ RSpec::Matchers.define :have_output_on_stdout do |expected|
 
     next false unless @old_actual.respond_to? :stdout
 
-    @announcer ||= Aruba::Announcer.new(
-      self,
-      :stdout => @announce_stdout,
-      :stderr => @announce_stderr,
-      :dir    => @announce_dir,
-      :cmd    => @announce_cmd,
-      :env    => @announce_env
-    )
-
-    @old_actual.stop(@announcer) unless @old_actual.stopped?
+    @old_actual.stop
 
     @actual = sanitize_text(actual.stdout)
 

data/lib/aruba/matchers/file/be_an_existing_executable.rb

@@ -0,0 +1,37 @@
+require 'rspec/expectations/version'
+require 'shellwords'
+
+# @!method be_an_existing_executable
+#   This matchers checks if <file> exists in filesystem
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if file does not exist
+#     true:
+#     * if file exists
+#
+#   @example Use matcher
+#
+#     RSpec.describe do
+#       it { expect(file1).to be_an_existing_executable }
+#     end
+RSpec::Matchers.define :be_an_existing_executable do |_|
+  match do |actual|
+    @actual = Shellwords.split(actual.commandline).first if actual.respond_to? :commandline
+
+    executable?(@actual)
+  end
+
+  failure_message do |actual|
+    format("expected that executable \"%s\" exists", actual)
+  end
+
+  failure_message_when_negated do |actual|
+    format("expected that executable \"%s\" does not exist", actual)
+  end
+end
+
+if RSpec::Expectations::Version::STRING >= '3.0'
+  RSpec::Matchers.alias_matcher :an_existing_executable, :be_an_existing_executable
+end

data/lib/aruba/platform.rb

@@ -2,14 +2,18 @@ require 'thread'
 require 'aruba/platforms/unix_platform'
 require 'aruba/platforms/windows_platform'
 
+# Aruba
 module Aruba
   PLATFORM_MUTEX = Mutex.new
 end
 
+# Aruba
 module Aruba
+  # Platform
   Platform = [Platforms::WindowsPlatform, Platforms::UnixPlatform].find(&:match?)
 end
 
+# Aruba
 module Aruba
   PLATFORM_MUTEX.synchronize do
     @platform = Platform.new

data/lib/aruba/platforms/announcer.rb

@@ -0,0 +1,225 @@
+require 'shellwords'
+
+# Aruba
+module Aruba
+  # Platforms
+  module Platforms
+    # Announcer
+    #
+    # @private
+    #
+    # @example Activate your you own channel in cucumber
+    #
+    #   Before('@announce-my-channel') do
+    #     aruba.announcer.activate :my_channel
+    #   end
+    #
+    # @example Activate your you own channel in rspec > 3
+    #
+    #   before do
+    #     current_example = context.example
+    #     aruba.announcer.activate :my_channel if current_example.metadata[:announce_my_channel]
+    #   end
+    #
+    #   Aruba.announcer.announce(:my_channel, 'my message')
+    #
+    class Announcer
+      # Dev null
+      class NullAnnouncer
+        def announce(*)
+          nil
+        end
+
+        def mode?(*)
+          true
+        end
+      end
+
+      # Announcer using Kernel.puts
+      class KernelPutsAnnouncer
+        def announce(message)
+          Kernel.puts message
+        end
+
+        def mode?(m)
+          :kernel_puts == m
+        end
+      end
+
+      # Announcer using Main#puts
+      class PutsAnnouncer
+        def announce(message)
+          Kernel.puts message
+        end
+
+        def mode?(m)
+          :puts == m
+        end
+      end
+
+      private
+
+      attr_reader :announcers, :default_announcer, :announcer, :channels, :output_formats
+
+      public
+
+      def initialize(*args)
+        @announcers = []
+        @announcers << PutsAnnouncer.new
+        @announcers << KernelPutsAnnouncer.new
+        @announcers << NullAnnouncer.new
+
+        @default_announcer = @announcers.last
+        @announcer         = @announcers.first
+        @channels          = {}
+        @output_formats    = {}
+
+        @options           = args[1] || {}
+
+        after_init
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def after_init
+        output_format :changed_configuration, proc { |n, v| format('# %s = %s', n, v) }
+        output_format :changed_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :command, '$ %s'
+        output_format :directory, '$ cd %s'
+        output_format :environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :full_environment, proc { |h| Aruba.platform.simple_table(h) }
+        output_format :modified_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :stderr, "<<-STDERR\n%s\nSTDERR"
+        output_format :stdout, "<<-STDOUT\n%s\nSTDOUT"
+        output_format :stop_signal, proc { |p, s| format('Command will be stopped with `kill -%s %s`', s, p) }
+        output_format :timeout, '# %s-timeout: %s seconds'
+        output_format :wait_time, '# %s: %s seconds'
+
+        # rubocop:disable Metrics/LineLength
+        if @options[:stdout]
+          warn('The use of "@announce_stdout-instance" variable and "options[:stdout] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stdout)" instead.')
+          activate :stdout
+        end
+        if @options[:stderr]
+          warn('The use of "@announce_stderr-instance" variable and "options[:stderr] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stderr)" instead.')
+          activate :stderr
+        end
+        if @options[:dir]
+          warn('The use of "@announce_dir-instance" variable and "options[:dir] = true" for Announcer.new is deprecated. Please use "announcer.activate(:directory)" instead.')
+          activate :directory
+        end
+        if @options[:cmd]
+          warn('The use of "@announce_cmd-instance" variable and "options[:cmd] = true" for Announcer.new is deprecated. Please use "announcer.activate(:command)" instead.')
+          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(: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
+      end
+
+      public
+
+      # Reset announcer
+      def reset
+        @default_announcer = @announcers.last
+        @announcer         = @announcers.first
+      end
+
+      # 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
+
+      # 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.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)
+        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(name, value)
+        warn('The announcer now has a new api to activate channels. Please use this one: announce(:changed_environment, key, value)')
+
+        announce :changed_environment, name, value
+      end
+    end
+  end
+end