fig 0.1.69 → 0.1.71

data/lib/fig/grammar.treetop

@@ -1,32 +1,11 @@
 # Treetop (http://treetop.rubyforge.org/) grammar for package definitions.
 
-require 'fig/package'
-require 'fig/package_descriptor'
-require 'fig/parser'
-require 'fig/statement/archive'
-require 'fig/statement/command'
-require 'fig/statement/configuration'
-require 'fig/statement/include'
-require 'fig/statement/override'
-require 'fig/statement/path'
-require 'fig/statement/resource'
-require 'fig/statement/retrieve'
-require 'fig/statement/set'
-
 module Fig
   grammar Fig
     rule package
       optional_ws statements:(package_statement*) optional_ws {
         def to_package(directory, build_state)
-          Package.new(
-            build_state.descriptor.name,
-            build_state.descriptor.version,
-            directory,
-            statements.elements.map do
-              |statement|
-              statement.to_package_statement(build_state)
-            end
-          )
+          return build_state.new_package_statement(directory, statements)
         end
       }
     end
@@ -35,13 +14,13 @@ module Fig
       archive / resource / retrieve / config
     end
 
+    # Note that these are being parsed like they allow globbing despite
+    # globbing not being performed.
     rule archive
       statement_start:"archive" ws resource_url {
         def to_package_statement(build_state)
-          Statement::Archive.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            resource_url.value.text_value
+          return build_state.new_asset_statement(
+            Statement::Archive, statement_start, resource_url
           )
         end
       }
@@ -50,10 +29,8 @@ module Fig
     rule resource
       statement_start:"resource" ws resource_url {
         def to_package_statement(build_state)
-          Statement::Resource.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            resource_url.value.text_value
+          return build_state.new_asset_statement(
+            Statement::Resource, statement_start, resource_url
           )
         end
       }
@@ -62,12 +39,7 @@ module Fig
     rule retrieve
       statement_start:"retrieve" ws var:environment_variable_name "->" path:retrieve_path ws {
         def to_package_statement(build_state)
-          Statement::Retrieve.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            var.text_value,
-            path.text_value
-          )
+          return build_state.new_retrieve_statement(statement_start, var, path)
         end
       }
     end
@@ -79,14 +51,8 @@ module Fig
     rule config
       statement_start:"config" ws config_name ws statements:config_statement* "end" ws {
         def to_package_statement(build_state)
-          Statement::Configuration.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            config_name.text_value,
-            statements.elements.map do
-              |statement|
-              statement.to_config_statement(build_state)
-            end
+          return build_state.new_configuration_statement(
+            statement_start, config_name, statements
           )
         end
       }
@@ -103,19 +69,8 @@ module Fig
     rule include
       statement_start:"include" ws descriptor_string ws {
         def to_config_statement(build_state)
-          include_descriptor =
-            Statement::Include.parse_descriptor(
-              descriptor_string.text_value.strip,
-              :source_description =>
-                build_state.node_location_description(descriptor_string),
-              :validation_context => ' for an include statement'
-            )
-
-          Statement::Include.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            include_descriptor,
-            build_state.descriptor
+          return build_state.new_include_statement(
+            statement_start, descriptor_string
           )
         end
       }
@@ -124,19 +79,8 @@ module Fig
     rule override
       statement_start:"override" ws descriptor_string ws {
         def to_config_statement(build_state)
-          descriptor =
-            Statement::Override.parse_descriptor(
-              descriptor_string.text_value.strip,
-              :source_description =>
-                build_state.node_location_description(descriptor_string),
-              :validation_context => ' for an override statement'
-            )
-
-          return Statement::Override.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            descriptor.name,
-            descriptor.version
+          return build_state.new_override_statement(
+            statement_start, descriptor_string
           )
         end
       }
@@ -169,11 +113,7 @@ module Fig
     rule command
       statement_start:"command" ws string {
         def to_config_statement(build_state)
-          Statement::Command.new(
-            build_state.node_location(statement_start),
-            build_state.source_description,
-            string.value.text_value
-          )
+          return build_state.new_command_statement(statement_start, string)
         end
       }
     end
@@ -186,14 +126,6 @@ module Fig
       [\S]+
     end
 
-    rule package_name
-      [a-zA-Z0-9_.-]+
-    end
-
-    rule version_name
-      [a-zA-Z0-9_.-]+
-    end
-
     rule resource_url
       # Unquoted allows globbing for files, quoted does not.
       #
@@ -201,14 +133,14 @@ module Fig
       #    @      - To allow for package substitution
       #    "<>|   - Characters not allowed in filenames on Windows
       #    \s     - Necessary for the "ws" token to work
-      (value:[^@"<>|\s]+ ws)
+      (url:[^@"<>|\s]+ ws)
 
       # Quoted, anything but:
       #    @        - To allow for package substitution
       #    "<>|     - Characters not allowed in filenames on Windows
       #    *?\[\]{} - Characters significant to Dir.glob()
       #    \s       - We just don't want these. :]  (May need to allow space.)
-      / ('"' value:[^@"<>|*?\[\]{}\s]+ '"' ws)
+      / ('"' url:[^@"<>|*?\[\]{}\s]+ '"' ws)
     end
 
     rule ws

data/lib/fig/package_descriptor.rb

@@ -64,6 +64,7 @@ class Fig::PackageDescriptor
     validate_component name,    'name',    :name,    options
     validate_component version, 'version', :version, options
     validate_component config,  'config',  :config,  options
+    validate_name      options
     validate_across_components options
   end
 
@@ -112,6 +113,17 @@ class Fig::PackageDescriptor
     )
   end
 
+  def validate_name(options)
+    return if @name.nil?
+
+    return if ! Fig::Parser.strict_keyword? @name
+
+    raise Fig::PackageDescriptorParseError.new(
+      %Q<Invalid package name; "#{@name}" is a keyword#{standard_exception_suffix(options)}>,
+      @original_string
+    )
+  end
+
   def throw_presence_exception(name, presence_requirement_symbol, options)
     presence = options[presence_requirement_symbol]
     raise Fig::PackageDescriptorParseError.new(

data/lib/fig/parser.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'treetop'
 
 require 'fig/grammar' # this is grammar.treetop, not grammar.rb.
@@ -14,6 +15,19 @@ module Fig; end
 # Parses .fig files (wrapping the Treetop-generated parser object) and deals
 # with a few restrictions on them.
 class Fig::Parser
+  # Keywords that we really want to lock down.
+  def self.strict_keyword?(string)
+    # "config" is considered too useful for users, so we allow that where we
+    # restrict other keywords.
+    return false if string == 'config'
+
+    return keyword? string
+  end
+
+  def self.keyword?(string)
+    return KEYWORDS.include? string
+  end
+
   def initialize(application_config, check_include_versions)
     # Fig::FigParser class is synthesized by Treetop.
     @treetop_parser         = Fig::FigParser.new
@@ -51,6 +65,21 @@ class Fig::Parser
 
   private
 
+  KEYWORDS = Set.new
+  KEYWORDS << 'add'
+  KEYWORDS << 'append'
+  KEYWORDS << 'archive'
+  KEYWORDS << 'command'
+  KEYWORDS << 'config'
+  KEYWORDS << 'end'
+  KEYWORDS << 'include'
+  KEYWORDS << 'override'
+  KEYWORDS << 'path'
+  KEYWORDS << 'resource'
+  KEYWORDS << 'retrieve'
+  KEYWORDS << 'set'
+
+
   def extend_source_description(directory, original_description)
     if original_description
       extended = original_description

data/lib/fig/parser_package_build_state.rb

@@ -1,5 +1,15 @@
+require 'fig/package'
 require 'fig/package_parse_error'
 require 'fig/statement'
+require 'fig/statement/archive'
+require 'fig/statement/command'
+require 'fig/statement/configuration'
+require 'fig/statement/include'
+require 'fig/statement/override'
+require 'fig/statement/path'
+require 'fig/statement/resource'
+require 'fig/statement/retrieve'
+require 'fig/statement/set'
 
 module Fig; end
 
@@ -33,6 +43,93 @@ class Fig::ParserPackageBuildState
     )
   end
 
+  def new_package_statement(directory, statements)
+    return Fig::Package.new(
+      descriptor.name,
+      descriptor.version,
+      directory,
+      statements.elements.map do
+        |statement|
+        statement.to_package_statement(self)
+      end
+    )
+  end
+
+  def new_asset_statement(statement_class, keyword_node, url_node)
+    url = url_node.url.text_value
+
+    statement_class.validate_url(url) {
+      |error_description|
+
+      raise_invalid_value_parse_error(
+        keyword_node, url_node.url, 'URL/path', error_description
+      )
+    }
+
+    return statement_class.new(
+      node_location(keyword_node), source_description, url
+    )
+  end
+
+  def new_retrieve_statement(keyword_node, variable_name_node, path_node)
+    return Fig::Statement::Retrieve.new(
+      node_location(keyword_node),
+      source_description,
+      variable_name_node.text_value,
+      path_node.text_value
+    )
+  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
+
+    return Fig::Statement::Configuration.new(
+      node_location(keyword_node),
+      source_description,
+      name_node.text_value,
+      statements.elements.map do
+        |statement|
+        statement.to_config_statement(self)
+      end
+    )
+  end
+
+  def new_include_statement(keyword_node, descriptor_node)
+    include_descriptor =
+      Fig::Statement::Include.parse_descriptor(
+        descriptor_node.text_value.strip,
+        :source_description => node_location_description(descriptor_node),
+        :validation_context => ' for an include statement'
+      )
+
+    return Fig::Statement::Include.new(
+      node_location(keyword_node),
+      source_description,
+      include_descriptor,
+      descriptor
+    )
+  end
+
+  def new_override_statement(keyword_node, descriptor_node)
+    override_descriptor =
+      Fig::Statement::Override.parse_descriptor(
+        descriptor_node.text_value.strip,
+        :source_description => node_location_description(descriptor_node),
+        :validation_context => ' for an override statement'
+      )
+
+    return Fig::Statement::Override.new(
+      node_location(keyword_node),
+      source_description,
+      override_descriptor.name,
+      override_descriptor.version
+    )
+  end
+
   def new_environment_variable_statement(
     statement_class, keyword_node, value_node
   )
@@ -40,6 +137,7 @@ class Fig::ParserPackageBuildState
       raise_invalid_value_parse_error(
         keyword_node,
         value_node,
+        'value',
         statement_class.const_get(:ARGUMENT_DESCRIPTION)
       )
     }
@@ -48,9 +146,19 @@ class Fig::ParserPackageBuildState
     )
   end
 
-  def raise_invalid_value_parse_error(keyword_node, value_node, description)
+  def new_command_statement(keyword_node, command_node)
+    return Fig::Statement::Command.new(
+      node_location(keyword_node),
+      source_description,
+      command_node.value.text_value
+    )
+  end
+
+  def raise_invalid_value_parse_error(
+    keyword_node, value_node, value_name, description
+  )
     raise Fig::PackageParseError.new(
-      %Q<Invalid value for #{keyword_node.text_value} statement: "#{value_node.text_value}" #{description}#{node_location_description(value_node)}>
+      %Q<Invalid #{value_name} for #{keyword_node.text_value} statement: "#{value_node.text_value}" #{description}#{node_location_description(value_node)}>
     )
   end
 end

data/lib/fig/runtime_environment.rb

@@ -159,13 +159,12 @@ class Fig::RuntimeEnvironment
 
     # Check to see if this include has been overridden.
     if backtrace
-      override = backtrace.get_override(
-        descriptor.name || base_package.name
-      )
+      override_package_name = descriptor.name || base_package.name
+      override = backtrace.get_override(override_package_name)
       if override
         resolved_descriptor =
           Fig::PackageDescriptor.new(
-            descriptor.name, override, descriptor.config
+            override_package_name, override, descriptor.config
           )
       end
     end
@@ -433,7 +432,11 @@ class Fig::RuntimeEnvironment
   def raise_repository_error(message, backtrace, package)
     string_handle = StringIO.new
     backtrace.dump(string_handle) if backtrace
-    package.backtrace.dump(string_handle) if package && package.backtrace
+
+    if package && package.backtrace && package.backtrace != backtrace
+      package.backtrace.dump(string_handle)
+    end
+
     stacktrace = string_handle.string
 
     raise Fig::RepositoryError.new(

data/lib/fig/statement/asset.rb

@@ -1,8 +1,16 @@
+require 'fig/parser'
+
 module Fig; end
 class Fig::Statement; end
 
 # Some sort of file to be included in a package.
 module Fig::Statement::Asset
+  def self.included(class_included_into)
+    class_included_into.extend(ClassMethods)
+
+    return
+  end
+
   def urls()
     return [ url() ]
   end
@@ -16,4 +24,15 @@ module Fig::Statement::Asset
     # going to fix this now.
     return url().split('/').last()
   end
+
+  module ClassMethods
+    def validate_url(url)
+      # "config" is a reasonable asset name, so we let that pass.
+      if Fig::Parser.strict_keyword?(url)
+        yield 'is a keyword.'
+      end
+
+      return
+    end
+  end
 end