fig 0.2.1 → 0.2.3

data/Changes

@@ -1,3 +1,53 @@
+v0.2.3
+
+  Backwards incompatibilities:
+
+  - Now requires Ruby v1.9.2.
+
+  Miscellaneous:
+
+  - Warns about environment variables that refer to non-existent paths after
+    publishing.
+
+      fig --publish package/version --set foo=@/bar
+
+      Checking status of package/version...
+      Publishing package/version.
+      Publishing using the v0 grammar.
+      The foo variable points to a path that does not exist
+      (/tmp/fig-testing/home/repos/package/version/bar); retrieve statements
+      that are active when this package is included may fail.
+
+    Note that this check is done after the package has been successfully
+    published; it does not prevent problems, but only detects potential ones.
+    Due to the indirect and inexact relationship between paths from asset
+    statements and environment variable statements, the check cannot be done
+    before publishing.
+
+  - Warning about unused retrieve no longer appears when there is a problem
+    with the variable itself.
+
+  - Stack traces of includes contain file names and "command-line" if the
+    includes came from package definition files or from "--include" options.
+    E.g.
+
+      fig --update --list-variables --include thingy/1.0.0.30 --file some-dependencies.fig --config blahblahblah
+
+      Version mismatch for package thingy (1.0.0.30 vs 1.0.0.81).
+      <command-line>:default
+        thingy/1.0.0.30:default
+      <command-line>:default
+        <some-dependencies.fig>:blahblahblah
+          thingy/1.0.0.81:default
+
+  - Other error message clarifications.
+
+v0.2.2.beta.3
+v0.2.2.beta.2
+v0.2.2.beta.1
+
+  - Test releases
+
 v0.2.1
 
   Backwards incompatibilities:

data/bin/fig

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+( [1, 9, 2] <=> ( RUBY_VERSION.split(".").collect {|x| x.to_i} ) ) <= 0 or
+  abort "Ruby v1.9.2 is required; this is v#{RUBY_VERSION}."
+
 if ENV['FIG_COVERAGE']
   require File.expand_path(
     File.join(

data/bin/fig-debug

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+( [1, 9, 2] <=> ( RUBY_VERSION.split(".").collect {|x| x.to_i} ) ) <= 0 or
+  abort "Ruby v1.9.2 is required; this is v#{RUBY_VERSION}."
+
 if ENV['FIG_COVERAGE']
   require File.expand_path(
     File.join(

data/bin/fig-download

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+( [1, 9, 2] <=> ( RUBY_VERSION.split(".").collect {|x| x.to_i} ) ) <= 0 or
+  abort "Ruby v1.9.2 is required; this is v#{RUBY_VERSION}."
+
 # todo copied from os.rb
 NOT_MODIFIED = 3
 NOT_FOUND = 4
@@ -17,4 +20,4 @@ File.open(path) do |file|
   end
 end
 
-exit SUCCESS
+exit SUCCESS

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '0.2.1'
+  VERSION = '0.2.3'
 end

data/lib/fig/command.rb

@@ -58,7 +58,7 @@ class Fig::Command
     if actions.any? {|action| not action.allow_both_descriptor_and_file? }
       ensure_descriptor_and_file_were_not_both_specified()
     end
-    check_package_content_options()
+    check_asset_options()
 
     configure()
     set_up_base_package()
@@ -71,7 +71,8 @@ class Fig::Command
       @environment,
       @repository,
       @operating_system,
-      @package_source_description
+      @package_source_description,
+      @package_loaded_from_path
     )
 
     actions.each do
@@ -130,7 +131,8 @@ class Fig::Command
       :environment,
       :repository,
       :operating_system,
-      :package_source_description
+      :package_source_description,
+      :package_loaded_from_path
     )
 
   def handle_nothing_to_do()
@@ -149,6 +151,7 @@ class Fig::Command
     end
 
     $stderr.puts %q<Run "fig --help" for a full list of commands.>
+    check_asset_options
 
     return Fig::Command::Action::EXIT_FAILURE
   end
@@ -296,6 +299,7 @@ class Fig::Command
       @base_package = package_loader.load_package_object_from_file()
     end
     @package_source_description = package_loader.package_source_description()
+    @package_loaded_from_path = package_loader.package_loaded_from_path()
 
     return
   end
@@ -380,12 +384,12 @@ class Fig::Command
     return
   end
 
-  def check_package_content_options()
-    statements = @options.package_contents_statements
+  def check_asset_options()
+    statements = @options.asset_statements
     return if statements.empty?
 
     return if @options.actions.any? \
-      {|action| action.cares_about_package_content_options?}
+      {|action| action.cares_about_asset_options?}
 
     statements.each do
       |statement|

data/lib/fig/command/action.rb

@@ -39,7 +39,7 @@ module Fig::Command::Action
 
   # Does the action care about command-line options that affect package
   # contents, i.e. --resource/--archive?
-  def cares_about_package_content_options?()
+  def cares_about_asset_options?()
     return false
   end
 

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

@@ -18,6 +18,10 @@ class Fig::Command::Action::DumpPackageDefinitionForCommandLine
     return nil
   end
 
+  def cares_about_asset_options?()
+    return true
+  end
+
   def modifies_repository?()
     return false
   end
@@ -35,15 +39,15 @@ class Fig::Command::Action::DumpPackageDefinitionForCommandLine
   end
 
   def configure(options)
-    @environment_statements       = options.environment_statements
-    @package_contents_statements  = options.package_contents_statements
+    @environment_statements = options.environment_statements
+    @asset_statements       = options.asset_statements
 
     return
   end
 
   def execute()
     text_assembler = Fig::PackageDefinitionTextAssembler.new :emit_as_input
-    text_assembler.add_output @package_contents_statements
+    text_assembler.add_output @asset_statements
     text_assembler.add_output [
       Fig::Statement::Configuration.new(
         nil,

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

@@ -28,7 +28,8 @@ module Fig::Command::Action::Role::ListWalkingDependencyTree
         Fig::PackageDescriptor.new(
           base_package.name(),
           base_package.version(),
-          config_name
+          config_name,
+          :description => base_package.description
         )
       )
 

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

@@ -19,7 +19,7 @@ module Fig::Command::Action::Role::Publish
     return true
   end
 
-  def cares_about_package_content_options?()
+  def cares_about_asset_options?()
     return true
   end
 
@@ -48,10 +48,10 @@ module Fig::Command::Action::Role::Publish
   end
 
   def configure(options)
-    @descriptor                   = options.descriptor
-    @environment_statements       = options.environment_statements
-    @package_contents_statements  = options.package_contents_statements
-    @force                        = options.force?
+    @descriptor             = options.descriptor
+    @environment_statements = options.environment_statements
+    @asset_statements       = options.asset_statements
+    @force                  = options.force?
 
     return
   end
@@ -70,7 +70,7 @@ module Fig::Command::Action::Role::Publish
 
     if not @environment_statements.empty?
       derive_publish_statements_from_environment_statements
-    elsif not @package_contents_statements.empty?
+    elsif not @asset_statements.empty?
       raise Fig::UserInputError.new(
         '--resource/--archive options were specified, but no --set/--append option was given. Will not publish.'
       )
@@ -86,9 +86,9 @@ module Fig::Command::Action::Role::Publish
   end
 
   def derive_publish_statements_from_environment_statements
-    if @execution_context.package_source_description
+    if @execution_context.package_loaded_from_path
       message = 'Cannot publish based upon both a package definition file ('
-      message << @execution_context.package_source_description
+      message << @execution_context.package_loaded_from_path
       message << ') and --set/--append options.'
 
       if @execution_context.package_source_description ==
@@ -104,7 +104,7 @@ module Fig::Command::Action::Role::Publish
     end
 
     @publish_statements =
-      @package_contents_statements +
+      @asset_statements +
       [
         Fig::Statement::Configuration.new(
           nil,

data/lib/fig/command/options.rb

@@ -51,7 +51,7 @@ class Fig::Command::Options
   attr_reader   :home
   attr_reader   :log_config
   attr_reader   :log_level
-  attr_reader   :package_contents_statements
+  attr_reader   :asset_statements
   attr_reader   :package_definition_file
   attr_reader   :parser
   attr_reader   :shell_command
@@ -191,7 +191,7 @@ class Fig::Command::Options
     set_up_remote_repository_access()
     set_up_commands()
     set_up_environment_statements()
-    set_up_package_contents_statements()
+    set_up_asset_statements()
     set_up_queries()
     set_up_program_configuration()
 
@@ -459,15 +459,15 @@ class Fig::Command::Options
     return
   end
 
-  def set_up_package_contents_statements()
-    @package_contents_statements = []
+  def set_up_asset_statements()
+    @asset_statements = []
     @parser.on(
       '--archive PATH',
       STARTS_WITH_NON_HYPHEN,
       'include PATH archive in package (when using --publish)'
     ) do |path|
-      @package_contents_statements <<
-        new_content_statement('--archive', path, Fig::Statement::Archive)
+      @asset_statements <<
+        new_asset_statement('--archive', path, Fig::Statement::Archive)
     end
 
     @parser.on(
@@ -475,8 +475,8 @@ class Fig::Command::Options
       STARTS_WITH_NON_HYPHEN,
       'include PATH resource in package (when using --publish)'
     ) do |path|
-      @package_contents_statements <<
-        new_content_statement('--resource', path, Fig::Statement::Resource)
+      @asset_statements <<
+        new_asset_statement('--resource', path, Fig::Statement::Resource)
     end
 
     return
@@ -608,7 +608,7 @@ class Fig::Command::Options
     return statement_class.new(nil, "#{option} option", variable, value)
   end
 
-  def new_content_statement(option, raw_path, statement_class)
+  def new_asset_statement(option, raw_path, statement_class)
     tokenized_path =
       statement_class.validate_and_process_escapes_in_location(raw_path) do
         |error_description|

data/lib/fig/command/package_applier.rb

@@ -66,7 +66,10 @@ class Fig::Command::PackageApplier
         nil,
         %Q<[synthetic statement created in #{__FILE__} line #{__LINE__}]>,
         Fig::PackageDescriptor.new(
-          @base_package.name(), @base_package.version(), @base_config
+          @base_package.name(),
+          @base_package.version(),
+          @base_config,
+          :description => @base_package.description
         ),
         nil
       )
@@ -82,7 +85,9 @@ class Fig::Command::PackageApplier
         configuration_statements.flatten()
       )
 
-    return Fig::Package.new(nil, nil, '.', [configuration_statement])
+    return Fig::Package.new(
+      nil, nil, 'command-line', '.', [configuration_statement]
+    )
   end
 
   def make_no_such_package_exception_descriptive(exception)

data/lib/fig/command/package_loader.rb

@@ -5,6 +5,8 @@ module Fig; end
 class Fig::Command; end
 
 class Fig::Command::PackageLoader
+  attr_reader :package_loaded_from_path
+
   DEFAULT_FIG_FILE = 'package.fig'
 
   def initialize(
@@ -43,8 +45,9 @@ class Fig::Command::PackageLoader
     if @package_loaded_from_path
       return @package_loaded_from_path
     elsif @descriptor
-      return
-        Fig::PackageDescriptor.format(@descriptor.name, @descriptor.version, nil)
+      return Fig::PackageDescriptor.format(
+        @descriptor.name, @descriptor.version, nil
+      )
     end
 
     return nil
@@ -92,14 +95,17 @@ class Fig::Command::PackageLoader
 
     source_description = package_source_description()
 
+    descriptor = Fig::PackageDescriptor.new(
+      nil,
+      nil,
+      nil,
+      :description => source_description,
+      :source_description => source_description
+    )
+
     @base_package =
       Fig::Parser.new(@application_configuration, :check_include_versions).parse_package(
-        Fig::PackageDescriptor.new(
-          nil, nil, nil, :source_description => source_description
-        ),
-        '.',
-        source_description,
-        definition_text
+        descriptor, '.', source_description, definition_text
       )
 
     return
@@ -109,6 +115,7 @@ class Fig::Command::PackageLoader
     @base_package = Fig::Package.new(
       nil,
       nil,
+      'synthetic',
       '.',
       [
         Fig::Statement::Configuration.new(

data/lib/fig/include_backtrace.rb

@@ -51,7 +51,7 @@ class Fig::IncludeBacktrace
     for descriptor in stack
       indent=''
       i.times { indent += '  ' }
-      out.puts indent + descriptor.to_string(:use_default_config)
+      out.puts indent + descriptor.to_string(:use_default_config, :use_description)
       i += 1
     end
   end

data/lib/fig/operating_system.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 require 'find'
 # Must specify absolute path of ::Archive when using
 # this module to avoid conflicts with Fig::Statement::Archive
-require 'libarchive_ruby' unless RUBY_PLATFORM == 'java'
+require 'libarchive_ruby'
 require 'net/http'
 require 'net/ssh'
 require 'net/sftp'
@@ -19,6 +19,7 @@ require 'fig/environment_variables/case_sensitive'
 require 'fig/file_not_found_error'
 require 'fig/logging'
 require 'fig/network_error'
+require 'fig/repository_error'
 require 'fig/url'
 require 'fig/user_input_error'
 
@@ -34,10 +35,6 @@ class Fig::OperatingSystem
     RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
   end
 
-  def self.java?
-    RUBY_PLATFORM == 'java'
-  end
-
   def self.unix?
     !windows?
   end
@@ -418,26 +415,22 @@ class Fig::OperatingSystem
 
   # Expects files_to_archive as an Array of filenames.
   def create_archive(archive_name, files_to_archive)
-    if Fig::OperatingSystem.java?
-      `tar czvf #{archive_name} #{files_to_archive.join(' ')}`
-    else
-      # TODO: Need to verify files_to_archive exists.
-      ::Archive.write_open_filename(
-        archive_name, ::Archive::COMPRESSION_GZIP, ::Archive::FORMAT_TAR
-      ) do |writer|
-        files_to_archive.each do |file_name|
-          writer.new_entry do |entry|
-            entry.copy_lstat(file_name)
-            entry.pathname = file_name
-            if entry.symbolic_link?
-              linked = File.readlink(file_name)
-              entry.symlink = linked
-            end
-            writer.write_header(entry)
+    # TODO: Need to verify files_to_archive exists.
+    ::Archive.write_open_filename(
+      archive_name, ::Archive::COMPRESSION_GZIP, ::Archive::FORMAT_TAR
+    ) do |writer|
+      files_to_archive.each do |file_name|
+        writer.new_entry do |entry|
+          entry.copy_lstat(file_name)
+          entry.pathname = file_name
+          if entry.symbolic_link?
+            linked = File.readlink(file_name)
+            entry.symlink = linked
+          end
+          writer.write_header(entry)
 
-            if entry.regular?
-              writer.write_data(open(file_name) {|f| f.binmode; f.read })
-            end
+          if entry.regular?
+            writer.write_data(open(file_name) {|f| f.binmode; f.read })
           end
         end
       end
@@ -451,12 +444,21 @@ class Fig::OperatingSystem
   # .zip
   def unpack_archive(dir, file)
     Dir.chdir(dir) do
-      if Fig::OperatingSystem.java?
-        `tar xzvf #{file}`
-      else
-        ::Archive.read_open_filename(file) do |reader|
-          while entry = reader.next_header
+      ::Archive.read_open_filename(file) do |reader|
+        while entry = reader.next_header
+          begin
             reader.extract(entry)
+          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: /, ''
+            new_exception =
+              Fig::RepositoryError.new(
+                "Could not extract #{entry.pathname} from #{file}: #{message}"
+              )
+
+            new_exception.set_backtrace exception.backtrace
+            raise new_exception
           end
         end
       end
@@ -465,9 +467,9 @@ class Fig::OperatingSystem
 
   def shell_exec(command)
     if Fig::OperatingSystem.windows?
-      plain_exec( [ ENV['ComSpec'], '/c', command ] )
+      plain_exec [ ENV['ComSpec'], '/c', command ]
     else
-      plain_exec( [ ENV['SHELL'],   '-c', command ] )
+      plain_exec [ ENV['SHELL'],   '-c', command ]
     end
   end