fig 0.1.39 → 0.1.41

data/lib/fig/figrc.rb

@@ -0,0 +1,105 @@
+require 'json'
+
+require 'fig/applicationconfiguration'
+require 'fig/configfileerror'
+require 'fig/os'
+
+REPOSITORY_CONFIGURATION = '_meta/figrc'
+
+module Fig
+  class FigRC
+    def self.find(
+      override_path, repository_url, login, fig_home, disable_figrc = false
+    )
+      configuration = ApplicationConfiguration.new(repository_url)
+
+      handle_override_configuration(configuration, override_path)
+      handle_figrc(configuration) if not disable_figrc
+      handle_repository_configuration(
+        configuration, repository_url, login, fig_home
+      )
+
+      return configuration
+    end
+
+    private
+
+    def self.handle_override_configuration(configuration, override_path)
+      begin
+        if not override_path.nil?
+          configuration.push_dataset(
+            JSON.parse(File::open(override_path).read)
+          )
+        end
+      rescue JSON::ParserError => exception
+        translate_parse_error(exception, override_path)
+      end
+
+      return
+    end
+
+    def self.handle_figrc(configuration)
+      user_figrc_path = File.expand_path('~/.figrc')
+      return if not File.exists? user_figrc_path
+
+      begin
+        configuration.push_dataset(
+          JSON.parse(File::open(user_figrc_path).read)
+        )
+      rescue JSON::ParserError => exception
+        translate_parse_error(exception, user_figrc_path)
+      end
+
+      return
+    end
+
+    def self.handle_repository_configuration(
+      configuration, repository_url, login, fig_home
+    )
+      return if repository_url.nil?
+
+      figrc_url = "#{repository_url}/#{REPOSITORY_CONFIGURATION}"
+      repo_figrc_path =
+        File.expand_path(File.join(fig_home, REPOSITORY_CONFIGURATION))
+
+      os = OS.new(login)
+
+      repo_config_exists = nil
+      begin
+        os.download( figrc_url, repo_figrc_path )
+        repo_config_exists = true
+      rescue NotFoundError => e
+        repo_config_exists = false
+      end
+
+      return configuration if not repo_config_exists
+
+      begin
+        configuration.push_dataset(
+          JSON.parse(File.open(repo_figrc_path).read)
+        )
+      rescue JSON::ParserError => exception
+        translate_parse_error(exception, figrc_url)
+      end
+
+      return
+    end
+
+    def self.translate_parse_error(json_parse_error, config_file_path)
+      message = json_parse_error.message
+      message.chomp!
+
+      # JSON::ParserError tends to include final newline inside of single
+      # quotes, which makes error messages ugly.
+      message.sub!(/ \n+ ' \z /xm, %q<'>)
+
+      # Also, there's a useless source code line number in the message.
+      message.sub!(/ \A \d+ : \s+ /xm, %q<>)
+
+      raise ConfigFileError.new(
+        "Parse issue with #{config_file_path}: #{message}",
+        config_file_path
+      )
+    end
+  end
+end

data/lib/fig/grammar.treetop

@@ -107,7 +107,7 @@ grammar Fig
   end
 
   rule descriptor
-    ((package:package_name ("/" version:version_name)? (":" config:config_name)? ws) / 
+    ((package:package_name ("/" version:version_name)? (":" config:config_name)? ws) /
     (":" config:config_name ws)) {
       def get_version
         elements.each do |element|

data/lib/fig/log4rconfigerror.rb

@@ -0,0 +1,14 @@
+require 'fig/userinputerror'
+
+module Fig
+  class Log4rConfigError < UserInputError
+    def initialize(config_file, original_exception)
+      super(
+        %Q<Problem with #{config_file}: #{original_exception.message}>
+      )
+
+      @config_file = config_file
+      @original_exception = original_exception
+    end
+  end
+end

data/lib/fig/logging.rb

@@ -0,0 +1,131 @@
+require 'log4r'
+require 'log4r/configurator'
+require 'log4r/yamlconfigurator'
+
+require 'fig/configfileerror'
+require 'fig/log4rconfigerror'
+
+module Fig; end
+
+module Fig::Logging
+  if not Log4r::Logger['initial']
+    @@logger = Log4r::Logger.new('initial')
+  end
+
+  STRING_TO_LEVEL_MAPPING = {
+    'off'   => Log4r::OFF,
+    'fatal' => Log4r::FATAL,
+    'error' => Log4r::ERROR,
+    'warn'  => Log4r::WARN,
+    'info'  => Log4r::INFO,
+    'debug' => Log4r::DEBUG,
+    'all'   => Log4r::ALL
+  }
+
+  def self.initialize_pre_configuration(log_level = nil)
+    log_level ||= 'info'
+
+    assign_log_level(@@logger, log_level)
+    setup_default_outputter(@@logger)
+  end
+
+  def self.initialize_post_configuration(
+    config_file = nil,
+    log_level = nil,
+    suppress_default_configuration = false
+  )
+    if config_file
+      begin
+        case config_file
+          when / [.] xml \z /x
+            Log4r::Configurator.load_xml_file(config_file)
+          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
+        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)
+      end
+    end
+
+    if Log4r::Logger['fig'].nil?
+      @@logger = Log4r::Logger.new('fig')
+    else
+      @@logger = Log4r::Logger['fig']
+    end
+
+    if not config_file and not suppress_default_configuration
+      assign_log_level(@@logger, 'info')
+      setup_default_outputter(@@logger)
+    end
+
+    assign_log_level(@@logger, log_level)
+
+    return
+  end
+
+  def self.fatal(data = nil, propagated = nil)
+    @@logger.fatal data, propagated
+  end
+
+  def self.fatal?()
+    return @@logger.fatal?
+  end
+
+  def self.error(data = nil, propagated = nil)
+    @@logger.error data, propagated
+  end
+
+  def self.error?()
+    return @@logger.error?
+  end
+
+  def self.warn(data = nil, propagated = nil)
+    @@logger.warn data, propagated
+  end
+
+  def self.warn?()
+    return @@logger.warn?
+  end
+
+  def self.info(data = nil, propagated = nil)
+    @@logger.info data, propagated
+  end
+
+  def self.info?()
+    return @@logger.info?
+  end
+
+  def self.debug(data = nil, propagated = nil)
+    @@logger.debug data, propagated
+  end
+
+  def self.debug?()
+    return @@logger.debug?
+  end
+
+  private
+
+  def self.assign_log_level(logger, string_level)
+    return if string_level.nil?
+
+    level = STRING_TO_LEVEL_MAPPING[string_level.downcase]
+    logger.level = level
+    logger.outputters.each { | outputter | outputter.level = level }
+
+    return
+  end
+
+  def self.setup_default_outputter(logger)
+    outputter = Log4r::Outputter.stdout
+    logger.add outputter
+    outputter.formatter = Log4r::PatternFormatter.new :pattern => '%M'
+
+    return
+  end
+end

data/lib/fig/networkerror.rb

@@ -0,0 +1,7 @@
+require 'fig/userinputerror'
+
+module Fig
+  # A problem with file transfer over the network.
+  class NetworkError < UserInputError
+  end
+end

data/lib/fig/notfounderror.rb

@@ -0,0 +1,4 @@
+module Fig
+  class NotFoundError < StandardError
+  end
+end

data/lib/fig/options.rb

@@ -6,101 +6,238 @@ module Fig
     # todo should use treetop for these:
     package_name = descriptor =~ /^([^:\/]+)/ ? $1 : nil
     config_name = descriptor =~ /:([^:\/]+)/ ? $1 : nil
-    version_name = descriptor =~ /\/([^:\/]+)/ ? $1 : nil  
+    version_name = descriptor =~ /\/([^:\/]+)/ ? $1 : nil
     return package_name, config_name, version_name
   end
 
+  USAGE = <<EOF
+
+Usage: fig [--debug] [--update] [--config <config>] [--get <var> | --list | <package> | -- <command>]
+
+Relevant env vars: FIG_REMOTE_URL (required), FIG_HOME (path to local repository cache, defaults
+to $HOME/.fighome).
+
+EOF
+
+  LOG_LEVELS = %w[ off fatal error warn info debug all ]
+  LOG_ALIASES = { 'warning' => 'warn' }
+
+  # Returns hash of option values, the remainders of argv, and an exit code if
+  # full program processing occured in this method, otherwise nil.
   def parse_options(argv)
     options = {}
 
     parser = OptionParser.new do |opts|
-      opts.banner = "Usage: fig [--debug] [--update] [--config <config>] [--get <var> | --list | <package> | - <command>]"
-
+      opts.banner = USAGE
       opts.on('-?', '-h','--help','display this help text') do
-        puts opts
-	exit 1
-      end 
+        puts opts.help
+        puts "\n    --  end of fig options; everything following is a command to run in the fig environment.\n\n"
+        return nil, nil, 0
+      end
 
-      options[:debug] = false
-      opts.on('-d', '--debug', 'print debug info') { options[:debug] = true }
+      opts.on('-v', '--version', 'Print fig version') do
+        line = nil
 
-      options[:update] = false
-      opts.on('-u', '--update', 'check remote repository for updates') { options[:update] = true; options[:retrieve] = true }
+        begin
+          File.open(
+            "#{File.expand_path(File.dirname(__FILE__) + '/../../VERSION')}"
+          ) do |file|
+            line = file.gets
+          end
+        rescue
+          $stderr.puts 'Could not retrieve version number. Something has mucked with your gem install.'
+          return nil, nil, 1
+        end
 
-      options[:update_if_missing] = false
-      opts.on('-m', '--update-if-missing', 'check for updates only if package is missing locally') { options[:update_if_missing] = true; options[:retrieve] = true }
+        if line !~ /\d+\.\d+\.\d+/
+          $stderr.puts %Q<"#{line}" does not look like a version number. Something has mucked with your gem install.>
+          return nil, nil, 1
+        end
 
-      options[:config] = "default"
-      opts.on('-c', '--config CFG', 'name of configuration to apply') { |config| options[:config] = config }
+        puts File.basename($0) + ' v' + line
 
-      options[:echo] = nil
-      opts.on('-g', '--get VAR', 'print value of environment variable') { |echo| options[:echo] = echo }
+        return nil, nil, 0
+      end
 
-      options[:publish] = nil
-      opts.on('--publish PKG', 'install package in local and remote repositories') { |publish| options[:publish] = publish }
+      options[:modifiers] = []
+      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] << Path.new(var, val)
+      end
 
-      options[:publish_local] = nil
-      opts.on('--publish-local PKG', 'install package in local repositorie only') { |publish_local| options[:publish_local] = publish_local }
+      options[:archives] = []
+      opts.on(
+        '--archive FULLPATH',
+        'include FULLPATH archive in package (when using --publish)'
+      ) do |path|
+        options[:archives] << Archive.new(path)
+      end
 
-      options[:force] = nil
-      opts.on('--force', 'force overwriting of an existing remote package version') { |force| options[:force] = force }
+      options[:cleans] = []
+      opts.on('--clean PKG', 'remove package from $FIG_HOME') do |descriptor|
+        options[:cleans] << descriptor
+      end
 
-      options[:resources] =[]
-      opts.on('--resource PATH', 'resource to include in package (when using --publish)') do |path| 
-        options[:resources] << Resource.new(path) 
+      options[:config] = 'default'
+      opts.on(
+        '-c',
+        '--config CFG',
+        %q<apply configuration CFG, default is 'default'>
+      ) do |config|
+        options[:config] = config
       end
 
-      options[:archives] =[]
-      opts.on('--archive PATH', 'archive to include in package (when using --publish)') do |path| 
-        options[:archives] << Archive.new(path)
+      options[:debug] = false
+      opts.on('-d', '--debug', 'print debug info') do
+        options[:debug] = true
       end
 
-      options[:login] = false
-      opts.on('-l', '--login', 'login into the FTP server as a non-anonymous user') { options[:login] = true }
+      options[:input] = nil
+      opts.on(
+        '--file FILE',
+        %q<read fig file FILE. Use '-' for stdin. See also --no-file>
+      ) do |path|
+        options[:input] = path
+      end
+
+      options[:force] = nil
+      opts.on(
+        '--force',
+        'force-overwrite existing version of a package to the remote repo'
+      ) do |force|
+        options[:force] = force
+      end
+
+      options[:echo] = nil
+      opts.on(
+        '-g',
+        '--get VAR',
+        'print value of environment variable VAR'
+      ) do |echo|
+        options[:echo] = echo
+      end
+
+      opts.on(
+        '-i',
+        '--include PKG',
+        'include PKG (with any variable prepends) in environment'
+      ) do |descriptor|
+        package_name, config_name, version_name = parse_descriptor(descriptor)
+        options[:modifiers] << Include.new(package_name, config_name, version_name, {})
+      end
 
       options[:list] = false
-      opts.on('--list', 'list packages in local repository') { options[:list] = true }
+      opts.on('--list', 'list packages in $FIG_HOME') do
+        options[:list] = true
+      end
+
+      options[:list_configs] = []
+      opts.on(
+        '--list-configs PKG', 'list configurations in package'
+      ) do |descriptor|
+        options[:list_configs] << descriptor
+      end
 
       options[:list_remote] = false
-      opts.on('--list-remote', 'list packages in remote repository') { options[:list_remote] = true }
+      opts.on('--list-remote', 'list packages in remote repo') do
+        options[:list_remote] = true
+      end
 
-      options[:list_configs] = []
-      opts.on('--list-configs PKG', 'list configurations in package') { |descriptor| options[:list_configs] << descriptor }
+      options[:login] = false
+      opts.on(
+        '-l', '--login', 'login to remote repo as a non-anonymous user'
+      ) do
+        options[:login] = true
+      end
 
-      options[:cleans] = []
-      opts.on('--clean PKG', 'remove  package from local repository') { |descriptor| options[:cleans] <<  descriptor }
+      opts.on(
+        '--no-file', 'ignore package.fig file in current directory'
+      ) do |path|
+        options[:input] = :none
+      end
 
-      options[:modifiers] = []
+      options[:publish] = nil
+      opts.on(
+        '--publish PKG', 'install PKG in $FIG_HOME and in remote repo'
+      ) do |publish|
+        options[:publish] = publish
+      end
 
-      opts.on('-i', '--include PKG', 'include package in environment') do |descriptor| 
-        package_name, config_name, version_name = parse_descriptor(descriptor)
-        options[:modifiers] << Include.new(package_name, config_name, version_name, {}) 
+      options[:publish_local] = nil
+      opts.on(
+        '--publish-local PKG', 'install package only in $FIG_HOME'
+      ) do |publish_local|
+        options[:publish_local] = publish_local
       end
 
-#      opts.on('-o', '--override PKG', 'override version of included package') do |descriptor| 
-#        package_name, config_name, version_name = parse_descriptor(descriptor)
-#        options[:modifiers] << Include.new(package_name, config_name, version_name, {}) 
-#      end
+      options[:resources] =[]
+      opts.on(
+        '--resource FULLPATH',
+        'include FULLPATH resource in package (when using --publish)'
+      ) do |path|
+        options[:resources] << Resource.new(path)
+      end
 
-      opts.on('-s', '--set VAR=VAL', 'set environment variable') do |var_val| 
+      opts.on(
+        '-s', '--set VAR=VAL', 'set environment variable VAR to VAL'
+      ) do |var_val|
         var, val = var_val.split('=')
-        options[:modifiers] << Set.new(var, val) 
+        options[:modifiers] << Set.new(var, val)
       end
 
-      opts.on('-p', '--append VAR=VAL', 'append environment variable') do |var_val| 
-        var, val = var_val.split('=')
-        options[:modifiers] << Path.new(var, val)
+      options[:update] = false
+      opts.on(
+        '-u',
+        '--update',
+        'check remote repo for updates and download to $FIG_HOME as necessary'
+      ) do
+        options[:update] = true; options[:retrieve] = true
       end
 
-      options[:input] = nil
-      opts.on('--file FILE', 'fig file to read (use - for stdin)') { |path| options[:input] = path }
-      opts.on('--no-file', 'ignore package.fig file in current directory') { |path| options[:input] = :none }
+      options[:update_if_missing] = false
+      opts.on(
+        '-m',
+        '--update-if-missing',
+        'check remote repo for updates only if package missing from $FIG_HOME'
+      ) do
+        options[:update_if_missing] = true; options[:retrieve] = true
+      end
+
+      opts.on(
+        '--figrc PATH', 'add PATH to configuration used for Fig'
+      ) do |path|
+        options[:figrc] = path
+      end
+
+      opts.on('--no-figrc', 'ignore ~/.figrc') { options[:no_figrc] = true }
+
+      opts.on(
+        '--log-config PATH', 'use PATH file as configuration for Log4r'
+      ) do |path|
+        options[:log_config] = path
+      end
+
+      level_list = LOG_LEVELS.join(', ')
+      opts.on(
+        '--log-level LEVEL',
+        LOG_LEVELS,
+        LOG_ALIASES,
+        'set logging level to LEVEL',
+        "  (#{level_list})"
+      ) do |log_level|
+        options[:log_level] = log_level
+      end
 
-      options[:home] = ENV['FIG_HOME'] || File.expand_path("~/.fighome")
+      options[:home] = ENV['FIG_HOME'] || File.expand_path('~/.fighome')
     end
 
+    # Need to catch the exception thrown from parser and retranslate into a fig exception
     parser.parse!(argv)
 
-    return options, argv
+    return options, argv, nil
   end
 end