fluent_command_builder 0.8.18 → 0.9.0

data/lib/fluent_command_builder/execution_context.rb

@@ -1,15 +1,13 @@
-require File.expand_path(File.dirname(__FILE__) + '/printer')
+require File.expand_path(File.dirname(__FILE__) + '/internal/printer')
 require File.expand_path(File.dirname(__FILE__) + '/command_executors/system_executor')
-require File.expand_path(File.dirname(__FILE__) + '/command_formatters/null_formatter')
 
 module FluentCommandBuilder
   class ExecutionContext
 
-    attr_accessor :executor, :formatter, :should_print_on_execute, :should_fail_on_error
+    attr_accessor :executor, :printer, :should_print_on_execute, :should_fail_on_error
 
     def initialize(executor)
       @executor = executor
-      @formatter = NullFormatter.new
       @should_print_on_execute = true
       @should_fail_on_error = true
       @printer = FluentCommandBuilder::Printer.new

data/lib/fluent_command_builder/{argument_formatter.rb → internal/argument_formatter.rb}

@@ -16,6 +16,14 @@ module FluentCommandBuilder
       end
     end
 
+    def format_password(value)
+      password = quote_if_includes_space value.to_s
+      @passwords << password
+      password
+    end
+
+    private
+
     def format_hash(hash, delimiter, key_value_separator)
       hash.map { |k, v| quote_if_includes_space(k.to_s) + key_value_separator + quote_if_includes_space(v.to_s) }.join delimiter
     end
@@ -24,12 +32,6 @@ module FluentCommandBuilder
       array.map { |v| quote_if_includes_space v }.join delimiter
     end
 
-    def format_password(value)
-      password = quote_if_includes_space value.to_s
-      @passwords << password
-      password
-    end
-
     def quote_if_includes_space(value)
       value.to_s.include?(' ') ? %Q["#{value}"] : value
     end

data/lib/fluent_command_builder/internal/command_builder_config.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/path_validator')
+require File.expand_path(File.dirname(__FILE__) + '/version_validator')
+require File.expand_path(File.dirname(__FILE__) + '/version_detectors/default_version_detector')
+
+module FluentCommandBuilder
+  class CommandBuilderConfig
+
+    attr_accessor :path, :command_name, :version, :version_detector,
+                  :path_validation_level, :version_validation_level,
+                  :path_validator, :version_validator,
+                  :is_windows
+
+    def initialize(command_name, version=nil)
+      @path = nil
+      @command_name = command_name
+      @version = version
+      @version_detector = DefaultVersionDetector.new command_name
+      @path_validation_level = :fatal
+      @version_validation_level = :fatal
+      @path_validator = PathValidator.new self
+      @version_validator = VersionValidator.new self
+      @is_windows = !ENV['WINDIR'].nil?
+    end
+
+    def validate_path
+      @path_validator.validate
+    end
+
+    def validate_version
+      @version_validator.validate if @version
+    end
+
+    def executable
+      e = @path ? File.join(@path, @command_name) : @command_name
+      normalise_path e
+    end
+
+    def evaluated_executable
+      evaluate_path executable
+    end
+
+    def evaluated_path
+      evaluate_path @path if @path
+    end
+
+    private
+
+    def evaluate_path(path)
+      `echo #{normalise_path path}`.strip
+    end
+
+    def normalise_path(path)
+      @is_windows ? path.gsub('/', '\\') : path.gsub('\\', '/')
+    end
+
+  end
+end

data/lib/fluent_command_builder/{path_finder.rb → internal/path_finder.rb}

@@ -1,20 +1,20 @@
-require File.expand_path(File.dirname(__FILE__) + '/path_finders/unix_path_finder')
-require File.expand_path(File.dirname(__FILE__) + '/path_finders/windows_path_finder')
-
-module FluentCommandBuilder
-
-  def self.path_finder
-    @path_finder ||= is_windows? ? WindowsPathFinder.new : UnixPathFinder.new
-  end
-
-  def self.path_finder=(value)
-    @path_finder = value
-  end
-
-  private
-
-  def self.is_windows?
-    !ENV['WINDIR'].nil?
-  end
-
+require File.expand_path(File.dirname(__FILE__) + '/path_finders/unix_path_finder')
+require File.expand_path(File.dirname(__FILE__) + '/path_finders/windows_path_finder')
+
+module FluentCommandBuilder
+
+  def self.path_finder
+    @path_finder ||= is_windows? ? WindowsPathFinder.new : UnixPathFinder.new
+  end
+
+  def self.path_finder=(value)
+    @path_finder = value
+  end
+
+  private
+
+  def self.is_windows?
+    !ENV['WINDIR'].nil?
+  end
+
 end

data/lib/fluent_command_builder/{path_finders → internal/path_finders}/unix_path_finder.rb

@@ -1,13 +1,13 @@
-module FluentCommandBuilder
-  class UnixPathFinder
-
-    def find_path(executable_name)
-      executable = `which #{executable_name}`
-      real_executable = `readlink #{executable}`.strip
-      result = real_executable == '' ? executable : real_executable
-      return unless result
-      File.dirname result
-    end
-
-  end
+module FluentCommandBuilder
+  class UnixPathFinder
+
+    def find_path(executable_name)
+      executable = `which #{executable_name}`
+      real_executable = `readlink #{executable}`.strip
+      result = real_executable == '' ? executable : real_executable
+      return unless result
+      File.dirname result
+    end
+
+  end
 end

data/lib/fluent_command_builder/{path_finders → internal/path_finders}/windows_path_finder.rb

@@ -1,14 +1,14 @@
-module FluentCommandBuilder
-  class WindowsPathFinder
-
-    def find_path(executable_name)
-      paths =  ENV['PATH'].split ';'
-      extensions = ENV['PATHEXT'].split ';'
-      possibilities = paths.map { |path| extensions.map { |ext| File.join(path, executable_name + ext.downcase).gsub('/', '\\') } }.flatten
-      executable = possibilities.select { |exe| File.exist? exe }.first
-      return unless executable
-      File.dirname executable
-    end
-
-  end
+module FluentCommandBuilder
+  class WindowsPathFinder
+
+    def find_path(executable_name)
+      paths =  ENV['PATH'].split ';'
+      extensions = ENV['PATHEXT'].split ';'
+      possibilities = paths.map { |path| extensions.map { |ext| File.join(path, executable_name + ext.downcase).gsub('/', '\\') } }.flatten
+      executable = possibilities.select { |exe| File.exist? exe }.first
+      return unless executable
+      File.dirname executable
+    end
+
+  end
 end

data/lib/fluent_command_builder/internal/path_validator.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/printer')
+
+module FluentCommandBuilder
+  class PathValidator
+
+    attr_accessor :path_finder, :printer, :should_abort_on_fatal
+
+    def initialize(command_builder_config)
+      @c = command_builder_config
+      @path_finder = FluentCommandBuilder.path_finder
+      @printer = Printer.new
+      @should_abort_on_fatal = true
+    end
+
+    def validate
+      validate_validation_level
+      return if validation_level == :off
+
+      if @c.path
+        path = @c.evaluated_path
+        return if File.exist? path
+        message = %Q[Path for command "#{@c.command_name}", version "#{@c.version}" does not exist. Path: #{path}]
+      else
+        return if @path_finder.find_path @c.command_name
+        message = %Q[Command "#{@c.command_name}" was not found on the PATH.]
+      end
+
+      case validation_level
+        when :warn
+          @printer.print_warning message
+        when :fatal
+          @printer.print_error message
+          abort if @should_abort_on_fatal
+        else
+          # do nothing
+      end
+    end
+
+    private
+
+    def validation_level
+      @c.path_validation_level
+    end
+
+    def validate_validation_level
+      raise %Q[Validation level "#{validation_level}" is not supported.] unless validation_level_valid?
+    end
+
+    def validation_level_valid?
+      [:off, :warn, :fatal].include? validation_level
+    end
+
+  end
+end

data/lib/fluent_command_builder/{printer.rb → internal/printer.rb}

@@ -5,18 +5,18 @@ module FluentCommandBuilder
     include Term::ANSIColor
 
     def print_warning(message)
-      print yellow, 'WARNING: ', message, reset, "\n"
-      STDOUT.flush
+      $stderr.print yellow, 'Warning: ', message, reset, "\n"
+      $stderr.flush
     end
 
     def print_error(message)
-      print red, 'ERROR: ', message, reset, "\n"
-      STDOUT.flush
+      $stderr.print red, 'Error: ', message, reset, "\n"
+      $stderr.flush
     end
 
     def print_command(command)
       print magenta, command, reset, "\n"
-      STDOUT.flush
+      $stdout.flush
     end
 
   end

data/lib/fluent_command_builder/{underlying_builder.rb → internal/underlying_builder.rb}

@@ -1,16 +1,18 @@
 require File.expand_path(File.dirname(__FILE__) + '/argument_formatter')
-require File.expand_path(File.dirname(__FILE__) + '/execution_context')
+require File.expand_path(File.dirname(__FILE__) + '/../execution_context')
 
 module FluentCommandBuilder
   class UnderlyingBuilder
     include ArgumentFormatter
 
     attr_reader :args, :passwords
+    attr_accessor :password_formatter, :execution_context
 
     def initialize(command_builder_config)
       @c = command_builder_config
       @args = nil
       @passwords = []
+      @password_formatter = FluentCommandBuilder.password_formatter
       @execution_context = FluentCommandBuilder.execution_context
     end
 
@@ -21,19 +23,23 @@ module FluentCommandBuilder
     end
 
     def executable
-      @c.path ? File.join(@c.tidy_path, @c.command_name) : @c.command_name
+      @c.executable
     end
 
     def execute
-      @c.validate_path :fatal
+      @c.validate_path
       @c.validate_version
-      visible_command = @execution_context.formatter.format self
       @execution_context.execute to_s, visible_command
     end
 
     def to_s
-      quoted_executable = @c.evaluated_path.to_s.include?(' ') ? %Q["#{executable}"] : executable
-      "#{quoted_executable} #{@args}".strip
+      "#{quote_if_includes_space @c.evaluated_executable} #{@args}".strip
+    end
+
+    private
+
+    def visible_command
+      @password_formatter.format to_s, @passwords
     end
 
   end

data/lib/fluent_command_builder/{version.rb → internal/version.rb}

@@ -2,7 +2,7 @@ module FluentCommandBuilder
   class Version
 
     VERSION_REGEX = '(?:\d+\.)+(?:\d+)'
-    SEQUENCE_SEPARATOR = '.'
+    DELIMITER = '.'
 
     attr_accessor :version
 
@@ -12,20 +12,19 @@ module FluentCommandBuilder
     end
 
     def compact
-      to_a.first(2).join
+      first 2, ''
     end
 
-    def to_s(count=nil)
-      count ? truncate(count) : @version
-    end
+    def first(count, delimiter=DELIMITER)
+       to_a.first(count).join(delimiter)
+     end
 
-    def to_a
-      @version.split SEQUENCE_SEPARATOR
+    def to_s
+      @version
     end
 
-    def self.is_valid?(version)
-      exp = Regexp.new "^#{VERSION_REGEX}$"
-      version.scan(exp)[0] != nil
+    def to_a
+      @version.split DELIMITER
     end
 
     def self.match(value)
@@ -35,15 +34,11 @@ module FluentCommandBuilder
       Version.new(version)
     end
 
-    def self.version_or_nil(version)
-      return unless version
-      is_valid?(version) ? Version.new(version) : nil
-    end
-
     private
 
-    def truncate(count)
-      to_a.first(count).join(SEQUENCE_SEPARATOR)
+    def self.is_valid?(version)
+      exp = Regexp.new "^#{VERSION_REGEX}$"
+      version.scan(exp)[0] != nil
     end
 
   end

data/lib/fluent_command_builder/internal/version_detectors.rb

@@ -0,0 +1 @@
+Dir[File.expand_path(File.dirname(__FILE__) + '/version_detectors/*.rb')].each { |f| require f }

data/lib/fluent_command_builder/{version_detectors → internal/version_detectors}/appengine_python_version_detector.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require File.expand_path(File.dirname(__FILE__) + '/../path_finder')
 
 module FluentCommandBuilder
   class AppEnginePythonVersionDetector

data/lib/fluent_command_builder/{version_detectors → internal/version_detectors}/default_version_detector.rb

@@ -1,3 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../path_finder')
 require File.expand_path(File.dirname(__FILE__) + '/../version')
 require File.expand_path(File.dirname(__FILE__) + '/standard_version_detector')
 

data/lib/fluent_command_builder/{version_detectors → internal/version_detectors}/standard_version_detector.rb

@@ -1,5 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../path_finder')
 require File.expand_path(File.dirname(__FILE__) + '/../version')
-require File.expand_path(File.dirname(__FILE__) + '/../command_executors/backticks_executor')
+require File.expand_path(File.dirname(__FILE__) + '/../../command_executors/backticks_executor')
 
 module FluentCommandBuilder
   class StandardVersionDetector
@@ -15,11 +16,13 @@ module FluentCommandBuilder
     def version(path=nil)
       path ||= FluentCommandBuilder.path_finder.find_path @command_name
       return unless path
-      executable = File.join path, @command_name
-      command = %Q["#{executable}" #{@command_arg} 2>&1]
-      output = @backticks_executor.execute command
-      v = Version.match(output)
-      v ? v.version : nil
+      return unless File.exist? path
+      Dir.chdir path do
+        command = %Q["#{@command_name}" #{@command_arg} 2>&1]
+        output = @backticks_executor.execute command
+        v = Version.match(output)
+        v ? v.version : nil
+      end
     end
 
   end

data/lib/fluent_command_builder/{version_validator.rb → internal/version_validator.rb}

@@ -3,15 +3,19 @@ require File.expand_path(File.dirname(__FILE__) + '/printer')
 module FluentCommandBuilder
   class VersionValidator
 
+    attr_accessor :printer, :should_abort_on_fatal
+
     def initialize(command_builder_config)
-      @command_builder_config = command_builder_config
+      @c = command_builder_config
       @printer = Printer.new
+      @should_abort_on_fatal = true
     end
 
-    def validate(validation_level)
+    def validate
+      validate_validation_level
       return if validation_level == :off
 
-      @actual_version_string = version_detector.version(path)
+      @actual_version_string = @c.version_detector.version(@c.evaluated_path)
 
       unless actual_version
         @printer.print_warning error_message('unable to determine actual version')
@@ -19,52 +23,51 @@ module FluentCommandBuilder
       end
 
       unless is_valid?
-        message = error_message actual_version.to_s(expected_version.to_a.length)
+        message = error_message actual_version.first(expected_version.to_a.length)
 
         case validation_level
           when :warn
             @printer.print_warning message
           when :fatal
             @printer.print_error message
-            abort
+            abort if @should_abort_on_fatal
           else
-            @printer.print_warning %Q[Version validation failed. Validation level "#{validation_level}" is not supported.]
+            # do nothing
         end
       end
     end
 
     private
 
-    def is_valid?
-      actual_version.to_a.first(expected_version.to_a.length) == expected_version.to_a
+    def validation_level
+      @c.version_validation_level
     end
 
-    def expected_version
-      @expected_version ||= Version.new(expected_version_string)
+    def validate_validation_level
+      raise %Q[Validation level "#{validation_level}" is not supported.] unless validation_level_valid?
     end
 
-    def actual_version
-      @actual_version ||= Version.new(@actual_version_string) if @actual_version_string
+    def validation_level_valid?
+      [:off, :warn, :fatal].include? validation_level
     end
 
-    def error_message(actual_version)
-      %Q[Version validation for command "#{command_name}" failed. Expected version #{expected_version} but was #{actual_version}.]
-    end
 
-    def path
-      @command_builder_config.path
+
+
+    def is_valid?
+      actual_version.to_a.first(expected_version.to_a.length) == expected_version.to_a
     end
 
-    def command_name
-      @command_builder_config.command_name
+    def expected_version
+      @expected_version ||= Version.new(@c.version)
     end
 
-    def expected_version_string
-      @command_builder_config.version
+    def actual_version
+      @actual_version ||= Version.new(@actual_version_string) if @actual_version_string
     end
 
-    def version_detector
-      @command_builder_config.version_detector
+    def error_message(actual_version)
+      %Q[Version validation for command "#{@c.command_name}" failed. Expected version #{expected_version} but was #{actual_version}.]
     end
 
   end