fig 0.1.69 → 0.1.71

data/lib/fig/command/action/role/publish.rb

@@ -19,6 +19,10 @@ module Fig::Command::Action::Role::Publish
     return true
   end
 
+  def cares_about_package_content_options?()
+    return true
+  end
+
   def load_base_package?()
     return true
   end

data/lib/fig/command/options.rb

@@ -1,6 +1,9 @@
 require 'fig/command/action/clean'
+require 'fig/command/action/dump_package_definition_parsed'
+require 'fig/command/action/dump_package_definition_text'
 require 'fig/command/action/get'
 require 'fig/command/action/help'
+require 'fig/command/action/help_long'
 require 'fig/command/action/list_configs'
 require 'fig/command/action/list_dependencies'
 require 'fig/command/action/list_dependencies/all_configs'
@@ -14,6 +17,7 @@ require 'fig/command/action/list_variables/all_configs'
 require 'fig/command/action/list_variables/default'
 require 'fig/command/action/list_variables/tree'
 require 'fig/command/action/list_variables/tree_all_configs'
+require 'fig/command/action/options'
 require 'fig/command/action/publish'
 require 'fig/command/action/publish_local'
 require 'fig/command/action/run_command_line'
@@ -35,27 +39,6 @@ class Fig::Command; end
 
 # Command-line processing.
 class Fig::Command::Options
-  # Public version of #strip_shell_command() here so that it can be kept in
-  # sync.
-  def self.strip_shell_command(argv)
-    argv.each_with_index do |arg, i|
-      found_command_line_end = false
-
-      case arg
-        when '--'
-          found_command_line_end = true
-        when '--command-extra-args'
-          found_command_line_end = true
-      end
-
-      if found_command_line_end
-        return argv.slice(i..-1)
-      end
-    end
-
-    return argv
-  end
-
   attr_reader   :command_extra_argv
   attr_reader   :config
   attr_reader   :descriptor
@@ -84,7 +67,6 @@ class Fig::Command::Options
     strip_shell_command(argv)
 
     set_up_parser()
-    @help_message = @parser.help
 
     @parser.parse!(argv)
 
@@ -128,13 +110,16 @@ class Fig::Command::Options
     return @force
   end
 
-  def help_message()
-    return @help_message + <<-'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.
+  def short_help_message()
+    return @parser.short_help
+  end
 
-    END_MESSAGE
+  def full_help_message()
+    return @parser.full_help + EXTRA_OPTIONS_DESCRIPTION
+  end
+
+  def options_message()
+    return @parser.options_message + EXTRA_OPTIONS_DESCRIPTION
   end
 
   def login?()
@@ -151,7 +136,14 @@ class Fig::Command::Options
 
   private
 
-  # Note that OptionParser insist that the regex match the entire value, not
+  EXTRA_OPTIONS_DESCRIPTION = <<-'END_DESCRIPTION'
+        --                           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_DESCRIPTION
+
+  # Note that OptionParser insists 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
@@ -187,12 +179,12 @@ class Fig::Command::Options
   end
 
   def set_up_parser
+    set_up_package_configuration_source()
+    set_up_remote_repository_access()
     set_up_queries()
     set_up_commands()
-    set_up_package_configuration_source()
     set_up_environment_statements()
     set_up_package_contents_statements()
-    set_up_remote_repository_access()
     set_up_program_configuration()
 
     return
@@ -200,10 +192,20 @@ class Fig::Command::Options
 
   def set_up_queries()
     @parser.on_tail(
-      '-?', '-h','--help','display this help text'
+      '-?', '-h', '--help', 'display short usage summary'
     ) do
       set_base_action(Fig::Command::Action::Help)
     end
+    @parser.on_tail(
+      '--help-long', 'display full usage'
+    ) do
+      set_base_action(Fig::Command::Action::HelpLong)
+    end
+    @parser.on_tail(
+      '--options', 'just list Fig options'
+    ) do
+      set_base_action(Fig::Command::Action::Options)
+    end
 
     @parser.on_tail('-v', '--version', 'print Fig version') do
       set_base_action(Fig::Command::Action::Version)
@@ -221,6 +223,19 @@ class Fig::Command::Options
 
     set_up_listings()
 
+    @parser.on(
+      '--dump-package-definition-text',
+      'emit the unparsed definition of the base package, if there is one'
+    ) do
+      set_base_action(Fig::Command::Action::DumpPackageDefinitionText)
+    end
+    @parser.on(
+      '--dump-package-definition-parsed',
+      'emit the parsed definition of the base package'
+    ) do
+      set_base_action(Fig::Command::Action::DumpPackageDefinitionParsed)
+    end
+
     return
   end
 
@@ -297,6 +312,14 @@ class Fig::Command::Options
       set_base_action(Fig::Command::Action::PublishLocal)
     end
 
+    @force = nil
+    @parser.on(
+      '--force',
+      'force-overwrite existing version of a package to the remote repo'
+    ) do |force|
+      @force = force
+    end
+
     return
   end
 
@@ -418,7 +441,7 @@ class Fig::Command::Options
       'include PATH archive in package (when using --publish)'
     ) do |path|
       @package_contents_statements <<
-        Fig::Statement::Archive.new(nil, '--archive option', path)
+        new_content_statement('--archive', path, Fig::Statement::Archive)
     end
 
     @parser.on(
@@ -427,7 +450,7 @@ class Fig::Command::Options
       'include PATH resource in package (when using --publish)'
     ) do |path|
       @package_contents_statements <<
-        Fig::Statement::Resource.new(nil, '--resource option', path)
+        new_content_statement('--resource', path, Fig::Statement::Resource)
     end
 
     return
@@ -456,14 +479,6 @@ class Fig::Command::Options
       @login = true
     end
 
-    @force = nil
-    @parser.on(
-      '--force',
-      'force-overwrite existing version of a package to the remote repo'
-    ) do |force|
-      @force = force
-    end
-
     return
   end
 
@@ -500,14 +515,14 @@ class Fig::Command::Options
       @log_level = log_level
     end
 
-    @update_lock_response = :fail
-    update_lock_responses = [:fail, :wait, :ignore]
+    @update_lock_response = nil # Nil means wait, but warn.
+    update_lock_responses = [:wait, :fail, :ignore]
     response_list = update_lock_responses.join(', ')
     @parser.on(
       '--update-lock-response TYPE',
       update_lock_responses,
       'what to do when update lock already exists',
-      "  (#{response_list}, default is fail)"
+      "  (#{response_list}, default is wait)"
     ) do |response|
       @update_lock_response = response
     end
@@ -563,6 +578,16 @@ class Fig::Command::Options
     return statement_class.new(nil, "#{option} option", variable, value)
   end
 
+  def new_content_statement(option, path, statement_class)
+    statement_class.validate_url(path) {
+      |error_description|
+
+      @parser.raise_invalid_argument(option, path, error_description)
+    }
+
+    return statement_class.new(nil, "#{option} option", path)
+  end
+
   def set_up_sub_actions()
     if @base_action and @base_action.sub_action?
       # This is a cheat because the only things with sub-actions at present are

data/lib/fig/command/options/parser.rb

@@ -10,58 +10,105 @@ class Fig::Command::Options; end
 class Fig::Command::Options::Parser
   # This class knows way too much about how OptionParser works.
 
-  USAGE = <<-EOF
-Usage:
+  SHORT_USAGE = <<-'END_SHORT_USAGE'
+Short usage summary (use --help-long for everything):
 
-  fig [...] [DESCRIPTOR] [--update | --update-if-missing] [-- COMMAND]
-  fig [...] [DESCRIPTOR] [--update | --update-if-missing] [--command-extra-args VALUES]
+Running under Fig:
+  fig [...] [DESCRIPTOR] [-- COMMAND]
+  fig [...] [DESCRIPTOR] --command-extra-args VALUES
 
+Querying:
+  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
+  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
+
+Publishing packages:
   fig {--publish | --publish-local} DESCRIPTOR
-      [--resource PATH]
-      [--archive  PATH]
-      [--include  DESCRIPTOR]
-      [--override DESCRIPTOR]
-      [--force]
+      [--resource PATH]      [--archive  PATH]
+      [--include DESCRIPTOR] [--override DESCRIPTOR]
       [...]
 
-  fig --clean DESCRIPTOR [...]
+Standard options (represented as "[...]" above):
+      [--update | --update-if-missing]
+      [--set    VARIABLE=VALUE]
+      [--append VARIABLE=VALUE]
+      [--file PATH] [--no-file]
 
-  fig --get VARIABLE                                         [DESCRIPTOR] [...]
-  fig --list-configs                                         [DESCRIPTOR] [...]
+(--options for full option list; --help-long for everything)
+  END_SHORT_USAGE
+
+  FULL_USAGE = <<-'END_FULL_USAGE'
+Running under Fig:
+
+  fig [...] [DESCRIPTOR] [-- COMMAND]
+  fig [...] [DESCRIPTOR] --command-extra-args VALUES
+
+Querying:
+
+  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
   fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
-  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
+  fig --list-variables    [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-configs                                         [DESCRIPTOR] [...]
+  fig --dump-package-definition-text                         [DESCRIPTOR] [...]
+  fig --dump-package-definition-parsed                       [DESCRIPTOR] [...]
   fig {--list-local | --list-remote}                                      [...]
 
-  fig {--version | --help}
+Publishing packages:
 
+  fig {--publish | --publish-local} DESCRIPTOR
+      [--resource       PATH]
+      [--archive        PATH]
+      [{-i | --include} DESCRIPTOR]
+      [--override       DESCRIPTOR]
+      [--force]
+      [...]
 
-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.
+Local repository maintenance:
+
+  fig --clean DESCRIPTOR [...]
 
 Standard options (represented as "[...]" above):
 
-      [--set    VARIABLE=VALUE]
-      [--append VARIABLE=VALUE]
+      [-u | --update | -m | --update-if-missing]
+      --update-lock-response TYPE
+
+      [{-s | --set}    VARIABLE=VALUE]
+      [{-p | --append} VARIABLE=VALUE]
+
       [--file PATH] [--no-file]
-      [--config CONFIG]
-      [--login]
+      [{-c | --config} CONFIG]
+
+      [-l | --login]
+
       [--log-level LEVEL] [--log-config PATH]
-      [--figrc PATH] [--no-figrc]
+      [--figrc PATH]      [--no-figrc]
+
       [--suppress-warning-include-statement-missing-version]
 
+Information:
+
+  fig --help
+  fig --help-long
+  fig --options
+  fig {-v | --version}
+
+
+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.
+
 Environment variables:
 
-  FIG_REMOTE_URL (required),
-  FIG_HOME (path to local repository cache, defaults to $HOME/.fighome).
-  EOF
+  FIG_REMOTE_URL location of remote repository, required for remote operations
+  FIG_HOME       path to local repository, defaults to $HOME/.fighome
+  END_FULL_USAGE
 
   def initialize()
     @switches             = {}
     @argument_description = {}
     @parser               = OptionParser.new
 
-    @parser.banner = "#{USAGE}\n"
+    @parser.banner = "#{FULL_USAGE}\nAll options:\n\n"
   end
 
   def add_argument_description(options, description)
@@ -108,10 +155,18 @@ Environment variables:
     return
   end
 
-  def help()
+  def short_help()
+    return SHORT_USAGE
+  end
+
+  def full_help()
     return @parser.help
   end
 
+  def options_message()
+    return @parser.summarize('')
+  end
+
   def parse!(argv)
     begin
       @parser.parse!(argv)
@@ -121,7 +176,7 @@ Environment variables:
       raise_missing_argument(error.args[0])
     rescue OptionParser::InvalidOption => error
       raise Fig::Command::OptionError.new(
-        "Unknown option #{error.args[0]}.\n\n#{USAGE}"
+        "Unknown option #{error.args[0]}.\n\n#{SHORT_USAGE}"
       )
     rescue OptionParser::ParseError => error
       raise Fig::Command::OptionError.new(error.to_s)
@@ -130,7 +185,7 @@ Environment variables:
     return
   end
 
-  def raise_invalid_argument(option, value)
+  def raise_invalid_argument(option, value, description = nil)
     # *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
@@ -142,7 +197,7 @@ Environment variables:
       raise_missing_argument(option)
     end
 
-    description = @argument_description[option]
+    description ||= @argument_description[option]
     if description.nil?
       description = ''
     else
@@ -157,6 +212,9 @@ Environment variables:
   private
 
   def make_switch_array(arguments, block)
+    # This method is a means of interjecting ourselves between the creation of
+    # a Switch object and putting it into the list of actual switches.
+    #
     # From the OptionParser code, the contents of the array:
     #
     # +switch+::      OptionParser::Switch instance to be inserted.

data/lib/fig/figrc.rb

@@ -14,12 +14,23 @@ class Fig::FigRC
       "#{Fig::Repository::METADATA_SUBDIRECTORY}/figrc"
 
   def self.find(
-    override_path, repository_url, login, fig_home, disable_figrc = false
+    override_path,
+    specified_repository_url,
+    login,
+    fig_home,
+    disable_figrc = false
   )
-    configuration = Fig::ApplicationConfiguration.new(repository_url)
+    configuration = Fig::ApplicationConfiguration.new()
 
     handle_override_configuration(configuration, override_path)
     handle_figrc(configuration) if not disable_figrc
+
+    repository_url =
+      derive_repository_url(specified_repository_url, configuration)
+
+    configuration.base_whitelisted_url = repository_url
+    configuration.remote_repository_url = repository_url
+
     handle_repository_configuration(
       configuration, repository_url, login, fig_home
     )
@@ -58,6 +69,12 @@ class Fig::FigRC
     return
   end
 
+  def self.derive_repository_url(specified_repository_url, configuration)
+    return specified_repository_url if specified_repository_url
+
+    return configuration['default FIG_REMOTE_URL']
+  end
+
   def self.handle_repository_configuration(
     configuration, repository_url, login, fig_home
   )
@@ -77,7 +94,7 @@ class Fig::FigRC
       repo_config_exists = false
     end
 
-    return configuration if not repo_config_exists
+    return if not repo_config_exists
 
     begin
       configuration.push_dataset(