fig18 0.1.39 → 0.1.40

data/lib/fig/applicationconfiguration.rb

@@ -0,0 +1,52 @@
+
+module Fig
+  class ApplicationConfiguration
+    def initialize(remote_repository_url)
+      @data = []
+      @remote_repository_url = remote_repository_url
+      clear_cached_data
+    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
+
+    def [](key)
+      @data.each do |dataset|
+        if dataset.has_key?(key)
+          return dataset[key]
+        end
+      end
+      return nil
+    end
+
+    def push_dataset(dataset)
+      @data.push(dataset)
+    end
+
+    def unshift_dataset(dataset)
+      @data.unshift(dataset)
+    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
+    end
+  end
+end

data/lib/fig/backtrace.rb

@@ -5,7 +5,7 @@ class Backtrace
     @parent = parent
     @package_name = package_name
     @version_name = version_name
-    @config_name = config_name || "default"
+    @config_name = config_name || 'default'
     @overrides = {}
   end
 
@@ -13,15 +13,15 @@ class Backtrace
     if @parent
       @parent.collect(stack)
     end
-    elem = ""
+    elem = ''
     if @package_name
       elem = @package_name
     end
     if @version_name
-      elem += "/" + @version_name
+      elem += '/' + @version_name
     end
     if @config_name
-      elem += ":" + @config_name
+      elem += ':' + @config_name
     end
     stack << elem
   end
@@ -41,8 +41,8 @@ class Backtrace
     collect(stack)
     i=0
     for elem in stack
-      indent=""
-      i.times { indent += "  " }
+      indent=''
+      i.times { indent += '  ' }
       out.puts indent+elem
       i += 1
     end

data/lib/fig/configfileerror.rb

@@ -0,0 +1,15 @@
+require 'fig/userinputerror'
+
+module Fig
+  # Could not determine some kind of information from a configuration file,
+  # whether .figrc, log4r, package.fig, etc.
+  class ConfigFileError < UserInputError
+    def initialize(message, file)
+      super(message)
+
+      @file = file
+
+      return
+    end
+  end
+end

data/lib/fig/environment.rb

@@ -1,11 +1,14 @@
+require 'stringio'
+
 require 'fig/backtrace'
+require 'fig/logging'
+require 'fig/repositoryerror'
 
 module Fig
-
-  # This class manages the program's state, including the value of all environment 
-  # variables, and which packages have already been applied
+  # This class manages the program's state, including the value of all
+  # environment variables, and which packages have already been applied.
   class Environment
-    DEFAULT_VERSION_NAME = "current"
+    DEFAULT_VERSION_NAME = 'current'
 
     def initialize(os, repository, variables, retriever)
       @os = os
@@ -22,8 +25,8 @@ module Fig
       @variables[name]
     end
 
-    # Indicates that the values from a particular envrionment variable path should
-    # be copied to a local directory 
+    # Indicates that the values from a particular envrionment variable path
+
     def add_retrieve(name, path)
       @retrieve_vars[name] = path
     end
@@ -31,8 +34,8 @@ module Fig
     def register_package(package)
       name = package.package_name
       if @packages[name]
-        $stderr.puts "Package already exists with name: #{name}"
-        exit 10
+        Fig::Logging.fatal %Q<There is already a package with the name "#{name}".>
+        raise RepositoryError.new
       end
       @packages[name] = package
     end
@@ -41,7 +44,7 @@ module Fig
       if (@applied_configs[package.package_name] ||= []).member?(config_name)
         return
       end
-      new_backtrace = backtrace #Backtrace.new(backtrace, package.package_name, package.version_name, config_name)
+      new_backtrace = backtrace
 
       config = package[config_name]
       config.statements.each { |stmt| apply_config_statement(package, stmt, new_backtrace) }
@@ -57,11 +60,11 @@ module Fig
     def execute_config(base_package, package_name, config_name, version_name, args)
       package = lookup_package(package_name || base_package.package_name, version_name, Backtrace.new(nil, package_name, version_name, config_name))
       result = nil
-      commands = package[config_name || "default"].commands
+      commands = package[config_name || 'default'].commands
       with_environment do
-        # todo nil check
+        # TODO nil check
         commands.each do |command|
-          result = yield expand_arg("#{command.command} #{args.join(' ')}").gsub("@",package.directory).split(" ")
+          result = yield expand_arg("#{command.command} #{args.join(' ')}").gsub('@',package.directory).split(' ')
         end
       end
       result
@@ -83,7 +86,7 @@ module Fig
     end
 
     def include_config(base_package, package_name, config_name, version_name, overrides, backtrace)
-      # Check to see if this include has been overridden
+      # Check to see if this include has been overridden.
       if backtrace
         override = backtrace.get_override(package_name || base_package.package_name)
         if override
@@ -95,7 +98,7 @@ module Fig
         new_backtrace.add_override(override.package_name, override.version_name)
       end
       package = lookup_package(package_name || base_package.package_name, version_name, new_backtrace)
-      apply_config(package, config_name || "default", new_backtrace)
+      apply_config(package, config_name || 'default', new_backtrace)
     end
 
     def direct_retrieve(package_name, source_path, target_path)
@@ -104,7 +107,7 @@ module Fig
       FileUtils.cp_r(File.join(package.directory, source_path, '.'), target_path)
     end
 
-    private 
+    private
 
     def set_variable(base_package, name, value)
       @variables[name] = expand_value(base_package, name, value)
@@ -146,10 +149,14 @@ module Fig
         package.backtrace = backtrace
         @packages[package_name] = package
       elsif version_name && version_name != package.version_name
-        $stderr.puts "Version mismatch: #{package_name}" 
-        backtrace.dump($stderr) if backtrace
-        package.backtrace.dump($stderr) if package.backtrace
-        exit 10
+        string_handle = StringIO.new
+        backtrace.dump(string_handle) if backtrace
+        package.backtrace.dump(string_handle) if package.backtrace
+        stacktrace = string_handle.to_s
+        Fig::Logging.fatal                      \
+            "Version mismatch: #{package_name}" \
+          + stacktrace.empty? ? '' : "\n#{stacktrace}"
+        raise RepositoryError.new
       end
       package
     end
@@ -159,18 +166,31 @@ module Fig
       return value unless base_package && base_package.package_name
       file = value.gsub(/\@/, base_package.directory)
       if @retrieve_vars.member?(name)
-        # A '//' in the source file's path tells us to preserve path information
-        # after the '//' when doing a retrieve.
+        # A '//' in the source file's path tells us to preserve path
+        # information after the '//' when doing a retrieve.
         if file.split('//').size > 1
           preserved_path = file.split('//').last
-          target = File.join(@retrieve_vars[name].gsub(/\[package\]/, base_package.package_name), preserved_path)
+          target = File.join(
+            @retrieve_vars[name].gsub(
+              /\[package\]/,
+              base_package.package_name
+            ),
+            preserved_path
+          )
         else
-          target = File.join(@retrieve_vars[name].gsub(/\[package\]/, base_package.package_name))
+          target = File.join(
+            @retrieve_vars[name].gsub(
+              /\[package\]/,
+              base_package.package_name
+            )
+          )
           if not File.directory?(file)
             target = File.join(target, File.basename(file))
           end
         end
-        @retriever.with_config(base_package.package_name, base_package.version_name) do
+        @retriever.with_package_config(
+          base_package.package_name, base_package.version_name
+        ) do
           @retriever.retrieve(file, target)
         end
         file = target
@@ -182,8 +202,8 @@ module Fig
       arg.gsub(/\@([a-zA-Z0-9\-\.]+)/) do |match|
         package = @packages[$1]
         if package.nil?
-          $stderr.puts "Package not found: #{$1}"
-          exit 10
+          Fig::Logging.fatal "Package not found: #{$1}"
+          raise RepositoryError.new
         end
         package.directory
       end

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