fig 0.1.65 → 0.1.67

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

@@ -0,0 +1,90 @@
+require 'set'
+
+require 'fig/include_backtrace'
+require 'fig/package_descriptor'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+module Fig::Command::Action::Role::ListWalkingDependencyTree
+  def walk_dependency_tree(base_package, config_names, backtrace, depth, &block)
+    config_names.each do
+      |config_name|
+
+      if depth < 1
+        @execution_context.repository.reset_cached_data
+      end
+
+      yield base_package, config_name, depth
+
+      new_backtrace = Fig::IncludeBacktrace.new(
+        backtrace,
+        Fig::PackageDescriptor.new(
+          base_package.name(),
+          base_package.version(),
+          config_name
+        )
+      )
+
+      base_package.package_dependencies(config_name, new_backtrace).each do
+        |descriptor|
+
+        package = nil
+        if descriptor.name
+          package =
+            @execution_context.repository.get_package(
+              descriptor, :allow_any_version
+            )
+        else
+          package = base_package
+        end
+
+        walk_dependency_tree(
+          package, [descriptor.config], new_backtrace, depth + 1, &block
+        )
+      end
+    end
+
+    return
+  end
+
+  def configure(options)
+    @descriptor = options.descriptor
+  end
+
+  def gather_package_dependency_configurations()
+    packages = {}
+    starting_config_names = base_display_config_names()
+    base_package = @execution_context.base_package
+
+    if ! base_package.name.nil?
+      packages[base_package] = starting_config_names.to_set
+    end
+
+    walk_dependency_tree(base_package, starting_config_names, nil, 0) do
+      |package, config_name, depth|
+
+      if (
+            ! package.name.nil?           \
+        &&  ! (
+                  ! list_all_configs?    \
+              &&  @descriptor                     \
+              &&  package.name == @descriptor.name
+            )
+      )
+        packages[package] ||= Set.new
+        packages[package] << config_name
+      end
+    end
+
+    if ! list_all_configs? && @descriptor
+      packages.reject! do |package, config_names|
+        package.name == @descriptor.name
+      end
+    end
+
+    return packages
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'fig/package'
+require 'fig/statement/configuration'
+require 'fig/user_input_error'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+module Fig::Command::Action::Role::Publish
+  def descriptor_requirement()
+    return :required
+  end
+
+  def allow_both_descriptor_and_file?()
+    # Actually, publishing requires a descriptor and another source of the base
+    # package.
+    return true
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def base_package_can_come_from_descriptor?()
+    return false
+  end
+
+  def register_base_package?()
+    return false
+  end
+
+  def apply_config?()
+    return true
+  end
+
+  def apply_base_config?()
+    return nil # don't care
+  end
+
+  def configure(options)
+    @descriptor                   = options.descriptor
+    @environment_statements       = options.environment_statements
+    @package_contents_statements  = options.package_contents_statements
+    @force                        = options.force?
+
+    return
+  end
+
+  def publish_preflight()
+    if @descriptor.name.nil? || @descriptor.version.nil?
+      raise Fig::UserInputError.new(
+        'Please specify a package name and a version name.'
+      )
+    end
+    if @descriptor.name == '_meta'
+      raise Fig::UserInputError.new(
+        %q<Due to implementation issues, cannot create a package named "_meta".>
+      )
+    end
+
+    # TODO: fail on environment statements && --file because the --file will
+    # get ignored as far as statements are concerned.
+    publish_statements = nil
+    if not @environment_statements.empty?
+      @publish_statements =
+        @package_contents_statements +
+        [
+          Fig::Statement::Configuration.new(
+            nil,
+            nil,
+            Fig::Package::DEFAULT_CONFIG,
+            @environment_statements
+          )
+        ]
+    elsif not @package_contents_statements.empty?
+      raise Fig::UserInputError.new(
+        '--resource/--archive options were specified, but no --set/--append option was given. Will not publish.'
+      )
+    else
+      if not @execution_context.base_package.statements.empty?
+        @publish_statements = @execution_context.base_package.statements
+      else
+        raise Fig::UserInputError.new('Nothing to publish.')
+      end
+    end
+
+    return
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'fig/command/action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+module  Fig::Command::Action::Role; end
+
+module Fig::Command::Action::Role::Update
+  def descriptor_requirement()
+    return nil
+  end
+
+  def allow_both_descriptor_and_file?()
+    # We don't care, so we let the base action say what it wants.
+    return true
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return true
+  end
+
+  def apply_config?()
+    return true
+  end
+
+  def apply_base_config?()
+    return true
+  end
+
+  def retrieves_should_happen?()
+    return true
+  end
+
+  def remote_operation_necessary?()
+    return true
+  end
+
+  def execute()
+    # Don't do anything.
+    return Fig::Command::Action::EXIT_SUCCESS
+  end
+end

data/lib/fig/command/action/run_command_line.rb

@@ -0,0 +1,45 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::RunCommandLine
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<-->
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return true
+  end
+
+  def apply_config?()
+    return true
+  end
+
+  def apply_base_config?()
+    return true
+  end
+
+  def configure(options)
+    @command_line = options.shell_command
+  end
+
+  def execute()
+    @execution_context.environment.execute_shell(@command_line) do
+      |command| @execution_context.operating_system.shell_exec command
+    end
+  end
+end

data/lib/fig/command/action/run_command_statement.rb

@@ -0,0 +1,52 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::RunCommandStatement
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--command-extra-args>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return true
+  end
+
+  def apply_config?()
+    return true
+  end
+
+  def apply_base_config?()
+    return true
+  end
+
+  def configure(options)
+    @extra_argv = options.command_extra_argv
+    @descriptor = options.descriptor
+  end
+
+  def execute()
+    environment   = @execution_context.environment
+    base_package  = @execution_context.base_package
+
+    # TODO: Elliot's current theory is that this is pointless as long as
+    # we've applied the config.
+    environment.include_config(base_package, @descriptor, nil)
+    environment.execute_config(
+      base_package, @descriptor, @extra_argv || []
+    ) { |command| @execution_context.operating_system.shell_exec command }
+  end
+end

data/lib/fig/command/action/update.rb

@@ -0,0 +1,17 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+require 'fig/command/action/role/update'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::Update
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+  include Fig::Command::Action::Role::Update
+
+  def options()
+    return %w<--update>
+  end
+end

data/lib/fig/command/action/update_if_missing.rb

@@ -0,0 +1,17 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+require 'fig/command/action/role/update'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::UpdateIfMissing
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+  include Fig::Command::Action::Role::Update
+
+  def options()
+    return %w<--update-if-missing>
+  end
+end

data/lib/fig/command/action/version.rb

@@ -0,0 +1,27 @@
+require 'fig'
+require 'fig/command'
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::Version
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--version>
+  end
+
+  def execute_immediately_after_command_line_parse?
+    return true
+  end
+
+  def execute()
+    puts File.basename($0) + ' v' + Fig::VERSION
+
+    return EXIT_SUCCESS
+  end
+end

data/lib/fig/command/{optionerror.rb → option_error.rb}

@@ -1,4 +1,4 @@
-require 'fig/userinputerror'
+require 'fig/user_input_error'
 
 module Fig; end
 class Fig::Command; end

data/lib/fig/command/options.rb

@@ -1,8 +1,31 @@
 require 'optparse'
 
-require 'fig/command/optionerror'
+require 'fig/command/action/clean'
+require 'fig/command/action/get'
+require 'fig/command/action/help'
+require 'fig/command/action/list_configs'
+require 'fig/command/action/list_dependencies'
+require 'fig/command/action/list_dependencies/all_configs'
+require 'fig/command/action/list_dependencies/default'
+require 'fig/command/action/list_dependencies/tree'
+require 'fig/command/action/list_dependencies/tree_all_configs'
+require 'fig/command/action/list_local'
+require 'fig/command/action/list_remote'
+require 'fig/command/action/list_variables'
+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/publish'
+require 'fig/command/action/publish_local'
+require 'fig/command/action/run_command_line'
+require 'fig/command/action/run_command_statement'
+require 'fig/command/action/update'
+require 'fig/command/action/update_if_missing'
+require 'fig/command/action/version'
+require 'fig/command/option_error'
 require 'fig/package'
-require 'fig/packagedescriptor'
+require 'fig/package_descriptor'
 require 'fig/statement/archive'
 require 'fig/statement/include'
 require 'fig/statement/path'
@@ -63,21 +86,50 @@ Environment variables:
   LOG_LEVELS = %w[ off fatal error warn info debug all ]
   LOG_ALIASES = { 'warning' => 'warn' }
 
+  # 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 :shell_command
   attr_reader :command_extra_argv
   attr_reader :descriptor
   attr_reader :exit_code
+  attr_reader :update_packages
 
   def initialize(argv)
     process_command_line(argv)
   end
 
-  def archives()
-    return @options[:archives]
-  end
+  def actions()
+    actions = []
 
-  def clean?()
-    return @options[:clean]
+    # Update has got to come first so that the Repository knows what's going
+    # on.
+    if @update_action
+      actions << @update_action
+    end
+    if @base_action
+      actions << @base_action
+    end
+
+    return actions
   end
 
   def config()
@@ -92,30 +144,14 @@ Environment variables:
     return @options[:force]
   end
 
-  def get()
-    return @options[:get]
-  end
-
-  def help?()
-    return @options[:help]
+  def variable_to_get()
+    return @options[:variable_to_get]
   end
 
   def home()
     return @options[:home]
   end
 
-  def listing()
-    return @options[:listing]
-  end
-
-  def list_tree?()
-    return @options[:list_tree]
-  end
-
-  def list_all_configs?()
-    return @options[:list_all_configs]
-  end
-
   def log_config()
     return @options[:log_config]
   end
@@ -140,86 +176,21 @@ Environment variables:
     return @options[:package_definition_file]
   end
 
-  def publish?()
-    return @options[:publish]
-  end
-
-  def publish_local?()
-    return @options[:publish_local]
-  end
-
-  def publishing?()
-    return publish? || publish_local?
-  end
-
-  def resources()
-    return @options[:resources]
+  def package_contents_statements()
+    return @options[:package_contents_statements]
   end
 
   def suppress_warning_include_statement_missing_version?()
     return @options[:suppress_warning_include_statement_missing_version]
   end
 
-  def update?()
-    return @options[:update]
-  end
-
-  def update_if_missing?()
-    return @options[:update_if_missing]
-  end
-
-  def updating?()
-    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
-  # to be set by a command-line option in general; if we do this, the
-  # Environment class will need to be changed to support deletion of values
-  # from ENV.
-  def reset_environment?()
-    return listing() == :variables
-  end
-
-  # 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
-
-      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
-    end
-
-    return
-  end
-
-  # This needs to be public for efficient use of custom command.rb wrappers.
-  def help()
-    puts @help_message
-    puts <<-'END_MESSAGE'
+  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.
 
     END_MESSAGE
-
-    return 0
   end
 
   private
@@ -234,6 +205,14 @@ Environment variables:
     '--append' => Fig::Statement::Path::ARGUMENT_DESCRIPTION
   }
 
+  def list_tree?()
+    return @options[:list_tree]
+  end
+
+  def list_all_configs?()
+    return @options[:list_all_configs]
+  end
+
   def process_command_line(argv)
     argv = argv.clone
     strip_shell_command(argv)
@@ -271,6 +250,34 @@ Environment variables:
     end
 
     derive_primary_descriptor(argv.first)
+    if not @base_action and @descriptor
+      set_base_action(Fig::Command::Action::RunCommandStatement)
+    end
+    set_up_sub_actions()
+
+    actions().each {|action| action.configure(self)}
+
+    return
+  end
+
+  def strip_shell_command(argv)
+    argv.each_with_index do |arg, i|
+      terminating_option = nil
+
+      case arg
+        when '--'
+          set_base_action(Fig::Command::Action::RunCommandLine)
+          @shell_command = argv[(i+1)..-1]
+        when '--command-extra-args'
+          set_base_action(Fig::Command::Action::RunCommandStatement)
+          @command_extra_argv = argv[(i+1)..-1]
+      end
+
+      if @base_action
+        argv.slice!(i..-1)
+        break
+      end
+    end
 
     return
   end
@@ -324,11 +331,11 @@ Environment variables:
     @switches << parser.define_tail(
       '-?', '-h','--help','display this help text'
     ) do
-      @options[:help] = true
+      set_base_action(Fig::Command::Action::Help)
     end
 
     @switches << parser.define_tail('-v', '--version', 'print Fig version') do
-      @options[:version] = true
+      set_base_action(Fig::Command::Action::Version)
     end
 
     @switches << parser.define(
@@ -336,8 +343,9 @@ Environment variables:
       '--get VARIABLE',
       STARTS_WITH_NON_HYPHEN,
       'print value of environment variable VARIABLE'
-    ) do |get|
-      @options[:get] = get
+    ) do |variable_to_get|
+      set_base_action(Fig::Command::Action::Get)
+      @options[:variable_to_get] = variable_to_get
     end
 
     set_up_listings(parser)
@@ -347,40 +355,41 @@ Environment variables:
 
   def set_up_listings(parser)
     option_mapping = {
-      :local_packages =>
-        [ '--list-local', '--list', 'list packages in $FIG_HOME' ],
+      :local_packages => [
+        ['--list-local', '--list', 'list packages in $FIG_HOME'],
+        Fig::Command::Action::ListLocal
+      ],
 
-      :configs =>
+      :configs => [
         ['--list-configs', 'list configurations'],
+        Fig::Command::Action::ListConfigs
+      ],
 
-      :dependencies =>
+      :dependencies => [
         ['--list-dependencies', 'list package dependencies, recursively'],
+        Fig::Command::Action::ListDependencies
+      ],
 
-      :variables =>
+      :variables => [
         [
           '--list-variables',
           'list all variables defined/used by package and its dependencies'
         ],
+        Fig::Command::Action::ListVariables
+      ],
 
-      :remote_packages =>
-        ['--list-remote', 'list packages in remote repo']
+      :remote_packages => [
+        ['--list-remote', 'list packages in remote repo'],
+        Fig::Command::Action::ListRemote
+      ],
     }
 
     option_mapping.each_pair do
-      | type, specification |
+      | type, specification_action_class |
 
+      specification, action_class = *specification_action_class
       @switches << parser.define(*specification) do
-        if @options[:listing]
-          options_string =
-            (
-              option_mapping.values.collect {|specification| specification[0]}
-            ).join(', ')
-
-          $stderr.puts "Can only specify one of #{options_string}."
-          @exit_code = 1
-        else
-          @options[:listing] = type
-        end
+        set_base_action(action_class)
       end
     end
 
@@ -402,19 +411,19 @@ Environment variables:
 
   def set_up_commands(parser)
     @switches << parser.define('--clean', 'remove package from $FIG_HOME') do
-      @options[:clean] = true
+      set_base_action(Fig::Command::Action::Clean)
     end
 
     @switches << parser.define(
       '--publish', 'install package in $FIG_HOME and in remote repo'
     ) do |publish|
-      @options[:publish] = true
+      set_base_action(Fig::Command::Action::Publish)
     end
 
     @switches << parser.define(
       '--publish-local', 'install package only in $FIG_HOME'
     ) do |publish_local|
-      @options[:publish_local] = true
+      set_base_action(Fig::Command::Action::PublishLocal)
     end
 
     return
@@ -525,23 +534,22 @@ Environment variables:
   end
 
   def set_up_package_contents_statements(parser)
-    @options[:archives] = []
+    @options[:package_contents_statements] = []
     @switches << parser.define(
       '--archive PATH',
       STARTS_WITH_NON_HYPHEN,
       'include PATH archive in package (when using --publish)'
     ) do |path|
-      @options[:archives] <<
+      @options[:package_contents_statements] <<
         Fig::Statement::Archive.new(nil, '--archive option', path)
     end
 
-    @options[:resources] =[]
     @switches << parser.define(
       '--resource PATH',
       STARTS_WITH_NON_HYPHEN,
       'include PATH resource in package (when using --publish)'
     ) do |path|
-      @options[:resources] <<
+      @options[:package_contents_statements] <<
         Fig::Statement::Resource.new(nil, '--resource option', path)
     end
 
@@ -554,7 +562,7 @@ Environment variables:
       '--update',
       'check remote repo for updates and download to $FIG_HOME as necessary'
     ) do
-      @options[:update] = true
+      set_update_action(Fig::Command::Action::Update, :unconditionally)
     end
 
     @switches << parser.define(
@@ -562,7 +570,7 @@ Environment variables:
       '--update-if-missing',
       'check remote repo for updates only if package missing from $FIG_HOME'
     ) do
-      @options[:update_if_missing] = true
+      set_update_action(Fig::Command::Action::UpdateIfMissing, :if_missing)
     end
 
     @switches << parser.define(
@@ -622,6 +630,39 @@ Environment variables:
     return
   end
 
+  def set_base_action(action_class)
+    action = action_class.new
+    # Help overrides anything.
+    if action_class == Fig::Command::Action::Help
+      @base_action = action
+      return
+    end
+
+    return if @base_action && @base_action == Fig::Command::Action::Help
+
+    if @base_action
+      raise Fig::Command::OptionError.new(
+        "Cannot specify both #{@base_action.primary_option()} and #{action.primary_option()}."
+      )
+    end
+
+    @base_action = action
+
+    return
+  end
+
+  def set_update_action(update_action_class, update_packages)
+    update_action = update_action_class.new
+    if @update_action
+      raise Fig::Command::OptionError.new(
+        "Cannot specify both #{@update_action.primary_option()} and #{update_action.primary_option()}."
+      )
+    end
+
+    @update_action = update_action
+    @update_packages = update_packages
+  end
+
   def new_variable_statement(option, name_value, statement_class)
     variable, value = statement_class.parse_name_value(name_value) {
       raise_invalid_argument(option, name_value)
@@ -630,8 +671,25 @@ Environment variables:
     return statement_class.new(nil, "#{option} option", variable, value)
   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
+      # --list-dependencies and --list-variables.  This will need to be
+      # refactored if we get further sub-action actions.
+      sub_action_name = :Default
+      if list_tree?
+        sub_action_name = list_all_configs? ? :TreeAllConfigs : :Tree
+      elsif list_all_configs?
+        sub_action_name = :AllConfigs
+      end
+
+      @base_action.sub_action =
+        @base_action.class.const_get(sub_action_name).new
+    end
+  end
+
   # This will be the base package, unless we're publishing (in which case it's
-  # the name to publish to.
+  # the name to publish to).
   def derive_primary_descriptor(raw_string)
     return if raw_string.nil?