fig 0.1.69 → 0.1.71

data/Changes

@@ -1,3 +1,48 @@
+v0.1.71
+
+  Backwards incompatibilities:
+
+  - Packages, resources, archives, and configs cannot have names that are
+    keywords (other than "config") in order to have more clear parse error
+    messages and allow for future expandability.  (You didn't really want a
+    package named "end" did you?)
+
+  New features:
+
+  - Default for --update-lock-response is now "wait" instead of "fail".
+    However, if a pre-existing lock is encountered and you haven't explicitly
+    specified "--update-lock-response wait", you'll get a warning about the
+    wait.  Note that this warning is not influenced by --log-level.
+
+  - Can specify the location of the remote repository via ~/.figrc or the value
+    of the --figrc parameter by specifying a value for "default
+    FIG_REMOTE_URL", e.g.
+
+      { "default FIG_REMOTE_URL" : "file:///some/path" }
+
+  - New --dump-package-definition-text option, which gives you the text of the
+    base package.  Useful for looking at published packages.
+
+  - New --dump-package-definition-parsed option, which, surprise, gives you the
+    the base package after Fig has digested it.  Note that you won't see the
+    result of --set/--append/--archive/--resource options in this because those
+    get stored outside of the base package.
+
+  - Warns on ignored --archive/--resource options.
+
+  - The output "--help" was getting way too long.  The text that it now emits
+    is non-comprehensive, but it should fit onto a single screen and includes
+    pointers to the new "--options" and "--help-long" options.
+
+  Bug fixes:
+
+  - Loading an overridden package version that had one config include another
+    config of the same package could cause problems in some circumstances.
+
+v0.1.70.beta.1
+
+  - Test release
+
 v0.1.69
 
   Backwards incompatibilities:

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009-2012, Matthew Foemmel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+    * The names of the contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,45 @@
+Description
+===========
+
+Fig is a utility for configuring environments and managing dependencies across
+a team of developers.
+
+An "environment" in fig is a set of environment variables.  A "package" is a
+collection of files, along with some metadata describing which environment
+variables should be modified when the package is included.  For instance, each
+dependency may prepend its corresponding jar to CLASSPATH.  The metadata may
+also list that package's lower-level Fig package dependencies.
+
+Fig recursively builds an environment consisting of package dependencies
+(typically specified via command-line options or a package.fig file), each of
+which as noted above may have its own dependencies, and optionally executes a
+shell command in that environment.  The caller's environment is not affected.
+
+Developers can use package.fig files to specify the list of dependencies to use
+for different tasks. This file will typically be versioned along with the rest
+of the source files, ensuring that all developers on a team are using the same
+environments.
+
+Packages exist in two places: a "local" repository cache in the user's home
+directory-- also called the fig-home --and a "remote" repository on a shared
+server. Fig will automatically download packages from the remote repository and
+install them in the fig-home as needed.  Fig does not contact the remote
+repository unless it needs to.  The default fig-home is `$HOME/.fighome`, but
+may be changed by setting the `$FIG_HOME` environment variable.
+
+Full documentation
+==================
+
+https://github.com/mfoemmel/fig/wiki
+
+Community
+=========
+
+\#fig on irc.freenode.net
+
+[Fig Mailing List](http://groups.google.com/group/fig-user)
+
+Copyright
+=========
+
+Copyright (c) 2009-2012 Matthew Foemmel. See LICENSE for details.

data/lib/fig.rb

@@ -1,3 +1,3 @@
 module Fig
-  VERSION = '0.1.69'
+  VERSION = '0.1.71'
 end

data/lib/fig/application_configuration.rb

@@ -2,11 +2,11 @@ module Fig; end
 
 # Configuration for the Fig program, as opposed to a config in a package.
 class Fig::ApplicationConfiguration
-  attr_reader :remote_repository_url
+  attr_accessor :base_whitelisted_url
+  attr_accessor :remote_repository_url
 
-  def initialize(remote_repository_url)
+  def initialize()
     @data = []
-    @remote_repository_url = remote_repository_url
     clear_cached_data
   end
 
@@ -15,8 +15,12 @@ class Fig::ApplicationConfiguration
     whitelist = self['url whitelist']
     if whitelist.nil?
       @whitelist = []
+    elsif @base_whitelisted_url
+      @whitelist = [@base_whitelisted_url, whitelist].flatten
+    elsif whitelist.is_a? Array
+      @whitelist = whitelist
     else
-      @whitelist = [@remote_repository_url, whitelist].flatten
+      @whitelist = [whitelist]
     end
   end
 
@@ -33,12 +37,8 @@ class Fig::ApplicationConfiguration
     @data.push(dataset)
   end
 
-  def unshift_dataset(dataset)
-    @data.unshift(dataset)
-  end
-
-  # after push_dataset or unshift_dataset, call clear_cached, and lazy
-  # initialize as far as the list of things to exclude
+  # After push_dataset, call clear_cached, and lazy initialize as far as the
+  # list of things to exclude
   def clear_cached_data()
     @whitelist = nil
   end

data/lib/fig/command.rb

@@ -60,9 +60,11 @@ class Fig::Command
     if actions.any? {|action| not action.allow_both_descriptor_and_file? }
       ensure_descriptor_and_file_were_not_both_specified()
     end
+    check_package_content_options()
 
     configure()
     set_up_base_package()
+    invoke_post_set_up_actions()
 
     context = ExecutionContext.new(
       @base_package,
@@ -101,6 +103,13 @@ class Fig::Command
     return Fig::Command::Action::EXIT_FAILURE
   end
 
+  # Extension mechanism for customizing Fig.
+  def add_post_set_up_action(action)
+    @post_set_up_actions << action
+
+    return
+  end
+
   def add_publish_listener(listener)
     @publish_listeners << listener
 
@@ -108,6 +117,7 @@ class Fig::Command
   end
 
   def initialize()
+    @post_set_up_actions = []
     @publish_listeners = []
   end
 
@@ -123,17 +133,6 @@ class Fig::Command
       :package_source_description
     )
 
-  def derive_remote_url()
-    if remote_operation_necessary?()
-      if ENV['FIG_REMOTE_URL'].nil?
-        raise Fig::UserInputError.new('Please define the FIG_REMOTE_URL environment variable.')
-      end
-      return ENV['FIG_REMOTE_URL']
-    end
-
-    return nil
-  end
-
   def check_include_statements_versions?()
     return false if @options.suppress_warning_include_statement_missing_version?
 
@@ -176,12 +175,21 @@ class Fig::Command
   def set_up_application_configuration()
     @application_configuration = Fig::FigRC.find(
       @options.figrc(),
-      derive_remote_url(),
+      ENV['FIG_REMOTE_URL'],
       @options.login?,
       @options.home(),
       @options.no_figrc?
     )
 
+    if \
+          remote_operation_necessary? \
+      &&  @application_configuration.remote_repository_url.nil?
+
+      raise Fig::UserInputError.new(
+        'Please define the FIG_REMOTE_URL environment variable.'
+      )
+    end
+
     return
   end
 
@@ -260,6 +268,16 @@ class Fig::Command
     return
   end
 
+  def invoke_post_set_up_actions()
+    @post_set_up_actions.each do
+      |action|
+
+      action.set_up_finished(@application_configuration)
+    end
+
+    return
+  end
+
   def base_config()
     return @options.config()                 ||
            @descriptor && @descriptor.config ||
@@ -330,6 +348,24 @@ class Fig::Command
     return
   end
 
+  def check_package_content_options()
+    statements = @options.package_contents_statements
+    return if statements.empty?
+
+    return if @options.actions.any? \
+      {|action| action.cares_about_package_content_options?}
+
+    statements.each do
+      |statement|
+
+      Fig::Logging.warn(
+        "Ignored #{statement.source_description} for #{statement.url}."
+      )
+    end
+
+    return
+  end
+
   def remote_operation_necessary?()
     return @options.actions.any? {|action| action.remote_operation_necessary?}
   end

data/lib/fig/command/action.rb

@@ -37,6 +37,10 @@ module Fig::Command::Action
     return false
   end
 
+  def cares_about_package_content_options?()
+    return false
+  end
+
   def load_base_package?()
     raise NotImplementedError
   end

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

@@ -0,0 +1,43 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::DumpPackageDefinitionParsed
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--dump-package-definition-parsed>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return false
+  end
+
+  def apply_config?()
+    return false
+  end
+
+  def execute()
+    lines = @execution_context.base_package.statements.map do
+      |statement|
+
+      statement.unparse('')
+    end
+
+    print lines.join("\n").strip
+
+    return EXIT_SUCCESS
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::DumpPackageDefinitionText
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--dump-package-definition-text>
+  end
+
+  def descriptor_requirement()
+    return nil
+  end
+
+  def load_base_package?()
+    return true
+  end
+
+  def register_base_package?()
+    return false
+  end
+
+  def apply_config?()
+    return false
+  end
+
+  def execute()
+    text = @execution_context.base_package.unparsed_text
+    if text
+      puts text.strip # Ensure one and only one ending newline.
+
+      return EXIT_SUCCESS
+    end
+
+    $stderr.puts %q<There's no text for the package.>
+
+    return EXIT_FAILURE
+  end
+end

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

@@ -18,7 +18,7 @@ class Fig::Command::Action::Help
   end
 
   def configure(options)
-    @help_message = options.help_message
+    @help_message = options.short_help_message
   end
 
   def execute()

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

@@ -0,0 +1,29 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::HelpLong
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--help-long>
+  end
+
+  def execute_immediately_after_command_line_parse?
+    return true
+  end
+
+  def configure(options)
+    @help_message = options.full_help_message
+  end
+
+  def execute()
+    puts @help_message
+
+    return EXIT_SUCCESS
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'fig/command/action'
+require 'fig/command/action/role/has_no_sub_action'
+
+module  Fig; end
+class   Fig::Command; end
+module  Fig::Command::Action; end
+
+class Fig::Command::Action::Options
+  include Fig::Command::Action
+  include Fig::Command::Action::Role::HasNoSubAction
+
+  def options()
+    return %w<--options>
+  end
+
+  def execute_immediately_after_command_line_parse?
+    return true
+  end
+
+  def configure(options)
+    @options_message = options.options_message
+  end
+
+  def execute()
+    puts "Fig options:\n\n"
+    puts @options_message
+
+    return EXIT_SUCCESS
+  end
+end