fig 0.1.73 → 0.1.75

data/lib/fig/grammar/version_identification.treetop

@@ -0,0 +1,27 @@
+# Treetop (http://treetop.rubyforge.org/) grammar for determining package
+# definition versions.
+
+require 'treetop'
+
+require 'fig/grammar/base'
+require 'fig/grammar/version'
+
+module Fig
+  module Grammar
+    grammar VersionIdentification
+      include Fig::Grammar::Base
+      include Fig::Grammar::Version
+
+      rule everything
+        ws_or_comment* grammar_version:grammar_version? .* {
+          def get_grammar_version(build_state)
+            return if not grammar_version
+            return if grammar_version.text_value.empty?
+
+            return grammar_version.to_package_statement(build_state)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/fig/log4r_config_error.rb

@@ -3,7 +3,7 @@ require 'fig/user_input_error'
 module Fig
   # A problem with configuring Log4r.
   class Log4rConfigError < UserInputError
-    attr_accessor :config_file, :original_exception
+    attr_reader :config_file, :original_exception
 
     def initialize(config_file, original_exception)
       super(

data/lib/fig/no_such_package_config_error.rb

@@ -4,7 +4,7 @@ require 'fig/user_input_error'
 module Fig
   # User specified a configuration for a Package that does not exist.
   class NoSuchPackageConfigError < UserInputError
-    attr_accessor :descriptor
+    attr_reader :descriptor
 
     def initialize(message, descriptor)
       super(message)

data/lib/fig/not_found_error.rb

@@ -3,5 +3,12 @@ module Fig
   # may not actually be a problem; i.e. this may be the result of an existence
   # test.
   class NotFoundError < StandardError
+    attr_reader :path
+
+    def initialize(message, path)
+      super(message)
+
+      @path = path
+    end
   end
 end

data/lib/fig/operating_system.rb

@@ -32,10 +32,12 @@ class Fig::OperatingSystem
   end
 
   def get_username()
+    # #ask() comes from highline
     @username ||= ask('Username: ') { |q| q.echo = true }
   end
 
   def get_password()
+    # #ask() comes from highline
     @password ||= ask('Password: ') { |q| q.echo = false }
   end
 
@@ -177,10 +179,10 @@ class Fig::OperatingSystem
         end
       rescue Net::FTPPermError => error
         Fig::Logging.debug error.message
-        raise Fig::NotFoundError.new
+        raise Fig::NotFoundError.new error.message, url
       rescue SocketError => error
         Fig::Logging.debug error.message
-        raise Fig::NotFoundError.new
+        raise Fig::NotFoundError.new error.message, url
       end
     when 'http'
       log_download(url, path)
@@ -191,10 +193,10 @@ class Fig::OperatingSystem
           download_via_http_get(url, file)
         rescue SystemCallError => error
           Fig::Logging.debug error.message
-          raise Fig::NotFoundError.new
+          raise Fig::NotFoundError.new error.message, url
         rescue SocketError => error
           Fig::Logging.debug error.message
-          raise Fig::NotFoundError.new
+          raise Fig::NotFoundError.new error.message, url
         end
       end
     when 'ssh'
@@ -208,8 +210,8 @@ class Fig::OperatingSystem
       begin
         FileUtils.cp(uri.path, path)
         return true
-      rescue Errno::ENOENT
-        raise Fig::NotFoundError.new
+      rescue Errno::ENOENT => error
+        raise Fig::NotFoundError.new error.message, url
       end
     else
       Fig::Logging.fatal "Unknown protocol: #{url}"
@@ -217,29 +219,36 @@ class Fig::OperatingSystem
     end
   end
 
-  def download_resource(url, dir)
-    FileUtils.mkdir_p(dir)
-    download(url, File.join(dir, URI.parse(url).path.split('/').last))
-  end
+  # Returns the basename and full path to the download.
+  def download_resource(url, download_directory)
+    FileUtils.mkdir_p(download_directory)
 
-  def download_and_unpack_archive(url, dir)
-    FileUtils.mkdir_p(dir)
     basename = URI.parse(url).path.split('/').last
-    path = File.join(dir, basename)
+    path     = File.join(download_directory, basename)
+
     download(url, path)
+
+    return basename, path
+  end
+
+  def download_and_unpack_archive(url, download_directory)
+    basename, path = download_resource(url, download_directory)
+
     case basename
     when /\.tar\.gz$/
-      unpack_archive(dir, path)
+      unpack_archive(download_directory, path)
     when /\.tgz$/
-      unpack_archive(dir, path)
+      unpack_archive(download_directory, path)
     when /\.tar\.bz2$/
-      unpack_archive(dir, path)
+      unpack_archive(download_directory, path)
     when /\.zip$/
-      unpack_archive(dir, path)
+      unpack_archive(download_directory, path)
     else
       Fig::Logging.fatal "Unknown archive type: #{basename}"
       raise Fig::NetworkError.new("Unknown archive type: #{basename}")
     end
+
+    return
   end
 
   def upload(local_file, remote_file)
@@ -429,7 +438,7 @@ class Fig::OperatingSystem
       return false
     when NOT_FOUND
       tempfile.delete
-      raise Fig::NotFoundError.new
+      raise Fig::NotFoundError.new 'Remote path not found', path
     when SUCCESS
       FileUtils.mv(tempfile.path, path)
       return true
@@ -454,7 +463,7 @@ class Fig::OperatingSystem
   def download_via_http_get(uri_string, file, redirection_limit = 10)
     if redirection_limit < 1
       Fig::Logging.debug 'Too many HTTP redirects.'
-      raise Fig::NotFoundError.new
+      raise Fig::NotFoundError.new 'Too many HTTP redirects.', uri_string
     end
 
     response = Net::HTTP.get_response(URI(uri_string))
@@ -468,7 +477,9 @@ class Fig::OperatingSystem
       download_via_http_get(location, file, limit - 1)
     else
       Fig::Logging.debug "Download failed: #{response.code} #{response.message}."
-      raise Fig::NotFoundError.new
+      raise Fig::NotFoundError.new(
+        "Download failed: #{response.code} #{response.message}.", uri_string
+      )
     end
 
     return

data/lib/fig/package.rb

@@ -16,11 +16,14 @@ module Fig; end
 class Fig::Package
   include Comparable
 
-  UNPUBLISHED     = '<unpublished>'
   DEFAULT_CONFIG  = 'default'
 
-  attr_reader   :name, :version, :directory, :statements
-  attr_accessor :backtrace, :unparsed_text
+  attr_reader   :name
+  attr_reader   :version
+  attr_reader   :directory
+  attr_reader   :statements
+  attr_accessor :backtrace
+  attr_accessor :unparsed_text
 
   def initialize(name, version, directory, statements)
     @name                 = name
@@ -151,6 +154,8 @@ class Fig::Package
 
   private
 
+  UNPUBLISHED     = '<unpublished>'
+
   def compare_components(mine, others)
     if mine.nil?
       if others.nil?

data/lib/fig/package_definition_text_assembler.rb

@@ -0,0 +1,88 @@
+require 'fig/unparser/v0'
+require 'fig/unparser/v1'
+
+module Fig; end
+
+# Used for building packages for publishing.
+class Fig::PackageDefinitionTextAssembler
+  attr_reader :input_statements
+  attr_reader :output_statements
+
+  def initialize()
+    @input_statements   = []
+    @output_statements  = []
+    @header_text        = []
+    @footer_text        = []
+
+    return
+  end
+
+  # Argument can either be a single Statement or an array of them.
+  def add_input(statements)
+    @input_statements << statements
+    @input_statements.flatten!
+
+    return
+  end
+
+  # Argument can either be a single Statement or an array of them.
+  def add_output(statements)
+    @output_statements << statements
+    @output_statements.flatten!
+
+    return
+  end
+
+  def asset_input_statements()
+    return @input_statements.select { |statement| statement.is_asset? }
+  end
+
+  # Argument can be a single string or an array of strings
+  def add_header(text)
+    @header_text << text
+
+    return
+  end
+
+  # Argument can be a single string or an array of strings
+  def add_footer(text)
+    @footer_text << text
+
+    return
+  end
+
+  def assemble_package_definition()
+    definition =
+      [@header_text, unparse_statements(), @footer_text].flatten.join("\n")
+    definition.gsub!(/\n{3,}/, "\n\n")
+    definition.strip!
+    definition << "\n"
+
+    return definition
+  end
+
+  private
+
+  def unparse_statements()
+    versions = @output_statements.map {|s| s.minimum_grammar_version_required}
+    version = versions.max || 0
+
+    unparser_class = nil
+    if version == 1
+      unparser_class = Fig::Unparser::V1
+    else
+      unparser_class = Fig::Unparser::V0
+    end
+
+    unparser = unparser_class.new :emit_as_to_be_published
+    text = unparser.unparse(@output_statements)
+
+    # TODO: Until v1 grammar handling is done, ensure we don't emit anything
+    # old fig versions cannot handle.
+    if version != 0
+      raise "Reached a point where something could not be represented by the current grammar. Bailing out.\n\nWould have attempted:\n#{text}"
+    end
+
+    return text
+  end
+end

data/lib/fig/package_descriptor_parse_error.rb

@@ -3,7 +3,7 @@ require 'fig/user_input_error'
 module Fig
   # Could not turn a string into a PackageDescriptor.
   class PackageDescriptorParseError < UserInputError
-    attr_accessor :original_string
+    attr_reader :original_string
 
     def initialize(message, original_string)
       super(message)

data/lib/fig/parser.rb

@@ -1,12 +1,13 @@
 require 'set'
-require 'treetop'
 
-require 'fig/grammar' # this is grammar.treetop, not grammar.rb.
+require 'fig/grammar/version_identification'
+require 'fig/grammar/v0'
+require 'fig/grammar/v1'
 require 'fig/logging'
 require 'fig/package_parse_error'
 require 'fig/parser_package_build_state'
-require 'fig/repository'
 require 'fig/statement'
+require 'fig/url'
 require 'fig/url_access_error'
 require 'fig/user_input_error'
 
@@ -29,25 +30,114 @@ class Fig::Parser
   end
 
   def initialize(application_config, check_include_versions)
-    # Fig::FigParser class is synthesized by Treetop.
-    @treetop_parser         = Fig::FigParser.new
     @application_config     = application_config
     @check_include_versions = check_include_versions
   end
 
   def parse_package(descriptor, directory, source_description, unparsed_text)
-    # Bye bye comments.
-    stripped_text = unparsed_text.gsub(/#.*$/, '')
+    version = get_grammar_version(
+      descriptor, directory, source_description, unparsed_text
+    )
+
+    if version == 0
+      return parse_v0(descriptor, directory, source_description, unparsed_text)
+    end
+
+    return parse_v1(descriptor, directory, source_description, unparsed_text)
+  end
+
+  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 get_grammar_version(
+    descriptor, directory, source_description, unparsed_text
+  )
+    version_parser = Fig::Grammar::VersionIdentificationParser.new()
+
+    extended_description =
+      extend_source_description(directory, source_description)
 
+    result = version_parser.parse(unparsed_text)
+    if result.nil?
+      raise_parse_error(version_parser, unparsed_text, extended_description)
+    end
+
+    statement = result.get_grammar_version(
+      Fig::ParserPackageBuildState.new(descriptor, extended_description)
+    )
+    return 0 if not statement
+
+    version = statement.version
+    # TODO: restore v1 grammar.
+    # if version > 1
+    if version > 0
+      raise Fig::PackageParseError.new(
+        %Q<Don't know how to parse grammar version #{version}#{statement.position_string()}.>
+      )
+    end
+
+    return version
+  end
+
+  def parse_v0(descriptor, directory, source_description, unparsed_text)
+    stripped_text = unparsed_text.gsub(/#.*$/, '') # Blech.
+
+    v0_parser = Fig::Grammar::V0Parser.new
+
+    return drive_parser(
+      v0_parser,
+      descriptor,
+      directory,
+      source_description,
+      unparsed_text,
+      stripped_text
+    )
+  end
+
+  def parse_v1(descriptor, directory, source_description, unparsed_text)
+    v1_parser = Fig::Grammar::V1Parser.new
+
+    return drive_parser(
+      v1_parser,
+      descriptor,
+      directory,
+      source_description,
+      unparsed_text,
+      unparsed_text
+    )
+  end
+
+  def drive_parser(
+    parser,
+    descriptor,
+    directory,
+    source_description,
+    unparsed_text, # Ugh. V0 strips comments via regex.
+    cleaned_text
+  )
     # Extra space at the end because most of the rules in the grammar require
     # trailing whitespace.
-    result = @treetop_parser.parse(stripped_text + ' ')
+    result = parser.parse(cleaned_text + ' ')
 
     extended_description =
       extend_source_description(directory, source_description)
 
     if result.nil?
-      raise_parse_error(extended_description)
+      raise_parse_error(parser, cleaned_text, extended_description)
     end
 
     package = result.to_package(
@@ -63,23 +153,6 @@ class Fig::Parser
     return package
   end
 
-  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
@@ -93,9 +166,22 @@ class Fig::Parser
     return directory
   end
 
-  def raise_parse_error(extended_description)
+  def raise_parse_error(treetop_parser, text, extended_description)
     message = extended_description
-    message << ": #{@treetop_parser.failure_reason}"
+
+    failure_reason = treetop_parser.failure_reason
+    message << ": #{failure_reason}"
+    if message.sub!( / after\s*\z/, %q< after '>)
+      start = treetop_parser.failure_index - 20
+      if start < 0
+        start = 0
+      else
+        message << '...'
+      end
+
+      message << text[start, treetop_parser.failure_index]
+      message << %q<'>
+    end
 
     raise Fig::PackageParseError.new(message)
   end
@@ -107,7 +193,7 @@ class Fig::Parser
     package.walk_statements do |statement|
       statement.urls.each do |url|
         # collect all bad urls in bad_urls
-        next if not Fig::Repository.is_url?(url)
+        next if not Fig::URL.is_url?(url)
         bad_urls << url if not @application_config.url_access_allowed?(url)
       end
     end