fig 0.1.62 → 0.1.64

data/lib/fig/command/coveragesupport.rb

@@ -0,0 +1,40 @@
+# This is not a normal module/class.  It contains code to be run by bin/fig and
+# bin/fig-debug when doing coverage.
+
+# Depends upon setup done by spec/spec_helper.rb.
+if ! ENV['FIG_COVERAGE_RUN_COUNT'] || ! ENV['FIG_COVERAGE_ROOT_DIRECTORY']
+  $stderr.puts \
+    'FIG_COVERAGE_RUN_COUNT or FIG_COVERAGE_ROOT_DIRECTORY not set. Cannot do coverage correctly.'
+  exit 1
+end
+
+require 'simplecov'
+
+# Normal load of .simplecov does not work because SimpleCov assumes that
+# everything is relative to the current directory.  The manipulation of
+# SimpleCov.root below takes care of most things, but that doesn't affect
+# .simplecov handling done in the "require 'simplecov'" above.
+load File.expand_path(
+  File.join(ENV['FIG_COVERAGE_ROOT_DIRECTORY'], '.simplecov')
+)
+
+# We may run the identical fig command-line multiple times, so we need to give
+# additional value to make the run name unique.
+SimpleCov.command_name(
+  "fig run #{ENV['FIG_COVERAGE_RUN_COUNT']} (#{ARGV.join(' ')})"
+)
+SimpleCov.root ENV['FIG_COVERAGE_ROOT_DIRECTORY']
+
+SimpleCov.at_exit do
+  # Have to invoke result() in order to get coverage data saved.
+  #
+  # Default at_exit() further invokes format():
+  #
+  #    1) We save time by not doing it on each fig run and let the rspec run
+  #       handle that.
+  #    2) The formatter emits a message to stdout, which screws up tests of
+  #       the fig output.
+  SimpleCov.result
+end
+
+SimpleCov.start

data/lib/fig/command/listing.rb

@@ -28,7 +28,7 @@ module Fig::Command::Listing
   end
 
   def display_configs_in_local_packages_list()
-    @package.configs.each do |config|
+    @base_package.configs.each do |config|
       puts config.name
     end
 
@@ -71,7 +71,7 @@ module Fig::Command::Listing
   end
 
   def display_dependencies_in_tree()
-    walk_dependency_tree(@package, derive_base_display_config_names(), nil, 0) do
+    walk_dependency_tree(@base_package, derive_base_display_config_names(), nil, 0) do
       |package, config_name, depth|
 
       print ' ' * (depth * 4)
@@ -150,7 +150,7 @@ module Fig::Command::Listing
 
   def derive_base_display_config_names()
     if @options.list_all_configs?
-      return @package.config_names
+      return @base_package.config_names
     end
 
     return [ base_config() ]
@@ -160,11 +160,11 @@ module Fig::Command::Listing
     packages = {}
     starting_config_names = derive_base_display_config_names()
 
-    if ! @package.name.nil?
-      packages[@package] = starting_config_names.to_set
+    if ! @base_package.name.nil?
+      packages[@base_package] = starting_config_names.to_set
     end
 
-    walk_dependency_tree(@package, starting_config_names, nil, 0) do
+    walk_dependency_tree(@base_package, starting_config_names, nil, 0) do
       |package, config_name, depth|
 
       if (
@@ -230,7 +230,7 @@ module Fig::Command::Listing
     prior_node = nil
     current_parent = tree
 
-    walk_dependency_tree(@package, derive_base_display_config_names(), nil, 0) do
+    walk_dependency_tree(@base_package, derive_base_display_config_names(), nil, 0) do
       |package, config_name, depth|
 
       if depth < prior_depth
@@ -327,7 +327,7 @@ module Fig::Command::Listing
   def display_variables_flat_from_repository()
     variable_names = Set.new()
 
-    walk_dependency_tree(@package, derive_base_display_config_names(), nil, 0) do
+    walk_dependency_tree(@base_package, derive_base_display_config_names(), nil, 0) do
       |package, config_name, depth|
 
       package[config_name].walk_statements() do |statement|

data/lib/fig/command/optionerror.rb

@@ -0,0 +1,8 @@
+require 'fig/userinputerror'
+
+module Fig; end
+class Fig::Command; end
+
+# Bad command-line option.
+class Fig::Command::OptionError < Fig::UserInputError
+end

data/lib/fig/{options.rb → command/options.rb}

@@ -1,5 +1,6 @@
 require 'optparse'
 
+require 'fig/command/optionerror'
 require 'fig/package'
 require 'fig/packagedescriptor'
 require 'fig/statement/archive'
@@ -7,14 +8,13 @@ require 'fig/statement/include'
 require 'fig/statement/path'
 require 'fig/statement/resource'
 require 'fig/statement/set'
-require 'fig/userinputerror'
 
 module Fig; end
+class Fig::Command; end
 
 # Command-line processing.
-class Fig::Options
+class Fig::Command::Options
   USAGE = <<-EOF
-
 Usage:
 
   fig [...] [DESCRIPTOR] [--update | --update-if-missing] [-- COMMAND]
@@ -24,6 +24,7 @@ Usage:
       [--resource PATH]
       [--archive  PATH]
       [--include  DESCRIPTOR]
+      [--override DESCRIPTOR]
       [--force]
       [...]
 
@@ -40,7 +41,7 @@ Usage:
 
 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
-required or allowed is dependent upon what your are doing
+required or allowed is dependent upon what your are doing.
 
 Standard options (represented as "[...]" above):
 
@@ -57,7 +58,6 @@ Environment variables:
 
   FIG_REMOTE_URL (required),
   FIG_HOME (path to local repository cache, defaults to $HOME/.fighome).
-
   EOF
 
   LOG_LEVELS = %w[ off fatal error warn info debug all ]
@@ -69,57 +69,7 @@ Environment variables:
   attr_reader :exit_code
 
   def initialize(argv)
-    argv = argv.clone
-    strip_shell_command(argv)
-
-    @options = {}
-
-    @options[:home] = ENV['FIG_HOME'] || File.expand_path('~/.fighome')
-
-    parser = new_parser()
-
-    begin
-      parser.parse!(argv)
-    rescue OptionParser::MissingArgument => error
-      $stderr.puts "Please provide the #{error}."
-      @exit_code = 1
-      return
-    end
-
-    if not exit_code.nil?
-      return
-    end
-
-    if argv.size > 1
-      $stderr.puts %q<Extra arguments. Should only have a package/version after all other options. Had "> + argv.join(%q<", ">) + %q<" left over.>
-      @exit_code = 1
-      return
-    end
-
-    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
+    process_command_line(argv)
   end
 
   def archives()
@@ -146,6 +96,10 @@ Environment variables:
     return @options[:get]
   end
 
+  def help?()
+    return @options[:help]
+  end
+
   def home()
     return @options[:home]
   end
@@ -178,12 +132,12 @@ Environment variables:
     return @options[:no_figrc]
   end
 
-  def non_command_package_statements()
-    return @options[:non_command_package_statements]
+  def environment_statements()
+    return @options[:environment_statements]
   end
 
-  def package_config_file()
-    return @options[:package_config_file]
+  def package_definition_file()
+    return @options[:package_definition_file]
   end
 
   def publish?()
@@ -218,6 +172,10 @@ Environment variables:
     return update? || update_if_missing?
   end
 
+  def version?()
+    return @options[:version]
+  end
+
   # Answers whether we should reset the environment to nothing, sort of like
   # the standardized environment that cron(1) creates.  At present, we're only
   # setting this when we're listing variables.  One could imagine allowing this
@@ -228,8 +186,7 @@ Environment variables:
     return listing() == :variables
   end
 
-  private
-
+  # This needs to be public for efficient use of custom command.rb wrappers.
   def strip_shell_command(argv)
     argv.each_with_index do |arg, i|
       terminating_option = nil
@@ -252,30 +209,132 @@ Environment variables:
     return
   end
 
+  # This needs to be public for efficient use of custom command.rb wrappers.
+  def help()
+    puts @help_message
+    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
+
+    return 0
+  end
+
+  private
+
+  # Note that OptionParser insist that the regex match the entire value, not
+  # just matches the regex in general.  In effect, OptionParser is wrapping the
+  # regex with "\A" and "\z".
+  STARTS_WITH_NON_HYPHEN = %r< \A [^-] .* >x
+
+  ARGUMENT_DESCRIPTION = {
+    '--set'    => Fig::Statement::Set::ARGUMENT_DESCRIPTION,
+    '--append' => Fig::Statement::Path::ARGUMENT_DESCRIPTION
+  }
+
+  def process_command_line(argv)
+    argv = argv.clone
+    strip_shell_command(argv)
+
+    @switches = []
+    @options = {}
+
+    @options[:home] = ENV['FIG_HOME'] || File.expand_path('~/.fighome')
+
+    parser = new_parser()
+    @help_message = parser.help
+
+    begin
+      parser.parse!(argv)
+    rescue OptionParser::InvalidArgument => error
+      raise_invalid_argument(error.args[0], error.args[1])
+    rescue OptionParser::MissingArgument => error
+      raise_missing_argument(error.args[0])
+    rescue OptionParser::InvalidOption => error
+      raise Fig::Command::OptionError.new(
+        "Unknown option #{error.args[0]}.\n\n#{USAGE}"
+      )
+    rescue OptionParser::ParseError => error
+      raise Fig::Command::OptionError.new(error.to_s)
+    end
+
+    if not exit_code.nil?
+      return
+    end
+
+    if argv.size > 1
+      $stderr.puts %q<Extra arguments. Should only have a package/version after all other options. Had "> + argv.join(%q<", ">) + %q<" left over.>
+      @exit_code = 1
+      return
+    end
+
+    derive_primary_descriptor(argv.first)
+
+    return
+  end
+
+  def raise_missing_argument(option)
+    raise Fig::Command::OptionError.new(
+      "Please provide a value for #{option}."
+    )
+  end
+
+  def raise_invalid_argument(option, value)
+    # *sigh* OptionParser does not raise MissingArgument for the case of an
+    # option with a required value being followed by another option.  It
+    # assigns the next option as the value instead.  E.g. for
+    #
+    #    fig --set --get FOO
+    #
+    # it assigns "--get" as the value of the "--set" option.
+    switch_strings =
+      (@switches.collect {|switch| [switch.short, switch.long]}).flatten
+    if switch_strings.any? {|string| string == value}
+      raise_missing_argument(option)
+    end
+
+    description = ARGUMENT_DESCRIPTION[option]
+    if description.nil?
+      description = ''
+    else
+      description = ' ' + description
+    end
+
+    raise Fig::Command::OptionError.new(
+      %Q<Invalid value for #{option}: "#{value}".#{description}>
+    )
+  end
+
   def new_parser
     return OptionParser.new do |parser|
       set_up_queries(parser)
       set_up_commands(parser)
       set_up_package_configuration_source(parser)
-      set_up_package_statements(parser)
+      set_up_environment_statements(parser)
+      set_up_package_contents_statements(parser)
       set_up_remote_repository_access(parser)
       set_up_program_configuration(parser)
     end
   end
 
   def set_up_queries(parser)
-    parser.banner = USAGE
-    parser.on_tail('-?', '-h','--help','display this help text') do
-      help(parser)
+    parser.banner = "#{USAGE}\n"
+    @switches << parser.define_tail(
+      '-?', '-h','--help','display this help text'
+    ) do
+      @options[:help] = true
     end
 
-    parser.on_tail('-v', '--version', 'print Fig version') do
-      version()
+    @switches << parser.define_tail('-v', '--version', 'print Fig version') do
+      @options[:version] = true
     end
 
-    parser.on(
+    @switches << parser.define(
       '-g',
       '--get VARIABLE',
+      STARTS_WITH_NON_HYPHEN,
       'print value of environment variable VARIABLE'
     ) do |get|
       @options[:get] = get
@@ -310,7 +369,7 @@ Environment variables:
     option_mapping.each_pair do
       | type, specification |
 
-      parser.on(*specification) do
+      @switches << parser.define(*specification) do
         if @options[:listing]
           options_string =
             (
@@ -325,11 +384,16 @@ Environment variables:
       end
     end
 
-    parser.on('--list-tree', 'for listings, output a tree instead of a list') do
+    @switches << parser.define(
+      '--list-tree', 'for listings, output a tree instead of a list'
+    ) do
       @options[:list_tree] = true
     end
 
-    parser.on('--list-all-configs', 'for listings, follow all configurations of the base package') do
+    @switches << parser.define(
+      '--list-all-configs',
+      'for listings, follow all configurations of the base package'
+    ) do
       @options[:list_all_configs] = true
     end
 
@@ -337,17 +401,17 @@ Environment variables:
   end
 
   def set_up_commands(parser)
-    parser.on('--clean', 'remove package from $FIG_HOME') do
+    @switches << parser.define('--clean', 'remove package from $FIG_HOME') do
       @options[:clean] = true
     end
 
-    parser.on(
+    @switches << parser.define(
       '--publish', 'install package in $FIG_HOME and in remote repo'
     ) do |publish|
       @options[:publish] = true
     end
 
-    parser.on(
+    @switches << parser.define(
       '--publish-local', 'install package only in $FIG_HOME'
     ) do |publish_local|
       @options[:publish_local] = true
@@ -356,86 +420,136 @@ Environment variables:
     return
   end
 
+  FILE_OPTION_VALUE_PATTERN =
+    %r<
+      \A
+      (?:
+          -         # Solely a hyphen, to allow for stdin
+        | [^-] .*   # or anything not starting with a hyphen.
+      )
+      \z
+    >x
+
   def set_up_package_configuration_source(parser)
-    parser.on(
+    @switches << parser.define(
       '-c',
       '--config CONFIG',
+      STARTS_WITH_NON_HYPHEN,
       %q<apply configuration CONFIG, default is "default">
     ) do |config|
       @options[:config] = config
     end
 
-    @options[:package_config_file] = nil
-    parser.on(
+    @options[:package_definition_file] = nil
+    @switches << parser.define(
       '--file FILE',
+      FILE_OPTION_VALUE_PATTERN,
       %q<read Fig file FILE. Use '-' for stdin. See also --no-file>
     ) do |path|
-      @options[:package_config_file] = path
+      @options[:package_definition_file] = path
     end
 
-    parser.on(
+    @switches << parser.define(
       '--no-file', 'ignore package.fig file in current directory'
     ) do |path|
-      @options[:package_config_file] = :none
+      @options[:package_definition_file] = :none
     end
 
     return
   end
 
-  def set_up_package_statements(parser)
-    @options[:non_command_package_statements] = []
-    parser.on(
+  def set_up_environment_statements(parser)
+    @options[:environment_statements] = []
+    @switches << parser.define(
       '-p',
       '--append VARIABLE=VALUE',
+      STARTS_WITH_NON_HYPHEN,
       '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(nil, var, val)
+    ) do |name_value|
+      @options[:environment_statements] <<
+        new_variable_statement('--append', name_value, Fig::Statement::Path)
+    end
+
+    @switches << parser.define(
+      '-s',
+      '--set VARIABLE=VALUE',
+      STARTS_WITH_NON_HYPHEN,
+      'set environment variable VARIABLE to VALUE'
+    ) do |name_value|
+      @options[:environment_statements] <<
+        new_variable_statement('--set', name_value, Fig::Statement::Set)
     end
 
-    parser.on(
+    @switches << parser.define(
       '-i',
       '--include DESCRIPTOR',
+      STARTS_WITH_NON_HYPHEN,
       'include package/version:config specified in DESCRIPTOR in environment'
     ) do |descriptor_string|
       statement =
         Fig::Statement::Include.new(
-          nil, Fig::PackageDescriptor.parse(descriptor_string), {}, nil
+          nil,
+          '--include option',
+          Fig::Statement::Include.parse_descriptor(
+            descriptor_string,
+            :validation_context => ' given in a --include option'
+          ),
+          nil
         )
+
+      # We've never allowed versionless includes from the command-line. Hooray!
       statement.complain_if_version_missing()
-      @options[:non_command_package_statements] << statement
+
+      @options[:environment_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(nil, var, val)
+    @switches << parser.define(
+      '--override DESCRIPTOR',
+      STARTS_WITH_NON_HYPHEN,
+      'dictate version of package as specified in DESCRIPTOR'
+    ) do |descriptor_string|
+      descriptor =
+        Fig::Statement::Override.parse_descriptor(
+          descriptor_string,
+          :validation_context => ' given in a --override option'
+        )
+      statement =
+        Fig::Statement::Override.new(
+          nil, '--override option', descriptor.name, descriptor.version
+        )
+
+      @options[:environment_statements] << statement
     end
 
+    return
+  end
+
+  def set_up_package_contents_statements(parser)
     @options[:archives] = []
-    parser.on(
+    @switches << parser.define(
       '--archive PATH',
+      STARTS_WITH_NON_HYPHEN,
       'include PATH archive in package (when using --publish)'
     ) do |path|
-      @options[:archives] << Fig::Statement::Archive.new(nil, path)
+      @options[:archives] <<
+        Fig::Statement::Archive.new(nil, '--archive option', path)
     end
 
     @options[:resources] =[]
-    parser.on(
+    @switches << parser.define(
       '--resource PATH',
+      STARTS_WITH_NON_HYPHEN,
       'include PATH resource in package (when using --publish)'
     ) do |path|
-      @options[:resources] << Fig::Statement::Resource.new(nil, path)
+      @options[:resources] <<
+        Fig::Statement::Resource.new(nil, '--resource option', path)
     end
 
     return
   end
 
   def set_up_remote_repository_access(parser)
-    parser.on(
+    @switches << parser.define(
       '-u',
       '--update',
       'check remote repo for updates and download to $FIG_HOME as necessary'
@@ -443,7 +557,7 @@ Environment variables:
       @options[:update] = true
     end
 
-    parser.on(
+    @switches << parser.define(
       '-m',
       '--update-if-missing',
       'check remote repo for updates only if package missing from $FIG_HOME'
@@ -451,14 +565,14 @@ Environment variables:
       @options[:update_if_missing] = true
     end
 
-    parser.on(
+    @switches << parser.define(
       '-l', '--login', 'login to remote repo as a non-anonymous user'
     ) do
       @options[:login] = true
     end
 
     @options[:force] = nil
-    parser.on(
+    @switches << parser.define(
       '--force',
       'force-overwrite existing version of a package to the remote repo'
     ) do |force|
@@ -469,22 +583,26 @@ Environment variables:
   end
 
   def set_up_program_configuration(parser)
-    parser.on(
-      '--figrc PATH', 'add PATH to configuration used for Fig'
+    @switches << parser.define(
+      '--figrc PATH',
+      STARTS_WITH_NON_HYPHEN,
+      'add PATH to configuration used for Fig'
     ) do |path|
       @options[:figrc] = path
     end
 
-    parser.on('--no-figrc', 'ignore ~/.figrc') { @options[:no_figrc] = true }
+    @switches << parser.define('--no-figrc', 'ignore ~/.figrc') { @options[:no_figrc] = true }
 
-    parser.on(
-      '--log-config PATH', 'use PATH file as configuration for Log4r'
+    @switches << parser.define(
+      '--log-config PATH',
+      STARTS_WITH_NON_HYPHEN,
+      'use PATH file as configuration for Log4r'
     ) do |path|
       @options[:log_config] = path
     end
 
     level_list = LOG_LEVELS.join(', ')
-    parser.on(
+    @switches << parser.define(
       '--log-level LEVEL',
       LOG_LEVELS,
       LOG_ALIASES,
@@ -494,7 +612,7 @@ Environment variables:
       @options[:log_level] = log_level
     end
 
-    parser.on(
+    @switches << parser.define(
       '--suppress-warning-include-statement-missing-version',
       %q<don't complain about "include package" without a version>
     ) do
@@ -504,46 +622,32 @@ Environment variables:
     return
   end
 
-  def help(parser)
-    puts parser.help
-    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
+  def new_variable_statement(option, name_value, statement_class)
+    variable, value = statement_class.parse_name_value(name_value) {
+      raise_invalid_argument(option, name_value)
+    }
 
-    return
+    return statement_class.new(nil, "#{option} option", variable, value)
   end
 
-  def version()
-    line = nil
+  # This will be the base package, unless we're publishing (in which case it's
+  # the name to publish to.
+  def derive_primary_descriptor(raw_string)
+    return if raw_string.nil?
 
-    begin
-      File.open(
-        "#{File.expand_path(File.dirname(__FILE__) + '/../../VERSION')}"
-      ) do |file|
-        line = file.gets
-      end
-    rescue
-      $stderr.puts 'Could not retrieve version number. Something has mucked with your Fig install.'
+    @descriptor = Fig::PackageDescriptor.parse(
+      raw_string,
+      :name    => :required,
+      :version => :required,
+      :validation_context => ' specified on command line'
+    )
 
+    if @descriptor.config && config()
+      $stderr.puts \
+        %Q<Cannot specify both --config and a config in the descriptor "#{raw_string}".>
       @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.>
-
-      @exit_code = 1
-      return
-    end
-
-    puts File.basename($0) + ' v' + line
-
-    @exit_code = 0
     return
   end
 end