fig 0.1.50 → 0.1.51

data/lib/fig/figrc.rb

@@ -7,6 +7,8 @@ require 'fig/os'
 REPOSITORY_CONFIGURATION = '_meta/figrc'
 
 module Fig
+  # Parse multiple figrc files and assemble them into a single
+  # ApplicationConfiguration object.
   class FigRC
     def self.find(
       override_path, repository_url, login, fig_home, disable_figrc = false

data/lib/fig/grammar.treetop

@@ -131,7 +131,7 @@ grammar Fig
   end
 
   rule set_value
-    [@a-zA-Z0-9/\\._-]+
+    [@a-zA-Z0-9/\\._-]*
   end
 
   rule command

data/lib/fig/log4rconfigerror.rb

@@ -1,6 +1,7 @@
 require 'fig/userinputerror'
 
 module Fig
+  # A problem with configuring Log4r.
   class Log4rConfigError < UserInputError
     def initialize(config_file, original_exception)
       super(

data/lib/fig/logging.rb

@@ -7,6 +7,8 @@ require 'fig/log4rconfigerror'
 
 module Fig; end
 
+# Logging facility that handles the fact that we may wish to do logging prior
+# to Log4r being properly configured.
 module Fig::Logging
   if not Log4r::Logger['initial']
     @@logger = Log4r::Logger.new('initial')

data/lib/fig/notfounderror.rb

@@ -1,4 +1,7 @@
 module Fig
+  # A (possibly remote) file that was looked for was not found.  This may or
+  # may not actually be a problem; i.e. this may be the result of an existence
+  # test.
   class NotFoundError < StandardError
   end
 end

data/lib/fig/options.rb

@@ -6,6 +6,9 @@ require 'fig/package/path'
 require 'fig/package/resource'
 require 'fig/package/set'
 
+# Command-line processing.
+
+
 module Fig
   def parse_descriptor(descriptor)
     # todo should use treetop for these:
@@ -17,7 +20,10 @@ module Fig
 
   USAGE = <<EOF
 
-Usage: fig [--debug] [--update] [--config <config>] [--get <var> | --list | <package> | -- <command>]
+Usage: fig [--update | --update-if-missing] [--file <path>] [--set <VAR=value>] [--config <config>] [--login] [--log-level <level>] [--log-config <path>] [--figrc <path>] [--no-figrc] [-- <command>]
+       fig [--publish | --publish-local] [--append <VAR=val>] [--resource <fullpath>] [--include <package name/version>] [--force] [--no-file] [--archive <path>] [--file] [--set <VAR=value>] [--config <config>] [--login] [--log-level <level>] [--log-config <path>] [--figrc <path>] [--no-figrc]
+       fig [--set <VAR=value>] [--get <VAR> | --list-configs <package name>/<version> | --list | --list-remote | --clean <package name/version> | --version] [--log-level <level>] [--log-config <path>] [--figrc <path>] [--no-figrc] [-- <command>]
+       fig [<package name>/<version>] [--log-level <level>] [--log-config <path>] [--figrc <path>] [--no-figrc]
 
 Relevant env vars: FIG_REMOTE_URL (required), FIG_HOME (path to local repository cache, defaults
 to $HOME/.fighome).
@@ -64,14 +70,14 @@ EOF
         return nil, nil, 0
       end
 
-      options[:modifiers] = []
+      options[:non_command_package_statements] = []
       opts.on(
         '-p',
         '--append VAR=VAL',
         'append (actually, prepend) VAL to environment var VAR, delimited by separator'
       ) do |var_val|
         var, val = var_val.split('=')
-        options[:modifiers] << Package::Path.new(var, val)
+        options[:non_command_package_statements] << Package::Path.new(var, val)
       end
 
       options[:archives] = []
@@ -96,11 +102,6 @@ EOF
         options[:config] = config
       end
 
-      options[:debug] = false
-      opts.on('-d', '--debug', 'print debug info') do
-        options[:debug] = true
-      end
-
       options[:package_config_file] = nil
       opts.on(
         '--file FILE',
@@ -117,13 +118,13 @@ EOF
         options[:force] = force
       end
 
-      options[:echo] = nil
+      options[:get] = nil
       opts.on(
         '-g',
         '--get VAR',
         'print value of environment variable VAR'
-      ) do |echo|
-        options[:echo] = echo
+      ) do |get|
+        options[:get] = get
       end
 
       opts.on(
@@ -132,7 +133,7 @@ EOF
         'include PKG (with any variable prepends) in environment'
       ) do |descriptor|
         package_name, config_name, version_name = parse_descriptor(descriptor)
-        options[:modifiers] << Package::Include.new(package_name, config_name, version_name, {})
+        options[:non_command_package_statements] << Package::Include.new(package_name, config_name, version_name, {})
       end
 
       options[:list] = false
@@ -191,7 +192,7 @@ EOF
         '-s', '--set VAR=VAL', 'set environment variable VAR to VAL'
       ) do |var_val|
         var, val = var_val.split('=')
-        options[:modifiers] << Package::Set.new(var, val)
+        options[:non_command_package_statements] << Package::Set.new(var, val)
       end
 
       options[:update] = false
@@ -241,7 +242,12 @@ EOF
     end
 
     # Need to catch the exception thrown from parser and retranslate into a fig exception
-    parser.parse!(argv)
+    begin
+      parser.parse!(argv)
+    rescue OptionParser::MissingArgument => error
+      $stderr.puts "Please provide the #{error}."
+      return nil, nil, 1
+    end
 
     return options, argv, nil
   end

data/lib/fig/os.rb

@@ -15,6 +15,8 @@ require 'fig/networkerror'
 require 'fig/notfounderror'
 
 module Fig
+  # Does things requiring real O/S interaction, primarilly taking care of file
+  # transfers and running external commands.
   class OS
     def initialize(login)
       @login = login

data/lib/fig/package.rb

@@ -7,13 +7,15 @@ require 'fig/package/retrieve'
 
 module Fig; end
 
+# The parsed representation of a configuration file.  Contains the statement
+# objects.
 class Fig::Package
   attr_reader :package_name, :version_name, :directory, :statements
   attr_accessor :backtrace
 
   def initialize(package_name, version_name, directory, statements)
-    @package_name = package_name || 'uninitialized'
-    @version_name = version_name || 'default'
+    @package_name = package_name
+    @version_name = version_name
     @directory = directory
     @statements = statements
     @backtrace = nil
@@ -23,9 +25,7 @@ class Fig::Package
     @statements.each do |stmt|
       return stmt if stmt.is_a?(Configuration) && stmt.name == config_name
     end
-    message =
-      "Configuration not found: #{@package_name}/#{@version_name}:#{config_name}"
-    Fig::Logging.fatal message
+    message = "Configuration not found: #{@package_name}/#{@version_name}:#{config_name}"
     raise Fig::PackageError.new message
   end
 
@@ -64,7 +64,9 @@ class Fig::Package
   end
 
   def to_s
-    @package_name + '/' + @version_name
+    package_name ||= 'uninitialized'
+    version_name ||= 'uninitialized'
+    package_name + '/' + version_name
   end
 end
 
@@ -72,4 +74,3 @@ def unparse_statements(indent, prefix, statements, suffix)
   body = @statements.map { |statement| statement.unparse(indent+'  ') }.join("\n")
   return ["\n#{indent}#{prefix}", body, "#{indent}#{suffix}"].join("\n")
 end
-

data/lib/fig/package/archive.rb

@@ -5,6 +5,9 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Specifies an archive file (possibly via a URL) that is part of the current package.
+#
+# Differs from a Resource in that the contents will be extracted.
 class Fig::Package::Archive
   include Fig::Package::Statement
 

data/lib/fig/package/command.rb

@@ -5,6 +5,8 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Specifies a default command that will be executed for a given Configuration
+# if no command is specified on the command-line.
 class Fig::Package::Command
   include Fig::Package::Statement
 

data/lib/fig/package/configuration.rb

@@ -6,6 +6,7 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# A grouping of statements within a configuration.  May not be nested.
 class Fig::Package::Configuration
   include Fig::Package::Statement
 
@@ -20,11 +21,10 @@ class Fig::Package::Configuration
     Configuration.new(name, statements)
   end
 
-  def commands
-    result = statements.select do
+  def command
+    return statements.find do
       |statement| statement.is_a?(Fig::Package::Command)
     end
-    result
   end
 
   def walk_statements(&block)

data/lib/fig/package/include.rb

@@ -5,6 +5,8 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Dual role: "include :configname" incorporates one configuration into another;
+# "include package[/version]" declares a dependency upon another package.
 class Fig::Package::Include
   include Fig::Package::Statement
 

data/lib/fig/package/install.rb

@@ -5,6 +5,7 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# This class appears to be unused, though it is in the grammar.
 class Fig::Package::Install
   include Fig::Package::Statement
 

data/lib/fig/package/override.rb

@@ -5,6 +5,13 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Overrides one package version dependency with another in an include
+# statement.
+#
+#    include blah/1.2.3 override somedependency/3.2.6
+#
+# indicates that, regardless of which version of somedependency the blah
+# package says it needs, the blah package will actually use v3.2.6.
 class Fig::Package::Override
   include Fig::Package::Statement
 

data/lib/fig/package/path.rb

@@ -5,6 +5,8 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# A statement that specifies or modifies a path environment variable, e.g.
+# "append", "path", "add" (though those are all synonyms).
 class Fig::Package::Path
   include Fig::Package::Statement
 

data/lib/fig/package/publish.rb

@@ -5,6 +5,8 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Artificial statement (it's not in the grammar) used to handle default
+# publishing.
 class Fig::Package::Publish
   include Fig::Package::Statement
 

data/lib/fig/package/resource.rb

@@ -5,6 +5,9 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Specifies a file (possibly via a URL) that is part of the current package.
+#
+# Differs from an Archive in that the contents will not be extracted.
 class Fig::Package::Resource
   include Fig::Package::Statement
 

data/lib/fig/package/retrieve.rb

@@ -5,6 +5,7 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# Specifies the destination to put a dependency into.
 class Fig::Package::Retrieve
   include Fig::Package::Statement
 

data/lib/fig/package/set.rb

@@ -5,6 +5,7 @@ require 'fig/package/statement'
 module Fig; end
 class Fig::Package; end
 
+# A statement that sets the value of an environment variable.
 class Fig::Package::Set
   include Fig::Package::Statement
 

data/lib/fig/package/statement.rb

@@ -1,6 +1,7 @@
 module Fig; end
 class Fig::Package; end
 
+# A statement within a package configuration file (package.fig).
 module Fig::Package::Statement
   def walk_statements(&block)
     return

data/lib/fig/packageerror.rb

@@ -1,7 +1,8 @@
 require 'fig/userinputerror'
 
 module Fig
-  # An issue with a stored package.
+  # An issue with a stored package, i.e. not a package.fig in the current
+  # directory.
   class PackageError < UserInputError
   end
 end

data/lib/fig/parser.rb

@@ -6,22 +6,17 @@ require 'fig/logging'
 require 'fig/packageerror'
 require 'fig/repository'
 require 'fig/urlaccesserror'
+require 'fig/userinputerror'
 
 module Fig
+  # Parses configuration files and deals with a few restrictions on them.
   class Parser
     def initialize(application_config)
       @parser = FigParser.new
       @application_config = application_config
     end
 
-    def parse_package(package_name, version_name, directory, input)
-      input = input.gsub(/#.*$/, '')
-      result = @parser.parse(" #{input} ")
-      if result.nil?
-        Logging.fatal "#{directory}: #{@parser.failure_reason}"
-        raise PackageError.new("#{directory}: #{@parser.failure_reason}")
-      end
-      package = result.to_package(package_name, version_name, directory)
+    def find_bad_urls(package, package_name, version_name)
       bad_urls = []
       package.walk_statements do |statement|
         statement.urls.each do |url|
@@ -30,7 +25,38 @@ module Fig
           bad_urls << url if not @application_config.url_access_allowed?(url)
         end
       end
+
       raise URLAccessError.new(bad_urls, package_name, version_name) if not bad_urls.empty?
+    end
+
+    def find_multiple_command_statements(package)
+      command_processed = false
+      package.walk_statements do |statement|
+        if statement.is_a?(Package::Command)
+          if command_processed == true
+            raise UserInputError.new("Multiple command statements cannot be processed.")
+          end
+          command_processed = true
+        elsif statement.is_a?(Package::Configuration)
+          command_processed = false
+        end
+      end
+    end
+
+    def parse_package(package_name, version_name, directory, input)
+      input = input.gsub(/#.*$/, '')
+      result = @parser.parse(" #{input} ")
+
+      if result.nil?
+        Logging.fatal "#{directory}: #{@parser.failure_reason}"
+        raise PackageError.new("#{directory}: #{@parser.failure_reason}")
+      end
+
+      package = result.to_package(package_name, version_name, directory)
+
+      find_bad_urls(package, package_name, version_name)
+      find_multiple_command_statements(package)
+
       return package
     end
   end

data/lib/fig/repository.rb

@@ -7,6 +7,8 @@ require 'fig/repositoryerror'
 require 'fig/urlaccesserror'
 
 module Fig
+  # Overall management of a repository.  Handles local operations itself;
+  # defers remote operations to others.
   class Repository
     def self.is_url?(url)
       not (/ftp:\/\/|http:\/\/|file:\/\/|ssh:\/\// =~ url).nil?

data/lib/fig/retriever.rb

@@ -3,11 +3,11 @@ require 'set'
 
 require 'fig/logging'
 
-# This class copies files from the project directories in ~/.fighome to the
-# user's working directory. It keeps track of which files have already been copied, and which
-# package/versions they came from, and deletes files as necessary to ensure that
-# we never have files from two different versions of the same package in the user's
-# working directory.
+# Copies files from the project directories in FIG_HOME to the user's working
+# directory. It keeps track of which files have already been copied, and which
+# package/versions they came from, and deletes files as necessary to ensure
+# that we never have files from two different versions of the same package in
+# the user's working directory.
 class Retriever
   def initialize(base_dir)
     @base_dir = base_dir
@@ -55,7 +55,7 @@ class Retriever
     end
   end
 
-private
+  private
 
   def load(file)
     File.open(file).each_line do |line|
@@ -108,6 +108,7 @@ private
           Fig::Logging.info "+ [#{@config.name}/#{@config.version}] #{relpath}"
         end
         FileUtils.mkdir_p(File.dirname(target))
+
         FileUtils.cp(source, target, :preserve => true)
       end
       @config.files << relpath if @config