fig 0.1.62 → 0.1.64

data/lib/fig/statement.rb

@@ -1,15 +1,35 @@
 module Fig; end
 
-# A statement within a package configuration file (package.fig).
+# A statement within a package definition file (package.fig).
 class Fig::Statement
-  attr_reader :line, :column
+  ENVIRONMENT_VARIABLE_NAME_REGEX = %r< \A \w+ \z >x
+
+  attr_reader :line, :column, :source_description
+
+  def self.position_description(line, column, source_description)
+    if not line or not column
+      return '' if not source_description
+
+      return " (#{source_description})"
+    end
+
+    description = " (line #{line}, column #{column}"
+    if source_description
+      description << ", #{source_description}"
+    end
+    description << ')'
+
+    return description
+  end
 
   # 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)
+  def initialize(line_column, source_description)
     if line_column
       @line, @column = *line_column
     end
+
+    @source_description = source_description
   end
 
   # Block will receive a Statement.
@@ -17,13 +37,12 @@ class Fig::Statement
     return
   end
 
-  # Block will receive a Package and a Statement.
-  def walk_statements_following_package_dependencies(repository, package, configuration, &block)
-    return
+  def urls()
+    return []
   end
 
-  def urls
-    return []
+  def is_asset?()
+    return false
   end
 
   # Returns a representation of the position of this statement, if the position
@@ -32,9 +51,8 @@ class Fig::Statement
   # statement%{statement.position_string()}.>" and get nice looking output
   # regardless of whether the position is actually known or not.
   def position_string
-    return '' if not @line
-    return '' if not @column
-
-    return " (line #{@line}, column #{@column})"
+    return Fig::Statement.position_description(
+      @line, @column, @source_description
+    )
   end
 end

data/lib/fig/statement/archive.rb

@@ -1,21 +1,24 @@
 require 'fig/statement'
+require 'fig/statement/asset'
 
 module Fig; end
 
-# Specifies an archive file (possibly via a URL) that is part of the current package.
+# Specifies an archive file (possibly via a URL) that is part of a package.
 #
 # Differs from a Resource in that the contents will be extracted.
 class Fig::Statement::Archive < Fig::Statement
+  include Fig::Statement::Asset
+
   attr_reader :url
 
-  def initialize(line_column, url)
-    super(line_column)
+  def initialize(line_column, source_description, url)
+    super(line_column, source_description)
 
     @url = url
   end
 
-  def urls
-    return [@url]
+  def asset_name()
+    return standard_asset_name()
   end
 
   def unparse(indent)

data/lib/fig/statement/asset.rb

@@ -0,0 +1,19 @@
+module Fig; end
+class Fig::Statement; end
+
+# Some sort of file to be included in a package.
+module Fig::Statement::Asset
+  def urls()
+    return [ url() ]
+  end
+
+  def is_asset?()
+    return true
+  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
+end

data/lib/fig/statement/command.rb

@@ -7,8 +7,8 @@ module Fig; end
 class Fig::Statement::Command < Fig::Statement
   attr_reader :command
 
-  def initialize(line_column, command)
-    super(line_column)
+  def initialize(line_column, source_description, command)
+    super(line_column, source_description)
 
     @command = command
   end

data/lib/fig/statement/configuration.rb

@@ -3,22 +3,25 @@ require 'fig/statement/command'
 
 module Fig; end
 
-# A grouping of statements within a configuration.  May not be nested.
+# A grouping of statements within a package.  May not be nested.
+#
+# Any processing of statements is guaranteed to hit any Overrides first.
 class Fig::Statement::Configuration < Fig::Statement
   attr_reader :name, :statements
 
-  def initialize(line_column, name, statements)
-    super(line_column)
+  def initialize(line_column, source_description, name, statements)
+    super(line_column, source_description)
 
     @name = name
-    @statements = statements
-  end
 
-  def with_name(name)
-    Configuration.new(name, statements)
+    overrides, others = statements.partition do
+      |statement| statement.is_a?(Fig::Statement::Override)
+    end
+
+    @statements = [overrides, others].flatten
   end
 
-  def command
+  def command_statement
     return statements.find do
       |statement| statement.is_a?(Fig::Statement::Command)
     end
@@ -32,19 +35,16 @@ class Fig::Statement::Configuration < Fig::Statement
     end
   end
 
-  # Block will receive a Package and a Statement.
-  def walk_statements_following_package_dependencies(repository, package, configuration, &block)
-    @statements.each do |statement|
-      yield package, self, statement
-      statement.walk_statements_following_package_dependencies(
-        repository, package, self, &block
-      )
-    end
-
-    return
-  end
-
   def unparse(indent)
     unparse_statements(indent, "config #{@name}", @statements, 'end')
   end
+
+  private
+
+  def unparse_statements(indent, prefix, statements, suffix)
+    body =
+      @statements.map {|statement| statement.unparse(indent + '  ') }.join("\n")
+
+    return ["\n#{indent}#{prefix}", body, "#{indent}#{suffix}"].join("\n")
+  end
 end

data/lib/fig/statement/include.rb

@@ -4,15 +4,22 @@ require 'fig/statement'
 module Fig; end
 
 # Dual role: "include :configname" incorporates one configuration into another;
-# "include package[/version]" declares a dependency upon another package.
+# "include package[/version]" declares a dependency upon another package (with
+# incorporation of the "default" configuration from that other package if no
+# ":configname" is specified.
 class Fig::Statement::Include < Fig::Statement
-  attr_reader :descriptor, :overrides, :containing_package_descriptor
+  attr_reader :descriptor, :containing_package_descriptor
 
-  def initialize(line_column, descriptor, overrides, containing_package_descriptor)
-    super(line_column)
+  # Centralized definition of requirements for descriptors for include
+  # statements.
+  def self.parse_descriptor(raw_string, options = {})
+    return Fig::PackageDescriptor.parse(raw_string, options)
+  end
+
+  def initialize(line_column, source_description, descriptor, containing_package_descriptor)
+    super(line_column, source_description)
 
     @descriptor                    = descriptor
-    @overrides                     = overrides
     @containing_package_descriptor = containing_package_descriptor
   end
 
@@ -55,35 +62,12 @@ class Fig::Statement::Include < Fig::Statement
     )
   end
 
-  # Block will receive a Package and a Statement.
-  def walk_statements_following_package_dependencies(
-    repository, package, configuration, &block
-  )
-    referenced_package = nil
-    if package_name()
-      referenced_package = repository.get_package(descriptor())
-    else
-      referenced_package = package
-    end
-
-    configuration = referenced_package[referenced_config_name()]
-
-    yield referenced_package, configuration
-    configuration.walk_statements_following_package_dependencies(
-      repository, referenced_package, nil, &block
-    )
-
-    return
-  end
-
   def unparse(indent)
     text = ''
     text += package_name() if package_name()
     text += "/#{version()}" if version()
     text += ":#{config_name()}" if config_name()
-    @overrides.each do |override|
-      text += override.unparse
-    end
+
     return "#{indent}include #{text}"
   end
 
@@ -94,11 +78,6 @@ class Fig::Statement::Include < Fig::Statement
   end
 
   def referenced_version(containing_package, backtrace)
-    overrides().each do
-      |override|
-      backtrace.add_override(override.package_name(), override.version())
-    end
-
     package_name = nil
     original_version = nil
     if package_name()

data/lib/fig/statement/override.rb

@@ -3,24 +3,38 @@ require 'fig/statement'
 
 module Fig; end
 
-# Overrides one package version dependency with another in an include
-# statement.
+# Overrides one package version dependency with another.
 #
-#    include blah/1.2.3 override somedependency/3.2.6
+#   config whatever
+#     override somedependency/3.2.6
+#   end
 #
 # indicates that, regardless of which version of somedependency the blah
 # package says it needs, the blah package will actually use v3.2.6.
 class Fig::Statement::Override < Fig::Statement
   attr_reader :package_name, :version
 
-  def initialize(line_column, package_name, version)
-    super(line_column)
+  # Centralized definition of requirements for descriptors for override
+  # statements.
+  def self.parse_descriptor(raw_string, options = {})
+    filled_in_options = {}
+    filled_in_options.merge!(options)
+    filled_in_options[:name]    = :required
+    filled_in_options[:version] = :required
+    filled_in_options[:config]  = :forbidden
+
+    return Fig::PackageDescriptor.parse(raw_string, filled_in_options)
+  end
+
+  def initialize(line_column, source_description, package_name, version)
+    super(line_column, source_description)
 
     @package_name = package_name
     @version = version
   end
 
-  def unparse()
-    return ' override ' + Fig::PackageDescriptor.format(@package_name, @version, nil)
+  def unparse(indent)
+    return "#{indent}override " +
+      Fig::PackageDescriptor.format(@package_name, @version, nil)
   end
 end

data/lib/fig/statement/path.rb

@@ -5,10 +5,30 @@ 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
+  VALUE_REGEX          = %r< \A [^;:"<>|\s]+ \z >x
+  ARGUMENT_DESCRIPTION =
+    %q[The value must look like "NAME=VALUE". VALUE cannot contain any of ";:<>|", double quotes, or whitespace.]
+
+  # Yields on error.
+  def self.parse_name_value(combined)
+    variable, value = combined.split("=")
+
+    if variable !~ ENVIRONMENT_VARIABLE_NAME_REGEX
+      yield
+    end
+
+    value = '' if value.nil?
+    if value !~ VALUE_REGEX
+      yield
+    end
+
+    return [variable, value]
+  end
+
   attr_reader :name, :value
 
-  def initialize(line_column, name, value)
-    super(line_column)
+  def initialize(line_column, source_description, name, value)
+    super(line_column, source_description)
 
     @name = name
     @value = value

data/lib/fig/statement/resource.rb

@@ -1,4 +1,6 @@
+require 'fig/repository'
 require 'fig/statement'
+require 'fig/statement/asset'
 
 module Fig; end
 
@@ -6,16 +8,24 @@ module Fig; end
 #
 # Differs from an Archive in that the contents will not be extracted.
 class Fig::Statement::Resource < Fig::Statement
+  include Fig::Statement::Asset
+
   attr_reader :url
 
-  def initialize(line_column, url)
-    super(line_column)
+  def initialize(line_column, source_description, url)
+    super(line_column, source_description)
 
     @url = url
   end
 
-  def urls
-    return [@url]
+  def asset_name()
+    if Fig::Repository.is_url?(url())
+      return standard_asset_name()
+    end
+
+    # This resource will end up being bundled with others and will not live in
+    # the package by itself.
+    return nil
   end
 
   def unparse(indent)

data/lib/fig/statement/retrieve.rb

@@ -1,16 +1,46 @@
+require 'fig/logging'
 require 'fig/statement'
 
 module Fig; end
 
-# Specifies the destination to put a dependency into.
+# Specifies that files from a package should be copied into the current
+# directory when an environment variable has its value changed.
 class Fig::Statement::Retrieve < Fig::Statement
-  attr_reader :var, :path
+  attr_reader   :var, :path
 
-  def initialize(line_column, var, path)
-    super(line_column)
+  def initialize(line_column, source_description, var, path)
+    super(line_column, source_description)
 
     @var = var
     @path = path
+
+    # Yeah, it's not cross-platform, but File doesn't have an #absolute? method
+    # and this is better than nothing.
+    if path =~ %r< ^ / >x
+      Fig::Logging.warn(
+        %Q<The retrieve path "#{path}"#{position_string()} looks like it is intended to be absolute; retrieve paths are always treated as relative.>
+      )
+    end
+  end
+
+  def loaded_but_not_referenced?()
+    return added_to_environment? && ! referenced?
+  end
+
+  def added_to_environment?()
+    return @added_to_environment
+  end
+
+  def added_to_environment(yea_or_nay)
+    @added_to_environment = yea_or_nay
+  end
+
+  def referenced?()
+    return @referenced
+  end
+
+  def referenced(yea_or_nay)
+    @referenced = yea_or_nay
   end
 
   def unparse(indent)

data/lib/fig/statement/set.rb

@@ -4,10 +4,30 @@ module Fig; end
 
 # A statement that sets the value of an environment variable.
 class Fig::Statement::Set < Fig::Statement
+  VALUE_REGEX          = %r< \A \S* \z >x
+  ARGUMENT_DESCRIPTION =
+    %q<The value must look like "NAME=VALUE", though VALUE can be empty.>
+
+  # Yields on error.
+  def self.parse_name_value(combined)
+    variable, value = combined.split("=")
+
+    if variable !~ ENVIRONMENT_VARIABLE_NAME_REGEX
+      yield
+    end
+
+    value = '' if value.nil?
+    if value !~ VALUE_REGEX
+      yield
+    end
+
+    return [variable, value]
+  end
+
   attr_reader :name, :value
 
-  def initialize(line_column, name, value)
-    super(line_column)
+  def initialize(line_column, source_description, name, value)
+    super(line_column, source_description)
 
     @name = name
     @value = value