fig 1.4.0 → 1.5.0

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/fig/command.rb

@@ -248,14 +248,14 @@ class Fig::Command
   end
 
   def prepare_runtime_environment()
-    @working_directory_maintainer = Fig::WorkingDirectoryMaintainer.new('.')
+    if retrieves_should_happen?
+      @working_directory_maintainer = Fig::WorkingDirectoryMaintainer.new('.')
 
-    Fig::AtExit.add do
-      @working_directory_maintainer.prepare_for_shutdown(
-        @base_package                             &&
-        retrieves_should_happen?                  &&
-        ! @options.suppress_cleanup_of_retrieves
-      )
+      Fig::AtExit.add do
+        @working_directory_maintainer.prepare_for_shutdown(
+          @base_package && ! @options.suppress_cleanup_of_retrieves
+        )
+      end
     end
 
     environment_variables = nil
@@ -455,7 +455,7 @@ class Fig::Command
   end
 
   def should_perform?(actions, failure_description, &predicate)
-    yes_actions, no_actions = actions.partition &predicate
+    yes_actions, no_actions = actions.partition(&predicate)
     # Filter out the "don't care" actions".
     no_actions = no_actions.select { |action| ! predicate.call(action).nil?  }
 

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

@@ -57,8 +57,7 @@ class Fig::Command::Action::DumpPackageDefinitionForCommandLine
       )
     ]
 
-
-    unparsed, explanations = text_assembler.assemble_package_definition
+    unparsed, * = text_assembler.assemble_package_definition
     print unparsed
 
     return EXIT_SUCCESS

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

@@ -55,7 +55,7 @@ class Fig::Command::Action::DumpPackageDefinitionParsed
     text_assembler = Fig::PackageDefinitionTextAssembler.new :emit_as_input
     text_assembler.add_output package.statements
 
-    unparsed, explanations = text_assembler.assemble_package_definition
+    unparsed, * = text_assembler.assemble_package_definition
     print unparsed
 
     return

data/lib/fig/command/package_loader.rb

@@ -80,7 +80,7 @@ class Fig::Command::PackageLoader
   def read_in_package_definition_file(config_file)
     if File.exist?(config_file)
       @package_loaded_from_path = config_file
-      @package_base_directory = File.dirname config_file
+      @package_include_file_base_directory = File.dirname config_file
 
       return File.read(config_file)
     else
@@ -107,11 +107,12 @@ class Fig::Command::PackageLoader
     )
 
     unparsed_package = Fig::NotYetParsedPackage.new
-    unparsed_package.descriptor         = descriptor
-    unparsed_package.working_directory  = '.'
-    unparsed_package.base_directory     = @package_base_directory || '.'
-    unparsed_package.source_description = source_description
-    unparsed_package.unparsed_text      = definition_text
+    unparsed_package.descriptor                   = descriptor
+    unparsed_package.working_directory            = '.'
+    unparsed_package.include_file_base_directory  =
+      @package_include_file_base_directory || '.'
+    unparsed_package.source_description           = source_description
+    unparsed_package.unparsed_text                = definition_text
 
     set_base_package(
       Fig::Parser.new(

data/lib/fig/{unparser.rb → deparser.rb}

@@ -1,10 +1,10 @@
 # Note: we very specifically do not require the files containing the
-# Unparser classes in order to avoid circular dependencies.
+# Deparser classes in order to avoid circular dependencies.
 
 module Fig; end
 
-module Fig::Unparser
-  # Determine the class of Unparser necessary for a set of Statements; the
+module Fig::Deparser
+  # Determine the class of Deparser necessary for a set of Statements; the
   # parameter can be a single statement or multiple.  Returns both the class
   # and a list of explanations of why the class was picked.
   def self.class_for_statements(
@@ -19,25 +19,25 @@ module Fig::Unparser
 
     case version
     when 0
-      return Fig::Unparser::V0, explanations
+      return Fig::Deparser::V0, explanations
     when 1
-      return Fig::Unparser::V1, explanations
+      return Fig::Deparser::V1, explanations
     when 2
-      return Fig::Unparser::V2, explanations
+      return Fig::Deparser::V2, explanations
     end
 
     raise "Unexpected version #{version}."
   end
 
-  def self.determine_version_and_unparse(
+  def self.determine_version_and_deparse(
     statements, emit_as_input_or_to_be_published_values
   )
-    unparser_class, explanations = self.class_for_statements(
+    deparser_class, explanations = self.class_for_statements(
       statements, emit_as_input_or_to_be_published_values
     )
-    unparser = unparser_class.new emit_as_input_or_to_be_published_values
+    deparser = deparser_class.new emit_as_input_or_to_be_published_values
 
-    return (unparser.unparse [statements].flatten), explanations
+    return (deparser.deparse [statements].flatten), explanations
   end
 
   private
@@ -46,7 +46,6 @@ module Fig::Unparser
     all_statements = gather_all_statements statements
 
     if emit_as_input_or_to_be_published_values == :emit_as_input
-      versions = []
       return all_statements.map {
         |statement|
 
@@ -95,13 +94,13 @@ module Fig::Unparser
 
   public
 
-  def unparse(statements)
+  def deparse(statements)
     # It's double dispatch time!
 
     @text         = ''
     @indent_level = @initial_indent_level
 
-    statements.each { |statement| statement.unparse_as_version(self) }
+    statements.each { |statement| statement.deparse_as_version(self) }
 
     text          = @text
     @text         = nil
@@ -135,7 +134,7 @@ module Fig::Unparser
       configuration_statement.statements.each do
         |statement|
 
-        statement.unparse_as_version(self)
+        statement.deparse_as_version(self)
       end
     ensure
       @indent_level -= 1

data/lib/fig/{unparser → deparser}/v0.rb

@@ -1,11 +1,11 @@
-require 'fig/unparser'
+require 'fig/deparser'
 
 module Fig; end
-module Fig::Unparser; end
+module Fig::Deparser; end
 
 # Handles serializing of statements in the v0 grammar.
-class Fig::Unparser::V0
-  include Fig::Unparser
+class Fig::Deparser::V0
+  include Fig::Deparser
 
   def initialize(
     emit_as_input_or_to_be_published_values,

data/lib/fig/{unparser → deparser}/v1.rb

@@ -1,13 +1,13 @@
-require 'fig/unparser'
-require 'fig/unparser/v1_base'
+require 'fig/deparser'
+require 'fig/deparser/v1_base'
 
 module Fig; end
-module Fig::Unparser; end
+module Fig::Deparser; end
 
 # Handles serializing of statements in the v1 grammar.
-class Fig::Unparser::V1
-  include Fig::Unparser
-  include Fig::Unparser::V1Base
+class Fig::Deparser::V1
+  include Fig::Deparser
+  include Fig::Deparser::V1Base
 
   def initialize(
     emit_as_input_or_to_be_published_values,

data/lib/fig/{unparser → deparser}/v1_base.rb

@@ -1,8 +1,8 @@
 module Fig; end
-module Fig::Unparser; end
+module Fig::Deparser; end
 
 # Handles serializing of statements in the v1 grammar.
-module Fig::Unparser::V1Base
+module Fig::Deparser::V1Base
   def command(statement)
     add_indent
     @text << %Q<command\n>

data/lib/fig/{unparser → deparser}/v2.rb

@@ -1,13 +1,13 @@
-require 'fig/unparser'
-require 'fig/unparser/v1_base'
+require 'fig/deparser'
+require 'fig/deparser/v1_base'
 
 module Fig; end
-module Fig::Unparser; end
+module Fig::Deparser; end
 
 # Handles serializing of statements in the v2 grammar.
-class Fig::Unparser::V2
-  include Fig::Unparser
-  include Fig::Unparser::V1Base
+class Fig::Deparser::V2
+  include Fig::Deparser
+  include Fig::Deparser::V1Base
 
   def initialize(
     emit_as_input_or_to_be_published_values,

data/lib/fig/not_yet_parsed_package.rb

@@ -4,13 +4,13 @@ module Fig; end
 class Fig::NotYetParsedPackage
   attr_accessor :descriptor
   attr_accessor :working_directory
-  attr_accessor :base_directory
+  attr_accessor :include_file_base_directory
   attr_accessor :source_description
   attr_accessor :unparsed_text
 
   def extended_source_description()
     if source_description
-      if source_description.start_with? working_directory
+      if source_description.include? "(#{working_directory})"
         return source_description
       end
 

data/lib/fig/operating_system.rb

@@ -228,7 +228,7 @@ class Fig::OperatingSystem
           rescue Archive::Error => exception
             # Nice how the error message doesn't include any information about
             # what was having the problem.
-            message = exception.message.sub /^Extract archive failed: /, ''
+            message = exception.message.sub(/^Extract archive failed: /, '')
             new_exception =
               Fig::RepositoryError.new(
                 "Could not extract #{entry.pathname} from #{archive_path}: #{message}"

data/lib/fig/package.rb

@@ -22,7 +22,7 @@ class Fig::Package
   attr_reader   :version
   attr_reader   :description
   attr_reader   :runtime_directory
-  attr_reader   :base_directory
+  attr_reader   :include_file_base_directory
   attr_reader   :statements
   attr_accessor :backtrace
   attr_accessor :unparsed_text
@@ -32,19 +32,19 @@ class Fig::Package
     version,
     description,
     runtime_directory,
-    base_directory,
+    include_file_base_directory,
     statements,
     synthetic
   )
-    @name                 = name
-    @version              = version
-    @description          = description
-    @runtime_directory    = runtime_directory
-    @base_directory       = base_directory
-    @statements           = statements
-    @synthetic            = synthetic
-    @applied_config_names = []
-    @backtrace            = nil
+    @name                         = name
+    @version                      = version
+    @description                  = description
+    @runtime_directory            = runtime_directory
+    @include_file_base_directory  = include_file_base_directory
+    @statements                   = statements
+    @synthetic                    = synthetic
+    @applied_config_names         = []
+    @backtrace                    = nil
   end
 
   # Was this package (supposedly) created from something other than usual
@@ -149,7 +149,7 @@ class Fig::Package
   def walk_statements(&block)
     @statements.each do |statement|
       yield statement
-      statement.walk_statements &block
+      statement.walk_statements(&block)
     end
 
     return

data/lib/fig/package_definition_text_assembler.rb

@@ -1,8 +1,8 @@
+require 'fig/deparser'
+require 'fig/deparser/v0'
+require 'fig/deparser/v1'
+require 'fig/deparser/v2'
 require 'fig/statement/grammar_version'
-require 'fig/unparser'
-require 'fig/unparser/v0'
-require 'fig/unparser/v1'
-require 'fig/unparser/v2'
 
 module Fig; end
 
@@ -61,7 +61,7 @@ class Fig::PackageDefinitionTextAssembler
   end
 
   def assemble_package_definition()
-    unparsed_statements, explanations = unparse_statements()
+    unparsed_statements, explanations = deparse_statements()
     definition =
       [@header_text, unparsed_statements, @footer_text].flatten.join("\n")
     definition.gsub!(/\n{3,}/, "\n\n")
@@ -73,8 +73,8 @@ class Fig::PackageDefinitionTextAssembler
 
   private
 
-  def unparse_statements()
-    unparser_class, explanations = Fig::Unparser.class_for_statements(
+  def deparse_statements()
+    deparser_class, explanations = Fig::Deparser.class_for_statements(
       @output_statements, @emit_as_input_or_to_be_published_values
     )
 
@@ -82,14 +82,14 @@ class Fig::PackageDefinitionTextAssembler
       Fig::Statement::GrammarVersion.new(
         nil,
         %Q<[synthetic statement created in #{__FILE__} line #{__LINE__}]>,
-        %q<Fake grammar version that shouldn't be used because the Unparser should determine what gets emitted.>
+        %q<Fake grammar version that shouldn't be used because the Deparser should determine what gets emitted.>
       )
 
-    unparser = unparser_class.new @emit_as_input_or_to_be_published_values
-    text = unparser.unparse( [grammar_statement] + @output_statements )
+    deparser = deparser_class.new @emit_as_input_or_to_be_published_values
+    text = deparser.deparse( [grammar_statement] + @output_statements )
 
     explanations.unshift(
-      "Publishing using the #{unparser.grammar_description} grammar."
+      "Publishing using the #{deparser.grammar_description} grammar."
     )
 
     return text, explanations

data/lib/fig/parser_package_build_state.rb

@@ -68,7 +68,7 @@ class Fig::ParserPackageBuildState
       @descriptor.version,
       @descriptor.description,
       unparsed_package.working_directory,
-      unparsed_package.base_directory,
+      unparsed_package.include_file_base_directory,
       statement_objects,
       false,
     )

data/lib/fig/repository.rb

@@ -329,16 +329,9 @@ class Fig::Repository
     temporary_package = File.join temporary_directory, 'packages'
     temporary_runtime = File.join temporary_directory, 'runtime'
     temp_fig_file   = fig_file_for_package_download(temporary_package)
-
-    FileUtils.rm_rf temporary_directory
-    if File.exist? package_directory
-      FileUtils.mkdir_p File.dirname(temporary_package)
-      FileUtils.cp_r(
-        package_directory, temporary_package, :preserve => true
-      )
-    else
-      FileUtils.mkdir_p temporary_package
-    end
+    set_up_package_download_directories(
+      temporary_directory, temporary_package, package_directory
+    )
 
     @updating_package_definition = true
     return if ! @operating_system.download(
@@ -348,42 +341,14 @@ class Fig::Repository
     package = read_package_from_directory(temporary_package, descriptor)
     @updating_package_definition = false
 
-    remote_package_directory = remote_directory_for_package(descriptor)
-    package.archive_locations.each do
-      |archive_location|
-
-      if not Fig::URL.is_url?(archive_location)
-        archive_location = Fig::URL.append_path_components(
-          remote_package_directory, [archive_location]
-        )
-      end
-      @operating_system.download_and_unpack_archive(
-        archive_location, temporary_package, temporary_runtime
-      )
-    end
-    package.resource_locations.each do
-      |resource_location|
-
-      if not Fig::URL.is_url?(resource_location)
-        resource_location = Fig::URL.append_path_components(
-          remote_package_directory, [resource_location]
-        )
-      end
-
-      basename, path =
-        @operating_system.download_resource(
-          resource_location, temporary_package
-        )
-
-      @operating_system.copy path, File.join(temporary_runtime, basename)
-    end
+    download_assets(package, descriptor, temporary_package, temporary_runtime)
 
     nuke_package descriptor
 
     FileUtils.mkdir_p File.dirname(package_directory)
     FileUtils.mv temporary_package, package_directory
 
-    runtime_directory = runtime_for_package(descriptor)
+    runtime_directory = package.runtime_directory
     if File.exists? temporary_runtime
       FileUtils.mkdir_p File.dirname(runtime_directory)
       FileUtils.mv temporary_runtime, runtime_directory
@@ -420,7 +385,8 @@ class Fig::Repository
 
     unparsed_package = Fig::NotYetParsedPackage.new
     unparsed_package.descriptor         = descriptor
-    unparsed_package.working_directory  = unparsed_package.base_directory =
+    unparsed_package.working_directory  =
+      unparsed_package.include_file_base_directory =
       runtime_for_package(descriptor)
     unparsed_package.source_description = descriptor.to_string()
     unparsed_package.unparsed_text      = content
@@ -432,6 +398,56 @@ class Fig::Repository
     return package
   end
 
+  def set_up_package_download_directories(
+    temporary_directory, temporary_package, package_directory
+  )
+    FileUtils.rm_rf temporary_directory
+    if File.exist? package_directory
+      FileUtils.mkdir_p File.dirname(temporary_package)
+      FileUtils.cp_r(
+        package_directory, temporary_package, :preserve => true
+      )
+    else
+      FileUtils.mkdir_p temporary_package
+    end
+
+    return
+  end
+
+  def download_assets(package, descriptor, temporary_package, temporary_runtime)
+    remote_package_directory = remote_directory_for_package(descriptor)
+    package.archive_locations.each do
+      |archive_location|
+
+      if not Fig::URL.is_url?(archive_location)
+        archive_location = Fig::URL.append_path_components(
+          remote_package_directory, [archive_location]
+        )
+      end
+      @operating_system.download_and_unpack_archive(
+        archive_location, temporary_package, temporary_runtime
+      )
+    end
+    package.resource_locations.each do
+      |resource_location|
+
+      if not Fig::URL.is_url?(resource_location)
+        resource_location = Fig::URL.append_path_components(
+          remote_package_directory, [resource_location]
+        )
+      end
+
+      basename, path =
+        @operating_system.download_resource(
+          resource_location, temporary_package
+        )
+
+      @operating_system.copy path, File.join(temporary_runtime, basename)
+    end
+
+    return
+  end
+
   def remote_fig_file_for_package(descriptor)
     return Fig::URL.append_path_components(
       remote_directory_for_package(descriptor), [PACKAGE_FILE_IN_REPO]