fig 0.1.67 → 0.1.69

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

@@ -0,0 +1,187 @@
+require 'optparse'
+
+require 'fig/command/option_error'
+
+module Fig; end
+class Fig::Command; end
+class Fig::Command::Options; end
+
+# Command-line processing.
+class Fig::Command::Options::Parser
+  # This class knows way too much about how OptionParser works.
+
+  USAGE = <<-EOF
+Usage:
+
+  fig [...] [DESCRIPTOR] [--update | --update-if-missing] [-- COMMAND]
+  fig [...] [DESCRIPTOR] [--update | --update-if-missing] [--command-extra-args VALUES]
+
+  fig {--publish | --publish-local} DESCRIPTOR
+      [--resource PATH]
+      [--archive  PATH]
+      [--include  DESCRIPTOR]
+      [--override DESCRIPTOR]
+      [--force]
+      [...]
+
+  fig --clean DESCRIPTOR [...]
+
+  fig --get VARIABLE                                         [DESCRIPTOR] [...]
+  fig --list-configs                                         [DESCRIPTOR] [...]
+  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
+  fig {--list-local | --list-remote}                                      [...]
+
+  fig {--version | --help}
+
+
+A DESCRIPTOR looks like <package name>[/<version>][:<config>] e.g. "foo",
+"foo/1.2.3", and "foo/1.2.3:default". Whether ":<config>" and "/<version>" are
+required or allowed is dependent upon what your are doing.
+
+Standard options (represented as "[...]" above):
+
+      [--set    VARIABLE=VALUE]
+      [--append VARIABLE=VALUE]
+      [--file PATH] [--no-file]
+      [--config CONFIG]
+      [--login]
+      [--log-level LEVEL] [--log-config PATH]
+      [--figrc PATH] [--no-figrc]
+      [--suppress-warning-include-statement-missing-version]
+
+Environment variables:
+
+  FIG_REMOTE_URL (required),
+  FIG_HOME (path to local repository cache, defaults to $HOME/.fighome).
+  EOF
+
+  def initialize()
+    @switches             = {}
+    @argument_description = {}
+    @parser               = OptionParser.new
+
+    @parser.banner = "#{USAGE}\n"
+  end
+
+  def add_argument_description(options, description)
+    if options.is_a? Array
+      options.each do
+        |option|
+
+        @argument_description[option] = description
+      end
+    else
+      @argument_description[options] = description
+    end
+
+    return
+  end
+
+  def on_head(*arguments, &block)
+    switch_array = make_switch_array(arguments, block)
+
+    return if not switch_array
+
+    @parser.top.prepend(*switch_array)
+
+    return
+  end
+
+  def on(*arguments, &block)
+    switch_array = make_switch_array(arguments, block)
+
+    return if not switch_array
+
+    @parser.top.append(*switch_array)
+
+    return
+  end
+
+  def on_tail(*arguments, &block)
+    switch_array = make_switch_array(arguments, block)
+
+    return if not switch_array
+
+    @parser.base.append(*switch_array)
+
+    return
+  end
+
+  def help()
+    return @parser.help
+  end
+
+  def parse!(argv)
+    begin
+      @parser.parse!(argv)
+    rescue OptionParser::InvalidArgument => error
+      raise_invalid_argument(error.args[0], error.args[1])
+    rescue OptionParser::MissingArgument => error
+      raise_missing_argument(error.args[0])
+    rescue OptionParser::InvalidOption => error
+      raise Fig::Command::OptionError.new(
+        "Unknown option #{error.args[0]}.\n\n#{USAGE}"
+      )
+    rescue OptionParser::ParseError => error
+      raise Fig::Command::OptionError.new(error.to_s)
+    end
+
+    return
+  end
+
+  def raise_invalid_argument(option, value)
+    # *sigh* OptionParser does not raise MissingArgument for the case of an
+    # option with a required value being followed by another option.  It
+    # assigns the next option as the value instead.  E.g. for
+    #
+    #    fig --set --get FOO
+    #
+    # it assigns "--get" as the value of the "--set" option.
+    if @switches.has_key? value
+      raise_missing_argument(option)
+    end
+
+    description = @argument_description[option]
+    if description.nil?
+      description = ''
+    else
+      description = ' ' + description
+    end
+
+    raise Fig::Command::OptionError.new(
+      %Q<Invalid value for #{option}: "#{value}".#{description}>
+    )
+  end
+
+  private
+
+  def make_switch_array(arguments, block)
+    # From the OptionParser code, the contents of the array:
+    #
+    # +switch+::      OptionParser::Switch instance to be inserted.
+    # +short_opts+::  List of short style options.
+    # +long_opts+::   List of long style options.
+    # +nolong_opts+:: List of long style options with "no-" prefix.
+    #
+    # Why returning this data separate from the Switch object is necessary, I
+    # do not understand.
+
+    switch_array = @parser.make_switch(arguments, block)
+    switch = switch_array[0]
+
+    options = [switch.long, switch.short].flatten
+
+    return if options.any? {|option| @switches.has_key? option}
+
+    options.each {|option| @switches[option] = switch}
+
+    return switch_array
+  end
+
+  def raise_missing_argument(option)
+    raise Fig::Command::OptionError.new(
+      "Please provide a value for #{option}."
+    )
+  end
+end

data/lib/fig/logging.rb

@@ -45,14 +45,14 @@ module Fig::Logging
           when / [.] ya?ml \z /x
             Log4r::YamlConfigurator.load_yaml_file(config_file)
           else
-            raise ConfigFileError, %Q<Don't know what format #{config_file} is in.>, config_file
+            raise Fig::ConfigFileError, %Q<Don't know what format #{config_file} is in.>, config_file
         end
 
         if Log4r::Logger['fig'].nil?
           $stderr.puts %q<A value was provided for --log-config but no "fig" logger was defined.>
         end
       rescue Log4r::ConfigError, ArgumentError => exception
-        raise Log4rConfigError.new(config_file, exception)
+        raise Fig::Log4rConfigError.new(config_file, exception)
       end
     end
 

data/lib/fig/operating_system.rb

@@ -242,7 +242,7 @@ class Fig::OperatingSystem
     end
   end
 
-  def upload(local_file, remote_file, user)
+  def upload(local_file, remote_file)
     Fig::Logging.debug "Uploading #{local_file} to #{remote_file}."
     uri = URI.parse(remote_file)
     case uri.scheme

data/lib/fig/package.rb

@@ -20,15 +20,15 @@ class Fig::Package
   DEFAULT_CONFIG  = 'default'
 
   attr_reader   :name, :version, :directory, :statements
-  attr_accessor :backtrace
+  attr_accessor :backtrace, :unparsed_text
 
   def initialize(name, version, directory, statements)
-    @name = name
-    @version = version
-    @directory = directory
-    @statements = statements
+    @name                 = name
+    @version              = version
+    @directory            = directory
+    @statements           = statements
     @applied_config_names = []
-    @backtrace = nil
+    @backtrace            = nil
   end
 
   def [](config_name)

data/lib/fig/parser.rb

@@ -21,13 +21,13 @@ class Fig::Parser
     @check_include_versions = check_include_versions
   end
 
-  def parse_package(descriptor, directory, source_description, input)
+  def parse_package(descriptor, directory, source_description, unparsed_text)
     # Bye bye comments.
-    input = input.gsub(/#.*$/, '')
+    stripped_text = unparsed_text.gsub(/#.*$/, '')
 
     # Extra space at the end because most of the rules in the grammar require
     # trailing whitespace.
-    result = @treetop_parser.parse(input + ' ')
+    result = @treetop_parser.parse(stripped_text + ' ')
 
     extended_description =
       extend_source_description(directory, source_description)
@@ -40,6 +40,7 @@ class Fig::Parser
       directory,
       Fig::ParserPackageBuildState.new(descriptor, extended_description)
     )
+    package.unparsed_text = unparsed_text
 
     check_for_bad_urls(package, descriptor)
     check_for_multiple_command_statements(package)

data/lib/fig/repository.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'set'
 require 'socket'
 require 'sys/admin'
@@ -5,16 +6,13 @@ require 'tmpdir'
 
 require 'fig'
 require 'fig/at_exit'
-require 'fig/command'
 require 'fig/logging'
 require 'fig/not_found_error'
 require 'fig/package_cache'
 require 'fig/package_descriptor'
 require 'fig/parser'
 require 'fig/repository_error'
-require 'fig/statement/archive'
-require 'fig/statement/resource'
-require 'fig/url_access_error'
+require 'fig/repository_package_publisher'
 
 module Fig; end
 
@@ -22,6 +20,7 @@ module Fig; end
 # defers remote operations to others.
 class Fig::Repository
   METADATA_SUBDIRECTORY = '_meta'
+  PACKAGE_FILE_IN_REPO  = '.fig'
   RESOURCES_FILE        = 'resources.tar.gz'
   VERSION_FILE_NAME     = 'repository-format-version'
   VERSION_SUPPORTED     = 1
@@ -34,13 +33,13 @@ class Fig::Repository
     os,
     local_repository_directory,
     application_config,
-    remote_repository_user,
+    publish_listeners,
     check_include_versions
   )
     @operating_system             = os
     @local_repository_directory   = local_repository_directory
     @application_config           = application_config
-    @remote_repository_user       = remote_repository_user
+    @publish_listeners            = publish_listeners
 
     @parser = Fig::Parser.new(application_config, check_include_versions)
 
@@ -123,38 +122,31 @@ class Fig::Repository
     return
   end
 
-  def publish_package(package_statements, descriptor, local_only)
+  def publish_package(
+    package_statements, descriptor, local_only, source_package, was_forced
+  )
     check_local_repository_format()
     if not local_only
       check_remote_repository_format()
     end
 
-    validate_asset_names(package_statements)
-
-    temp_dir = publish_temp_dir()
-    @operating_system.delete_and_recreate_directory(temp_dir)
-    local_dir = local_dir_for_package(descriptor)
-    @operating_system.delete_and_recreate_directory(local_dir)
-    fig_file = File.join(temp_dir, PACKAGE_FILE_IN_REPO)
-    content = publish_package_content_and_derive_dot_fig_contents(
-      package_statements, descriptor, local_dir, local_only
-    )
-    @operating_system.write(fig_file, content)
-
-    if not local_only
-      @operating_system.upload(
-        fig_file,
-        remote_fig_file_for_package(descriptor),
-        @remote_repository_user
-      )
-    end
-    @operating_system.copy(
-      fig_file, local_fig_file_for_package(descriptor)
-    )
-
-    FileUtils.rm_rf(temp_dir)
-
-    return true
+    publisher = Fig::RepositoryPackagePublisher.new
+    publisher.operating_system       = @operating_system
+    publisher.publish_listeners      = @publish_listeners
+    publisher.package_statements     = package_statements
+    publisher.descriptor             = descriptor
+    publisher.source_package         = source_package
+    publisher.was_forced             = was_forced
+    publisher.base_temp_dir          = base_temp_dir
+    publisher.local_dir_for_package  = local_dir_for_package(descriptor)
+    publisher.remote_dir_for_package = remote_dir_for_package(descriptor)
+    publisher.local_only             = local_only
+    publisher.local_fig_file_for_package =
+      local_fig_file_for_package(descriptor)
+    publisher.remote_fig_file_for_package =
+      remote_fig_file_for_package(descriptor)
+
+    return publisher.publish_package()
   end
 
   def update_unconditionally()
@@ -167,12 +159,8 @@ class Fig::Repository
 
   private
 
-  PACKAGE_FILE_IN_REPO = '.fig'
-
   def initialize_local_repository()
-    if not File.exist?(@local_repository_directory)
-      Dir.mkdir(@local_repository_directory)
-    end
+    FileUtils.mkdir_p(@local_repository_directory)
 
     version_file = local_version_file()
     if not File.exist?(version_file)
@@ -261,31 +249,6 @@ class Fig::Repository
     return version_string.to_i()
   end
 
-  def validate_asset_names(package_statements)
-    asset_statements = package_statements.select { |s| s.is_asset? }
-
-    asset_names = Set.new()
-    asset_statements.each do
-      |statement|
-
-      asset_name = statement.asset_name()
-      if not asset_name.nil?
-        if asset_name == RESOURCES_FILE
-          Fig::Logging.fatal \
-            %Q<You cannot have an asset with the name "#{RESOURCES_FILE}"#{statement.position_string()} due to Fig implementation details.>
-        end
-
-        if asset_names.include?(asset_name)
-          Fig::Logging.fatal \
-            %Q<Found multiple archives with the name "#{asset_name}"#{statement.position_string()}. If these were allowed, archives would overwrite each other.>
-          raise Fig::RepositoryError.new
-        else
-          asset_names.add(asset_name)
-        end
-      end
-    end
-  end
-
   def remote_repository_url()
     return @application_config.remote_repository_url()
   end
@@ -326,12 +289,16 @@ class Fig::Repository
   end
 
   def install_package(descriptor, temp_dir)
+    remote_fig_file = remote_fig_file_for_package(descriptor)
+    local_dir       = local_dir_for_package(descriptor)
+    local_fig_file  = fig_file_for_package_download(local_dir)
+    return if not @operating_system.download(remote_fig_file, local_fig_file)
+
     @operating_system.delete_and_recreate_directory(temp_dir)
 
-    remote_fig_file = remote_fig_file_for_package(descriptor)
-    local_fig_file = fig_file_for_package_download(temp_dir)
+    temp_fig_file = fig_file_for_package_download(temp_dir)
 
-    return if not @operating_system.download(remote_fig_file, local_fig_file)
+    @operating_system.download(remote_fig_file, temp_fig_file)
 
     package = read_package_from_directory(temp_dir, descriptor)
 
@@ -349,7 +316,6 @@ class Fig::Repository
       @operating_system.download_resource(resource_url, temp_dir)
     end
 
-    local_dir = local_dir_for_package(descriptor)
     FileUtils.rm_rf(local_dir)
     FileUtils.mkdir_p( File.dirname(local_dir) )
     FileUtils.mv(temp_dir, local_dir)
@@ -357,25 +323,6 @@ class Fig::Repository
     return
   end
 
-  # 'resources' is an Array of fileglob patterns: ['tmp/foo/file1',
-  # 'tmp/foo/*.jar']
-  def expand_globs_from(resources)
-    expanded_files = []
-
-    resources.each do
-      |path|
-
-      globbed_files = Dir.glob(path)
-      if globbed_files.empty?
-        expanded_files << path
-      else
-        expanded_files.concat(globbed_files)
-      end
-    end
-
-    return expanded_files
-  end
-
   def read_package_from_directory(directory, descriptor)
     dot_fig_file = File.join(directory, PACKAGE_FILE_IN_REPO)
     if not File.exist?(dot_fig_file)
@@ -432,10 +379,6 @@ class Fig::Repository
     File.join(@local_repository_directory, 'tmp')
   end
 
-  def publish_temp_dir()
-    File.join(base_temp_dir(), 'publish')
-  end
-
   def package_download_temp_dir(descriptor)
     base_directory = File.join(base_temp_dir(), 'package-download')
     FileUtils.mkdir_p(base_directory)
@@ -448,161 +391,4 @@ class Fig::Repository
   def package_missing?(descriptor)
     not File.exist?(local_fig_file_for_package(descriptor))
   end
-
-  def publish_package_content_and_derive_dot_fig_contents(
-    package_statements, descriptor, local_dir, local_only
-  )
-    header_strings = derive_package_metadata_comments(
-      package_statements, descriptor
-    )
-    deparsed_statement_strings = publish_package_content(
-      package_statements, descriptor, local_dir, local_only
-    )
-
-    statement_strings = [header_strings, deparsed_statement_strings].flatten()
-    return statement_strings.join("\n").gsub(/\n{3,}/, "\n\n").strip() + "\n"
-  end
-
-  def derive_package_metadata_comments(package_statements, descriptor)
-    now = Time.now()
-
-    asset_statements =
-      package_statements.select { |statement| statement.is_asset? }
-    asset_strings =
-      asset_statements.collect { |statement| statement.unparse('#    ') }
-    asset_summary = nil
-
-    if asset_strings.empty?
-      asset_summary = [
-        %q<#>,
-        %q<# There were no asset statements in the unpublished package definition.>
-      ]
-    else
-      asset_summary = [
-        %q<#>,
-        %q<# Original asset statements: >,
-        %q<#>,
-        asset_strings
-      ]
-    end
-
-    return [
-      %Q<# Publishing information for #{descriptor.to_string()}:>,
-      %q<#>,
-      %Q<#     Time: #{now} (epoch: #{now.to_i()})>,
-      %Q<#     User: #{Sys::Admin.get_login()}>,
-      %Q<#     Host: #{Socket.gethostname()}>,
-      %Q<#     Args: "#{ARGV.join %q[", "]}">,
-      %Q<#     Fig:  v#{Fig::VERSION}>,
-      asset_summary,
-      %Q<\n>,
-    ].flatten()
-  end
-
-  # Deals with Archive and Resource statements.  It downloads any remote
-  # files (those where the statement references a URL as opposed to a local
-  # file) and then copies all files into the local repository and the remote
-  # repository (if not a local-only publish).
-  #
-  # Returns the deparsed strings for the resource statements with URLs
-  # replaced with in-package paths.
-  def publish_package_content(
-    package_statements, descriptor, local_dir, local_only
-  )
-    return create_resource_archive(package_statements).map do |statement|
-      if statement.is_asset?
-        asset_name = statement.asset_name()
-        asset_remote = "#{remote_dir_for_package(descriptor)}/#{asset_name}"
-
-        if Fig::Repository.is_url?(statement.url)
-          asset_local = File.join(publish_temp_dir(), asset_name)
-
-          begin
-            @operating_system.download(statement.url, asset_local)
-          rescue Fig::NotFoundError
-            Fig::Logging.fatal "Could not download #{statement.url}."
-            raise Fig::RepositoryError.new
-          end
-        else
-          asset_local = statement.url
-          check_asset_path(asset_local)
-        end
-
-        if not local_only
-          @operating_system.upload(
-            asset_local, asset_remote, @remote_repository_user
-          )
-        end
-
-        @operating_system.copy(asset_local, local_dir + '/' + asset_name)
-        if statement.is_a?(Fig::Statement::Archive)
-          @operating_system.unpack_archive(local_dir, asset_name)
-        end
-
-        statement.class.new(nil, nil, asset_name).unparse('')
-      else
-        statement.unparse('')
-      end
-    end
-  end
-
-  # Grabs all of the Resource statements that don't reference URLs, creates a
-  # "resources.tar.gz" file containing all the referenced files, strips the
-  # Resource statements out of the statements, replacing them with a single
-  # Archive statement.  Thus the caller should substitute its set of
-  # statements with the return value.
-  def create_resource_archive(package_statements)
-    asset_paths = []
-    new_package_statements = package_statements.reject do |statement|
-      if (
-        statement.is_a?(Fig::Statement::Resource) &&
-        ! Fig::Repository.is_url?(statement.url)
-      )
-        asset_paths << statement.url
-        true
-      else
-        false
-      end
-    end
-
-    if asset_paths.size > 0
-      asset_paths = expand_globs_from(asset_paths)
-      check_asset_paths(asset_paths)
-
-      file = RESOURCES_FILE
-      @operating_system.create_archive(file, asset_paths)
-      new_package_statements.unshift(
-        Fig::Statement::Archive.new(nil, nil, file)
-      )
-      Fig::AtExit.add { File.delete(file) }
-    end
-
-    return new_package_statements
-  end
-
-  def check_asset_path(asset_path)
-    if not File.exist?(asset_path)
-      Fig::Logging.fatal "Could not find file #{asset_path}."
-      raise Fig::RepositoryError.new
-    end
-
-    return
-  end
-
-  def check_asset_paths(asset_paths)
-    non_existing_paths =
-      asset_paths.select {|path| ! File.exist?(path) && ! File.symlink?(path) }
-
-    if not non_existing_paths.empty?
-      if non_existing_paths.size > 1
-        Fig::Logging.fatal "Could not find files: #{ non_existing_paths.join(', ') }"
-      else
-        Fig::Logging.fatal "Could not find file #{non_existing_paths[0]}."
-      end
-
-      raise Fig::RepositoryError.new
-    end
-
-    return
-  end
 end