fig 1.1.0 → 1.2.0

data/lib/fig/runtime_environment.rb

@@ -2,15 +2,17 @@ require 'stringio'
 
 require 'fig/include_backtrace'
 require 'fig/logging'
+require 'fig/not_yet_parsed_package'
 require 'fig/package'
 require 'fig/package_descriptor'
 require 'fig/repository_error'
 require 'fig/statement/include'
+require 'fig/statement/include_file'
 require 'fig/statement/override'
 require 'fig/statement/path'
 require 'fig/statement/set'
-require 'fig/user_input_error'
 require 'fig/unparser'
+require 'fig/user_input_error'
 
 module Fig; end
 
@@ -24,16 +26,19 @@ class Fig::RuntimeEnvironment
 
   def initialize(
     repository,
+    parser,
     suppress_includes,
     variables_override,
     working_directory_maintainer
   )
     @repository                   = repository
+    @parser                       = parser
     @suppress_includes            = suppress_includes
     @variables                    =
       variables_override || Fig::OperatingSystem.get_environment_variables()
     @retrieves                    = {}
-    @packages                     = {}
+    @named_packages               = {}
+    @packages_from_files          = {}
     @working_directory_maintainer = working_directory_maintainer
   end
 
@@ -74,13 +79,13 @@ class Fig::RuntimeEnvironment
       )
     end
 
-    @packages[name] = package
+    @named_packages[name] = package
 
     return
   end
 
   def get_package(name)
-    return @packages[name]
+    return @named_packages[name]
   end
 
   def apply_config(package, config_name, backtrace)
@@ -88,6 +93,10 @@ class Fig::RuntimeEnvironment
       return
     end
 
+    Fig::Logging.debug(
+      "Applying #{package.to_descriptive_string_with_config config_name}."
+    )
+
     new_backtrace = backtrace ||
       Fig::IncludeBacktrace.new(
         nil,
@@ -99,11 +108,13 @@ class Fig::RuntimeEnvironment
         )
       )
 
-    config = package[config_name]
+    config = nil
+    begin
+      config = package[config_name]
+    rescue Fig::NoSuchPackageConfigError => error
+      raise_repository_error(error.message, new_backtrace, error.package)
+    end
 
-    Fig::Logging.debug(
-      "Applying #{package.to_descriptive_string_with_config config_name}."
-    )
     package.add_applied_config_name(config_name)
     config.statements.each do
       |statement|
@@ -155,7 +166,11 @@ class Fig::RuntimeEnvironment
     when Fig::Statement::Set
       set_variable(package, statement, backtrace)
     when Fig::Statement::Include
-      include_config(package, statement.descriptor, backtrace)
+      include_config(package, statement, backtrace)
+    when Fig::Statement::IncludeFile
+      include_file_config(
+        package, statement.path, statement.config_name, backtrace
+      )
     when Fig::Statement::Override
       backtrace.add_override(statement)
     end
@@ -180,20 +195,46 @@ class Fig::RuntimeEnvironment
 
   private
 
-  def include_config(starting_package, descriptor, backtrace)
+  def include_config(starting_package, include_statement, backtrace)
     # Because package application starts with the synthetic package for the
     # command-line, we can't really disable includes, full stop.  Instead, we
     # use the flag on the base package to break the chain of includes.
-    #
-    # Alternative approach: We could put a flag on synthetic include statements
-    # that says to always apply them.
     return if starting_package.base? && @suppress_includes == :all
 
+    package, resolved_descriptor, new_backtrace =
+      determine_included_package starting_package, include_statement, backtrace
+
+    return if                                   \
+          starting_package.base?                \
+      &&  @suppress_includes == :cross_package  \
+      &&  package != starting_package
+
+    apply_config(
+      package,
+      resolved_descriptor.config || Fig::Package::DEFAULT_CONFIG,
+      new_backtrace
+    )
+
+    return
+  end
+
+  def determine_included_package(starting_package, include_statement, backtrace)
+    descriptor = include_statement.descriptor
+
+    if ! include_statement.included_package.nil?
+      return \
+        include_statement.included_package,
+        descriptor,
+        Fig::IncludeBacktrace.new(backtrace, descriptor)
+    end
+
     resolved_descriptor = nil
 
     # Check to see if this include has been overridden.
-    if backtrace
+    if (
+      backtrace and
       override_package_name = descriptor.name || starting_package.name
+    )
       override = backtrace.get_override(override_package_name)
       if override
         resolved_descriptor =
@@ -205,21 +246,33 @@ class Fig::RuntimeEnvironment
     resolved_descriptor ||= descriptor
 
     new_backtrace = Fig::IncludeBacktrace.new(backtrace, resolved_descriptor)
-    package = lookup_package(
-      resolved_descriptor.name || starting_package.name,
-      resolved_descriptor.version,
-      new_backtrace
-    )
+    package = nil
 
-    return if                                   \
-          starting_package.base?                \
-      &&  @suppress_includes == :cross_package  \
-      &&  package != starting_package
+    if included_name = resolved_descriptor.name || starting_package.name
+      package = lookup_package(
+        included_name, resolved_descriptor.version, new_backtrace
+      )
+    else
+      package = starting_package
+    end
+
+    return package, resolved_descriptor, new_backtrace
+  end
+
+  def include_file_config(including_package, path, config_name, backtrace)
+    return if @suppress_includes
+
+    full_path = File.absolute_path(path, including_package.base_directory)
+
+    descriptor =
+      Fig::PackageDescriptor.new(nil, nil, nil, :description => full_path)
+
+    new_backtrace = Fig::IncludeBacktrace.new(backtrace, descriptor)
+    package =
+      package_for_file(including_package, full_path, descriptor, backtrace)
 
     apply_config(
-      package,
-      resolved_descriptor.config || Fig::Package::DEFAULT_CONFIG,
-      new_backtrace
+      package, config_name || Fig::Package::DEFAULT_CONFIG, new_backtrace
     )
 
     return
@@ -284,7 +337,7 @@ class Fig::RuntimeEnvironment
         Fig::PackageDescriptor.new(name, version, nil)
       )
       package.backtrace = backtrace
-      @packages[name] = package
+      @named_packages[name] = package
     elsif version && version != package.version
       raise_repository_error(
         "Version mismatch for package #{name} (#{version} vs #{package.version}).",
@@ -296,6 +349,32 @@ class Fig::RuntimeEnvironment
     return package
   end
 
+  def package_for_file(including_package, full_path, descriptor, backtrace)
+    package = @packages_from_files[full_path]
+    return package if package
+
+    if ! File.exist? full_path
+      raise_repository_error(
+        %Q<"#{full_path}" does not exist.>, backtrace, including_package
+      )
+    end
+
+    content = File.read full_path
+
+    unparsed_package = Fig::NotYetParsedPackage.new
+    unparsed_package.descriptor         = descriptor
+    unparsed_package.working_directory  = unparsed_package.base_directory =
+      File.dirname(full_path)
+    unparsed_package.source_description = full_path
+    unparsed_package.unparsed_text      = content
+
+    package = @parser.parse_package unparsed_package
+
+    @packages_from_files[full_path] = package
+
+    return package
+  end
+
   def determine_package_for_execution(base_package, base_config, descriptor)
     config_name =
       determine_config_to_executed(base_package, base_config, descriptor)
@@ -367,13 +446,20 @@ class Fig::RuntimeEnvironment
   )
     tokenized_value = statement.tokenized_value
     return tokenized_value.to_expanded_string { '@' } \
-      unless package && package.name
+      unless package && (package.name || ! (package.synthetic? || package.base?))
 
     variable_value =
       tokenized_value.to_expanded_string { package.runtime_directory }
 
     return variable_value if not @retrieves.member?(statement.name)
 
+    if ! package.name
+      Fig::Logging.warn \
+        "Retrieve of #{statement.name}=#{variable_value} ignored because the statement#{statement.position_string} is in an unnamed package."
+
+      return variable_value
+    end
+
     return retrieve_files(
       statement.name, variable_value, package, backtrace
     )

data/lib/fig/statement/include.rb

@@ -8,7 +8,9 @@ module Fig; end
 # incorporation of the "default" configuration from that other package if no
 # ":configname" is specified.
 class Fig::Statement::Include < Fig::Statement
-  attr_reader :descriptor, :containing_package_descriptor
+  attr_reader :descriptor
+  attr_reader :included_package
+  attr_reader :containing_package_descriptor
 
   # Centralized definition of requirements for descriptors for include
   # statements.
@@ -16,10 +18,17 @@ class Fig::Statement::Include < Fig::Statement
     return Fig::PackageDescriptor.parse(raw_string, options)
   end
 
-  def initialize(line_column, source_description, descriptor, containing_package_descriptor)
+  def initialize(
+    line_column,
+    source_description,
+    descriptor,
+    included_package,  # For synthetic Package for command-line options.
+    containing_package_descriptor
+  )
     super(line_column, source_description)
 
     @descriptor                    = descriptor
+    @included_package              = included_package
     @containing_package_descriptor = containing_package_descriptor
   end
 
@@ -71,11 +80,11 @@ class Fig::Statement::Include < Fig::Statement
   end
 
   def minimum_grammar_for_emitting_input()
-    return [0]
+    return minimum_grammar
   end
 
   def minimum_grammar_for_publishing()
-    return [0]
+    return minimum_grammar
   end
 
   private
@@ -101,4 +110,12 @@ class Fig::Statement::Include < Fig::Statement
   def referenced_config_name()
     config_name() || Fig::Package::DEFAULT_CONFIG
   end
+
+  def minimum_grammar()
+    if included_package
+      raise 'Cannot unparse synthetic include statement with directly referenced package.'
+    end
+
+    return [0]
+  end
 end

data/lib/fig/statement/include_file.rb

@@ -0,0 +1,94 @@
+require 'fig/package_descriptor'
+require 'fig/statement'
+require 'fig/user_input_error'
+
+module Fig; end
+
+# Like an include, but of an unpublished file.
+class Fig::Statement::IncludeFile < Fig::Statement
+  def self.parse_path_with_config(path_with_config, &block)
+    if match = PATH_WITH_CONFIG_PATTERN.match(path_with_config)
+      return validate_and_process_raw_path_and_config_name(
+        match[:path], match[:config], &block
+      )
+    end
+
+    yield 'could not be understood as a path followed by a config name.'
+    return
+  end
+
+  def self.validate_and_process_raw_path_and_config_name(
+    raw_path, config_name, &block
+  )
+    if raw_path !~ /['"]/ && raw_path =~ /:/
+      yield 'has an unquoted colon (:) in the path portion.'
+      return
+    end
+    if (
+      ! config_name.nil? &&
+      config_name !~ Fig::PackageDescriptor::COMPONENT_PATTERN
+    )
+      yield "contains an invalid config name (#{config_name})."
+      return
+    end
+    tokenized_path = validate_and_process_escapes_in_path(raw_path, &block)
+    return if tokenized_path.nil?
+
+    return tokenized_path.to_expanded_string, config_name
+  end
+
+  private
+
+  def self.validate_and_process_escapes_in_path(path, &block)
+    return Fig::StringTokenizer.new.tokenize(path, &block)
+  end
+
+
+  public
+
+  attr_reader :path
+  attr_reader :config_name
+  attr_reader :containing_package_descriptor
+
+  def initialize(
+    line_column,
+    source_description,
+    path,
+    config_name,
+    containing_package_descriptor
+  )
+    super(line_column, source_description)
+
+    @path                          = path
+    @config_name                   = config_name
+    @containing_package_descriptor = containing_package_descriptor
+  end
+
+  def statement_type()
+    return 'include-file'
+  end
+
+  def unparse_as_version(unparser)
+    return unparser.include_file(self)
+  end
+
+  def minimum_grammar_for_emitting_input()
+    return [2, %q<didn't exist prior to v2>]
+  end
+
+  def minimum_grammar_for_publishing()
+    raise Fig::UserInputError.new 'Cannot publish an include-file statement.'
+  end
+
+  private
+
+  PATH_WITH_CONFIG_PATTERN = /
+    \A
+    (?<path> .+?)
+    (?:
+      [:]
+      (?<config> #{Fig::PackageDescriptor::UNBRACKETED_COMPONENT_PATTERN})
+    )?
+    \z
+  /x
+end

data/lib/fig/unparser.rb

@@ -20,9 +20,13 @@ module Fig::Unparser
     case version
     when 0
       return Fig::Unparser::V0, explanations
+    when 1
+      return Fig::Unparser::V1, explanations
+    when 2
+      return Fig::Unparser::V2, explanations
     end
 
-    return Fig::Unparser::V1, explanations
+    raise "Unexpected version #{version}."
   end
 
   def self.determine_version_and_unparse(
@@ -113,7 +117,7 @@ module Fig::Unparser
   end
 
   def command(statement)
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   def configuration(configuration_statement)
@@ -144,7 +148,7 @@ module Fig::Unparser
   end
 
   def grammar_version(statement)
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   def include(statement)
@@ -159,6 +163,10 @@ module Fig::Unparser
     return
   end
 
+  def include_file(statement)
+    raise NotImplementedError.new self
+  end
+
   def override(statement)
     add_indent
 
@@ -186,7 +194,7 @@ module Fig::Unparser
   end
 
   def retrieve(statement)
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   def set(statement)
@@ -202,13 +210,13 @@ module Fig::Unparser
   end
 
   def grammar_description
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   private
 
   def asset(keyword, statement)
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   def asset_path(statement)
@@ -220,7 +228,7 @@ module Fig::Unparser
   end
 
   def environment_variable(statement, keyword)
-    raise NotImplementedError
+    raise NotImplementedError.new self
   end
 
   def add_indent(indent_level = @indent_level)