fig 0.1.57 → 0.1.59

data/Changes

@@ -1,3 +1,83 @@
+v0.1.59
+
+  Backwards incompatibilities:
+
+  - Specifying a config in the descriptor and --config is now an error, i.e you
+    can't do:
+
+        fig package/1.2.3:some_config --config some_other_config
+
+    Allowing configurations in both locations was ambiguous and the developers,
+    let alone users, couldn't tell which configuration would prevail.
+
+  New features:
+
+  - "--list-variables" option.  This will display all variables manipulated by
+    Fig, following package dependencies recursively.  Can have
+    "--list-all-configs" and "--list-tree" applied to it for tracking down
+    where that nasty setting of EDITOR to "emacs" comes from.
+
+    Example "--list-variables --list-tree" output:
+
+        A/1.2.3
+        |   CLASSPATH = something:$CLASSPATH
+        |   FROM_A    = blah
+        '---C/5.6.7
+        |       CLASSPATH = something_else:$CLASSPATH
+        |       FROM_C    = blah
+        '---B/1.2.3
+                CLASSPATH = planet_x:$CLASSPATH
+                FROM_B    = blah
+
+    See README.md for more.
+
+    Suggestions for changes to the output format welcome.
+
+  - "--command-extra-args" option.  Allows you to say that the rest of the fig
+    command-line is to be appended to the end of the command in a "command"
+    statement.
+
+  - The .fig file created in a repository now contains metadata about
+    the publishing of the package (time/user/host).
+
+  - Logging output is colorized if going to a tty on *nix.  This includes
+    restoration of the old colorization of local package downloads/deletions.
+    Colors are not currently configurable.
+
+  - The primary package is now treated the same as other packages as far as
+    updates are concerned.  Previously, if you started with a new environment,
+    e.g. FIG_HOME was empty, running "fig foo/1.2.3 -- echo foo" would fall
+    over.  Even asking for updates ("fig --update foo/1.2.3 -- echo foo")
+    wouldn't change anything.  Now the latter case will work.
+
+  - "--suppress-warning-include-statement-missing-version" option and "suppress
+    warnings" entry in figrc will, unsurprisingly, turn off warnings for things
+    like "include foo" in included packages.  Note that this will NOT turn off
+    these warnings for the contents of a package.fig file.
+
+    The idea is that, while not having a version on an include is a bad idea,
+    you don't decide on the contents of your dependencies.  So, this allows you
+    to stop Fig from complaining about things you can't control, while still
+    yelling at you for things that you do.
+
+  - The test suite passes on MS Windows!
+
+  Bug fixes:
+
+  - You can publish packages that have versionless includes again.
+
+  Significant Internals:
+
+  - The definition of a package descriptor has become more restrictive in the
+    Ruby code.  This shouldn't be an issue because the Treetop grammar has
+    already restricted it this way; this is just a check from the Ruby side.
+
+v0.1.58.beta.1
+v0.1.58.alpha.2
+v0.1.58.alpha.1
+
+  - Test releases
+
 v0.1.57
 
   - Logging output now goes to stderr by default, instead of stdout.

data/VERSION

@@ -1 +1 @@
-0.1.57
+0.1.59

data/bin/fig-debug

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), %w< .. lib > ))
+
+require 'rubygems'
+
+require 'fig/command'
+
+# Identical to regular fig, but doesn't use exception handling so you can see
+# stack traces.
+return_code = Fig::Command.new.run_fig(ARGV)
+exit return_code

data/bin/fig.bat

@@ -0,0 +1 @@
+@"ruby.exe" "%~dpn0" %*

data/lib/fig/applicationconfiguration.rb

@@ -1,53 +1,53 @@
-module Fig
-  # Configuration for the Fig program, as opposed to the configuration for a
-  # package.
-  class ApplicationConfiguration
-    def initialize(remote_repository_url)
-      @data = []
-      @remote_repository_url = remote_repository_url
-      clear_cached_data
-    end
+module Fig; end
 
-    def ensure_url_whitelist_initialized()
-      return if not @whitelist.nil?
-      whitelist = self['url whitelist']
-      if whitelist.nil?
-        @whitelist = []
-      else
-        @whitelist = [@remote_repository_url, whitelist].flatten
-      end
-    end
+# Configuration for the Fig program, as opposed to the configuration in a
+# package.
+class Fig::ApplicationConfiguration
+  def initialize(remote_repository_url)
+    @data = []
+    @remote_repository_url = remote_repository_url
+    clear_cached_data
+  end
 
-    def [](key)
-      @data.each do |dataset|
-        if dataset.has_key?(key)
-          return dataset[key]
-        end
-      end
-      return nil
+  def ensure_url_whitelist_initialized()
+    return if not @whitelist.nil?
+    whitelist = self['url whitelist']
+    if whitelist.nil?
+      @whitelist = []
+    else
+      @whitelist = [@remote_repository_url, whitelist].flatten
     end
+  end
 
-    def push_dataset(dataset)
-      @data.push(dataset)
+  def [](key)
+    @data.each do |dataset|
+      if dataset.has_key?(key)
+        return dataset[key]
+      end
     end
+    return nil
+  end
 
-    def unshift_dataset(dataset)
-      @data.unshift(dataset)
-    end
+  def push_dataset(dataset)
+    @data.push(dataset)
+  end
 
-    # after push_dataset or unshift_dataset, call clear_cached, and lazy initialize as far as the list of things to exclude
+  def unshift_dataset(dataset)
+    @data.unshift(dataset)
+  end
 
-    def clear_cached_data()
-      @whitelist = nil
-    end
+  # after push_dataset or unshift_dataset, call clear_cached, and lazy
+  # initialize as far as the list of things to exclude
+  def clear_cached_data()
+    @whitelist = nil
+  end
 
-    def url_access_allowed?(url)
-      ensure_url_whitelist_initialized
-      return true if @whitelist.empty?
-      @whitelist.each do |allowed_url|
-        return true if url.match(/\A#{Regexp.quote(allowed_url)}\b/)
-      end
-      return false
+  def url_access_allowed?(url)
+    ensure_url_whitelist_initialized
+    return true if @whitelist.empty?
+    @whitelist.each do |allowed_url|
+      return true if url.match(/\A#{Regexp.quote(allowed_url)}\b/)
     end
+    return false
   end
 end

data/lib/fig/backtrace.rb

@@ -5,50 +5,48 @@ module Fig; end
 class Fig::Backtrace
   attr_reader :overrides
 
-  def initialize(parent, package_name, version_name, config_name)
-    @parent = parent
-    @package_name = package_name
-    @version_name = version_name
-    @config_name = config_name || 'default'
-    @overrides = {}
+  def initialize(parent, descriptor)
+    @parent     = parent
+    @descriptor = descriptor
+    @overrides  = {}
   end
 
-  def collect(stack)
-    if @parent
-      @parent.collect(stack)
-    end
-    elem = ''
-    if @package_name
-      elem = @package_name
-    end
-    if @version_name
-      elem += '/' + @version_name
-    end
-    if @config_name
-      elem += ':' + @config_name
-    end
-    stack << elem
-  end
-
-  def add_override(package_name, version_name)
+  def add_override(package_name, version)
     # Don't replace an existing override on the stack
     return if get_override(package_name)
-    @overrides[package_name] = version_name
+
+    @overrides[package_name] = version
   end
 
-  def get_override(package_name)
-    return @overrides[package_name] || (@parent ? @parent.get_override(package_name) : nil)
+  # Returns a version.
+  def get_override(package_name, default_version = nil)
+    version = @overrides[package_name]
+    return version if version
+
+    return @parent.get_override(package_name, default_version) if @parent
+    return default_version
   end
 
+  # Prints a stack trace to the IO object.
   def dump(out)
     stack = []
     collect(stack)
     i=0
-    for elem in stack
+    for descriptor in stack
       indent=''
       i.times { indent += '  ' }
-      out.puts indent+elem
+      out.puts indent + descriptor.to_string(:use_default_config)
       i += 1
     end
-   end
+  end
+
+  private
+
+  def collect(stack)
+    if @parent
+      @parent.collect(stack)
+    end
+
+    stack << @descriptor
+  end
 end

data/lib/fig/command.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'net/ftp'
-require 'log4r'
 require 'set'
 
 require 'fig/environment'
@@ -17,17 +16,21 @@ require 'fig/statement/configuration'
 require 'fig/statement/publish'
 require 'fig/userinputerror'
 
-# This is a breakout of part of this class simply to keep the file size down.
+# These are a breakout of parts of this class simply to keep the file size down.
+
 # You will need to look in this file for any stuff related to --list-* options.
 require 'fig/command/listing'
 
+# You will need to look in this file for any stuff related to loading the
+# primary Package object.
+require 'fig/command/packageload'
+
 module Fig; end
 
 # Main program
 class Fig::Command
   include Fig::Command::Listing
-
-  DEFAULT_FIG_FILE = 'package.fig'
+  include Fig::Command::PackageLoad
 
   def run_fig(argv)
     @options = Fig::Options.new(argv)
@@ -40,7 +43,7 @@ class Fig::Command
 
     if @options.clean?
       check_required_package_descriptor('to clean')
-      @repository.clean(@descriptor.name, @descriptor.version)
+      @repository.clean(@descriptor)
       return 0
     end
 
@@ -52,7 +55,7 @@ class Fig::Command
       return publish()
     end
 
-    get_package()
+    load_package_object()
 
     if @options.listing()
       handle_post_parse_list_options()
@@ -63,11 +66,11 @@ class Fig::Command
         |command| @operating_system.shell_exec command
       end
     elsif @descriptor
-      @environment.include_config(
-        @package, @descriptor.name, @descriptor.config, @descriptor.version, {}, nil
-      )
+      @environment.include_config(@package, @descriptor, {}, nil)
       @environment.execute_config(
-        @package, @descriptor.name, @descriptor.config, nil, []
+        @package,
+        @descriptor,
+        @options.command_extra_argv || []
       ) { |cmd| @operating_system.shell_exec cmd }
     elsif not @repository.updating?
       $stderr.puts "Nothing to do.\n"
@@ -113,6 +116,15 @@ class Fig::Command
     return nil
   end
 
+  def check_include_statements_versions?()
+    return false if @options.suppress_warning_include_statement_missing_version?
+
+    suppressed_warnings = @configuration['suppress warnings']
+    return true if not suppressed_warnings
+
+    return ! suppressed_warnings.include?('include statement missing version')
+  end
+
   def configure()
     Fig::Logging.initialize_pre_configuration(@options.log_level())
 
@@ -139,21 +151,36 @@ class Fig::Command
       @configuration,
       nil, # remote_user
       @options.update?,
-      @options.update_if_missing?
+      @options.update_if_missing?,
+      check_include_statements_versions?
     )
 
     @retriever = Fig::Retriever.new('.')
 
-    # Check to see if this is still happening with the new layers of abstraction.
-    at_exit { @retriever.save }
+    at_exit { @retriever.save_metadata() }
 
-    @environment = Fig::Environment.new(@repository, @options.reset_environment? ? {} : nil, @retriever)
+    @environment = prepare_environment
 
     @options.non_command_package_statements().each do |statement|
       @environment.apply_config_statement(nil, statement, nil)
     end
   end
 
+  def prepare_environment()
+    environment_variables = nil
+    if @options.reset_environment?
+      environment_variables = Fig::OperatingSystem.get_environment_variables({})
+    end
+
+    return Fig::Environment.new(@repository, environment_variables, @retriever)
+  end
+
+  def base_config()
+    return @options.config()                 ||
+           @descriptor && @descriptor.config ||
+           Fig::Package::DEFAULT_CONFIG
+  end
+
   def check_required_package_descriptor(operation_description)
     if not @descriptor
       raise Fig::UserInputError.new(
@@ -172,100 +199,12 @@ class Fig::Command
     end
   end
 
-  def read_in_package_config_file(config_file)
-    if File.exist?(config_file)
-      return File.read(config_file)
-    else
-      raise Fig::UserInputError.new(%Q<File not found: "#{config_file}".>)
-    end
-  end
-
   def remote_operation_necessary?()
     return @options.updating?                     ||
            @options.publish?                      ||
            @options.listing == :remote_packages
   end
 
-  def load_package_config_file_contents()
-    package_config_file = @options.package_config_file()
-
-    if package_config_file == :none
-      return nil
-    elsif package_config_file == '-'
-      return $stdin.read
-    elsif package_config_file.nil?
-      if File.exist?(DEFAULT_FIG_FILE)
-        return File.read(DEFAULT_FIG_FILE)
-      end
-    else
-      return read_in_package_config_file(package_config_file)
-    end
-
-    return
-  end
-
-  def register_package_with_environment_if_not_listing()
-    return if @options.listing
-
-    register_package_with_environment()
-
-    return
-  end
-
-  def register_package_with_environment()
-    if @options.updating?
-      @package.retrieves.each do |var, path|
-        @environment.add_retrieve(var, path)
-      end
-    end
-
-    @environment.register_package(@package)
-    @environment.apply_config(
-      @package,
-      @options.config() || @descriptor && @descriptor.config() || 'default',
-      nil
-    )
-    return
-  end
-
-  def parse_package_config_file(config_raw_text)
-    if config_raw_text.nil?
-      @package = Fig::Package.new(nil, nil, '.', [])
-      return
-    end
-
-    @package =
-      Fig::Parser.new(@configuration).parse_package(
-        nil, nil, '.', config_raw_text
-      )
-
-    register_package_with_environment_if_not_listing()
-
-    return
-  end
-
-  def load_package_file()
-    config_raw_text = load_package_config_file_contents()
-
-    parse_package_config_file(config_raw_text)
-  end
-
-  def get_package()
-    if @descriptor.nil?
-      load_package_file()
-    else
-      # TODO: complain if config file was specified on the command-line.
-      @package =
-        @repository.get_package(
-          @descriptor.name, @descriptor.version, :disable_updating
-        )
-
-      register_package_with_environment_if_not_listing()
-    end
-
-    return
-  end
-
   def publish()
     check_required_package_descriptor('to publish')
 
@@ -279,10 +218,12 @@ class Fig::Command
         @options.archives() +
         [
           Fig::Statement::Configuration.new(
-            'default', @options.non_command_package_statements()
+            nil,
+            Fig::Package::DEFAULT_CONFIG,
+            @options.non_command_package_statements()
           )
         ]
-      publish_statements << Fig::Statement::Publish.new('default','default')
+      publish_statements << Fig::Statement::Publish.new()
     else
       load_package_file()
       if not @package.statements.empty?
@@ -294,10 +235,12 @@ class Fig::Command
     end
 
     if @options.publish?
-      Fig::Logging.info "Checking status of #{@descriptor.name}/#{@descriptor.version}..."
+      Fig::Logging.info "Checking status of #{@descriptor.to_string()}..."
 
-      if @repository.list_remote_packages.include?("#{@descriptor.name}/#{@descriptor.version}")
-        Fig::Logging.info "#{@descriptor.name}/#{@descriptor.version} has already been published."
+      package_description =
+        Fig::PackageDescriptor.format(@descriptor.name, @descriptor.version, nil)
+      if @repository.list_remote_packages.include?("#{package_description}")
+        Fig::Logging.info "#{@descriptor.to_string()} has already been published."
 
         if not @options.force?
           Fig::Logging.fatal 'Use the --force option if you really want to overwrite, or use --publish-local for testing.'
@@ -308,12 +251,9 @@ class Fig::Command
       end
     end
 
-    Fig::Logging.info "Publishing #{@descriptor.name}/#{@descriptor.version}."
+    Fig::Logging.info "Publishing #{@descriptor.to_string()}."
     @repository.publish_package(
-      publish_statements,
-      @descriptor.name,
-      @descriptor.version,
-      @options.publish_local?
+      publish_statements, @descriptor, @options.publish_local?
     )
 
     return 0