fig 0.1.57 → 0.1.59

data/lib/fig/log4r/outputter.rb

@@ -0,0 +1,96 @@
+require 'colorize'
+require 'log4r/logger'
+require 'log4r/outputter/iooutputter'
+
+require 'fig/logging/colorizable'
+require 'fig/operatingsystem'
+
+module Fig; end
+module Fig::Log4r; end
+
+class Fig::Log4r::Outputter < Log4r::IOOutputter
+  def initialize(name, file_handle, hash = {})
+    @colors = hash.delete(:colors)
+    @colors ||= {
+      :debug => :white,
+      :info  => :light_white,
+      :warn  => :yellow,
+      :error => :red,
+      :fatal => {:color => :light_yellow, :background => :red}
+    }
+    @colorize = file_handle.tty? && Fig::OperatingSystem.unix?
+
+    super(name, file_handle, hash)
+
+    initialize_colors_by_level()
+  end
+
+  private
+
+  def initialize_colors_by_level()
+    @colors_by_level = {}
+
+    Log4r::LNAMES.each_index do
+      |index|
+
+      name_symbol = Log4r::LNAMES[index].downcase.to_sym
+      color = @colors[name_symbol]
+      if color
+        @colors_by_level[index] = color
+      end
+    end
+
+    return
+  end
+
+  def canonical_log(logevent)
+    synch { write( format(logevent), logevent ) }
+  end
+
+  def write(data, logevent)
+    begin
+      if not @colorize
+        @out.print data
+      else
+        if logevent.data.is_a? Fig::Logging::Colorizable
+          emit_colorizable(data, logevent.data)
+        else
+          color = @colors_by_level[logevent.level]
+          if color
+            @out.print data.colorize(color)
+            @out.print ''.uncolorize
+          else
+            @out.print data
+          end
+        end
+      end
+
+      @out.flush
+    rescue IOError => error # recover from this instead of crash
+      Log4r::Logger.log_internal {"IOError in Outputter '#{@name}'!"}
+      Log4r::Logger.log_internal {error}
+      close
+    rescue NameError => error
+      Log4r::Logger.log_internal {"Outputter '#{@name}' IO is #{@out.class}!"}
+      Log4r::Logger.log_internal {error}
+      close
+    end
+
+    return
+  end
+
+  def emit_colorizable(formatted_data, raw_data)
+    color = {}
+    if raw_data.foreground
+      color[:color] = raw_data.foreground
+    end
+    if raw_data.background
+      color[:background] = raw_data.background
+    end
+
+    @out.print formatted_data.colorize(color)
+    @out.print ''.uncolorize
+
+    return
+  end
+end

data/lib/fig/logging.rb

@@ -4,6 +4,7 @@ require 'log4r/yamlconfigurator'
 
 require 'fig/configfileerror'
 require 'fig/log4rconfigerror'
+require 'fig/log4r/outputter'
 
 module Fig; end
 
@@ -124,7 +125,7 @@ module Fig::Logging
   end
 
   def self.setup_default_outputter(logger)
-    outputter = Log4r::Outputter.stderr
+    outputter = Fig::Log4r::Outputter.new('fig stderr', $stderr)
     logger.add outputter
     outputter.formatter = Log4r::PatternFormatter.new :pattern => '%M'
 

data/lib/fig/logging/colorizable.rb

@@ -0,0 +1,14 @@
+module Fig; end
+module Fig::Logging; end
+
+# A String that has colors associated with it.
+class Fig::Logging::Colorizable < String
+  attr_reader :foreground, :background
+
+  def initialize(string = '', foreground = nil, background = nil)
+    super(string)
+
+    @foreground = foreground
+    @background = background
+  end
+end

data/lib/fig/nosuchpackageconfigerror.rb

@@ -0,0 +1,15 @@
+require 'fig/packagedescriptor'
+require 'fig/userinputerror'
+
+module Fig
+  # User specified a configuration for a Package that does not exist.
+  class NoSuchPackageConfigError < UserInputError
+    attr_accessor :descriptor
+
+    def initialize(message, descriptor)
+      super(message)
+
+      @descriptor = descriptor
+    end
+  end
+end

data/lib/fig/operatingsystem.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'find'
 # Must specify absolute path of ::Archive when using
 # this module to avoid conflicts with Fig::Statement::Archive
 require 'libarchive_ruby' unless RUBY_PLATFORM == 'java'
@@ -12,10 +13,11 @@ require 'uri'
 
 require 'highline/import'
 
+require 'fig/environmentvariables/caseinsensitive'
+require 'fig/environmentvariables/casesensitive'
 require 'fig/logging'
 require 'fig/networkerror'
 require 'fig/notfounderror'
-require 'fig/windows'
 
 module Fig
   # Does things requiring real O/S interaction, primarilly taking care of file
@@ -100,7 +102,11 @@ module Fig
         packages
       when 'file'
         packages = []
-        ls = %x<[ -d #{uri.path} ] && find #{uri.path}>
+        return packages if ! File.exist?(uri.path)
+
+        ls = ''
+        Find.find(uri.path) { |file| ls << file.to_s; ls << "\n" }
+
         strip_paths_for_list(ls, packages, uri.path)
         return packages
       else
@@ -347,25 +353,30 @@ module Fig
 
     def shell_exec(cmd)
       if OperatingSystem.windows?
-        Windows.shell_exec_windows(cmd)
+        Kernel.exec(ENV['ComSpec'], '/c', cmd.join(' '))
       else
-        shell_exec_unix(cmd)
+        Kernel.exec(ENV['SHELL'], '-c', cmd.join(' '))
       end
     end
 
-    private
-
-    def shell_exec_unix(cmd)
-      Kernel.exec(ENV['SHELL'], '-c', cmd.join(' '))
+    def self.add_shell_variable_expansion(variable_name)
+      if OperatingSystem.windows?
+        return "%#{variable_name}%"
+      else
+        return "$#{variable_name}"
+      end
     end
 
-    def shell_exec_windows(cmd)
-      #command = ['C:/WINDOWS/system32/cmd.exe', '/C', 'call'] + cmd
-      command = ['cmd.exe', '/C'] + cmd
-      command = command.join(' ')
-      Kernel.exec(command)
+    def self.get_environment_variables(initial_values = nil)
+      if OperatingSystem.windows?
+        return EnvironmentVariables::CaseInsensitive.new(initial_values)
+      end
+
+      return EnvironmentVariables::CaseSensitive.new(initial_values)
     end
 
+    private
+
     # path = The local path the file should be downloaded to.
     # cmd = The command to be run on the remote host.
     def ssh_download(user, host, path, cmd)

data/lib/fig/options.rb

@@ -18,6 +18,7 @@ class Fig::Options
 Usage:
 
   fig [...] [DESCRIPTOR] [--update | --update-if-missing] [-- COMMAND]
+  fig [...] [DESCRIPTOR] [--update | --update-if-missing] [--command-extra-args VALUES]
 
   fig {--publish | --publish-local} DESCRIPTOR
       [--resource PATH]
@@ -31,12 +32,11 @@ Usage:
   fig --get VARIABLE                                         [DESCRIPTOR] [...]
   fig --list-configs                                         [DESCRIPTOR] [...]
   fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
   fig {--list-local | --list-remote}                                      [...]
 
   fig {--version | --help}
 
-Not yet implemented:
-  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
 
 A DESCRIPTOR looks like <package name>[/<version>][:<config>] e.g. "foo",
 "foo/1.2.3", and "foo/1.2.3:default". Whether ":<config>" and "/<version>" are
@@ -51,6 +51,7 @@ Standard options (represented as "[...]" above):
       [--login]
       [--log-level LEVEL] [--log-config PATH]
       [--figrc PATH] [--no-figrc]
+      [--suppress-warning-include-statement-missing-version]
 
 Environment variables:
 
@@ -63,10 +64,12 @@ Environment variables:
   LOG_ALIASES = { 'warning' => 'warn' }
 
   attr_reader :shell_command
+  attr_reader :command_extra_argv
   attr_reader :descriptor
   attr_reader :exit_code
 
   def initialize(argv)
+    argv = argv.clone
     strip_shell_command(argv)
 
     @options = {}
@@ -75,7 +78,6 @@ Environment variables:
 
     parser = new_parser()
 
-    # TODO: Need to catch the exception thrown from parser and retranslate into a fig exception
     begin
       parser.parse!(argv)
     rescue OptionParser::MissingArgument => error
@@ -97,6 +99,24 @@ Environment variables:
     package_text = argv.first
     if package_text
       @descriptor = Fig::PackageDescriptor.parse(package_text)
+      if not @descriptor.name
+        $stderr.puts %Q<No package name specified in descriptor "#{package_text}".>
+        @exit_code = 1
+        return
+      end
+
+      if not @descriptor.version
+        $stderr.puts %Q<No version specified in descriptor "#{package_text}".>
+        @exit_code = 1
+        return
+      end
+
+      if @descriptor.config && config()
+        $stderr.puts \
+          %Q<Cannot specify both --config and a config in the descriptor "#{package_text}".>
+        @exit_code = 1
+        return
+      end
     end
 
     return
@@ -182,6 +202,10 @@ Environment variables:
     return @options[:resources]
   end
 
+  def suppress_warning_include_statement_missing_version?()
+    return @options[:suppress_warning_include_statement_missing_version]
+  end
+
   def update?()
     return @options[:update]
   end
@@ -208,8 +232,18 @@ Environment variables:
 
   def strip_shell_command(argv)
     argv.each_with_index do |arg, i|
-      if arg == '--'
-        @shell_command = argv[(i+1)..-1]
+      terminating_option = nil
+
+      case arg
+        when '--'
+          terminating_option = arg
+          @shell_command = argv[(i+1)..-1]
+        when '--command-extra-args'
+          terminating_option = arg
+          @command_extra_argv = argv[(i+1)..-1]
+      end
+
+      if terminating_option
         argv.slice!(i..-1)
         break
       end
@@ -231,11 +265,11 @@ Environment variables:
 
   def set_up_queries(parser)
     parser.banner = USAGE
-    parser.on('-?', '-h','--help','display this help text') do
+    parser.on_tail('-?', '-h','--help','display this help text') do
       help(parser)
     end
 
-    parser.on('-v', '--version', 'Print fig version') do
+    parser.on_tail('-v', '--version', 'print Fig version') do
       version()
     end
 
@@ -334,7 +368,7 @@ Environment variables:
     @options[:package_config_file] = nil
     parser.on(
       '--file FILE',
-      %q<read fig file FILE. Use '-' for stdin. See also --no-file>
+      %q<read Fig file FILE. Use '-' for stdin. See also --no-file>
     ) do |path|
       @options[:package_config_file] = path
     end
@@ -353,28 +387,32 @@ Environment variables:
     parser.on(
       '-p',
       '--append VARIABLE=VALUE',
-      'append (actually, prepend) VALUE to environment variable VARIABLE, delimited by separator'
+      'append (actually, prepend) VALUE to PATH-like environment variable VARIABLE'
     ) do |var_val|
       var, val = var_val.split('=')
-      @options[:non_command_package_statements] << Fig::Statement::Path.new(var, val)
+      @options[:non_command_package_statements] <<
+        Fig::Statement::Path.new(nil, var, val)
     end
 
     parser.on(
       '-i',
       '--include DESCRIPTOR',
-      'include package/version:config specified in DESCRIPTOR (with any variable prepends) in environment'
-    ) do |descriptor|
-      @options[:non_command_package_statements] <<
+      'include package/version:config specified in DESCRIPTOR in environment'
+    ) do |descriptor_string|
+      statement =
         Fig::Statement::Include.new(
-          Fig::PackageDescriptor.parse(descriptor), {}, nil
+          nil, Fig::PackageDescriptor.parse(descriptor_string), {}, nil
         )
+      statement.complain_if_version_missing()
+      @options[:non_command_package_statements] << statement
     end
 
     parser.on(
       '-s', '--set VARIABLE=VALUE', 'set environment variable VARIABLE to VALUE'
     ) do |var_val|
       var, val = var_val.split('=')
-      @options[:non_command_package_statements] << Fig::Statement::Set.new(var, val)
+      @options[:non_command_package_statements] <<
+        Fig::Statement::Set.new(nil, var, val)
     end
 
     @options[:archives] = []
@@ -382,7 +420,7 @@ Environment variables:
       '--archive PATH',
       'include PATH archive in package (when using --publish)'
     ) do |path|
-      @options[:archives] << Fig::Statement::Archive.new(path)
+      @options[:archives] << Fig::Statement::Archive.new(nil, path)
     end
 
     @options[:resources] =[]
@@ -390,7 +428,7 @@ Environment variables:
       '--resource PATH',
       'include PATH resource in package (when using --publish)'
     ) do |path|
-      @options[:resources] << Fig::Statement::Resource.new(path)
+      @options[:resources] << Fig::Statement::Resource.new(nil, path)
     end
 
     return
@@ -456,12 +494,24 @@ Environment variables:
       @options[:log_level] = log_level
     end
 
+    parser.on(
+      '--suppress-warning-include-statement-missing-version',
+      %q<don't complain about "include package" without a version>
+    ) do
+      @options[:suppress_warning_include_statement_missing_version] = true
+    end
+
     return
   end
 
   def help(parser)
     puts parser.help
-    puts "        --                           end of fig options; anything after this is used as a command to run\n\n"
+    puts <<-'END_MESSAGE'
+        --                           end of Fig options; anything after this is used as a command to run
+        --command-extra-args         end of Fig options; anything after this is appended to the end of a
+                                     "command" statement in a "config" block.
+
+    END_MESSAGE
 
     @exit_code = 0
 
@@ -478,14 +528,14 @@ Environment variables:
         line = file.gets
       end
     rescue
-      $stderr.puts 'Could not retrieve version number. Something has mucked with your fig install.'
+      $stderr.puts 'Could not retrieve version number. Something has mucked with your Fig install.'
 
       @exit_code = 1
       return
     end
 
     if line !~ /\d+\.\d+\.\d+/
-      $stderr.puts %Q<"#{line}" does not look like a version number. Something has mucked with your fig install.>
+      $stderr.puts %Q<"#{line}" does not look like a version number. Something has mucked with your Fig install.>
 
       @exit_code = 1
       return

data/lib/fig/package.rb

@@ -1,5 +1,6 @@
 require 'fig/logging'
-require 'fig/packageerror'
+require 'fig/nosuchpackageconfigerror'
+require 'fig/packagedescriptor'
 require 'fig/statement/archive'
 require 'fig/statement/configuration'
 require 'fig/statement/resource'
@@ -7,20 +8,23 @@ require 'fig/statement/retrieve'
 
 module Fig; end
 
-# The parsed representation of a configuration file.  Contains the statement
-# objects.
+# The parsed representation of a configuration file for a specific version.
+# Contains the statement objects.
+#
+# Unique identifier for this object: name and version. A different version of
+# the same package will be a separate instance of this class.
 class Fig::Package
   include Comparable
 
   UNPUBLISHED     = '<unpublished>'
   DEFAULT_CONFIG  = 'default'
 
-  attr_reader   :package_name, :version_name, :directory, :statements
+  attr_reader   :name, :version, :directory, :statements
   attr_accessor :backtrace
 
-  def initialize(package_name, version_name, directory, statements)
-    @package_name = package_name
-    @version_name = version_name
+  def initialize(name, version, directory, statements)
+    @name = name
+    @version = version
     @directory = directory
     @statements = statements
     @applied_config_names = []
@@ -32,22 +36,17 @@ class Fig::Package
       return stmt if stmt.is_a?(Fig::Statement::Configuration) && stmt.name == config_name
     end
 
-    message =
-      'Configuration not found: ' +
-      (@package_name || '<empty>')  +
-      '/'                         +
-      (@version_name || '<empty>')  +
-      ':'                         +
-      (config_name || '<empty>')
+    descriptor = Fig::PackageDescriptor.new(@name, @version, config_name)
+    message = 'Configuration not found: ' + descriptor.to_string()
 
-    raise Fig::PackageError.new(message)
+    raise Fig::NoSuchPackageConfigError.new(message, descriptor)
   end
 
   def <=>(other)
-    compared = compare_components(package_name, other.package_name)
+    compared = compare_components(name, other.name)
     return compared if compared != 0
 
-    return compare_components(version_name, other.version_name)
+    return compare_components(version, other.version)
   end
 
   def configs
@@ -91,14 +90,14 @@ class Fig::Package
   end
 
   # Returns an array of PackageDescriptors
-  def package_dependencies(config_name)
+  def package_dependencies(config_name, backtrace)
     descriptors = []
 
     self[config_name || DEFAULT_CONFIG].walk_statements do
       |statement|
 
       if statement.is_a?(Fig::Statement::Include)
-        descriptors << statement.resolved_dependency_descriptor(self)
+        descriptors << statement.resolved_dependency_descriptor(self, backtrace)
       end
     end
 
@@ -120,7 +119,7 @@ class Fig::Package
     @statements.each do |statement|
       yield self, statement
       statement.walk_statements_following_package_dependencies(
-        repository, self, &block
+        repository, self, nil, &block
       )
     end
 
@@ -134,21 +133,21 @@ class Fig::Package
   def ==(other)
     return false if other.nil?
 
-    return @package_name == other.package_name &&
-           @version_name == other.version_name &&
+    return @name == other.name &&
+           @version == other.version &&
            @statements.to_yaml == other.statements.to_yaml
   end
 
   def to_s
-    package_name = @package_name || '<empty>'
-    version_name = @version_name || '<empty>'
-    return package_name + '/' + version_name
+    name    = @name || '<empty>'
+    version = @version || '<empty>'
+    return Fig::PackageDescriptor.format(name, version, nil)
   end
 
   def to_s_with_config(config_name)
     string = nil
 
-    if package_name.nil?
+    if name.nil?
       string = UNPUBLISHED
     else
       string = to_s