fig 0.1.77 → 0.1.79

data/lib/fig/statement.rb

@@ -26,121 +26,6 @@ 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)
@@ -151,6 +36,12 @@ class Fig::Statement
     @source_description = source_description
   end
 
+  # A name for this kind of Statement, usually a keyword for this statement as
+  # it appears in package definition files.
+  def statement_type()
+    raise NotImplementedError
+  end
+
   # Block will receive a Statement.
   def walk_statements(&block)
     return
@@ -160,7 +51,15 @@ class Fig::Statement
     raise NotImplementedError
   end
 
-  def minimum_grammar_version_required()
+  # Returns a two element array containing the version and an explanation of
+  # why the version is necessary if the version is greater than 0.
+  def minimum_grammar_for_emitting_input()
+    raise NotImplementedError
+  end
+
+  # Returns a two element array containing the version and an explanation of
+  # why the version is necessary if the version is greater than 0.
+  def minimum_grammar_for_publishing()
     raise NotImplementedError
   end
 

data/lib/fig/statement/archive.rb

@@ -10,15 +10,17 @@ class  Fig::Statement; end
 class Fig::Statement::Archive < Fig::Statement
   include Fig::Statement::Asset
 
-  attr_reader :url
-
-  def initialize(line_column, source_description, url, glob_if_not_url)
+  def initialize(line_column, source_description, location, glob_if_not_url)
     super(line_column, source_description)
 
-    @url             = url
+    @location        = location
     @glob_if_not_url = glob_if_not_url
   end
 
+  def statement_type()
+    return 'archive'
+  end
+
   def asset_name()
     return standard_asset_name()
   end

data/lib/fig/statement/asset.rb

@@ -1,5 +1,8 @@
+require 'cgi'
+
 require 'fig/parser'
 require 'fig/statement'
+require 'fig/string_tokenizer'
 require 'fig/url'
 
 module Fig; end
@@ -7,7 +10,7 @@ class Fig::Statement; end
 
 # Some sort of file to be included in a package.
 module Fig::Statement::Asset
-  attr_reader :url
+  attr_reader :location
 
   def self.included(class_included_into)
     class_included_into.extend(ClassMethods)
@@ -20,7 +23,7 @@ module Fig::Statement::Asset
   end
 
   def urls()
-    return [ url() ]
+    return [location()]
   end
 
   def is_asset?()
@@ -28,57 +31,69 @@ module Fig::Statement::Asset
   end
 
   def requires_globbing?()
-    return glob_if_not_url? && ! Fig::URL.is_url?(url())
+    return glob_if_not_url? && ! Fig::URL.is_url?(location())
   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
+    # Not so hot of an idea if the location is a URL and has query parameters
+    # in it, but not going to fix this now.
+    basename = location().split('/').last
 
-  def minimum_grammar_version_required()
-    return 1 if url =~ /\s/
+    if Fig::URL.is_url? location
+      return CGI.unescape basename
+    end
 
-    # Can't have octothorpes anywhere in v0 due to comment stripping via regex.
-    return 1 if url =~ /#/
+    return basename
+  end
 
-    # If we shouldn't glob, but we've got glob characters...
-    return 1 if ! glob_if_not_url? && url =~ /[*?\[\]{}]/
+  def minimum_grammar_for_emitting_input()
+    return minimum_grammar_for_value location
+  end
 
-    return 0
+  def minimum_grammar_for_publishing()
+    return minimum_grammar_for_value asset_name
   end
 
   private
 
-  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.>
-        return
-      end
+  def minimum_grammar_for_value(value)
+    return [0] if value.nil?
 
-      if url =~ / ( ["<>|] ) /x
-        yield %Q<contains a "#{$1}", which isn't permitted because Windows doesn't allow it in file names.>
-        return
-      end
+    if value =~ /\s/
+      return [1, 'contains whitespace']
+    end
 
-      if url =~ / ( ' ) /x
-        yield %Q<contains a "#{$1}", which isn't permitted to allow for future grammar expansion.>
-        return
-      end
+    # Can't have octothorpes anywhere in v0 due to comment stripping via
+    # regex.
+    if value =~ /#/
+      return [1, 'contains a "#" character']
+    end
+
+    if ! glob_if_not_url? && value =~ / ( [*?\[\]{}] ) /x
+      return [
+        1, %Q<contains a glob character ("#{$1}") which should not be globbed>
+      ]
+    end
+
+    if value =~ / ( ["'<>|] ) /x
+      return [1, %Q<contains a "#{$1}" character>]
+    end
+
+    return [0]
+  end
+
+  module ClassMethods
+    def validate_and_process_escapes_in_location(location, &block)
+      tokenizer = Fig::StringTokenizer.new
+      tokenized_string = tokenizer.tokenize(location, &block)
+      return if ! tokenized_string
 
       # "config" is a reasonable asset name, so we let that pass.
-      if Fig::Parser.strict_keyword?(url)
+      if Fig::Parser.strict_keyword?(tokenized_string.to_expanded_string)
         yield 'is a keyword.'
       end
 
-      return ! was_in_single_quotes
+      return tokenized_string
     end
   end
 end

data/lib/fig/statement/command.rb

@@ -13,11 +13,15 @@ class Fig::Statement::Command < Fig::Statement
     @command = command
   end
 
+  def statement_type()
+    return 'command'
+  end
+
   def unparse_as_version(unparser)
     return unparser.command(self)
   end
 
-  def minimum_grammar_version_required()
-    return 0
+  def minimum_grammar_for_publishing()
+    return [0]
   end
 end

data/lib/fig/statement/configuration.rb

@@ -21,6 +21,10 @@ class Fig::Statement::Configuration < Fig::Statement
     @statements = [overrides, others].flatten
   end
 
+  def statement_type()
+    return 'config'
+  end
+
   def command_statement
     return statements.find do
       |statement| statement.is_a?(Fig::Statement::Command)
@@ -39,7 +43,11 @@ class Fig::Statement::Configuration < Fig::Statement
     return unparser.configuration(self)
   end
 
-  def minimum_grammar_version_required()
-    return 0
+  def minimum_grammar_for_emitting_input()
+    return [0]
+  end
+
+  def minimum_grammar_for_publishing()
+    return [0]
   end
 end

data/lib/fig/statement/environment_variable.rb

@@ -0,0 +1,35 @@
+module Fig; end
+class Fig::Statement; end
+
+# A statement that manipulates an environment variable.
+module Fig::Statement::EnvironmentVariable
+  attr_reader :name, :value
+
+  def minimum_grammar_for_emitting_input()
+    return minimum_grammar()
+  end
+
+  def minimum_grammar_for_publishing()
+    return minimum_grammar()
+  end
+
+  private
+
+  def minimum_grammar()
+    if value =~ /\s/
+      return [1, 'contains whitespace']
+    end
+
+    # Can't have octothorpes anywhere in v0 due to comment stripping via
+    # regex.
+    if value =~ /#/
+      return [1, 'contains a "#" character']
+    end
+
+    if value =~ / ( ["'] ) /x
+      return [1, %Q<contains a "#{$1}" character>]
+    end
+
+    return [0]
+  end
+end

data/lib/fig/statement/grammar_version.rb

@@ -12,11 +12,15 @@ class Fig::Statement::GrammarVersion < Fig::Statement
     @version = version
   end
 
+  def statement_type()
+    return 'grammar'
+  end
+
   def unparse_as_version(unparser)
     return unparser.grammar_version(self)
   end
 
-  def minimum_grammar_version_required()
-    return version
+  def minimum_grammar_for_publishing()
+    return [version]
   end
 end

data/lib/fig/statement/include.rb

@@ -23,6 +23,10 @@ class Fig::Statement::Include < Fig::Statement
     @containing_package_descriptor = containing_package_descriptor
   end
 
+  def statement_type()
+    return 'include'
+  end
+
   def package_name
     return @descriptor.name
   end
@@ -66,8 +70,8 @@ class Fig::Statement::Include < Fig::Statement
     return unparser.include(self)
   end
 
-  def minimum_grammar_version_required()
-    return 0
+  def minimum_grammar_for_publishing()
+    return [0]
   end
 
   private

data/lib/fig/statement/override.rb

@@ -33,11 +33,15 @@ class Fig::Statement::Override < Fig::Statement
     @version = version
   end
 
+  def statement_type()
+    return 'override'
+  end
+
   def unparse_as_version(unparser)
     return unparser.override(self)
   end
 
-  def minimum_grammar_version_required()
-    return 0
+  def minimum_grammar_for_publishing()
+    return [0]
   end
 end

data/lib/fig/statement/path.rb

@@ -1,10 +1,13 @@
 require 'fig/statement'
+require 'fig/statement/environment_variable'
 
 module Fig; end
 
 # A statement that specifies or modifies a path environment variable, e.g.
 # "append", "path", "add" (though those are all synonyms).
 class Fig::Statement::Path < Fig::Statement
+  include Fig::Statement::EnvironmentVariable
+
   # We block single-quotes right now in order to allow for using them for
   # quoting later.
   VALUE_REGEX          = %r< \A [^;:'"<>|\s]+ \z >x
@@ -27,8 +30,6 @@ class Fig::Statement::Path < Fig::Statement
     return [variable, value]
   end
 
-  attr_reader :name, :value
-
   def initialize(line_column, source_description, name, value)
     super(line_column, source_description)
 
@@ -36,6 +37,10 @@ class Fig::Statement::Path < Fig::Statement
     @value = value
   end
 
+  def statement_type()
+    return 'path'
+  end
+
   def is_environment_variable?()
     return true
   end
@@ -43,10 +48,4 @@ class Fig::Statement::Path < Fig::Statement
   def unparse_as_version(unparser)
     return unparser.path(self)
   end
-
-  def minimum_grammar_version_required()
-    # TODO: fix this once going through
-    # Statement.strip_quotes_and_process_escapes()
-    return 0
-  end
 end