fig 1.1.0 → 1.2.0

data/lib/fig/grammar/v2.treetop

@@ -0,0 +1,65 @@
+# Treetop (http://treetop.rubyforge.org/) grammar for package definitions in v2
+# format.
+
+require 'treetop'
+
+require 'fig/grammar/base'
+require 'fig/grammar/v1_base'
+require 'fig/grammar/version'
+
+module Fig
+  module Grammar
+    grammar V2
+      include Fig::Grammar::Base
+      include Fig::Grammar::Version
+      include Fig::Grammar::V1Base
+
+      # It would nice to be able to put this into Fig::Grammar::V1Base, but it
+      # looks like the root has to be declared in the concrete grammar.
+      rule package
+        optional_ws_or_comment
+        grammar_version:grammar_version?
+        statements:(package_statement_with_ws*)
+        optional_ws_or_comment
+        {
+          def to_package(unparsed_package, build_state)
+            return build_state.new_package_statement(
+              unparsed_package, grammar_version, statements
+            )
+          end
+        }
+      end
+
+      rule config_statement
+        override / include / include_file / command / path / set
+      end
+
+      rule include_file
+        statement_start:'include-file'
+        ws_or_comment+
+        path:file_path
+        config:(':' config_name:config_name)?
+        {
+          def to_config_statement(build_state)
+            config_name = nil
+            if config.respond_to? :config_name
+              config_name = config.config_name
+            end
+
+            return build_state.new_include_file_statement(
+              statement_start, path, config_name
+            )
+          end
+        }
+      end
+
+      rule file_path
+        # This is like quoted_or_bare_string, but disallows unquoted colons so
+        # that we can differentiate config names.
+        '"' ( [^"\\] / '\\' . )* '"' /
+        "'" ( [^'\\] / '\\' . )* "'" /
+        [^\s#:]+
+      end
+    end
+  end
+end

data/lib/fig/grammar_monkey_patches.rb

@@ -4,6 +4,7 @@
 
 require 'fig/grammar/v0'
 require 'fig/grammar/v1'
+require 'fig/grammar/v2'
 
 module Fig; end
 module Fig::Grammar; end
@@ -19,3 +20,9 @@ class Fig::Grammar::V1Parser
     return 1
   end
 end
+
+class Fig::Grammar::V2Parser
+  def version()
+    return 2
+  end
+end

data/lib/fig/no_such_package_config_error.rb

@@ -5,11 +5,13 @@ module Fig
   # User specified a configuration for a Package that does not exist.
   class NoSuchPackageConfigError < UserInputError
     attr_reader :descriptor
+    attr_reader :package
 
-    def initialize(message, descriptor)
+    def initialize(message, descriptor, package)
       super(message)
 
       @descriptor = descriptor
+      @package = package
     end
   end
 end

data/lib/fig/not_yet_parsed_package.rb

@@ -0,0 +1,27 @@
+module Fig; end
+
+# Metadata about a package definition file that hasn't been read yet.
+class Fig::NotYetParsedPackage
+  attr_accessor :descriptor
+  attr_accessor :working_directory
+  attr_accessor :base_directory
+  attr_accessor :source_description
+  attr_accessor :unparsed_text
+
+  def extended_source_description()
+    if source_description
+      if source_description.start_with? working_directory
+        return source_description
+      end
+
+      extended = source_description
+      if working_directory != '.'
+        extended << " (#{working_directory})"
+      end
+
+      return extended
+    end
+
+    return working_directory
+  end
+end

data/lib/fig/operating_system.rb

@@ -94,21 +94,21 @@ class Fig::OperatingSystem
 
   # Determine whether we need to update something.  Returns nil to indicate
   # "don't know".
-  def path_up_to_date?(url, path)
+  def path_up_to_date?(url, path, prompt_for_login)
     return false if ! File.exist? path
 
     protocol, uri = decode_protocol url
-    return protocol.path_up_to_date? uri, path
+    return protocol.path_up_to_date? uri, path, prompt_for_login
   end
 
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
-  def download(url, path)
+  def download(url, path, prompt_for_login)
     protocol, uri = decode_protocol url
 
     FileUtils.mkdir_p(File.dirname path)
 
-    return protocol.download uri, path
+    return protocol.download uri, path, prompt_for_login
   end
 
   # Returns the basename and full path to the download.
@@ -118,7 +118,7 @@ class Fig::OperatingSystem
     basename = CGI.unescape Fig::URL.parse(url).path.split('/').last
     path     = File.join(download_directory, basename)
 
-    download(url, path)
+    download(url, path, false)
 
     return basename, path
   end

data/lib/fig/package.rb

@@ -22,20 +22,38 @@ class Fig::Package
   attr_reader   :version
   attr_reader   :description
   attr_reader   :runtime_directory
+  attr_reader   :base_directory
   attr_reader   :statements
   attr_accessor :backtrace
   attr_accessor :unparsed_text
 
-  def initialize(name, version, description, runtime_directory, statements)
+  def initialize(
+    name,
+    version,
+    description,
+    runtime_directory,
+    base_directory,
+    statements,
+    synthetic
+  )
     @name                 = name
     @version              = version
     @description          = description
     @runtime_directory    = runtime_directory
+    @base_directory       = base_directory
     @statements           = statements
+    @synthetic            = synthetic
     @applied_config_names = []
     @backtrace            = nil
   end
 
+  # Was this package (supposedly) created from something other than usual
+  # parsing?  (Note that some tests artificially create "non-synthetic"
+  # instances.)
+  def synthetic?
+    return @synthetic
+  end
+
   # Is this the base package?
   def base?()
     return @base
@@ -64,7 +82,7 @@ class Fig::Package
 
     message = %Q<There is no "#{config_description}" config.>
 
-    raise Fig::NoSuchPackageConfigError.new(message, descriptor)
+    raise Fig::NoSuchPackageConfigError.new(message, descriptor, self)
   end
 
   def <=>(other)

data/lib/fig/package_definition_text_assembler.rb

@@ -2,6 +2,7 @@ require 'fig/statement/grammar_version'
 require 'fig/unparser'
 require 'fig/unparser/v0'
 require 'fig/unparser/v1'
+require 'fig/unparser/v2'
 
 module Fig; end
 
@@ -34,7 +35,7 @@ class Fig::PackageDefinitionTextAssembler
   def add_output(*statements)
     # Version gets determined by other statements, not by existing grammar.
     @output_statements <<
-      statements.reject { |s| s.is_a? Fig::Statement::GrammarVersion }
+      statements.flatten.reject { |s| s.is_a? Fig::Statement::GrammarVersion }
 
     @output_statements.flatten!
 

data/lib/fig/package_descriptor.rb

@@ -6,7 +6,8 @@ module Fig; end
 class Fig::PackageDescriptor
   include Comparable
 
-  COMPONENT_PATTERN = / \A (?! [.]{1,2} $) [a-zA-Z0-9_.-]+ \z /x
+  UNBRACKETED_COMPONENT_PATTERN = / (?! [.]{1,2} $) [a-zA-Z0-9_.-]+ /x
+  COMPONENT_PATTERN = / \A #{UNBRACKETED_COMPONENT_PATTERN} \z /x
 
   attr_reader :name, :version, :config, :original_string, :description
 
@@ -65,9 +66,9 @@ class Fig::PackageDescriptor
   #                                      most likely the result of invoking
   #                                      Fig::Statement.position_description().
   def initialize(name, version, config, options = {})
-    @name            = name
-    @version         = version
-    @config          = config
+    @name            = translate_component(name)
+    @version         = translate_component(version)
+    @config          = translate_component(config)
     @original_string = options[:original_string]
     @description     = options[:description]
 
@@ -94,6 +95,12 @@ class Fig::PackageDescriptor
 
   private
 
+  def translate_component(value)
+    return if value.nil?
+    return if value.empty?
+    return value
+  end
+
   def validate_component(
     value, name, presence_requirement_symbol, options
   )

data/lib/fig/parser.rb

@@ -3,6 +3,7 @@ require 'set'
 require 'fig/grammar/version_identification'
 require 'fig/grammar/v0'
 require 'fig/grammar/v1'
+require 'fig/grammar/v2'
 require 'fig/grammar_monkey_patches'
 require 'fig/logging'
 require 'fig/package_parse_error'
@@ -22,123 +23,108 @@ class Fig::Parser
     @check_include_versions = check_include_versions
   end
 
-  def parse_package(descriptor, directory, source_description, unparsed_text)
-    version = get_grammar_version(
-      descriptor, directory, source_description, unparsed_text
-    )
+  def parse_package(unparsed_package)
+    version = get_grammar_version unparsed_package
 
     if version == 0
-      return parse_v0(descriptor, directory, source_description, unparsed_text)
+      return parse_v0 unparsed_package
     end
 
-    return parse_v1(descriptor, directory, source_description, unparsed_text)
+    return parse_v1_or_later version, unparsed_package
   end
 
   private
 
-  def get_grammar_version(
-    descriptor, directory, source_description, unparsed_text
-  )
+  PARSER_CLASS = {
+    1 => Fig::Grammar::V1Parser,
+    2 => Fig::Grammar::V2Parser,
+  }
+
+  # TODO: Remove this once stablized.
+  @@seen_v2 = false
+
+  def get_grammar_version(unparsed_package)
     version_parser = Fig::Grammar::VersionIdentificationParser.new()
 
-    extended_description =
-      extend_source_description(directory, source_description)
+    extended_description = unparsed_package.extended_source_description
 
-    result = version_parser.parse(unparsed_text)
+    result = version_parser.parse(unparsed_package.unparsed_text)
     if result.nil?
-      raise_parse_error(version_parser, unparsed_text, extended_description)
+      raise_parse_error(
+        version_parser,
+        unparsed_package.unparsed_text,
+        extended_description
+      )
     end
 
     statement = result.get_grammar_version(
-      Fig::ParserPackageBuildState.new(nil, descriptor, extended_description)
+      Fig::ParserPackageBuildState.new(
+        nil, unparsed_package.descriptor, extended_description
+      )
     )
     return 0 if not statement
 
     version = statement.version
-    if version > 1
+    if version > 2
       raise Fig::PackageParseError.new(
         %Q<Don't know how to parse grammar version #{version}#{statement.position_string()}.>
       )
     end
+    if version == 2 && ! @@seen_v2
+      @@seen_v2 = true
+      Fig::Logging.info(
+        'Encountered v2 grammar.  This is experimental and subject to change without notice.'
+      )
+    end
 
     return version
   end
 
-  def parse_v0(descriptor, directory, source_description, unparsed_text)
-    stripped_text = unparsed_text.gsub(/#.*$/, '') # Blech.
+  def parse_v0(unparsed_package)
+    stripped_text = unparsed_package.unparsed_text.gsub(/#.*$/, '') # Blech.
 
     v0_parser = Fig::Grammar::V0Parser.new
 
-    return drive_treetop_parser(
-      v0_parser,
-      descriptor,
-      directory,
-      source_description,
-      unparsed_text,
-      stripped_text
-    )
+    return drive_treetop_parser(v0_parser, unparsed_package, stripped_text)
   end
 
-  def parse_v1(descriptor, directory, source_description, unparsed_text)
-    v1_parser = Fig::Grammar::V1Parser.new
+  def parse_v1_or_later(version, unparsed_package)
+    parser = PARSER_CLASS[version].new
 
     return drive_treetop_parser(
-      v1_parser,
-      descriptor,
-      directory,
-      source_description,
-      unparsed_text,
-      unparsed_text
+      parser,
+      unparsed_package,
+      unparsed_package.unparsed_text
     )
   end
 
   def drive_treetop_parser(
-    parser,
-    descriptor,
-    directory,
-    source_description,
-    unparsed_text, # Ugh. V0 strips comments via regex.
-    cleaned_text
+    parser, unparsed_package, cleaned_text # Ugh. V0 strips comments via regex.
   )
     # Extra space at the end because most of the rules in the grammar require
     # trailing whitespace.
     result = parser.parse(cleaned_text + ' ')
 
-    extended_description =
-      extend_source_description(directory, source_description)
+    extended_description = unparsed_package.extended_source_description
 
     if result.nil?
       raise_parse_error(parser, cleaned_text, extended_description)
     end
 
     package = result.to_package(
-      directory,
+      unparsed_package,
       Fig::ParserPackageBuildState.new(
-        parser.version, descriptor, extended_description
+        parser.version, unparsed_package.descriptor, extended_description
       )
     )
-    package.unparsed_text = unparsed_text
 
-    check_for_bad_urls(package, descriptor)
+    check_for_bad_urls(package, unparsed_package.descriptor)
     check_for_multiple_command_statements(package)
     check_for_missing_versions_on_include_statements(package)
 
     return package
   end
 
-  def extend_source_description(directory, original_description)
-    if original_description
-      extended = original_description
-      if directory != '.'
-        extended << " (#{directory})"
-      end
-
-      return extended
-    end
-
-    return directory
-  end
-
   def raise_parse_error(treetop_parser, text, extended_description)
     message = extended_description
 

data/lib/fig/parser_package_build_state.rb

@@ -6,6 +6,7 @@ require 'fig/statement/command'
 require 'fig/statement/configuration'
 require 'fig/statement/grammar_version'
 require 'fig/statement/include'
+require 'fig/statement/include_file'
 require 'fig/statement/override'
 require 'fig/statement/path'
 require 'fig/statement/resource'
@@ -43,7 +44,7 @@ class Fig::ParserPackageBuildState
     )
   end
 
-  def new_package_statement(directory, grammar_node, statement_nodes)
+  def new_package_statement(unparsed_package, grammar_node, statement_nodes)
     grammar_statement = nil
     if grammar_node && ! grammar_node.empty?
       grammar_statement = grammar_node.to_package_statement(self)
@@ -62,13 +63,18 @@ class Fig::ParserPackageBuildState
       statement_objects << node.to_package_statement(self)
     end
 
-    return Fig::Package.new(
+    package = Fig::Package.new(
       @descriptor.name,
       @descriptor.version,
       @descriptor.description,
-      directory,
-      statement_objects
+      unparsed_package.working_directory,
+      unparsed_package.base_directory,
+      statement_objects,
+      false,
     )
+    package.unparsed_text = unparsed_package.unparsed_text
+
+    return package
   end
 
   def new_grammar_version_statement(keyword_node, version_node)
@@ -143,10 +149,39 @@ class Fig::ParserPackageBuildState
       node_location(keyword_node),
       @source_description,
       include_descriptor,
+      nil,
       @descriptor
     )
   end
 
+  def new_include_file_statement(keyword_node, path_node, config_name_node)
+    path, config_name =
+      Fig::Statement::IncludeFile.validate_and_process_raw_path_and_config_name(
+        path_node.text_value,
+        config_name_node.nil? ? nil : config_name_node.text_value,
+      ) do
+        |description|
+
+        value_text = path_node.text_value
+        if ! config_name_node.nil?
+          value_text << ':'
+          value_text << config_name_node.text_value
+        end
+
+        raise Fig::PackageParseError.new(
+          %Q<Invalid include-file statement: "#{value_text}" #{description}#{node_location_description(path_node)}>
+        )
+      end
+
+    return Fig::Statement::IncludeFile.new(
+      node_location(keyword_node),
+      @source_description,
+      path,
+      config_name,
+      @descriptor,
+    )
+  end
+
   def new_override_statement(keyword_node, descriptor_node)
     override_descriptor =
       Fig::Statement::Override.parse_descriptor(