aruba 1.0.1 → 1.1.1

data/lib/aruba/api/environment.rb

@@ -1,4 +1,4 @@
-require 'aruba/platform'
+require "aruba/platform"
 
 # Aruba
 module Aruba
@@ -96,7 +96,7 @@ module Aruba
 
         environment_change = { old: old_environment,
                                new: new_environment,
-                               changed: { name: name, value: '' } }
+                               changed: { name: name, value: "" } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self

data/lib/aruba/api/filesystem.rb

@@ -1,11 +1,10 @@
-require 'pathname'
+require "pathname"
 
-require 'aruba/platform'
-require 'aruba/extensions/string/strip'
+require "aruba/platform"
 
-Aruba.platform.require_matching_files('../matchers/file/*.rb', __FILE__)
-Aruba.platform.require_matching_files('../matchers/directory/*.rb', __FILE__)
-Aruba.platform.require_matching_files('../matchers/path/*.rb', __FILE__)
+Aruba.platform.require_matching_files("../matchers/file/*.rb", __FILE__)
+Aruba.platform.require_matching_files("../matchers/directory/*.rb", __FILE__)
+Aruba.platform.require_matching_files("../matchers/path/*.rb", __FILE__)
 
 # Aruba
 module Aruba
@@ -68,7 +67,7 @@ module Aruba
       # @return [Array]
       #   List of files and directories
       def all_paths
-        list('.').map { |path| expand_path(path) }
+        list(".").map { |path| expand_path(path) }
       end
 
       # Return all existing files in current directory
@@ -76,7 +75,7 @@ module Aruba
       # @return [Array]
       #   List of files
       def all_files
-        list('.').select { |p| file? p }.map { |p| expand_path(p) }
+        list(".").select { |p| file? p }.map { |p| expand_path(p) }
       end
 
       # Return all existing directories in current directory
@@ -84,7 +83,7 @@ module Aruba
       # @return [Array]
       #   List of files
       def all_directories
-        list('.').select { |p| directory? p }.map { |p| expand_path(p) }
+        list(".").select { |p| directory? p }.map { |p| expand_path(p) }
       end
 
       # Create directory object
@@ -109,8 +108,8 @@ module Aruba
                 %(Only directories are supported. Path "#{name}" is not a directory.)
         end
 
-        existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
-        current_working_directory = Pathname.new(expand_path('.'))
+        existing_files            = Dir.glob(expand_path(File.join(name, "**", "*")))
+        current_working_directory = Pathname.new(expand_path("."))
 
         existing_files.map do |d|
           Pathname.new(d).relative_path_from(current_working_directory).to_s
@@ -192,7 +191,7 @@ module Aruba
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
-          raise ArgumentError, 'Multiples sources can only be copied to a directory'
+          raise ArgumentError, "Multiples sources can only be copied to a directory"
         end
 
         source_paths     = source.map { |f| expand_path(f) }
@@ -241,7 +240,7 @@ module Aruba
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
-          raise ArgumentError, 'Multiple sources can only be copied to a directory'
+          raise ArgumentError, "Multiple sources can only be copied to a directory"
         end
 
         source_paths     = source.map { |f| expand_path(f) }
@@ -289,7 +288,7 @@ module Aruba
       # Change file system  permissions of file
       #
       # @param [Octal] mode
-      #   File system mode, eg. 0755
+      #   File system mode, eg. 0o755
       #
       # @param [String] file_name
       #   Name of file to be modified. This file needs to be present to succeed
@@ -327,8 +326,35 @@ module Aruba
       def append_to_file(file_name, file_content)
         file_name = expand_path(file_name)
 
-        Aruba.platform.mkdir(File.dirname(file_name))
-        File.open(file_name, 'a') { |f| f << file_content }
+        unless File.exist? file_name
+          Aruba.platform.deprecated("The ability to call #append_to_file with a file that" \
+                                    " does not exist is deprecated and will be removed in" \
+                                    " Aruba 2.0.")
+          Aruba.platform.mkdir(File.dirname(file_name))
+        end
+        File.open(file_name, "a") { |f| f << file_content }
+      end
+
+      # Append lines to a (text) file. This will make sure a newline is present
+      # between the old content and the new.
+      #
+      # @param [String] file_name
+      #   The name of the file to be used
+      #
+      # @param [String] file_content
+      #   The lines which should be appended to file
+      def append_lines_to_file(file_name, file_content)
+        file_name = expand_path(file_name)
+
+        last = File.open(file_name) do |f|
+          f.seek(-3, IO::SEEK_END)
+          f.read
+        end
+
+        File.open(file_name, "a") do |f|
+          f << "\n" unless last.end_with? "\n"
+          f << file_content
+        end
       end
 
       # Create a directory in current directory

data/lib/aruba/api/text.rb

@@ -30,9 +30,9 @@ module Aruba
       #   Input
       def extract_text(text)
         text
-          .gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '')
-          .gsub(/\\\[|\\\]/, '')
-          .gsub(/\007|\016|\017/, '')
+          .gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, "")
+          .gsub(/\\\[|\\\]/, "")
+          .gsub(/\007|\016|\017/, "")
       end
 
       # Unescape special characters and remove ANSI characters
@@ -51,7 +51,7 @@ module Aruba
       # @param [#to_s] text
       #   The text to parse
       def replace_variables(text)
-        if text.include? '<pid-last-command-started>'
+        if text.include? "<pid-last-command-started>"
           text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s)
         end
 

data/lib/aruba/aruba_path.rb

@@ -1,4 +1,4 @@
-require 'pathname'
+require "pathname"
 
 # Aruba
 module Aruba
@@ -57,9 +57,8 @@ module Aruba
     # Get path
     def to_pathname
       current_path = @obj.inject do |path, element|
-        if element.start_with? '~'
-          element
-        elsif Aruba.platform.absolute_path? element
+        if element.start_with?("~") ||
+           Aruba.platform.absolute_path?(element)
           element
         else
           File.join(path, element)

data/lib/aruba/basic_configuration.rb

@@ -1,6 +1,6 @@
-require 'contracts'
-require 'aruba/basic_configuration/option'
-require 'aruba/in_config_wrapper'
+require "contracts"
+require "aruba/basic_configuration/option"
+require "aruba/in_config_wrapper"
 
 # Aruba
 module Aruba
@@ -20,27 +20,18 @@ module Aruba
       # @param [Symbol] name
       #   The name of the reader
       #
-      # @param [Hash] opts
-      #   Options
-      #
-      # @option [Class, Module] contract
-      #   The contract for the option
+      # @option [Class, Module] type
+      #   The type contract for the option
       #
       # @option [Object] default
       #   The default value
-      def option_reader(name, opts = {})
-        contract = opts[:contract]
-        default  = opts[:default]
-
-        raise ArgumentError, 'Either use block or default value' if block_given? && default
-        raise ArgumentError, 'contract-options is required' if contract.nil?
+      def option_reader(name, type:, default: nil)
+        raise ArgumentError, "Either use block or default value" if block_given? && default
 
-        Contract contract
         add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
 
+        Contract None => type
         define_method(name) { find_option(name).value }
-
-        self
       end
 
       # Define an option reader and writer
@@ -48,30 +39,23 @@ module Aruba
       # @param [Symbol] name
       #   The name of the reader
       #
-      # @param [Hash] opts
-      #   Options
-      #
-      # @option [Class, Module] contract
-      #   The contract for the option
+      # @option [Class, Module] type
+      #   The type contract for the option
       #
       # @option [Object] default
       #   The default value
       #
-      def option_accessor(name, opts = {})
-        contract = opts[:contract]
-        default  = opts[:default]
-
-        raise ArgumentError, 'Either use block or default value' if block_given? && default
-        raise ArgumentError, 'contract-options is required' if contract.nil?
+      def option_accessor(name, type:, default: nil)
+        raise ArgumentError, "Either use block or default value" if block_given? && default
 
         # Add writer
         add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
 
-        Contract contract
+        Contract type => type
         define_method("#{name}=") { |v| find_option(name).value = v }
 
         # Add reader
-        option_reader name, contract: { None => contract.values.first }
+        option_reader name, type: type
       end
 
       private
@@ -90,8 +74,6 @@ module Aruba
     attr_accessor :local_options
     attr_writer :hooks
 
-    # attr_reader :hooks
-
     public
 
     # Create configuration
@@ -120,68 +102,68 @@ module Aruba
       obj
     end
 
-    # Define or run before-hook
+    # Define before-hook
     #
     # @param [Symbol, String] name
     #   The name of the hook
     #
-    # @param [Proc] context
-    #   The context a hook should run in. This is a runtime only option.
-    #
-    # @param [Array] args
-    #   Arguments for the run of hook. This is a runtime only option.
-    #
     # @yield
     #   The code block which should be run. This is a configure time only option
-    def before(name, context = proc {}, *args, &block)
-      name = format('%s_%s', 'before_', name.to_s).to_sym
+    def before(name, &block)
+      name = format("%s_%s", "before_", name.to_s).to_sym
+      raise ArgumentError, "A block is required" unless block
 
-      if block_given?
-        @hooks.append(name, block)
+      @hooks.append(name, block)
 
-        self
-      else
-        @hooks.execute(name, context, *args)
-      end
+      self
     end
 
-    # Define or run after-hook
+    # Run before-hook
     #
     # @param [Symbol, String] name
     #   The name of the hook
     #
     # @param [Proc] context
-    #   The context a hook should run in. This is a runtime only option.
+    #   The context a hook should run in
     #
     # @param [Array] args
-    #   Arguments for the run of hook. This is a runtime only option.
+    #   Arguments for the run of hook
+    def run_before_hook(name, context, *args)
+      name = format("%s_%s", "before_", name.to_s).to_sym
+
+      @hooks.execute(name, context, *args)
+    end
+
+    # Define after-hook
+    #
+    # @param [Symbol, String] name
+    #   The name of the hook
     #
     # @yield
     #   The code block which should be run. This is a configure time only option
-    def after(name, context = proc {}, *args, &block)
-      name = format('%s_%s', 'after_', name.to_s).to_sym
-
-      if block_given?
-        @hooks.append(name, block)
-
-        self
-      else
-        @hooks.execute(name, context, *args)
-      end
-    end
+    def after(name, &block)
+      name = format("%s_%s", "after_", name.to_s).to_sym
+      raise ArgumentError, "A block is required" unless block
 
-    # Check if before-hook <name> is defined
-    def before?(name)
-      name = format('%s_%s', 'before_', name.to_s).to_sym
+      @hooks.append(name, block)
 
-      @hooks.exist? name
+      self
     end
 
-    # Check if after-hook <name> is defined
-    def after?(name)
-      name = format('%s_%s', 'after_', name.to_s).to_sym
+    # Run after-hook
+    #
+    # @param [Symbol, String] name
+    #   The name of the hook
+    #
+    # @param [Proc] context
+    #   The context a hook should run in
+    #
+    # @param [Array] args
+    #   Arguments for the run of hook
+    def run_after_hook(name, context, *args)
+      name = format("%s_%s", "after_", name.to_s).to_sym
 
-      @hooks.exist? name
+      @hooks.execute(name, context, *args)
     end
 
     # Check if <name> is option

data/lib/aruba/cli.rb

@@ -1,6 +1,6 @@
-require 'thor'
-require 'aruba/console'
-require 'aruba/initializer'
+require "thor"
+require "aruba/console"
+require "aruba/initializer"
 
 # Aruba
 module Aruba
@@ -12,16 +12,16 @@ module Aruba
       true
     end
 
-    desc 'console', "Start aruba's console"
+    desc "console", "Start aruba's console"
     def console
       Aruba::Console.new.start
     end
 
-    desc 'init', 'Initialize aruba'
+    desc "init", "Initialize aruba"
     option :test_framework,
-           default: 'cucumber',
+           default: "cucumber",
            enum: %w(cucumber rspec minitest),
-           desc: 'Choose which test framework to use'
+           desc: "Choose which test framework to use"
     def init
       Aruba::Initializer.new.call(options[:test_framework])
     end

data/lib/aruba/command.rb

@@ -1,7 +1,7 @@
-require 'delegate'
-require 'aruba/processes/spawn_process'
-require 'aruba/processes/in_process'
-require 'aruba/processes/debug_process'
+require "delegate"
+require "aruba/processes/spawn_process"
+require "aruba/processes/in_process"
+require "aruba/processes/debug_process"
 
 # Aruba
 module Aruba

data/lib/aruba/config/jruby.rb

@@ -1,27 +1,27 @@
-require 'rbconfig'
+require "rbconfig"
 
 # ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
 Aruba.configure do |config|
   config.before :command do |command|
-    next unless RUBY_PLATFORM == 'java'
+    next unless RUBY_PLATFORM == "java"
 
     env = command.environment
 
-    jruby_opts = env['JRUBY_OPTS'] || ''
+    jruby_opts = env["JRUBY_OPTS"] || ""
 
     # disable JIT since these processes are so short lived
-    jruby_opts = "-X-C #{jruby_opts}" unless jruby_opts.include? '-X-C'
+    jruby_opts = "-X-C #{jruby_opts}" unless jruby_opts.include? "-X-C"
 
     # Faster startup for jruby
-    jruby_opts = "--dev #{jruby_opts}" unless jruby_opts.include? '--dev'
+    jruby_opts = "--dev #{jruby_opts}" unless jruby_opts.include? "--dev"
 
-    env['JRUBY_OPTS'] = jruby_opts
+    env["JRUBY_OPTS"] = jruby_opts
 
-    if /solaris|sunos/i.match?(RbConfig::CONFIG['host_os'])
-      java_opts = env['JAVA_OPTS'] || ''
+    if /solaris|sunos/i.match?(RbConfig::CONFIG["host_os"])
+      java_opts = env["JAVA_OPTS"] || ""
 
       # force jRuby to use client JVM for faster startup times
-      env['JAVA_OPTS'] = "-d32 #{java_opts}" unless java_opts.include?('-d32')
+      env["JAVA_OPTS"] = "-d32 #{java_opts}" unless java_opts.include?("-d32")
     end
   end
 end

data/lib/aruba/config_wrapper.rb

@@ -30,7 +30,7 @@ module Aruba
     # If one method ends with "=", e.g. ":option1=", then notify the event
     # queue, that the user changes the value of "option1"
     def method_missing(name, *args, &block)
-      notify(name, args) if name.to_s.end_with?('=')
+      notify(name, args) if name.to_s.end_with?("=")
 
       return config.send(name, *args, &block) if config.respond_to? name
 
@@ -63,7 +63,7 @@ module Aruba
       event_bus.notify(
         Events::ChangedConfiguration.new(
           changed: {
-            name: name.to_s.gsub(/=$/, ''),
+            name: name.to_s.gsub(/=$/, ""),
             value: args.first
           }
         )