fig 1.1.0 → 1.2.0

data/Changes

@@ -1,3 +1,97 @@
+v1.2.0
+
+  Bug fixes:
+
+  - Unparsing of unglobbed asset paths containing single quotes was broken.
+
+  - Deal with differences between return types of stat() from Net::SFTP and
+    File.
+
+  New features:
+
+  - Now looks in figrc for an array under the key "environment variables to
+    include in comments in published packages".  If present, the values of
+    those environment variables will, surprise, show up in the text of
+    published packages.
+
+  - When publishing, attempts to identify VCS (currently Subversion and Git)
+    URLs for the package and includes that information in comments in the
+    package.  This can be turned off via the
+    --suppress-vcs-comments-in-published-packages option.  The path to the VCS
+    programs can be controlled via the FIG_SVN_EXECUTABLE and
+    FIG_GIT_EXECUTABLE environment variables; individual VCS can be turned off
+    by setting the variable to the empty string.
+
+  - New --source-package option that will tell you what package a file was
+    retrieved from:
+
+      # Assuming a retrieve caused lib/libboost_timer.so to exist:
+      > fig --source-package lib/libboost_timer.so
+      boost/1.51.0.redhat6.gcc472
+
+      > fig --source-package lib
+      "lib" is a directory. Fig does not keep track of directories.
+
+      > fig --source-package some-local-file.txt
+      Don't know anything about "some-local-file.txt".
+
+  - New --suppress-retrieves option that stops "retrieve" statements from
+    firing, even if the --update* options are specified.  Useful if you want to
+    do things like "fig --update package/version
+    --dump-package-definition-text" without clobbering anything in your current
+    directory.
+
+  - It is now possible to use an unpublished package from within another via a
+    "include-file" statement/--include-file command-line option.
+
+    This is considered an experimental feature and its behavior has not been
+    set in stone yet; changes may happen without notice.  Comments on its
+    behavior, especially in terms of assets and of retrieves are welcome.
+
+    Using this statement requires grammar version 2.  The
+    statement/command-line option takes a single argument of a path to a
+    package definition file, optionally followed by a colon and a config name.
+    If the path requires quoting, the quotes go around the path and not the
+    config name; this allows for use of the default config in a file path
+    containing a colon, e.g. MS Windows absolute paths.  Given an unpublished
+    package in ./foo/bar/baz.fig, your can use it in ./foo/bar.fig like so:
+
+      grammar v2
+      config default
+        include-file 'bar/baz.fig':some-config
+      end
+
+    Note that the path is relative to including package, not relative to the
+    current directory.
+
+    The included package will act like a regularly published package with the
+    exception that retrieves will be ignored because "[package]" substitution
+    won't work because the package does not have a name.
+
+    Packages that use include-file cannot be published.
+
+  Miscellaneous:
+
+  - Fig now depends upon the open4 gem.
+
+  - Login behavior change for FTP with --login and for SFTP: Fig will not
+    attempt to use login credentials from FIG_USERNAME/FIG_PASSWORD or use
+    prompting for asset URLs.  Credentials in ~/.netrc will continue to be
+    used.
+
+  - Add -T as the short option for --dump-package-definition-text.
+
+  - Add -R as the short option for --suppress-retrieves.
+
+v1.1.1.beta.6
+v1.1.1.beta.5
+v1.1.1.beta.4
+v1.1.1.beta.3
+v1.1.1.beta.2
+v1.1.1.beta.1
+
+  - Test releases.
+
 v1.1.0
 
   Backwards incompatibilities:

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/fig/command.rb

@@ -70,6 +70,7 @@ class Fig::Command
       base_config(),
       @environment,
       @repository,
+      @working_directory_maintainer,
       @operating_system,
       @package_source_description,
       @package_loaded_from_path
@@ -130,6 +131,7 @@ class Fig::Command
       :base_config,
       :environment,
       :repository,
+      :working_directory_maintainer,
       :operating_system,
       :package_source_description,
       :package_loaded_from_path
@@ -177,8 +179,12 @@ class Fig::Command
       @options.log_level()
     )
 
+    @parser = Fig::Parser.new(
+      @application_configuration, check_include_statements_versions?
+    )
+
     prepare_repository()
-    prepare_environment()
+    prepare_runtime_environment()
   end
 
   def set_up_update_lock()
@@ -227,11 +233,13 @@ class Fig::Command
 
   def prepare_repository()
     @repository = Fig::Repository.new(
+      @application_configuration,
+      @options,
       @operating_system,
       @options.home(),
-      @application_configuration,
+      @application_configuration.remote_repository_url,
+      @parser,
       @publish_listeners,
-      check_include_statements_versions?
     )
 
     @options.actions.each {|action| action.prepare_repository(@repository)}
@@ -239,11 +247,11 @@ class Fig::Command
     return
   end
 
-  def prepare_environment()
-    working_directory_maintainer = Fig::WorkingDirectoryMaintainer.new('.')
+  def prepare_runtime_environment()
+    @working_directory_maintainer = Fig::WorkingDirectoryMaintainer.new('.')
 
     Fig::AtExit.add do
-      working_directory_maintainer.prepare_for_shutdown(
+      @working_directory_maintainer.prepare_for_shutdown(
         @base_package                             &&
         retrieves_should_happen?                  &&
         ! @options.suppress_cleanup_of_retrieves
@@ -257,9 +265,10 @@ class Fig::Command
 
     @environment = Fig::RuntimeEnvironment.new(
       @repository,
+      @parser,
       @options.suppress_includes,
       environment_variables,
-      working_directory_maintainer,
+      @working_directory_maintainer,
     )
 
     Fig::AtExit.add { @environment.check_unused_retrieves() }
@@ -419,6 +428,8 @@ class Fig::Command
   end
 
   def retrieves_should_happen?()
+    return false if @options.suppress_retrieves
+
     return @options.actions.any? {|action| action.retrieves_should_happen?}
   end
 

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

@@ -31,11 +31,11 @@ class Fig::Command::Action::DumpPackageDefinitionForCommandLine
   end
 
   def register_base_package?()
-    return false
+    return nil # don't care
   end
 
   def apply_config?()
-    return false
+    return nil # don't care
   end
 
   def configure(options)

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

@@ -27,11 +27,11 @@ class Fig::Command::Action::DumpPackageDefinitionParsed
   end
 
   def register_base_package?()
-    return false
+    return nil # don't care
   end
 
   def apply_config?()
-    return false
+    return nil # don't care
   end
 
   def execute()

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

@@ -26,11 +26,11 @@ class Fig::Command::Action::DumpPackageDefinitionText
   end
 
   def register_base_package?()
-    return false
+    return nil # don't care
   end
 
   def apply_config?()
-    return false
+    return nil # don't care
   end
 
   def execute()

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

@@ -0,0 +1,65 @@
+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::SourcePackage
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--get>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def modifies_repository?()
+    return false
+  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)
+    @file = options.file_to_find_package_for
+  end
+
+  def execute()
+    if ! File.exist? @file
+      $stderr.puts %Q<"#{@file}" does not exist.>
+      return EXIT_FAILURE
+    end
+    if File.directory? @file
+      $stderr.puts %Q<"#{@file}" is a directory. Fig does not keep track of directories.>
+      return EXIT_FAILURE
+    end
+
+    maintainer = @execution_context.working_directory_maintainer
+    package_version = maintainer.find_package_version_for_file @file
+    if ! package_version
+      $stderr.puts %Q<Don't know anything about "#{@file}".>
+      return EXIT_FAILURE
+    end
+
+    puts package_version
+
+    return EXIT_SUCCESS
+  end
+end

data/lib/fig/command/options.rb

@@ -27,6 +27,7 @@ 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/source_package'
 require 'fig/command/action/update'
 require 'fig/command/action/update_if_missing'
 require 'fig/command/action/version'
@@ -53,6 +54,7 @@ class Fig::Command::Options
   attr_reader   :environment_statements
   attr_reader   :exit_code
   attr_reader   :figrc
+  attr_reader   :file_to_find_package_for
   attr_reader   :home
   attr_reader   :log_config
   attr_reader   :log_level
@@ -61,6 +63,7 @@ class Fig::Command::Options
   attr_reader   :shell_command
   attr_reader   :suppress_cleanup_of_retrieves
   attr_reader   :suppress_includes
+  attr_reader   :suppress_retrieves
   attr_reader   :update_lock_response
   attr_reader   :variable_to_get
   attr_accessor :version_message
@@ -121,6 +124,10 @@ class Fig::Command::Options
     return @force
   end
 
+  def suppress_vcs_comments_in_published_packages?()
+    return @suppress_vcs_comments_in_published_packages
+  end
+
   def short_help_message()
     return @parser.short_help
   end
@@ -249,7 +256,16 @@ class Fig::Command::Options
     set_up_listings()
 
     @parser.on(
-      '--dump-package-definition-text',
+      '--source-package FILE',
+      STARTS_WITH_NON_HYPHEN,
+      'print package FILE was retrieved from'
+    ) do |file_to_find_package_for|
+      set_base_action(Fig::Command::Action::SourcePackage)
+      @file_to_find_package_for = file_to_find_package_for
+    end
+
+    @parser.on(
+      '-T', '--dump-package-definition-text',
       'emit the unparsed definition of the base package, if there is one'
     ) do
       set_base_action(Fig::Command::Action::DumpPackageDefinitionText)
@@ -354,6 +370,13 @@ class Fig::Command::Options
       @force = force
     end
 
+    @parser.on(
+      '--suppress-vcs-comments-in-published-packages',
+      %q<don't attempt to identify version control information when publishing>
+    ) do |suppress|
+      @suppress_vcs_comments_in_published_packages = suppress
+    end
+
     @parser.on('--clean', 'remove package from $FIG_HOME') do
       set_base_action(Fig::Command::Action::Clean)
     end
@@ -452,16 +475,16 @@ class Fig::Command::Options
       STARTS_WITH_NON_HYPHEN,
       'include package/version:config specified in DESCRIPTOR in environment'
     ) do |descriptor_string|
-      statement =
-        Fig::Statement::Include.new(
-          nil,
-          '--include option',
-          Fig::Statement::Include.parse_descriptor(
-            descriptor_string,
-            :validation_context => ' given in a --include option'
-          ),
-          nil
-        )
+      statement = Fig::Statement::Include.new(
+        nil,
+        '--include option',
+        Fig::Statement::Include.parse_descriptor(
+          descriptor_string,
+          :validation_context => ' given in a --include option'
+        ),
+        nil,
+        nil
+      )
 
       # We've never allowed versionless includes from the command-line. Hooray!
       statement.complain_if_version_missing()
@@ -469,6 +492,26 @@ class Fig::Command::Options
       @environment_statements << statement
     end
 
+    @parser.on(
+      '--include-file PATH:CONFIG',
+      STARTS_WITH_NON_HYPHEN,
+      'include package-definition-in-file:config in environment (incompatible with --publish)'
+    ) do |path_with_config|
+      path, config_name =
+        Fig::Statement::IncludeFile.parse_path_with_config(path_with_config) {
+          |message|
+
+          @parser.raise_invalid_argument(
+            '--include-file', path_with_config, message
+          )
+        }
+      statement = Fig::Statement::IncludeFile.new(
+        nil, '--include-file option', path, config_name, nil,
+      )
+
+      @environment_statements << statement
+    end
+
     @parser.on(
       '--override DESCRIPTOR',
       STARTS_WITH_NON_HYPHEN,
@@ -479,10 +522,9 @@ class Fig::Command::Options
           descriptor_string,
           :validation_context => ' given in a --override option'
         )
-      statement =
-        Fig::Statement::Override.new(
-          nil, '--override option', descriptor.name, descriptor.version
-        )
+      statement = Fig::Statement::Override.new(
+        nil, '--override option', descriptor.name, descriptor.version
+      )
 
       @environment_statements << statement
     end
@@ -530,6 +572,13 @@ class Fig::Command::Options
       set_update_action(Fig::Command::Action::UpdateIfMissing)
     end
 
+    @parser.on(
+      '-R', '--suppress-retrieves',
+      %q<don't process retrieves, even if they would otherwise be active>,
+    ) do
+      @suppress_retrieves = true
+    end
+
     @parser.on(
       '--suppress-cleanup-of-retrieves',
       %q<don't delete files from unreferenced retrieves>,

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

@@ -19,10 +19,7 @@ Running under Fig:
   fig [...] [DESCRIPTOR] --run-command-statement
 
 Publishing packages:
-  fig {--publish | --publish-local} DESCRIPTOR
-      [--resource PATH]      [--archive  PATH]
-      [--include DESCRIPTOR] [--override DESCRIPTOR]
-      [...]
+  fig {--publish | --publish-local} [--force] DESCRIPTOR [...]
 
 Querying:
   fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
@@ -33,6 +30,9 @@ Standard options (represented as "[...]" above):
       [--update | --update-if-missing]
       [--set    VARIABLE=VALUE]
       [--append VARIABLE=VALUE]
+      [--resource PATH]      [--archive  PATH]
+      [--include DESCRIPTOR] [--include-file PATH:CONFIG]
+      [--override DESCRIPTOR]
       [--file PATH] [--no-file]
 
 (--options for full option list; --help-long for everything)
@@ -47,13 +47,7 @@ Running under Fig:
 
 Publishing packages:
 
-  fig {--publish | --publish-local} DESCRIPTOR
-      [--resource       PATH]
-      [--archive        PATH]
-      [{-i | --include} DESCRIPTOR]
-      [--override       DESCRIPTOR]
-      [--force]
-      [...]
+  fig {--publish | --publish-local} [--force] DESCRIPTOR [...]
 
 Local repository maintenance:
 
@@ -66,7 +60,8 @@ Querying:
   fig --list-dependencies [...list options...]               [DESCRIPTOR] [...]
   fig --list-variables    [...list options...]               [DESCRIPTOR] [...]
   fig --list-configs                                         [DESCRIPTOR] [...]
-  fig --dump-package-definition-text                         [DESCRIPTOR] [...]
+  fig --source-package FILE                                  [DESCRIPTOR] [...]
+  fig {-T | --dump-package-definition-text}                  [DESCRIPTOR] [...]
   fig --dump-package-definition-parsed                       [DESCRIPTOR] [...]
   fig --dump-package-definition-for-command-line             [DESCRIPTOR] [...]
 
@@ -83,6 +78,15 @@ Standard options (represented as "[...]" above):
       [{-s | --set}    VARIABLE=VALUE]
       [{-p | --append} VARIABLE=VALUE]
 
+      [--resource       PATH]
+      [--archive        PATH]
+      [{-i | --include} DESCRIPTOR]
+      [--include-file   PATH:CONFIG]
+      [--override       DESCRIPTOR]
+
+      [-R | --suppress-retrieves] [--suppress-cleanup-of-retrieves]
+      [--suppress-all-includes] [--suppress-cross-package-includes]
+
       [--file PATH] [--no-file]
       [{-c | --config} CONFIG]
 
@@ -91,6 +95,7 @@ Standard options (represented as "[...]" above):
       [--log-level LEVEL] [--log-config PATH]
       [--figrc PATH]      [--no-figrc]
 
+      [--suppress-vcs-comments-in-published-packages]
       [--suppress-warning-include-statement-missing-version]
 
 Information:
@@ -107,8 +112,13 @@ required or allowed is dependent upon what your are doing.
 
 Environment variables:
 
-  FIG_REMOTE_URL location of remote repository, required for remote operations
-  FIG_HOME       path to local repository, defaults to $HOME/.fighome
+  FIG_REMOTE_URL     location of remote repository, required for remote
+                     operations
+  FIG_HOME           path to local repository, defaults to $HOME/.fighome
+  FIG_SVN_EXECUTABLE path to svn executable, set to empty string to suppress
+                     use of Subversion
+  FIG_GIT_EXECUTABLE path to git executable, set to empty string to suppress
+                     use of Git
   END_FULL_USAGE
 
   def initialize()