fig 0.1.81 → 0.2.1

data/Changes

@@ -1,3 +1,90 @@
+v0.2.1
+
+  Backwards incompatibilities:
+
+  - In a retrieve statement, it is now an error to have an unescaped open
+    square bracket ("[") that is not followed by "ackage]".  In other words,
+    the following was previously acceptable:
+
+      retrieve VARIABLE->foo[bar]baz
+
+    You now will need to use the v1 grammar and escape the square bracket:
+
+      grammar v1
+      retrieve VARIABLE->foo\[bar]baz
+
+  - Next version will not support Ruby v1.8.
+
+  Bug fix:
+
+  - Bad variable name with HTTP downloads fixed.
+
+  New features:
+
+  - New --dump-package-definition-for-command-line option, useful for
+    previewing a package defined via the --set, --append, --archive,
+    --resource, --include, and --override options.
+
+  - The long in-progress v1 grammar is available.  It solves a lot of
+    inconsistencies in the original, now v0, grammar.  The primary differences
+    are in allowing Bourne-shell like quoting and escaping of values (double
+    quotes allow whitespace, single quotes turns all interpolation off, etc.)
+    and the command statement now can be used without involving the shell.
+
+    For the most part, this should be transparent to you.
+
+    Command-line options are treated as if they were specified in the v1
+    grammar.
+
+    Older versions of fig cannot read v1 format, but versions since v0.1.75
+    will cleanly tell you that they can't handle it.
+
+    In order to be as compatible with older fig versions, the new fig will
+    publish packages using the v0 grammar, if it can find a way to do so, even
+    if the input package definition is given in the v1 grammar.  Thus, given a
+    package.fig file containing
+
+      grammar v1
+
+      config default
+        set foo='bar'
+      end
+
+    the published package will look like
+
+      # grammar v0
+
+      config default
+        set foo=bar
+      end
+
+    If, when publishing, fig determines that it needs to use the v1 grammar, it
+    will tell you why:
+
+      > fig --set 'baz=foo#bar' --publish-local v1-grammar/test
+
+      Publishing v1-grammar/test locally.
+      Publishing using the v1 grammar.
+      Grammar v1 is required because the set statement (--set option) contains a comment ("#") character.
+
+    Documentation for the new grammar is available at
+    https://github.com/mfoemmel/fig/wiki/v1-grammar.  It may be helpful to have
+    a look at the old one, as well:
+    https://github.com/mfoemmel/fig/wiki/v0-grammar
+
+  Miscellaneous:
+
+  - The restriction on using keywords in names introduced in v0.1.71 has been
+    reversed.  If changes are required to deal with that, there'll just be a
+    new grammar version introduced.
+
+  - Fewer stack traces with network errors.
+
+v0.2.0.beta.2
+v0.2.0.beta.1
+
+  - Test releases
+
 v0.1.81
 
   Backwards incompatibilities:

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '0.1.81'
+  VERSION = '0.2.1'
 end

data/lib/fig/command.rb

@@ -66,6 +66,7 @@ class Fig::Command
 
     context = ExecutionContext.new(
       @base_package,
+      @synthetic_package_for_command_line,
       base_config(),
       @environment,
       @repository,
@@ -124,6 +125,7 @@ class Fig::Command
   ExecutionContext =
     Struct.new(
       :base_package,
+      :synthetic_package_for_command_line,
       :base_config,
       :environment,
       :repository,
@@ -280,6 +282,9 @@ class Fig::Command
       applier.apply_config_to_environment(! apply_base_config)
     end
 
+    @synthetic_package_for_command_line =
+      applier.synthetic_package_for_command_line
+
     return
   end
 

data/lib/fig/command/action/dump_package_definition_for_command_line.rb

@@ -0,0 +1,62 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+require 'fig/package_definition_text_assembler'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::DumpPackageDefinitionForCommandLine
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--dump-package-definition-for-command-line>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def modifies_repository?()
+    return false
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return false
+  end
+
+  def apply_config?()
+    return false
+  end
+
+  def configure(options)
+    @environment_statements       = options.environment_statements
+    @package_contents_statements  = options.package_contents_statements
+
+    return
+  end
+
+  def execute()
+    text_assembler = Fig::PackageDefinitionTextAssembler.new :emit_as_input
+    text_assembler.add_output @package_contents_statements
+    text_assembler.add_output [
+      Fig::Statement::Configuration.new(
+        nil,
+        nil,
+        Fig::Package::DEFAULT_CONFIG,
+        @environment_statements
+      )
+    ]
+
+
+    unparsed, explanations = text_assembler.assemble_package_definition
+    print unparsed
+
+    return EXIT_SUCCESS
+  end
+end

data/lib/fig/command/action/dump_package_definition_parsed.rb

@@ -35,12 +35,29 @@ class Fig::Command::Action::DumpPackageDefinitionParsed
   end
 
   def execute()
+    if @execution_context.synthetic_package_for_command_line
+      # Purposely syntactically incorrect so that nothing attempts to round
+      # trip this.
+      puts "---- synthetic package for command-line ----\n"
+      dump_package @execution_context.synthetic_package_for_command_line
+
+      puts "\n---- base package ----\n"
+    end
+
+    dump_package @execution_context.base_package
+
+    return EXIT_SUCCESS
+  end
+
+  private
+
+  def dump_package(package)
     text_assembler = Fig::PackageDefinitionTextAssembler.new :emit_as_input
-    text_assembler.add_output @execution_context.base_package.statements
+    text_assembler.add_output package.statements
 
     unparsed, explanations = text_assembler.assemble_package_definition
     print unparsed
 
-    return EXIT_SUCCESS
+    return
   end
 end

data/lib/fig/command/action/list_local.rb

@@ -26,7 +26,15 @@ class Fig::Command::Action::ListLocal
   end
 
   def execute()
-    @execution_context.repository.list_packages.sort.each {|item| puts item}
+    packages = @execution_context.repository.list_packages
+
+    if packages.empty?
+      if $stdout.tty?
+        puts 'No local packages exist.'
+      end
+    else
+      packages.sort.each {|item| puts item}
+    end
 
     return EXIT_SUCCESS
   end

data/lib/fig/command/action/list_remote.rb

@@ -30,7 +30,15 @@ class Fig::Command::Action::ListRemote
   end
 
   def execute()
-    @execution_context.repository.list_remote_packages.sort.each {|item| puts item}
+    packages = @execution_context.repository.list_remote_packages
+
+    if packages.empty?
+      if $stdout.tty?
+        puts 'No local packages exist.'
+      end
+    else
+      packages.sort.each {|item| puts item}
+    end
 
     return EXIT_SUCCESS
   end

data/lib/fig/command/action/role/list_variables_in_a_tree.rb

@@ -135,7 +135,7 @@ module Fig::Command::Action::Role::ListVariablesInATree
 
       print "#{variable_indent}"
       print "#{statement.name().ljust(name_width)}"
-      print " = #{statement.value}"
+      print " = #{statement.tokenized_value.to_escaped_string}"
       if statement.is_a?(Fig::Statement::Path)
         print ":$#{statement.name}"
       end

data/lib/fig/command/action/run_command_line.rb

@@ -49,7 +49,7 @@ class Fig::Command::Action::RunCommandLine
     base_package  = @execution_context.base_package
     base_config   = @execution_context.base_config
 
-    environment.execute_command_line(
+    environment.expand_command_line(
       base_package, base_config, @descriptor, @command_line
     ) do
       |command| @execution_context.operating_system.plain_or_shell_exec command

data/lib/fig/command/action/run_command_statement.rb

@@ -49,9 +49,11 @@ class Fig::Command::Action::RunCommandStatement
     base_package  = @execution_context.base_package
     base_config   = @execution_context.base_config
 
-    environment.execute_config(
+    environment.expand_command_statement_from_config(
       base_package, base_config, @descriptor, @extra_argv || []
-    ) { |command| @execution_context.operating_system.shell_exec command }
+    ) {
+      |command| @execution_context.operating_system.plain_or_shell_exec command
+    }
 
     # Will never get here.
   end

data/lib/fig/command/options.rb

@@ -1,4 +1,5 @@
 require 'fig/command/action/clean'
+require 'fig/command/action/dump_package_definition_for_command_line'
 require 'fig/command/action/dump_package_definition_parsed'
 require 'fig/command/action/dump_package_definition_text'
 require 'fig/command/action/get'
@@ -30,6 +31,7 @@ require 'fig/command/option_error'
 require 'fig/command/options/parser'
 require 'fig/package_descriptor'
 require 'fig/statement/archive'
+require 'fig/statement/command'
 require 'fig/statement/include'
 require 'fig/statement/path'
 require 'fig/statement/resource'
@@ -162,10 +164,17 @@ class Fig::Command::Options
       case arg
         when '--'
           set_base_action(Fig::Command::Action::RunCommandLine)
-          @shell_command = argv[(i+1)..-1]
+          @shell_command = tokenize_command_arguments '--', argv[(i+1)..-1]
+
+          if @shell_command.empty?
+            raise Fig::Command::OptionError.new(
+              %q<The "--" option was used, but no command was specified.>
+            )
+          end
         when '--command-extra-args'
           set_base_action(Fig::Command::Action::RunCommandStatement)
-          @command_extra_argv = argv[(i+1)..-1]
+          @command_extra_argv =
+            tokenize_command_arguments '--command-extra-args', argv[(i+1)..-1]
       end
 
       if @base_action
@@ -177,13 +186,13 @@ class Fig::Command::Options
     return
   end
 
-  def set_up_parser
+  def set_up_parser()
     set_up_package_configuration_source()
     set_up_remote_repository_access()
-    set_up_queries()
     set_up_commands()
     set_up_environment_statements()
     set_up_package_contents_statements()
+    set_up_queries()
     set_up_program_configuration()
 
     return
@@ -239,6 +248,12 @@ class Fig::Command::Options
     ) do
       set_base_action(Fig::Command::Action::DumpPackageDefinitionParsed)
     end
+    @parser.on(
+      '--dump-package-definition-for-command-line',
+      'emit the synthetic package for the other options (--set/--archive/etc.)'
+    ) do
+      set_base_action(Fig::Command::Action::DumpPackageDefinitionForCommandLine)
+    end
 
     return
   end
@@ -300,16 +315,6 @@ class Fig::Command::Options
   end
 
   def set_up_commands()
-    @parser.on('--clean', 'remove package from $FIG_HOME') do
-      set_base_action(Fig::Command::Action::Clean)
-    end
-
-    @parser.on(
-      '--run-command-statement', 'run the command in even in local file'
-    ) do
-      set_base_action(Fig::Command::Action::RunCommandStatement)
-    end
-
     @parser.on(
       '--publish', 'install package in $FIG_HOME and in remote repo'
     ) do |publish|
@@ -330,6 +335,17 @@ class Fig::Command::Options
       @force = force
     end
 
+    @parser.on('--clean', 'remove package from $FIG_HOME') do
+      set_base_action(Fig::Command::Action::Clean)
+    end
+
+    @parser.on(
+      '--run-command-statement',
+      'run the command in even in package definition file (i.e. no descriptor)'
+    ) do
+      set_base_action(Fig::Command::Action::RunCommandStatement)
+    end
+
     return
   end
 
@@ -357,7 +373,7 @@ class Fig::Command::Options
     @parser.on(
       '--file FILE',
       FILE_OPTION_VALUE_PATTERN,
-      %q<read Fig file FILE. Use '-' for stdin. See also --no-file>
+      %q<read package definition FILE. Use '-' for stdin. See also --no-file>
     ) do |path|
       @package_definition_file = path
     end
@@ -383,7 +399,7 @@ class Fig::Command::Options
         new_variable_statement('--append', name_value, Fig::Statement::Path)
     end
     @parser.add_argument_description(
-      %w<-p --append>, Fig::Statement::Path::ARGUMENT_DESCRIPTION
+      %w<-p --append>, %q<The value of this option must look like "NAME=VALUE".>
     )
 
     @parser.on(
@@ -396,7 +412,7 @@ class Fig::Command::Options
         new_variable_statement('--set', name_value, Fig::Statement::Set)
     end
     @parser.add_argument_description(
-      %w<-s --set>, Fig::Statement::Set::ARGUMENT_DESCRIPTION
+      %w<-s --set>, %q<The value of this option must look like "NAME=VALUE".>
     )
 
     @parser.on(
@@ -584,7 +600,9 @@ class Fig::Command::Options
 
   def new_variable_statement(option, name_value, statement_class)
     variable, value = statement_class.parse_name_value(name_value) {
-      @parser.raise_invalid_argument(option, name_value)
+      |message|
+
+      @parser.raise_invalid_argument(option, name_value, message)
     }
 
     return statement_class.new(nil, "#{option} option", variable, value)
@@ -640,4 +658,18 @@ class Fig::Command::Options
 
     return
   end
+
+  def tokenize_command_arguments(option, arguments)
+    return arguments.map do
+      |argument|
+
+      Fig::Statement::Command.validate_and_process_escapes_in_argument(
+        argument
+      ) do
+        |error_description|
+
+        @parser.raise_invalid_argument(option, argument, error_description)
+      end
+    end
+  end
 end

data/lib/fig/command/options/parser.rb

@@ -18,17 +18,17 @@ Running under Fig:
   fig [...] [DESCRIPTOR] --command-extra-args VALUES
   fig [...] [DESCRIPTOR] --run-command-statement
 
-Querying:
-  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
-  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
-  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
-
 Publishing packages:
   fig {--publish | --publish-local} DESCRIPTOR
       [--resource PATH]      [--archive  PATH]
       [--include DESCRIPTOR] [--override DESCRIPTOR]
       [...]
 
+Querying:
+  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
+  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-variables [--list-tree] [--list-all-configs]    [DESCRIPTOR] [...]
+
 Standard options (represented as "[...]" above):
       [--update | --update-if-missing]
       [--set    VARIABLE=VALUE]
@@ -45,16 +45,6 @@ Running under Fig:
   fig [...] [DESCRIPTOR] --command-extra-args VALUES
   fig [...] [DESCRIPTOR] --run-command-statement
 
-Querying:
-
-  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
-  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
-  fig --list-variables    [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
-  fig --list-configs                                         [DESCRIPTOR] [...]
-  fig --dump-package-definition-text                         [DESCRIPTOR] [...]
-  fig --dump-package-definition-parsed                       [DESCRIPTOR] [...]
-  fig {--list-local | --list-remote}                                      [...]
-
 Publishing packages:
 
   fig {--publish | --publish-local} DESCRIPTOR
@@ -69,6 +59,17 @@ Local repository maintenance:
 
   fig --clean DESCRIPTOR [...]
 
+Querying:
+
+  fig {--list-local | --list-remote}                                      [...]
+  fig {-g | --get} VARIABLE                                  [DESCRIPTOR] [...]
+  fig --list-dependencies [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-variables    [--list-tree] [--list-all-configs] [DESCRIPTOR] [...]
+  fig --list-configs                                         [DESCRIPTOR] [...]
+  fig --dump-package-definition-text                         [DESCRIPTOR] [...]
+  fig --dump-package-definition-parsed                       [DESCRIPTOR] [...]
+  fig --dump-package-definition-for-command-line             [DESCRIPTOR] [...]
+
 Standard options (represented as "[...]" above):
 
       [-u | --update | -m | --update-if-missing]