fig 0.1.73 → 0.1.75

data/lib/fig/runtime_environment.rb

@@ -9,6 +9,7 @@ require 'fig/statement/include'
 require 'fig/statement/path'
 require 'fig/statement/set'
 require 'fig/user_input_error'
+require 'fig/unparser/v0'
 
 module Fig; end
 
@@ -106,19 +107,25 @@ class Fig::RuntimeEnvironment
     return
   end
 
-  def execute_config(base_package, descriptor, args, &block)
+  def execute_config(base_package, base_config, descriptor, args, &block)
     config_name =
-      descriptor.config || find_config_name_in_package(descriptor.name)
-
-    name = descriptor.name || base_package.name
-    package = lookup_package(
-      name,
-      descriptor.version,
-      Fig::IncludeBacktrace.new(
-        nil,
-        Fig::PackageDescriptor.new(name, descriptor.version, config_name)
+      determine_config_to_executed(base_package, base_config, descriptor)
+
+    package = nil
+
+    if descriptor
+      name    = descriptor.name || base_package.name
+      package = lookup_package(
+        name,
+        descriptor.version,
+        Fig::IncludeBacktrace.new(
+          nil,
+          Fig::PackageDescriptor.new(name, descriptor.version, config_name)
+        )
       )
-    )
+    else
+      package = base_package
+    end
 
     command_statement = package[config_name].command_statement
     if command_statement
@@ -148,7 +155,9 @@ class Fig::RuntimeEnvironment
     when Fig::Statement::Command
       # Skip - has no effect on environment.
     else
-      raise "Unexpected statement in a config block: #{statement.unparse('')}"
+      unparser = Fig::Unparser::V0.new :emit_as_to_be_published
+      text = unparser.unparse([statement]).strip
+      raise "Unexpected statement in a config block: #{text}"
     end
 
     return
@@ -191,8 +200,10 @@ class Fig::RuntimeEnvironment
 
       statement = @retrieves[name]
       if statement.loaded_but_not_referenced?
+        unparser = Fig::Unparser::V0.new :emit_as_to_be_published
+        text = unparser.unparse([statement]).strip
         Fig::Logging.warn \
-          %Q<The #{name} variable was never referenced or didn't need expansion, so "#{statement.unparse('')}"#{statement.position_string} was ignored.>
+          %Q<The #{name} variable was never referenced or didn't need expansion, so "#{text}"#{statement.position_string} was ignored.>
       end
     end
   end
@@ -264,12 +275,29 @@ class Fig::RuntimeEnvironment
     return package
   end
 
-  def find_config_name_in_package(name)
+  def determine_config_to_executed(base_package, base_config, descriptor)
+    return base_config if base_config
+
+    if descriptor
+      return descriptor.config if descriptor.config
+
+      config_name = find_config_name_in_package_named(descriptor.name)
+      return config_name if config_name
+    end
+
+    return find_config_name_in_package(base_package)
+  end
+
+  def find_config_name_in_package_named(name)
     package = get_package(name)
     if not package
       return Fig::Package::DEFAULT_CONFIG
     end
 
+    return find_config_name_in_package(package)
+  end
+
+  def find_config_name_in_package(package)
     return package.primary_config_name || Fig::Package::DEFAULT_CONFIG
   end
 

data/lib/fig/statement.rb

@@ -1,3 +1,7 @@
+# coding: utf-8
+
+require 'set'
+
 module Fig; end
 
 # A statement within a package definition file (package.fig).
@@ -22,6 +26,121 @@ class Fig::Statement
     return description
   end
 
+  # Parameter will be modified.
+  #
+  # Takes a block that is invoked when there is an error.  Block receives a
+  # single parameter of an error message that is the end of a statement
+  # describing the problem, with no leading space character.  For example,
+  # given «'foo», the block will receive a message like 'has unbalanced single
+  # quotes.'.
+  #
+  # Returns whether parameter was single-quoted; if there was a parse error,
+  # then the return value will be nil (and the block will have been invoked).
+  def self.strip_quotes_and_process_escapes!(string, &error_block)
+    return false if string.length == 0
+
+    replaced_quotes = strip_single_quotes!(string, &error_block)
+    return true if replaced_quotes
+    return      if replaced_quotes.nil?
+
+    return process_escapes_and_strip_double_quotes!(string, &error_block)
+  end
+
+  private
+
+  def self.strip_single_quotes!(string)
+    return false if string[0..0] != %q<'> && string[-1..-1] != %q<'>
+
+    if string.length == 1 || string[0..0] != %q<'> || string[-1..-1] != %q<'>
+      yield 'has unbalanced single quotes.'
+      return
+    end
+
+    if string =~ %r< \A ' [^']* ' .* ' \z >xs
+      yield %q<isn't permitted because it has a single quote inside single quotes.>
+      return
+    end
+
+    string.sub!(%r< \A ' (.*) ' \z >xs, '\1')
+
+    return true
+  end
+
+  ALLOWED_ESCAPED_CHARACTERS = Set.new
+  ALLOWED_ESCAPED_CHARACTERS << '\\'
+  ALLOWED_ESCAPED_CHARACTERS << %q<'>
+  ALLOWED_ESCAPED_CHARACTERS << %q<">
+  ALLOWED_ESCAPED_CHARACTERS << '@' # Environment variable package replacement
+
+  def self.process_escapes_and_strip_double_quotes!(string)
+    if string[0..0] == %q<"> && (string.length == 1 || string[-1..-1] != %q<">)
+      yield 'has unbalanced double quotes.'
+      return
+    end
+
+    new_string = ''
+
+    characters = string.each_char
+    initial_character   = characters.next
+    last_character      = nil
+    had_starting_quote  = initial_character == %q<">
+    in_escape           = initial_character == '\\'
+    if ! had_starting_quote && ! in_escape
+      new_string << initial_character
+    end
+
+    last_was_escaped = nil
+    loop do
+      last_character = character = characters.next
+      if in_escape
+        if ! ALLOWED_ESCAPED_CHARACTERS.include? character
+          yield "contains a bad escape sequence (\\#{character})."
+          return
+        end
+
+        new_string << character
+        in_escape = false
+        last_was_escaped = true
+      elsif character == %q<">
+        # If we're at the end of the string, we'll get bounced out of the loop
+        # by a StopIteration exception.
+        characters.next
+        yield 'has an unescaped double quote in the middle.'
+        return
+      elsif character == %q<'>
+        yield 'has an unescaped single quote in the middle.'
+        return
+      elsif character == '\\'
+        in_escape = true
+      # TODO: need an
+      #   «elsif character == '@'»
+      # here to deal with package substitution in variable statements
+      else
+        new_string << character
+        last_was_escaped = false
+      end
+    end
+
+    if in_escape
+      yield 'ends in an incomplete escape sequence.'
+      return
+    elsif had_starting_quote
+      if last_was_escaped
+        yield 'has unbalanced double quotes (last quote was escaped).'
+        return
+      end
+    elsif ! last_was_escaped && ! had_starting_quote && last_character == %q<">
+      yield 'has unbalanced double quotes.'
+      return
+    end
+
+    string.replace(new_string)
+
+    return false
+  end
+
+  public
+
   # This mess of getting these as a single array necessary is due to
   # limitations of the "*" array splat operator in ruby v1.8.
   def initialize(line_column, source_description)
@@ -37,6 +156,14 @@ class Fig::Statement
     return
   end
 
+  def unparse_as_version(unparser)
+    raise NotImplementedError
+  end
+
+  def minimum_grammar_version_required()
+    raise NotImplementedError
+  end
+
   def urls()
     return []
   end
@@ -45,6 +172,10 @@ class Fig::Statement
     return false
   end
 
+  def is_environment_variable?()
+    return false
+  end
+
   # Returns a representation of the position of this statement, if the position
   # is known, empty string otherwise.  This is written with the idea that you
   # can do something like "puts %Q<Found a
@@ -56,3 +187,5 @@ class Fig::Statement
     )
   end
 end
+
+# vim: set fileencoding=utf8 :

data/lib/fig/statement/archive.rb

@@ -2,6 +2,7 @@ require 'fig/statement'
 require 'fig/statement/asset'
 
 module Fig; end
+class  Fig::Statement; end
 
 # Specifies an archive file (possibly via a URL) that is part of a package.
 #
@@ -11,17 +12,18 @@ class Fig::Statement::Archive < Fig::Statement
 
   attr_reader :url
 
-  def initialize(line_column, source_description, url)
+  def initialize(line_column, source_description, url, glob_if_not_url)
     super(line_column, source_description)
 
-    set_up_url(url)
+    @url             = url
+    @glob_if_not_url = glob_if_not_url
   end
 
   def asset_name()
     return standard_asset_name()
   end
 
-  def unparse(indent)
-    %Q<#{indent}archive "#{url}">
+  def unparse_as_version(unparser)
+    return unparser.archive(self)
   end
 end

data/lib/fig/statement/asset.rb

@@ -1,18 +1,22 @@
 require 'fig/parser'
+require 'fig/statement'
+require 'fig/url'
 
 module Fig; end
 class Fig::Statement; end
 
 # Some sort of file to be included in a package.
 module Fig::Statement::Asset
+  attr_reader :url
+
   def self.included(class_included_into)
     class_included_into.extend(ClassMethods)
 
     return
   end
 
-  def glob?()
-    return @glob
+  def glob_if_not_url?()
+    return @glob_if_not_url
   end
 
   def urls()
@@ -23,44 +27,36 @@ module Fig::Statement::Asset
     return true
   end
 
+  def requires_globbing?()
+    return glob_if_not_url? && ! Fig::URL.is_url?(url())
+  end
+
   def standard_asset_name()
     # Not so hot of an idea if the URL has query parameters in it, but not
     # going to fix this now.
     return url().split('/').last()
   end
 
-  private
+  def minimum_grammar_version_required()
+    return 1 if url =~ /\s/
 
-  def set_up_url(url)
-    # Damn you Ruby 1.8!!!!
-    if url[0..0] == '"'
-      @url = url[1..-2]
-      @glob = true
-    else
-      @url = url
-      @glob = false
-    end
+    # Can't have octothorpes anywhere in v0 due to comment stripping via regex.
+    return 1 if url =~ /#/
 
-    return
-  end
+    # If we shouldn't glob, but we've got glob characters...
+    return 1 if ! glob_if_not_url? && url =~ /[*?\[\]{}]/
 
-  module ClassMethods
-    def validate_url(url)
-      # Damn you Ruby 1.8!!!!
-      if  url[0..0] == '"' && url[-1..-1] != '"' ||
-          url[0..0] != '"' && url[-1..-1] == '"'
-        yield 'has unbalanced quotes.'
-        return
-      end
+    return 0
+  end
 
-      if url[0..0] == '"'
-        if url.length < 3
-          yield 'is empty'
-          return
-        end
+  private
 
-        url = url[1..-2]
-      end
+  module ClassMethods
+    # Modifies the parameter to deal with quoting, escaping.
+    def validate_and_process_escapes_in_url!(url, &block)
+      was_in_single_quotes =
+        Fig::Statement.strip_quotes_and_process_escapes!(url, &block)
+      return if was_in_single_quotes.nil?
 
       if url.include? '@'
         yield %q<contains an "@", which isn't permitted in order to allow for package substitution.>
@@ -72,10 +68,8 @@ module Fig::Statement::Asset
         return
       end
 
-      if url =~ / \s /x
-        # We may need to allow a space character in the future, but this will
-        # require a change to the grammar.
-        yield %q<contains whitespace.>
+      if url =~ / ( ' ) /x
+        yield %Q<contains a "#{$1}", which isn't permitted to allow for future grammar expansion.>
         return
       end
 
@@ -84,7 +78,7 @@ module Fig::Statement::Asset
         yield 'is a keyword.'
       end
 
-      return
+      return ! was_in_single_quotes
     end
   end
 end

data/lib/fig/statement/command.rb

@@ -13,7 +13,11 @@ class Fig::Statement::Command < Fig::Statement
     @command = command
   end
 
-  def unparse(indent)
-    %Q<#{indent}command "#{@command}">
+  def unparse_as_version(unparser)
+    return unparser.command(self)
+  end
+
+  def minimum_grammar_version_required()
+    return 0
   end
 end

data/lib/fig/statement/configuration.rb

@@ -35,19 +35,11 @@ class Fig::Statement::Configuration < Fig::Statement
     end
   end
 
-  def unparse(indent)
-    unparse_statements(indent, "config #{@name}", @statements, 'end')
+  def unparse_as_version(unparser)
+    return unparser.configuration(self)
   end
 
-  private
-
-  def unparse_statements(indent, prefix, statements, suffix)
-    body =
-      @statements.map {|statement| statement.unparse(indent + '  ') }.join("\n")
-    if body.length > 0
-      body << "\n"
-    end
-
-    return "\n#{indent}#{prefix}\n#{body}#{indent}#{suffix}"
+  def minimum_grammar_version_required()
+    return 0
   end
 end

data/lib/fig/statement/grammar_version.rb

@@ -0,0 +1,22 @@
+require 'fig/statement'
+
+module Fig; end
+
+# A statement that declares the syntax that a package is to be serialized in.
+class Fig::Statement::GrammarVersion < Fig::Statement
+  attr_reader :version
+
+  def initialize(line_column, source_description, version)
+    super(line_column, source_description)
+
+    @version = version
+  end
+
+  def unparse_as_version(unparser)
+    return unparser.grammar_version(self)
+  end
+
+  def minimum_grammar_version_required()
+    return version
+  end
+end