aruba 1.0.0.pre.alpha.2 → 1.0.1

data/lib/aruba/api/environment.rb

@@ -13,6 +13,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def set_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -21,7 +23,10 @@ module Aruba
         aruba.environment[name] = value
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::AddedEnvironmentVariable.new(: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
       end
@@ -33,6 +38,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def append_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -41,7 +48,10 @@ module Aruba
         aruba.environment.append name, value
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(: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
       end
@@ -53,6 +63,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def prepend_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -61,18 +73,20 @@ module Aruba
         aruba.environment.prepend name, value
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(: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
       end
 
       # Remove existing environment variable
       #
-      # @param [String] key
+      # @param [String] name
       #   The name of the environment variable as string, e.g. 'HOME'
       #
-      # @param [String] value
-      #   The value of the environment variable. Needs to be a string.
+      # @return [self]
       def delete_environment_variable(name)
         name = name.to_s
 
@@ -80,7 +94,10 @@ module Aruba
         aruba.environment.delete name
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::DeletedEnvironmentVariable.new(: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
       end

data/lib/aruba/api/filesystem.rb

@@ -1,9 +1,8 @@
-require 'aruba/platform'
+require 'pathname'
 
+require 'aruba/platform'
 require 'aruba/extensions/string/strip'
 
-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__)
@@ -40,8 +39,10 @@ module Aruba
 
       # Check if file exist and is executable
       #
-      # @param [String] file
-      #   The file which should exist
+      # @param [String] path
+      #   The path which should exist and be executable
+      #
+      # @return [Boolean]
       def executable?(path)
         path = expand_path(path)
 
@@ -50,18 +51,16 @@ module Aruba
 
       # Check if path is absolute
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def absolute?(path)
-        ArubaPath.new(path).absolute?
+        Aruba.platform.absolute_path?(path)
       end
 
       # Check if path is relative
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def relative?(path)
-        ArubaPath.new(path).relative?
+        Aruba.platform.relative_path?(path)
       end
 
       # Return all existing paths (directories, files) in current dir
@@ -69,7 +68,7 @@ module Aruba
       # @return [Array]
       #   List of files and directories
       def all_paths
-        list('.').map { |p| expand_path(p) }
+        list('.').map { |path| expand_path(path) }
       end
 
       # Return all existing files in current directory
@@ -93,7 +92,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
@@ -103,22 +102,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
+
+        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 = ArubaPath.new(expand_path('.'))
+        current_working_directory = Pathname.new(expand_path('.'))
 
-        existing_files.map { |d| ArubaPath.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
@@ -128,10 +136,10 @@ module Aruba
       # The method does not check if file already exists. If the file name is a
       # path the method will create all neccessary directories.
       #
-      # @param [String] file_name
+      # @param [String] name
       #   The name of the file
       #
-      # @param [String] file_content
+      # @param [String] content
       #   The content which should be written to the file
       def write_file(name, content)
         Aruba.platform.create_file(expand_path(name), content, false)
@@ -146,7 +154,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
                     {}
@@ -169,9 +177,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,8 +186,14 @@ module Aruba
           raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
         end
 
-        raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix
-        raise ArgumentError, "Multiples sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)
+        if destination.start_with? aruba.config.fixtures_path_prefix
+          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'
+        end
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -198,7 +209,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Move a file and/or directory
       #
@@ -210,25 +220,29 @@ 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
 
-        raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix
+        if destination.start_with? aruba.config.fixtures_path_prefix
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
+        end
 
         source.each do |s|
           raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
         end
 
-        raise ArgumentError, "Multiple sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)
+        if source.count > 1 && exist?(destination) && !directory?(destination)
+          raise ArgumentError, 'Multiple sources can only be copied to a directory'
+        end
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -244,18 +258,16 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Create a file with the given size
       #
       # The method does not check if file already exists. If the file name is a
       # path the method will create all neccessary directories.
       #
-      # @param [String] file_name
+      # @param [String] name
       #   The name of the file
       #
-      # @param [Integer] file_size
+      # @param [Integer] size
       #   The size of the file
       def write_fixed_size_file(name, size)
         Aruba.platform.create_fixed_size_file(expand_path(name), size, false)
@@ -284,21 +296,21 @@ module Aruba
       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
                end
 
-        args.each { |p| raise "Expected #{p} to be present" unless exist?(p) }
-        paths = args.map { |p| expand_path(p) }
+        args.each { |path| raise "Expected #{path} to be present" unless exist?(path) }
+        paths = args.map { |path| expand_path(path) }
 
         Aruba.platform.chmod(mode, paths, options)
 
@@ -336,13 +348,13 @@ 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
                     {}
                   end
 
-        args = args.map { |p| expand_path(p) }
+        args = args.map { |path| expand_path(path) }
 
         Aruba.platform.rm(args, options)
       end
@@ -354,7 +366,7 @@ module Aruba
       #
       # @yield
       #   Pass the content of the given file to this block
-      def with_file_content(file, &block)
+      def with_file_content(file)
         expect(file).to be_an_existing_path
 
         content = read(file).join("\n")
@@ -370,31 +382,21 @@ module Aruba
       # @param [Array, Path] paths
       #   The paths
       #
-      # @result [FileSize]
+      # @return [FileSize]
       #   Bytes on disk
-
       def disk_usage(*paths)
-        expect(paths.flatten).to Aruba::Matchers.all be_an_existing_path
-        expanded = paths.flatten.map { |p| ArubaPath.new(expand_path(p)) }
-
-        # TODO: change the API so that you could set something like
-        # aruba.config.fs_allocation_unit_size directly
+        paths = paths.flatten
+        expect(paths).to Aruba::Matchers.all be_an_existing_path
+        expanded = paths.map { |path| expand_path(path) }
 
-        typical_fs_unit = 4096 # very typical, except for giant or embedded filesystems
-        typical_dev_bsize = 512 # google dev_bsize for more info
-
-        block_multiplier = typical_fs_unit / typical_dev_bsize
-        fs_unit_size = aruba.config.physical_block_size * block_multiplier
-
-        # TODO: the size argument here is unnecessary - ArubaPath should decide
-        # what the disk usage of a file is (even if Aruba.config needs to be
-        # read)
-        deprecated_block_count = fs_unit_size / block_multiplier
-        Aruba.platform.determine_disk_usage(expanded, deprecated_block_count)
+        Aruba.platform.determine_disk_usage(expanded)
       end
 
       # Get size of file
       #
+      # @param [String] name
+      #   File name
+      #
       # @return [Numeric]
       #   The size of the file
       def file_size(name)

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,11 +29,10 @@ module Aruba
       # @param [#to_s] text
       #   Input
       def extract_text(text)
-        if Aruba::VERSION < '1'
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '')
-        else
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '').gsub(/\\\[|\\\]/, '').gsub(/\007|\016|\017/, '')
-        end
+        text
+          .gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '')
+          .gsub(/\\\[|\\\]/, '')
+          .gsub(/\007|\016|\017/, '')
       end
 
       # Unescape special characters and remove ANSI characters
@@ -35,19 +41,19 @@ module Aruba
       #   The text to sanitize
       def sanitize_text(text)
         text = unescape_text(text)
-        text = extract_text(text) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+        text = extract_text(text) if aruba.config.remove_ansi_escape_sequences
 
         text.chomp
       end
 
-      # @experimental
-      #
-      # Replace variables in command string
+      # Replace variables in command string (experimental)
       #
       # @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,30 +1,21 @@
 require 'pathname'
-require 'delegate'
-
-require 'aruba/file_size'
 
 # Aruba
 module Aruba
   # Pathname for aruba files and directories
   #
   # @private
-  class ArubaPath < Delegator
+  class ArubaPath
     def initialize(path)
-      obj = [path.to_s].flatten
-
-      super obj
-
-      @delegate_sd_obj = obj
+      @obj = [path.to_s].flatten
     end
 
-    # Get path
-    def __getobj__
-      ::Pathname.new(::File.join(*@delegate_sd_obj))
+    def to_str
+      to_pathname.to_s
     end
 
-    # Set path
-    def __setobj__(obj)
-      @delegate_sd_obj = [obj.to_s].flatten
+    def to_s
+      to_str
     end
 
     # Add directory/file to path
@@ -39,49 +30,19 @@ module Aruba
     #   puts path
     #   # => path/to/dir.d/subdir.d
     def push(p)
-      @delegate_sd_obj << p
+      @obj << p
     end
     alias << push
 
-    # Remove last component of path
+    # Remove last pushed component of path
     #
     # @example
-    #   path = ArubaPath.new 'path/to/dir.d'
+    #   path = ArubaPath.new 'path/to'
+    #   path.push 'dir'
     #   path.pop
-    #   puts path
-    #   # => path/to
+    #   puts path # => path/to
     def pop
-      @delegate_sd_obj.pop
-    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
-      __getobj__.each_filename.to_a.size
-    end
-
-    # Path ends with string
-    #
-    # @param [String] string
-    #   The string to check
-    def end_with?(string)
-      to_s.end_with? string
-    end
-
-    # Path starts with string
-    #
-    # @param [String] string
-    #   The string to check
-    def start_with?(string)
-      to_s.start_with? string
+      @obj.pop
     end
 
     # Return string at index
@@ -91,67 +52,20 @@ module Aruba
       to_s[index]
     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
-    #
-    # @deprecated
-    def blocks
-      min_bytes_used = minimum_disk_space_used
-      min_bytes_used / Aruba.config.physical_block_size
-    end
+    private
 
-    # TODO: Aruba.config.physical_block_size could be allowed to be nil
-    # (So the unit size can be autodetected)
-
-    # Report minimum disk space used
-    #
-    # This estimates the minimum bytes allocated by the path.
-    #
-    # E.g. a 1-byte text file on a typical EXT-3 filesystem takes up 4096 bytes
-    # (could be more if it was truncated or less for sparse files).
-    #
-    # Both `File::Stat` and the `stat()` system call will report 8 `blocks`
-    # (each "usually" represents 512 bytes). So 8 * 512 is exactly 4096 bytes.
-    #
-    # (The "magic" 512 bye implied makes the value of "blocks" so confusing).
-    #
-    # Currently Aruba allows you to set what's called the `physical_block_size`,
-    # which is a bit misleading - it's the "512" value. So if you somehow have a
-    # "filesystem unit size" of 8192 (instead of a typical 4KB), set the
-    # `physical_block_size` to 1024 (yes, divide by 8: 8192/8 = 1024).
-    #
-    # Ideally, Aruba should provide e.g. `Aruba.config.fs_allocation_unit`
-    # (with 4096 as the default), so you wouldn't have to "divide by 8".
-    #
-    # (typical_fs_unit / typical_dev_bsize = 4096 / 512 = 8)
-    #
-    #
-    # @return [Integer]
-    #   Total bytes allocate
-    #
-    # TODO: this is recommended over the above "blocks"
-    def minimum_disk_space_used
-      # TODO: replace Aruba.config.physical_block_size
-      # with something like Aruba.config.fs_allocation_unit
-      dev_bsize = Aruba.config.physical_block_size
-
-      stat = File::Stat.new(to_s)
-
-      blocks = stat.blocks
-      return (blocks * dev_bsize) if blocks
-
-      typical_fs_unit = 4096
-      typical_dev_bsize = 512 # google dev_bsize for more info
-
-      block_multiplier = typical_fs_unit / typical_dev_bsize
-      fs_unit_size = dev_bsize * block_multiplier
-      fs_units = (stat.size + fs_unit_size - 1) / fs_unit_size
-      fs_units = 1 if fs_units.zero?
-      fs_units * fs_unit_size
+    # Get path
+    def to_pathname
+      current_path = @obj.inject do |path, element|
+        if element.start_with? '~'
+          element
+        elsif Aruba.platform.absolute_path? element
+          element
+        else
+          File.join(path, element)
+        end
+      end
+      ::Pathname.new(current_path)
     end
   end
 end