aruba 1.0.0 → 1.1.0

data/lib/aruba/api/environment.rb

@@ -1,4 +1,4 @@
-require 'aruba/platform'
+require "aruba/platform"
 
 # Aruba
 module Aruba
@@ -23,7 +23,9 @@ module Aruba
         aruba.environment[name] = value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::AddedEnvironmentVariable.new(environment_change)
 
         self
@@ -46,7 +48,9 @@ module Aruba
         aruba.environment.append name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
@@ -69,7 +73,9 @@ module Aruba
         aruba.environment.prepend name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
@@ -88,7 +94,9 @@ module Aruba
         aruba.environment.delete name
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: '' } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               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
@@ -92,7 +91,7 @@ module Aruba
       # @return [Dir]
       #   The directory object
       def directory(path)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
 
         Dir.new(expand_path(path))
       end
@@ -102,22 +101,31 @@ module Aruba
       # @return [Array]
       #   The content of directory
       def list(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
-        fail ArgumentError, %(Only directories are supported. Path "#{name}" is not a directory.) unless directory? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
 
-        existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
-        current_working_directory = Pathname.new(expand_path('.'))
+        unless directory? name
+          raise ArgumentError,
+                %(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.map { |d| Pathname.new(d).relative_path_from(current_working_directory).to_s }
+        existing_files.map do |d|
+          Pathname.new(d).relative_path_from(current_working_directory).to_s
+        end
       end
 
       # Return content of file
       #
       # @return [Array]
-      #   The content of file, without "\n" or "\r\n" at the end. To rebuild the file use `content.join("\n")`
+      #   The content of file, without "\n" or "\r\n" at the end.
+      #   To rebuild the file use `content.join("\n")`
       def read(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
-        fail ArgumentError, %(Only files are supported. Path "#{name}" is not a file.) unless file? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        unless file? name
+          raise ArgumentError, %(Only files are supported. Path "#{name}" is not a file.)
+        end
 
         File.readlines(expand_path(name)).map(&:chomp)
       end
@@ -145,7 +153,7 @@ module Aruba
       def touch(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
@@ -168,9 +176,6 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # def copy(*source, destination)
       def copy(*args)
         args = args.flatten
         destination = args.pop
@@ -181,11 +186,12 @@ module Aruba
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         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) }
@@ -202,7 +208,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Move a file and/or directory
       #
@@ -214,20 +219,20 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       def move(*args)
         args = args.flatten
         destination = args.pop
         source = args
 
         source.each do |s|
-          raise ArgumentError, "Using a fixture as source (#{source}) is not supported" if s.start_with? aruba.config.fixtures_path_prefix
+          if s.start_with? aruba.config.fixtures_path_prefix
+            raise ArgumentError, "Using a fixture as source (#{source}) is not supported"
+          end
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         end
 
         source.each do |s|
@@ -235,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) }
@@ -252,8 +257,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Create a file with the given size
       #
@@ -285,21 +288,21 @@ 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
       def chmod(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
                   end
 
         mode = args.shift
-        mode = if mode.kind_of? String
+        mode = if mode.is_a? String
                  mode.to_i(8)
                else
                  mode
@@ -323,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
@@ -344,7 +374,7 @@ module Aruba
       def remove(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}

data/lib/aruba/api/text.rb

@@ -14,7 +14,14 @@ module Aruba
       # @param [#to_s] text
       #   Input
       def unescape_text(text)
-        text.gsub('\n', "\n").gsub('\"', '"').gsub('\e', "\e").gsub('\033', "\e").gsub('\016', "\016").gsub('\017', "\017").gsub('\t', "\t")
+        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
@@ -22,7 +29,10 @@ module Aruba
       # @param [#to_s] text
       #   Input
       def extract_text(text)
-        text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '').gsub(/\\\[|\\\]/, '').gsub(/\007|\016|\017/, '')
+        text
+          .gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, "")
+          .gsub(/\\\[|\\\]/, "")
+          .gsub(/\007|\016|\017/, "")
       end
 
       # Unescape special characters and remove ANSI characters
@@ -41,7 +51,9 @@ module Aruba
       # @param [#to_s] text
       #   The text to parse
       def replace_variables(text)
-        text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s) 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
 
         text
       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]
-
-        fail ArgumentError, 'Either use block or default value' if block_given? && default
-        fail 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,31 +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]
-
-        fail ArgumentError, 'Either use block or default value' if block_given? && default
-        # fail ArgumentError, 'Either use block or default value' if !block_given? && default.nil? && default.to_s.empty?
-        fail 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
@@ -91,8 +74,6 @@ module Aruba
     attr_accessor :local_options
     attr_writer :hooks
 
-    # attr_reader :hooks
-
     public
 
     # Create configuration
@@ -121,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
@@ -210,7 +191,7 @@ module Aruba
     end
 
     def find_option(name)
-      fail NotImplementedError, %(Unknown option "#{name}") unless option? name
+      raise NotImplementedError, %(Unknown option "#{name}") unless option? name
 
       local_options[name]
     end