aruba 0.8.1 → 0.9.0.pre

data/lib/aruba/api/filesystem.rb

@@ -1,11 +1,15 @@
 require 'aruba/platform'
+
 require 'aruba/extensions/string/strip'
-require 'aruba/creators/aruba_file_creator'
-require 'aruba/creators/aruba_fixed_size_file_creator'
 
-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__)
+require 'aruba/platforms/aruba_file_creator'
+require 'aruba/platforms/aruba_fixed_size_file_creator'
+require 'aruba/disk_usage_calculator'
+require 'aruba/aruba_path'
+
+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__)
 
 module Aruba
   module Api
@@ -15,7 +19,7 @@ module Aruba
       # @param [String] file_or_directory
       #   The file/directory which should exist
       def exist?(file_or_directory)
-        Aruba::Platform.exist? expand_path(file_or_directory)
+        Aruba.platform.exist? expand_path(file_or_directory)
       end
 
       # Check if file exist and is file
@@ -23,7 +27,7 @@ module Aruba
       # @param [String] file
       #   The file/directory which should exist
       def file?(file)
-        Aruba::Platform.file? expand_path(file)
+        Aruba.platform.file? expand_path(file)
       end
 
       # Check if directory exist and is directory
@@ -31,7 +35,7 @@ module Aruba
       # @param [String] file
       #   The file/directory which should exist
       def directory?(file)
-        Aruba::Platform.directory? expand_path(file)
+        Aruba.platform.directory? expand_path(file)
       end
 
       # Check if path is absolute
@@ -140,7 +144,7 @@ module Aruba
 
         args.each { |p| create_directory(File.dirname(p)) }
 
-        Aruba::Platform.touch(args.map { |p| expand_path(p) }, options)
+        Aruba.platform.touch(args.map { |p| expand_path(p) }, options)
 
         self
       end
@@ -174,13 +178,13 @@ module Aruba
         destination_path = expand_path(destination)
 
         if source_paths.count > 1
-          Aruba::Platform.mkdir(destination_path)
+          Aruba.platform.mkdir(destination_path)
         else
-          Aruba::Platform.mkdir(File.dirname(destination_path))
+          Aruba.platform.mkdir(File.dirname(destination_path))
           source_paths = source_paths.first
         end
 
-        Aruba::Platform.cp source_paths, destination_path
+        Aruba.platform.cp source_paths, destination_path
 
         self
       end
@@ -239,7 +243,7 @@ module Aruba
         args.each { |p| raise "Expected #{p} to be present" unless exist?(p) }
         paths = args.map { |p| expand_path(p) }
 
-        Aruba::Platform.chmod(mode, paths, options)
+        Aruba.platform.chmod(mode, paths, options)
 
         self
       end
@@ -254,7 +258,7 @@ module Aruba
       def append_to_file(file_name, file_content)
         file_name = expand_path(file_name)
 
-        Aruba::Platform.mkdir(File.dirname(file_name))
+        Aruba.platform.mkdir(File.dirname(file_name))
         File.open(file_name, 'a') { |f| f << file_content }
       end
 
@@ -263,7 +267,7 @@ module Aruba
       # @param [String] directory_name
       #   The name of the directory which should be created
       def create_directory(directory_name)
-        Aruba::Platform.mkdir expand_path(directory_name)
+        Aruba.platform.mkdir expand_path(directory_name)
 
         self
       end
@@ -283,7 +287,7 @@ module Aruba
 
         args = args.map { |p| expand_path(p) }
 
-        Aruba::Platform.rm(args, options)
+        Aruba.platform.rm(args, options)
       end
 
       # Read content of file and yield the content to block
@@ -300,6 +304,27 @@ module Aruba
 
         yield(content)
       end
+
+      # Calculate disk usage for file(s) and/or directories
+      #
+      # It shows the disk usage for a single file/directory. If multiple paths
+      # are given, it sum their size up.
+      #
+      # @param [Array, Path] paths
+      #   The paths
+      #
+      # @result [FileSize]
+      #   Bytes on disk
+      def disk_usage(*paths)
+        size = paths.flatten.map do |p|
+          DiskUsageCalculator.new.calc(
+            ArubaPath.new(expand_path(p)).blocks,
+            aruba.config.physical_block_size
+          )
+        end.inject(0, &:+)
+
+        FileSize.new(size)
+      end
     end
   end
 end

data/lib/aruba/aruba_logger.rb

@@ -0,0 +1,77 @@
+require 'logger'
+
+module Aruba
+  class ArubaLogger
+    attr_reader :mode
+
+    # Create logger
+    #
+    # @param [Logger] logger (::Logger.new( $stderr ))
+    #   The logger with should be used to output data
+    def initialize(opts = {})
+      @mode = opts.fetch(:default_mode, :info)
+    end
+
+    [:fatal, :warn, :debug, :info, :error, :unknown].each do |m|
+      define_method m do |msg|
+        if RUBY_VERSION < '1.9'
+          logger.send m, msg
+        else
+          logger.public_send m, msg
+        end
+      end
+    end
+
+    # Create new logger on every invocation to make
+    # capturing $stderr possible
+    def logger
+      l = ::Logger.new($stderr)
+
+      case mode
+      when :debug
+        l.level = ::Logger::DEBUG
+        format_debug(l)
+      when :silent
+        l.level = 9_999
+      when :info
+        l.level = ::Logger::INFO
+        format_standard(l)
+      else
+        l.level = ::Logger::INFO
+        format_standard(l)
+      end
+
+      l
+    end
+
+    # Is mode?
+    #
+    # @param [String, Symbol] m
+    #   Mode to compare with
+    def mode?(m)
+      mode == m.to_sym
+    end
+
+    # Change mode of logger: :debug, ... + Change the output format
+    #
+    # @param [Symbol] m
+    #   the mode: :debug, ...
+    def mode=(m)
+      @mode = m.to_sym
+    end
+
+    private
+
+    def format_debug(l)
+      l.formatter = proc { |severity, datetime, progname, msg|
+        format("%s %s %s: %s\n", datetime, severity, progname, msg)
+      }
+    end
+
+    def format_standard(l)
+      l.formatter = proc { |severity, datetime, _, msg|
+        format("%s %s: %s\n", datetime, severity, msg)
+      }
+    end
+  end
+end

data/lib/aruba/aruba_path.rb

@@ -1,6 +1,8 @@
 require 'pathname'
 require 'delegate'
 
+require 'aruba/file_size'
+
 module Aruba
   class ArubaPath < Delegator
     def initialize(path)
@@ -60,6 +62,27 @@ module Aruba
       end
     end
 
+    # How many parts has the file name
+    #
+    # @return [Integer]
+    #   The count of file name parts
+    #
+    # @example
+    #
+    # path = ArubaPath.new('path/to/file.txt')
+    # path.depth # => 3
+    #
+    def depth
+      if RUBY_VERSION < '1.9'
+        items = []
+        __getobj__.each_filename { |f| items << f }
+
+        items.size
+      else
+        __getobj__.each_filename.to_a.size
+      end
+    end
+
     # Path ends with string
     #
     # @param [String] string
@@ -86,5 +109,15 @@ module Aruba
         to_s[index]
       end
     end
+
+    # Report count of blocks allocated on disk
+    #
+    # This reports the amount of blocks which are allocated by the path.
+    #
+    # @return [Integer]
+    #   The count of blocks on disk
+    def blocks
+      File::Stat.new(to_s).blocks
+    end
   end
 end

data/lib/aruba/basic_configuration.rb

@@ -94,7 +94,7 @@ module Aruba
     # Get access to hooks
     def hooks
       # rubocop:disable Metrics/LineLength
-      Aruba::Platform.deprecated 'The use of the "#aruba.config.hooks" is deprecated. Please use "#aruba.config.before(:name) {}" to define and "#aruba.config.before(:name, *args)" to run a hook. This method will become private in the next major version.'
+      Aruba.platform.deprecated 'The use of the "#aruba.config.hooks" is deprecated. Please use "#aruba.config.before(:name) {}" to define and "#aruba.config.before(:name, *args)" to run a hook. This method will become private in the next major version.'
       # rubocop:enable Metrics/LineLength
 
       @hooks
@@ -102,7 +102,7 @@ module Aruba
 
     # @deprecated
     def before_cmd(&block)
-      Aruba::Platform.deprecated 'The use of the "#before_cmd"-hook is deprecated. Please define with "#before(:command) {}" instead'
+      Aruba.platform.deprecated 'The use of the "#before_cmd"-hook is deprecated. Please define with "#before(:command) {}" instead'
 
       before(:command, &block)
     end

data/lib/aruba/cli.rb

@@ -0,0 +1,11 @@
+require 'thor'
+require 'aruba/console'
+
+module Aruba
+  class Cli < Thor
+    desc 'console', "Start aruba's console"
+    def console
+      Aruba::Console.new.start
+    end
+  end
+end

data/lib/aruba/config.rb

@@ -4,10 +4,12 @@ require 'aruba/version'
 require 'aruba/basic_configuration'
 require 'aruba/config_wrapper'
 require 'aruba/hooks'
+
 require 'aruba/contracts/relative_path'
 require 'aruba/contracts/absolute_path'
 require 'aruba/contracts/enum'
-require 'aruba/contracts/is_a'
+
+require 'aruba/contracts/is_power_of_two'
 
 module Aruba
   # Aruba Configuration
@@ -29,15 +31,16 @@ module Aruba
     option_accessor :exit_timeout, :contract => { Num => Num }, :default => 15
     option_accessor :io_wait_timeout, :contract => { Num => Num }, :default => 0.1
     option_accessor :fixtures_directories, :contract => { Array => ArrayOf[String] }, :default => %w(features/fixtures spec/fixtures test/fixtures)
-    option_accessor :command_runtime_environment, :contract => { Hash => Hash }, :default => ENV.to_hash
+    option_accessor :command_runtime_environment, :contract => { Hash => Hash }, :default => ENV.to_hash.dup
     # rubocop:disable Metrics/LineLength
     option_accessor(:command_search_paths, :contract => { ArrayOf[String] => ArrayOf[String] }) { |config| [File.join(config.root_directory.value, 'bin')] }
     # rubocop:enable Metrics/LineLength
     option_accessor :keep_ansi, :contract => { Bool => Bool }, :default => false
+    option_accessor :remove_ansi_escape_sequences, :contract => { Bool => Bool }, :default => true
     # rubocop:disable Metrics/LineLength
     option_accessor :command_launcher, :contract => { Aruba::Contracts::Enum[:in_process, :spawn, :debug] => Aruba::Contracts::Enum[:in_process, :spawn, :debug] }, :default => :spawn
     # rubocop:enable Metrics/LineLength
-    option_accessor :main_class, :contract => { Aruba::Contracts::IsA[Class] => Or[Aruba::Contracts::IsA[Class], Eq[nil]] }, :default => nil
+    option_accessor :main_class, :contract => { Class => Maybe[Class] }, :default => nil
     # rubocop:disable Metrics/LineLength
 
     # rubocop:disable Metrics/LineLength
@@ -49,6 +52,13 @@ module Aruba
       option_accessor :home_directory, :contract => { Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath] => Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath] }, :default => ENV['HOME']
     end
     # rubocop:enable Metrics/LineLength
+
+    # rubocop:disable Metrics/LineLength
+    option_accessor :log_level, :contract => { Aruba::Contracts::Enum[:fatal, :warn, :debug, :info, :error, :unknown, :silent] => Aruba::Contracts::Enum[:fatal, :warn, :debug, :info, :error, :unknown, :silent] }, :default => :info
+    # rubocop:enable Metrics/LineLength
+
+    option_accessor :physical_block_size, :contract => { Aruba::Contracts::IsPowerOfTwo => Aruba::Contracts::IsPowerOfTwo }, :default => 512
+    option_accessor :console_history_file, :contract => { String => String }, :default => '~/.aruba_history'
   end
 end
 

data/lib/aruba/config/jruby.rb

@@ -6,9 +6,12 @@ Aruba.configure do |config|
     next unless RUBY_PLATFORM == 'java'
 
     # disable JIT since these processes are so short lived
-    ENV['JRUBY_OPTS'] = "-X-C #{ENV['JRUBY_OPTS']}"
+    ENV['JRUBY_OPTS'] = "-X-C #{ENV['JRUBY_OPTS']}" unless ENV['JRUBY_OPTS'].include? '-X-C'
+
+    # Faster startup for jruby
+    ENV['JRUBY_OPTS'] = "--dev #{ENV['JRUBY_OPTS']}"  unless ENV['JRUBY_OPTS'].include? '--dev'
 
     # force jRuby to use client JVM for faster startup times
-    ENV['JAVA_OPTS'] = "-d32 #{ENV['JAVA_OPTS']}" if RbConfig::CONFIG['host_os'] =~ /solaris|sunos/i
+    ENV['JAVA_OPTS'] = "-d32 #{ENV['JAVA_OPTS']}" if RbConfig::CONFIG['host_os'] =~ /solaris|sunos/i && !ENV['JAVA_OPTS'].include?('-d32')
   end
 end

data/lib/aruba/console.rb

@@ -0,0 +1,66 @@
+require 'irb'
+
+require 'aruba/api'
+require 'aruba/console/help'
+
+module Aruba
+  class Console
+    # rubocop:disable Metrics/MethodLength
+    def start
+      # Start IRB with current context:
+      # http://stackoverflow.com/questions/4189818/how-to-run-irb-start-in-context-of-current-class
+      ARGV.clear
+      IRB.setup nil
+
+      IRB.conf[:PROMPT] = {}
+      IRB.conf[:IRB_NAME] = 'aruba'
+      IRB.conf[:PROMPT][:ARUBA] = {
+        :PROMPT_I => '%N:%03n:%i> ',
+        :PROMPT_N => '%N:%03n:%i> ',
+        :PROMPT_S => '%N:%03n:%i%l ',
+        :PROMPT_C => '%N:%03n:%i* ',
+        :RETURN => "# => %s\n"
+      }
+      IRB.conf[:PROMPT_MODE] = :ARUBA
+
+      IRB.conf[:RC] = false
+
+      require 'irb/completion'
+      require 'irb/ext/save-history'
+      IRB.conf[:READLINE] = true
+      IRB.conf[:SAVE_HISTORY] = 1000
+      IRB.conf[:HISTORY_FILE] = Aruba.config.console_history_file
+
+      # rubocop:disable Lint/NestedMethodDefinition
+      context = Class.new do
+        include Aruba::Api
+        include Aruba::Console::Help
+
+        def initialize
+          setup_aruba
+        end
+
+        def inspect
+          'nil'
+        end
+      end
+      # rubocop:enable Lint/NestedMethodDefinition
+
+      irb = IRB::Irb.new(IRB::WorkSpace.new(context.new))
+      IRB.conf[:MAIN_CONTEXT] = irb.context
+
+      trap("SIGINT") do
+        IRB.irb.signal_handle
+      end
+
+      begin
+        catch(:IRB_EXIT) do
+          irb.eval_input
+        end
+      ensure
+        IRB.irb_at_exit
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/aruba/console/help.rb

@@ -0,0 +1,33 @@
+require 'aruba/api'
+
+module Aruba
+  class Console
+    # Helpers for Aruba::Console
+    module Help
+      # Output help information
+      def aruba_help
+        puts 'Aruba Version: ' + Aruba::VERSION
+        puts 'Issue Tracker: ' + 'https://github.com/cucumber/aruba/issues'
+        puts "Documentation:\n" + %w(http://www.rubydoc.info/gems/aruba).map { |d| format('* %s', d) }.join("\n")
+        puts
+
+        nil
+      end
+
+      # List available methods in aruba
+      def aruba_methods
+        ms = if RUBY_VERSION < '1.9'
+               # rubocop:disable Style/EachWithObject
+               (Aruba::Api.instance_methods - Module.instance_methods).inject([]) { |a, e| a << format("* %s", e); a }.sort
+               # rubocop:enable Style/EachWithObject
+             else
+               (Aruba::Api.instance_methods - Module.instance_methods).each_with_object([]) { |e, a| a << format("* %s", e) }.sort
+             end
+
+        puts "Available Methods:\n" + ms.join("\n")
+
+        nil
+      end
+    end
+  end
+end