fig 0.1.81 → 0.2.1

data/lib/fig/parser_package_build_state.rb

@@ -14,11 +14,10 @@ require 'fig/statement/set'
 
 module Fig; end
 
+# The state of a Package while it is being built by a Parser.
 class Fig::ParserPackageBuildState
-  attr_reader :descriptor
-  attr_reader :source_description
-
-  def initialize(descriptor, source_description)
+  def initialize(grammar_version, descriptor, source_description)
+    @grammar_version    = grammar_version
     @descriptor         = descriptor
     @source_description = source_description
   end
@@ -40,7 +39,7 @@ class Fig::ParserPackageBuildState
     location = node_location(node)
 
     return Fig::Statement.position_description(
-      location[0], location[1], source_description
+      location[0], location[1], @source_description
     )
   end
 
@@ -64,8 +63,8 @@ class Fig::ParserPackageBuildState
     end
 
     return Fig::Package.new(
-      descriptor.name,
-      descriptor.version,
+      @descriptor.name,
+      @descriptor.version,
       directory,
       statement_objects
     )
@@ -74,7 +73,7 @@ class Fig::ParserPackageBuildState
   def new_grammar_version_statement(keyword_node, version_node)
     return Fig::Statement::GrammarVersion.new(
       node_location(keyword_node),
-      source_description,
+      @source_description,
       version_node.text_value.to_i
     )
   end
@@ -94,26 +93,29 @@ class Fig::ParserPackageBuildState
     location = tokenized_location.to_expanded_string
     need_to_glob = ! tokenized_location.single_quoted?
     return statement_class.new(
-      node_location(keyword_node), source_description, location, need_to_glob
+      node_location(keyword_node), @source_description, location, need_to_glob
     )
   end
 
   def new_retrieve_statement(keyword_node, variable_name_node, path_node)
+    tokenized_path =
+      Fig::Statement::Retrieve.tokenize_path(path_node.text_value) do
+        |error_description|
+
+        raise_invalid_value_parse_error(
+          keyword_node, path_node, 'path', error_description
+        )
+      end
+
     return Fig::Statement::Retrieve.new(
       node_location(keyword_node),
-      source_description,
+      @source_description,
       variable_name_node.text_value,
-      path_node.text_value
+      tokenized_path
     )
   end
 
   def new_configuration_statement(keyword_node, name_node, statements)
-    if Fig::Parser.strict_keyword? name_node.text_value
-      raise_invalid_value_parse_error(
-        keyword_node, name_node, 'name', 'is a keyword.'
-      )
-    end
-
     statement_objects = statements.elements.map do
       |statement|
 
@@ -122,7 +124,7 @@ class Fig::ParserPackageBuildState
 
     return Fig::Statement::Configuration.new(
       node_location(keyword_node),
-      source_description,
+      @source_description,
       name_node.text_value,
       statement_objects
     )
@@ -138,9 +140,9 @@ class Fig::ParserPackageBuildState
 
     return Fig::Statement::Include.new(
       node_location(keyword_node),
-      source_description,
+      @source_description,
       include_descriptor,
-      descriptor
+      @descriptor
     )
   end
 
@@ -154,7 +156,7 @@ class Fig::ParserPackageBuildState
 
     return Fig::Statement::Override.new(
       node_location(keyword_node),
-      source_description,
+      @source_description,
       override_descriptor.name,
       override_descriptor.version
     )
@@ -163,25 +165,55 @@ class Fig::ParserPackageBuildState
   def new_environment_variable_statement(
     statement_class, keyword_node, value_node
   )
-    name, value = statement_class.parse_name_value(value_node.text_value) {
-      description = statement_class.const_get(:ARGUMENT_DESCRIPTION)
-      raise Fig::PackageParseError.new(
-        %Q<Invalid #{keyword_node.text_value} statement: "#{value_node.text_value}" #{description}#{node_location_description(value_node)}>
-      )
-    }
+    name = value = nil
+
+    if @grammar_version == 0
+      name, value = statement_class.parse_v0_name_value(value_node.text_value) {
+        |description|
+        raise_invalid_statement_parse_error(
+          keyword_node, value_node, description
+        )
+      }
+    else
+      name, value = statement_class.parse_name_value(value_node.text_value) {
+        |description|
+        raise_invalid_statement_parse_error(
+          keyword_node, value_node, description
+        )
+      }
+    end
+
     return statement_class.new(
-      node_location(keyword_node), source_description, name, value
+      node_location(keyword_node), @source_description, name, value
     )
   end
 
-  def new_command_statement(keyword_node, command_node)
+  def new_v0_command_statement(keyword_node, command_line_node)
+    tokenized_command =
+      Fig::Statement::Command.validate_and_process_escapes_in_argument(
+        command_line_node.text_value
+      ) {
+        |description|
+        raise_invalid_statement_parse_error(
+          keyword_node, command_line_node, description
+        )
+      }
+
+    return Fig::Statement::Command.new(
+      node_location(keyword_node), @source_description, [tokenized_command]
+    )
+  end
+
+  def new_v1_command_statement(keyword_node, command_line)
     return Fig::Statement::Command.new(
       node_location(keyword_node),
-      source_description,
-      command_node.value.text_value
+      @source_description,
+      tokenize_v1_command_line(keyword_node, command_line)
     )
   end
 
+  private
+
   def raise_invalid_value_parse_error(
     keyword_node, value_node, value_name, description
   )
@@ -189,4 +221,33 @@ class Fig::ParserPackageBuildState
       %Q<Invalid #{value_name} for #{keyword_node.text_value} statement: "#{value_node.text_value}" #{description}#{node_location_description(value_node)}>
     )
   end
+
+  def raise_invalid_statement_parse_error(keyword_node, value_node, description)
+    raise Fig::PackageParseError.new(
+      %Q<Invalid #{keyword_node.text_value} statement: "#{value_node.text_value}" #{description}#{node_location_description(value_node)}>
+    )
+  end
+
+  def tokenize_v1_command_line(keyword_node, command_line)
+    tokenized_command_line = []
+
+    command_line.each do
+      |argument_node|
+
+      unparsed = argument_node.text_value
+      next if unparsed.empty?
+
+      tokenized_command_line <<
+        Fig::Statement::Command.validate_and_process_escapes_in_argument(
+          unparsed
+        ) {
+          |description|
+          raise_invalid_statement_parse_error(
+            keyword_node, argument_node, description
+          )
+        }
+    end
+
+    return tokenized_command_line
+  end
 end

data/lib/fig/repository_package_publisher.rb

@@ -113,8 +113,8 @@ class Fig::RepositoryPackagePublisher
     add_unparsed_text()
 
     file_content, explanations = @text_assembler.assemble_package_definition()
-    if Fig::Logging.debug?
-      explanations.each {|explanation| Fig::Logging.debug explanation}
+    if Fig::Logging.info?
+      explanations.each {|explanation| Fig::Logging.info explanation}
     end
 
     begin

data/lib/fig/runtime_environment.rb

@@ -42,7 +42,7 @@ class Fig::RuntimeEnvironment
   # Indicates that the values from a particular environment variable path
   # should be copied to a local directory.
   def add_retrieve(retrieve_statement)
-    name = retrieve_statement.var
+    name = retrieve_statement.variable
     if @retrieves.has_key?(name)
       Fig::Logging.warn \
         %q<About to overwrite "#{name}" retrieve path of "#{@retrieves[name].path}" with "#{retrieve_statement.path}".>
@@ -99,7 +99,7 @@ class Fig::RuntimeEnvironment
     return
   end
 
-  def execute_command_line(base_package, base_config, descriptor, command_line)
+  def expand_command_line(base_package, base_config, descriptor, command_line)
     package, * =
       determine_package_for_execution(base_package, base_config, descriptor)
 
@@ -108,14 +108,12 @@ class Fig::RuntimeEnvironment
         |argument| expand_command_line_argument(argument, base_package)
       }
 
-    @variables.with_environment do
-      yield expanded_command_line
-    end
+    @variables.with_environment { yield expanded_command_line }
 
     return
   end
 
-  def execute_config(
+  def expand_command_statement_from_config(
     base_package, base_config, descriptor, extra_arguments, &block
   )
     package, config_name =
@@ -123,7 +121,7 @@ class Fig::RuntimeEnvironment
 
     command_statement = package[config_name].command_statement
     if command_statement
-      execute_command(command_statement, extra_arguments, package, &block)
+      expand_command(command_statement, extra_arguments, package, &block)
     else
       raise Fig::UserInputError.new(
         %Q<The "#{package.to_s}" package with the "#{config_name}" configuration does not contain a command.>
@@ -213,10 +211,12 @@ class Fig::RuntimeEnvironment
     @variables[name] = expanded_value
 
     if Fig::Logging.debug?
-      value = statement.value
+      tokenized_value = statement.tokenized_value
+      escaped_value = tokenized_value.to_escaped_string
       expanded_message =
-        expanded_value == value ? ''  \
-                                : %Q< (expanded from "#{value}")>
+        expanded_value == escaped_value \
+            ? ''  \
+            : %Q< (expanded from "#{escaped_value}")>
 
       Fig::Logging.debug(
         %Q<Set #{name} to "#{expanded_value}"#{expanded_message}.>
@@ -234,10 +234,12 @@ class Fig::RuntimeEnvironment
     @variables.prepend_variable(name, expanded_value)
 
     if Fig::Logging.debug?
-      value = statement.value
+      tokenized_value = statement.tokenized_value
+      escaped_value = tokenized_value.to_escaped_string
       expanded_message =
-        expanded_value == value ? ''  \
-                                : %Q< ("#{value}" expanded to "#{expanded_value}")>
+        expanded_value == escaped_value \
+          ? ''  \
+          : %Q< ("#{escaped_value}" expanded to "#{expanded_value}")>
 
       Fig::Logging.debug(
         %Q<Prepending to #{name} resulted in "#{@variables[name]}"#{expanded_message}.>
@@ -323,27 +325,29 @@ class Fig::RuntimeEnvironment
     return package.primary_config_name || Fig::Package::DEFAULT_CONFIG
   end
 
-  def execute_command(command_statement, extra_arguments, package)
-    @variables.with_environment do
-      command =
-        expand_command_line_argument(
-          [command_statement.command, extra_arguments].flatten.join(' '),
-          package
-        )
+  def expand_command(command_statement, extra_arguments, package)
+    expanded_command_line =
+      [ command_statement.command, extra_arguments ].flatten.map {
+        |argument| expand_command_line_argument(argument, package)
+      }
 
-      yield command
+    if command_statement.command.size == 1
+      expanded_command_line = [ expanded_command_line.join(' ') ]
     end
 
+    @variables.with_environment { yield expanded_command_line }
+
     return
   end
 
   def expand_variable_as_path_and_process_retrieves(
     statement, package, backtrace
   )
-    return statement.value unless package && package.name
+    tokenized_value = statement.tokenized_value
+    return tokenized_value.to_expanded_string { '@' } \
+      unless package && package.name
 
-    variable_value =
-      expand_at_signs_in_path(statement.value, package, backtrace)
+    variable_value = tokenized_value.to_expanded_string { package.directory }
 
     return variable_value if not @retrieves.member?(statement.name)
 
@@ -399,112 +403,42 @@ class Fig::RuntimeEnvironment
     return File.join(retrieve_path, File.basename(variable_value))
   end
 
-  def expand_at_signs_in_path(path, package, backtrace)
-    expanded_path =
-      replace_at_signs_with_package_references(path, package)
-    check_for_bad_escape(expanded_path, path, package, backtrace)
-
-    return collapse_backslashes_for_escaped_at_signs(expanded_path)
-  end
-
-  def replace_at_signs_with_package_references(argument, package)
-    return argument.gsub(
-      %r<
-        (?: ^ | \G)           # Zero-width anchor.
-        ( [^\\@]* )           # A bunch of not-slashes-or-at-signs
-        ( \\* )               # Any leading backslashes
-        \@                    # The package indicator
-      >x
-    ) do |match|
-      frontmatter, backslashes = $1, $2
-
-      replacement = backslashes.length % 2 == 1 ? '@' : package.directory
-
-      "#{frontmatter}#{backslashes}#{replacement}"
-    end
-  end
-
-  def expand_command_line_argument(argument, package)
-    package_substituted = expand_package_references(argument, package)
-    check_for_bad_escape(package_substituted, argument, package, nil)
-
-    return collapse_backslashes_for_escaped_at_signs(package_substituted)
-  end
-
-  def expand_package_references(argument, package)
-    return argument.gsub(
-      # TODO: Refactor package name regex into PackageDescriptor constant.
-      %r<
-        (?: ^ | \G)           # Zero-width anchor.
-        ( [^\\@]* )           # A bunch of not-slashes-or-at-signs
-        ( \\* )               # Any leading backslashes
-        \@                    # The package indicator
-        ( [a-zA-Z0-9_.-]* )   # Package name
-      >x
-    ) do |match|
-      frontmatter, backslashes, package_name = $1, $2, $3
-
-      expand_package_reference(
-        frontmatter, backslashes, package_name, package
-      )
-    end
-  end
-
-  def expand_package_reference(
-    frontmatter, backslashes, package_name, starting_package
-  )
-    if backslashes.length % 2 == 1
-      return "#{frontmatter}#{backslashes}@#{package_name}"
-    end
-
-    package = nil
-    if ! package_name.empty?
-      package = get_package(package_name)
-      if package.nil?
-        raise_repository_error(
-          %Q<Command-line referenced the "#{package_name}" package, which has not been referenced by any other package, so there's nothing to substitute with.>,
-          nil,
-          nil
-        )
+  def expand_command_line_argument(argument, starting_package)
+    return argument.to_expanded_string() do
+      |token|
+
+      package_name = token.raw_value
+      package = nil
+      if package_name.empty?
+        package = starting_package
+      else
+        package = get_package(package_name)
+        if package.nil?
+          raise_repository_error(
+            %Q<Command-line referenced the "#{package_name}" package, which has not been referenced by any other package, so there's nothing to substitute with.>,
+            nil,
+            nil
+          )
+        end
       end
-    else
-      package = starting_package
-    end
-
-    if package && package.directory
-      return "#{frontmatter}#{backslashes}#{package.directory}"
-    end
 
-    return "#{frontmatter}#{backslashes}@"
-  end
+      if package && package.directory
+        next package.directory
+      end
 
-  # The value is expected to have had any @ substitution already done, but
-  # collapsing of escapes not done yet.
-  def check_for_bad_escape(substituted, original, package, backtrace)
-    if substituted =~ %r<
-      (?: ^ | [^\\])  # Start of line or non backslash
-      (?: \\{2})*     # Even number of backslashes (including zero)
-      ( \\ [^\\@] )   # A bad escape
-    >x
-      raise_repository_error(
-        %Q<Unknown escape "#{$1}" in "#{original}">, backtrace, package
-      )
+      next '@'
     end
-
-    return
-  end
-
-  # After @ substitution, we need to get rid of the backslashes in front of
-  # any escaped @ signs.
-  def collapse_backslashes_for_escaped_at_signs(string)
-    return string.gsub(%r< \\ ([\\@]) >x, '\1')
   end
 
   def get_retrieve_path_with_substitution(variable_name, package)
     retrieve_statement = @retrieves[variable_name]
     retrieve_statement.referenced(true)
 
-    return retrieve_statement.path.gsub(/ \[package\] /x, package.name)
+    return retrieve_statement.tokenized_path.to_expanded_string() do
+      |token|
+
+      package.name
+    end
   end
 
   def raise_repository_error(message, backtrace, package)