aruba 0.8.1 → 0.9.0.pre

data/lib/aruba/contracts/is_power_of_two.rb

@@ -0,0 +1,15 @@
+require 'aruba/aruba_path'
+
+module Aruba
+  module Contracts
+    class IsPowerOfTwo
+      def self.valid?(x)
+        # explanation for algorithm can be found here:
+        # http://www.exploringbinary.com/ten-ways-to-check-if-an-integer-is-a-power-of-two-in-c/
+        x != 0 && (x & (x - 1)) == 0 ? true : false
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/aruba/cucumber.rb

@@ -66,7 +66,7 @@ Given /^a mocked home directory$/ do
 end
 
 Given /^(?:a|the) directory(?: named)? "([^"]*)" does not exist$/ do |directory_name|
-  remove_directory(directory_name, :force => true)
+  remove(directory_name, :force => true)
 end
 
 When /^I write to "([^"]*)" with:$/ do |file_name, file_content|
@@ -86,15 +86,15 @@ When /^I append to "([^"]*)" with "([^"]*)"$/ do |file_name, file_content|
 end
 
 When /^I remove (?:a|the) file(?: named)? "([^"]*)"$/ do |file_name|
-  remove_file(file_name)
+  remove(file_name)
 end
 
 Given /^(?:a|the) file(?: named)? "([^"]*)" does not exist$/ do |file_name|
-  remove_file(file_name, :force => true)
+  remove(file_name, :force => true)
 end
 
 When(/^I remove (?:a|the) directory(?: named)? "(.*?)"$/) do |directory_name|
-  remove_directory(directory_name)
+  remove(directory_name)
 end
 
 When /^I cd to "([^"]*)"$/ do |dir|
@@ -121,22 +121,36 @@ end
 
 When /^I run "(.*)"$/ do |cmd|
   warn(%{\e[35m    The /^I run "(.*)"$/ step definition is deprecated. Please use the `backticks` version\e[0m})
-  run_simple(Aruba::Platform.unescape(cmd, aruba.config.keep_ansi), false)
+
+  cmd = unescape_text(cmd)
+  cmd = extract_text(cmd) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+
+  run_simple(cmd, false)
 end
 
 When /^I run `([^`]*)`$/ do |cmd|
-  run_simple(Aruba::Platform.unescape(cmd, aruba.config.keep_ansi), false)
+  cmd = unescape_text(cmd)
+  cmd = extract_text(cmd) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+
+  run_simple(cmd, false)
 end
 
 When /^I successfully run "(.*)"$/ do |cmd|
   warn(%{\e[35m    The  /^I successfully run "(.*)"$/ step definition is deprecated. Please use the `backticks` version\e[0m})
-  run_simple(Aruba::Platform.unescape(cmd, aruba.config.keep_ansi))
+
+  cmd = unescape_text(cmd)
+  cmd = extract_text(cmd) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+
+  run_simple(cmd)
 end
 
 ## I successfully run `echo -n "Hello"`
 ## I successfully run `sleep 29` for up to 30 seconds
 When /^I successfully run `(.*?)`(?: for up to (\d+) seconds)?$/ do |cmd, secs|
-  run_simple(Aruba::Platform.unescape(cmd, aruba.config.keep_ansi), true, secs && secs.to_i)
+  cmd = unescape_text(cmd)
+  cmd = extract_text(cmd) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+
+  run_simple(cmd, true, secs && secs.to_i)
 end
 
 When /^I run "([^"]*)" interactively$/ do |cmd|
@@ -145,11 +159,14 @@ When /^I run "([^"]*)" interactively$/ do |cmd|
 end
 
 When /^I run `([^`]*)` interactively$/ do |cmd|
-  @interactive = run(Aruba::Platform.unescape(cmd, aruba.config.keep_ansi))
+  cmd = unescape_text(cmd)
+  cmd = extract_text(cmd) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+
+  @interactive = run(cmd)
 end
 
 When /^I type "([^"]*)"$/ do |input|
-  type(input)
+  type(unescape_text(input))
 end
 
 When /^I close the stdin stream$/ do

data/lib/aruba/cucumber/hooks.rb

@@ -6,9 +6,9 @@ if Aruba::VERSION >= '1.0.0'
   Around do |_, block|
     begin
       if RUBY_VERSION < '1.9'
-        old_env = ENV.to_hash
+        old_env = ENV.to_hash.dup
       else
-        old_env = ENV.to_h
+        old_env = ENV.to_h.dup
       end
 
       block.call
@@ -47,7 +47,7 @@ Before('@announce-command') do
 end
 
 Before('@announce-cmd') do
-  Aruba::Platform.deprecated 'The use of "@announce-cmd"-hook is deprecated. Please use "@announce-command"'
+  Aruba.platform.deprecated 'The use of "@announce-cmd"-hook is deprecated. Please use "@announce-command"'
 
   announcer.activate :command
 end
@@ -61,7 +61,7 @@ Before('@announce-stderr') do
 end
 
 Before('@announce-dir') do
-  Aruba::Platform.deprecated 'The use of "@announce-dir"-hook is deprecated. Please use "@announce-directory"'
+  Aruba.platform.deprecated 'The use of "@announce-dir"-hook is deprecated. Please use "@announce-directory"'
 
   announcer.activate :directory
 end
@@ -71,13 +71,13 @@ Before('@announce-directory') do
 end
 
 Before('@announce-env') do
-  Aruba::Platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-modified-environment"'
+  Aruba.platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-modified-environment"'
 
   announcer.activate :environment
 end
 
 Before('@announce-environment') do
-  Aruba::Platform.deprecated '@announce-environment is deprecated. Use @announce-modified-environment instead'
+  Aruba.platform.deprecated '@announce-environment is deprecated. Use @announce-modified-environment instead'
 
   announcer.activate :modified_environment
 end
@@ -100,6 +100,7 @@ Before('@announce') do
   announcer.activate :stderr
   announcer.activate :directory
   announcer.activate :modified_environment
+  announcer.activate :full_environment
   announcer.activate :environment
   announcer.activate :timeout
 end
@@ -113,11 +114,17 @@ end
 # end
 
 Before('@ansi') do
-  @aruba_keep_ansi = true
+  Aruba.platform.deprecated('The use of "@ansi" is deprecated. Use "@keep-ansi-escape-sequences" instead')
+
+  aruba.config.remove_ansi_escape_sequences = false
+end
+
+Before('@keep-ansi-escape-sequences') do
+  aruba.config.remove_ansi_escape_sequences = false
 end
 
 Before '@mocked_home_directory' do
-  Aruba::Platform.deprecated('The use of "@mocked_home_directory" is deprecated. Use "@mocked-home-directory" instead')
+  Aruba.platform.deprecated('The use of "@mocked_home_directory" is deprecated. Use "@mocked-home-directory" instead')
 
   set_environment_variable 'HOME', expand_path('.')
 end

data/lib/aruba/disk_usage_calculator.rb

@@ -0,0 +1,7 @@
+module Aruba
+  class DiskUsageCalculator
+    def calc(blocks, block_size)
+      FileSize.new(blocks * block_size)
+    end
+  end
+end

data/lib/aruba/file_size.rb

@@ -0,0 +1,52 @@
+require 'delegate'
+
+module Aruba
+  class FileSize
+    include Comparable
+
+    private
+
+    attr_reader :bytes, :divisor
+
+    public
+
+    def initialize(bytes)
+      @bytes   = bytes
+      @divisor = 1024
+    end
+
+    def to_byte
+      bytes
+    end
+    alias_method :to_i, :to_byte
+
+    def to_f
+      to_i.to_f
+    end
+
+    def to_s
+      to_i.to_s
+    end
+    alias_method :inspect, :to_s
+
+    def coerce(other)
+      [bytes, other]
+    end
+
+    def to_kibi_byte
+      to_byte.to_f / divisor
+    end
+
+    def to_mebi_byte
+      to_kibi_byte.to_f / divisor
+    end
+
+    def to_gibi_byte
+      to_mebi_byte.to_f / divisor
+    end
+
+    def <=>(other)
+      to_i <=> other.to_i
+    end
+  end
+end

data/lib/aruba/in_process.rb

@@ -4,7 +4,7 @@ require 'aruba/platform'
 module Aruba
   class InProcess < Aruba::Processes::InProcess
     def initialize(*args)
-      Aruba::Platform.deprecated('The use of "Aruba::InProcess" is deprecated. Use "Aruba::Processes::InProcess" instead.')
+      Aruba.platform.deprecated('The use of "Aruba::InProcess" is deprecated. Use "Aruba::Processes::InProcess" instead.')
 
       super
     end

data/lib/aruba/jruby.rb

@@ -1,4 +1,4 @@
 require 'aruba/platform'
-Aruba::Platform.deprecated('The use of "aruba/jruby" is deprecated. Use "aruba/config/jruby" instead')
+Aruba.platform.deprecated('The use of "aruba/jruby" is deprecated. Use "aruba/config/jruby" instead')
 
 require 'aruba/config/jruby'

data/lib/aruba/matchers/command.rb

@@ -1 +1 @@
-Aruba::Platform.require_matching_files('../command/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files('../command/**/*.rb', __FILE__)

data/lib/aruba/matchers/directory.rb

@@ -1 +1 @@
-Aruba::Platform.require_matching_files('../directory/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files('../directory/**/*.rb', __FILE__)

data/lib/aruba/matchers/environment.rb

@@ -1 +1 @@
-Aruba::Platform.require_matching_files('../matchers/environment/*.rb', __FILE__)
+Aruba.platform.require_matching_files('../matchers/environment/*.rb', __FILE__)

data/lib/aruba/matchers/file.rb

@@ -1 +1 @@
-Aruba::Platform.require_matching_files('../file/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files('../file/**/*.rb', __FILE__)

data/lib/aruba/matchers/path.rb

@@ -1 +1 @@
-Aruba::Platform.require_matching_files('../path/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files('../path/**/*.rb', __FILE__)

data/lib/aruba/matchers/path/match_path_pattern.rb

@@ -24,7 +24,7 @@
 #     end
 RSpec::Matchers.define :match_path_pattern do |_|
   match do |actual|
-    Aruba::Platform.deprecated('The use of `expect().to match_path_pattern` is deprecated. Please use `expect().to include pattern /regex/` instead.')
+    Aruba.platform.deprecated('The use of `expect().to match_path_pattern` is deprecated. Please use `expect().to include pattern /regex/` instead.')
 
     next  !actual.select { |a| a == expected }.empty? if expected.is_a? String
 

data/lib/aruba/matchers/rspec_matcher_include_regexp.rb

@@ -18,7 +18,7 @@
 #     end
 RSpec::Matchers.define :include_regexp do |expected|
   match do |actual|
-    Aruba::Platform.deprecated('The use of "include_regexp"-matchers is deprecated. It will be removed soon.')
+    Aruba.platform.deprecated('The use of "include_regexp"-matchers is deprecated. It will be removed soon.')
 
     !actual.grep(expected).empty?
   end

data/lib/aruba/platform.rb

@@ -1,249 +1,21 @@
-require 'rbconfig'
-require 'pathname'
+require 'thread'
+require 'aruba/platforms/unix_platform'
+require 'aruba/platforms/windows_platform'
 
 module Aruba
-  # WARNING:
-  # All methods found here are not considered part of the public API of aruba.
-  #
-  # Those methods can be changed at any time in the feature or removed without
-  # any further notice.
-  module Platform
-    def detect_ruby(cmd)
-      if cmd =~ /^ruby\s/
-        cmd.gsub(/^ruby\s/, "#{current_ruby} ")
-      else
-        cmd
-      end
-    end
-
-    def deprecated(msg)
-      warn(format('%s. Called by %s', msg, caller[1]))
-    end
-
-    def current_ruby
-      ::File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-    end
-
-    # @deprecated
-    # Add newline at the end
-    def ensure_newline(str)
-      deprecated('The use of "#ensure_newline" is deprecated. It will be removed soon')
-
-      str.chomp << "\n"
-    end
-
-    def require_matching_files(pattern, base)
-      if RUBY_VERSION < '1.9.'
-        ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-      else
-        ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require_relative f }
-      end
-    end
-
-    # Create directory and subdirectories
-    def mkdir(dir_name)
-      dir_name = ::File.expand_path(dir_name)
-
-      ::FileUtils.mkdir_p(dir_name) unless ::File.directory?(dir_name)
-    end
-
-    # Remove file, directory + sub-directories
-    def rm(paths, options = {})
-      paths = Array(paths).map { |p| ::File.expand_path(p) }
-
-      FileUtils.rm_r(paths, options)
-    end
-
-    # Get current working directory
-    def getwd
-      Dir.getwd
-    end
-
-    # Change to directory
-    def chdir(dir_name, &block)
-      dir_name = ::File.expand_path(dir_name.to_s)
-
-      begin
-        if RUBY_VERSION <= '1.9.3'
-          old_env = ENV.to_hash
-        else
-          old_env = ENV.to_h
-        end
-
-        ENV['OLDPWD'] = getwd
-        ENV['PWD'] = dir_name
-        ::Dir.chdir(dir_name, &block)
-      ensure
-        ENV.clear
-        ENV.update old_env
-      end
-    end
-
-    # Touch file, directory
-    def touch(args, options)
-      FileUtils.touch(args, options)
-    end
-
-    # Copy file/directory
-    def cp(args, options)
-      FileUtils.cp_r(args, options)
-    end
-
-    # Change mode of file/directory
-    def chmod(mode, args, options)
-      FileUtils.chmod_R(mode, args, options)
-    end
-
-    # Exists and is file
-    def file?(f)
-      File.file? f
-    end
-
-    # Exists and is directory
-    def directory?(f)
-      File.directory? f
-    end
-
-    # Path Exists
-    def exist?(f)
-      File.exist? f
-    end
-
-    # Path is executable
-    def executable_file?(f)
-      File.file?(f) && File.executable?(f)
-    end
-
-    # Expand path
-    def expand_path(path, base)
-      File.expand_path(path, base)
-    end
-
-    def absolute_path?(path)
-      Pathname.new(path).absolute?
-    end
-
-    # Check if command is relative
-    #
-    # @return [TrueClass, FalseClass]
-    #   true
-    #     * bin/command.sh
-    #
-    #   false
-    #     * /bin/command.sh
-    #     * command.sh
-    def relative_command?(path)
-      p = Pathname.new(path)
-      p.relative? && p.basename != p
-    end
-
-    # Write to file
-    def write_file(path, content)
-      if RUBY_VERSION < '1.9'
-        File.open(path, 'wb') do |f|
-          f.print content
-        end
-      else
-        File.write(path, content)
-      end
-    end
-
-    # Unescape string
-    #
-    # @param [String] string
-    #   The string which should be unescaped, e.g. the output of a command
-    #
-    # @return
-    #   The string stripped from escape sequences
-    def unescape(string, keep_ansi = true)
-      string = string.gsub('\n', "\n").gsub('\"', '"').gsub('\e', "\e")
-      string = string.gsub(/\e\[\d+(?>(;\d+)*)m/, '') unless keep_ansi
-      string
-    end
-
-    # Resolve path for command using the PATH-environment variable
-    #
-    # Mostly taken from here: https://github.com/djberg96/ptools
-    #
-    # @param [#to_s] program
-    #   The name of the program which should be resolved
-    #
-    # @param [String] path
-    #   The PATH, a string concatenated with ":", e.g. /usr/bin/:/bin on a
-    #   UNIX-system
-    #
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def which(program, path = ENV['PATH'])
-      on_windows = false
-      on_windows = true if File::ALT_SEPARATOR
-
-      program = program.to_s
-
-      path_exts = ENV['PATHEXT'] ? ('.{' + ENV['PATHEXT'].tr(';', ',').tr('.','') + '}').downcase : '.{exe,com,bat}' if on_windows
-
-      raise ArgumentError, "ENV['PATH'] cannot be empty" if path.nil? || path.empty?
-
-      # Bail out early if an absolute path is provided or the command path is relative
-      # Examples: /usr/bin/command or bin/command.sh
-      if Aruba::Platform.absolute_path?(program) || Aruba::Platform.relative_command?(program)
-        program += path_exts if on_windows && File.extname(program).empty?
-
-        found = Dir[program].first
-
-        return File.expand_path(found) if found && Aruba::Platform.executable_file?(found)
-        return nil
-      end
-
-      # Iterate over each path glob the dir + program.
-      path.split(File::PATH_SEPARATOR).each do |dir|
-        dir = Aruba::Platform.expand_path(dir, Dir.getwd)
-
-        next unless Aruba::Platform.exist?(dir) # In case of bogus second argument
-        file = File.join(dir, program)
-
-        # Dir[] doesn't handle backslashes properly, so convert them. Also, if
-        # the program name doesn't have an extension, try them all.
-        if on_windows
-          file = file.tr("\\", "/")
-          file += path_exts if File.extname(program).empty?
-        end
-
-        found = Dir[file].first
+  PLATFORM_MUTEX = Mutex.new
+end
 
-        # Convert all forward slashes to backslashes if supported
-        if found && Aruba::Platform.executable_file?(found)
-          found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if on_windows
-          return found
-        end
-      end
+module Aruba
+  Platform = [Platforms::WindowsPlatform, Platforms::UnixPlatform].find(&:match?)
+end
 
-      nil
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
+module Aruba
+  PLATFORM_MUTEX.synchronize do
+    @platform = Platform.new
+  end
 
-    module_function :detect_ruby, \
-      :current_ruby, \
-      :ensure_newline, \
-      :require_matching_files, \
-      :mkdir, \
-      :rm, \
-      :chdir, \
-      :deprecated, \
-      :touch, \
-      :cp, \
-      :chmod, \
-      :file?, \
-      :directory?, \
-      :exist?, \
-      :expand_path, \
-      :absolute_path?, \
-      :relative_command?, \
-      :executable_file?, \
-      :unescape, \
-      :getwd, \
-      :which, \
-      :write_file
+  class << self
+    attr_reader :platform
   end
 end