fig 0.1.24-universal-darwin9.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009, 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,215 @@
+Description
+===========
+
+Fig is a utility for configuring environments and managing dependencies across a team of developers. You give it a list of packages and a shell command to run; it creates an environment that includes those packages, then executes the shell command in it (the caller's environment is not affected). 
+
+An "environment" in fig is just a set of environment variables. A "package" is a collection of files, plus some metadata describing what environment variables should be modified when the package is included. 
+
+Developers can use package 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. This ensures that all developers on a team are using the same environemnts. 
+
+Packages exist in two places: a "local" repository in the user's home directory, and a "remote" repository on a server somewhere that is shared by a team. Fig will automatically download packages from the remote repository and install them in the local repository, when needed. 
+
+Fig is similar to a lot of other package/dependnency managment tools. In particular, it steals a lot of ideas from Apache Ivy and Debian APT. However, unlike Ivy, fig is meant to be lightweight (no XML, no JVM startup time), language agnostic (Java doesn't get preferential treatment), and work with executables as well as libraries. And unlike APT, fig is meant to be cross platform (Windows support is coming) and project-oriented.
+
+Installation
+============
+
+Fig can be installed via rubygems. The gems are hosted at [Gemcutter](http://gemcutter.org), so you'll need to set that up first:
+
+    $ gem install gemcutter
+    $ gem tumble
+
+Fig also depends on a third-party library named, [libarchive](http://libarchive.rubyforge.org/). Libarchive is easily available 
+via most package management systems on Linux, FreeBSD, and OS X.  Libarchive versions greater than 2.6.0 are preferred.  If you are on Windows, the gem will install the libarchive binaries for you.
+
+    [Linux - Debian / Ubuntu]
+    apt-get libarchive-dev
+
+    [Linux - Red Hat / CentOS]
+    yum install libarchive-devel
+
+    [OS X - MacPorts]
+    port install libarchive
+
+Then you can install fig:
+
+     $ gem install fig
+
+Usage
+=====
+
+Fig recognizes the following options (not all are implemented yet):
+
+### Flags ###
+
+    -d, --debug   Print debug info
+        --force   Download/install packages from remote repository, even if up-to-date
+    -u, --update  Download/install packages from remote repository, if out-of-date
+    -n, --no      Automatically answer "n" for any prompt (batch mode)
+    -y, --yes     Automatically answer "y" for any prompt (batch mode)
+
+
+### Environment Modifiers ###
+
+The following otpions modify the environment generated by fig:
+
+    -i, --include DESCRIPTOR  Include package in environment (recursive)
+    -p, --append  VAR=VALUE   Append value to environment variable using platform-specific separator
+    -s, --set     VAR=VALUE   Set environment variable
+
+### Environment Commands ###
+
+The following commands will be run in the environment created by fig:
+
+    -b, --bash                Print bash commands so user's environment can be updated (usually used with 'eval')
+    -g, --get     VARIABLE    Get value of environment variable
+    -x, --execute DESCRIPTOR  Execute command associated with specified configuration
+
+    -- COMMAND [ARGS...]      Execute arbitrary shell command
+
+### Other Commands ###
+
+Fig also supports the following options, which don't require a fig environment. Any modifiers will be ignored:
+
+    -?, -h, --help   Display this help text
+    --publish        Upload package to the remote repository (also installs in local repository)
+    --publish-local  Install package in local repository only
+    --list           List the packages installed in local repository   
+
+Examples
+========
+
+Fig lets you configure environments three different ways:
+
+* From the command line
+* From a "package.fig" file in the current directory
+* From packages included indirectly via one of the previous two methods
+
+### Command Line ###
+
+So to get started, let's trying defining an environment variable via the command line and executing a command in the newenvironment. We'll set the "GREETING" variable to "Hello", then run a command that uses that variable:
+
+    $ fig -s GREETING=Hello -- echo "\$GREETING, World"
+    Hello, World
+
+Note that you need to put a slash before the dollar sign, otherwise the shell will evaluate the environment variable before it ever gets to fig.
+
+Also note that when running fig, the original environment isn't affected:
+
+     $ echo $GREETING
+     <nothing>
+
+Fig also lets you append environment variables, using the system-specified path separator (e.g. colon on unix, semicolon on windows). This is useful for adding directories to the PATH, LD_LIBRARY_PATH, CLASSPATH, etc. For example, let's create a "bin" directory, add a shell script to it, then include it in the PATH:
+
+    $ mkdir bin
+    $ echo "echo \$GREETING, World" > bin/hello
+    $ chmod +x bin/hello
+    $ fig -s GREETING=Hello -p PATH=bin -- hello
+    Hello, World
+
+### Fig Files ###
+
+You can also specify environment modifiers in files. Fig looks for a file called "package.fig" in the current directory, and automatically processes it. So we can implement the previous example by creating a "package.fig" file that looks like:
+        
+    config default
+      set GREETING=Hello
+      append PATH=@/bin
+    end
+    
+The '@' symbol represents the directory that the "package.fig" file is in (this example would still work if we just used "bin", but later on when we publish our project to the shared repository we'll definitely need the '@'). Then we can just run:
+
+    $ fig -- hello
+    Hello, World
+
+A single fig file can have multiple configurations:
+
+    config default 
+      set GREETING=Hello
+      append PATH=@/bin
+    end
+
+    config french
+      set GREETING=Bonjour
+      append PATH=@/bin
+    end
+
+Configurations other than "default" can be specified using the "-c" option:
+
+    $ fig -c french -- hello
+    Bonjour, World
+     
+### Packages ###
+
+Now let's say we want to share our little script with the rest of the team by bundling it into a package. The first thing we need to do is specify the location of the remote repository by defining the FIG_REMOTE_URL environment variable. If you just want to play around with fig, you can have it point to localhost:
+
+   $ export FIG_REMOTE_URL=ssh://localhost`pwd`/remote
+
+Before we publish our package, we'll need to tell fig which files we want to include. We do this by using the "resource" statement in our "package.fig" file:
+
+    resource bin/hello
+
+    config default...
+
+Now we can share the package with the rest of the team by using the "--publish" option:
+
+    $ fig --publish hello/1.0.0
+
+The "hello/1.0.0" string represents the name of the package and the version number. Once the package has been published, we can include it in other environments by using the "-i" or "--include" option (I'm going to move the "package.fig" file out of the way first, so that fig doesn't automatically process it.):
+
+    $ mv package.fig package.bak
+    $ fig -u -i hello/1.0.0 -- hello
+    ...downloading files...
+    Hello, World
+		
+The "-u" (or "--update") option tells fig to check the remote repository for packages if they aren't already installed locally (fig will never make any network connections unless this option is specified). Once the packages are downloaded, we can run the same command without the "-u" option:
+
+    $ fig -i hello/1.0.0 -- hello
+    Hello, World
+
+Also, when including a package, you can specify a particular configuration by appending it to the package name using a colon:
+
+    $ fig -i hello/1.0.0:french -- hello
+    Bonjour, World
+
+### Retrieves ###
+
+By default, the resources associated with a package live in the fig home directory, which defaults to "~/.fighome". This doesn't always play nicely with IDE's however, so fig gives you a way to copy resources from the repository to the current directory. To do this you add "retrieve" statements to your "package.fig" file.
+
+For example, let's create a package that contains a library for the "foo" programming language. First we'll define a "package.fig" file:
+
+    config default
+      append FOOPATH=lib/hello.foo
+    end
+
+Then:
+
+    $ mkdir lib
+    $ echo "print 'hello'" > lib/hello.foo
+    $ fig --publish hello-lib/3.2.1    
+
+Now we'll move to a different directory (or delete the current "package.fig" file) and create a new "package.fig" file:
+
+    retrieve FOOPATH->lib/[package]
+    config default
+      include hello-lib/3.2.1
+    end
+
+When we do an update, all resources in the FOOPATH will be copied into the lib directory, into a subdirectory that matches the package name:
+
+     $ fig -u
+     ...downloading...
+     ...retrieving...
+     $ cat lib/hello-lib/hello.foo
+     print 'hello'
+
+Community
+=========
+
+\#fig on irc.freenode.net
+
+[Fig Mailing List](http://groups.google.com/group/fig-user)
+
+Copyright
+=========
+
+Copyright (c) 2009 Matthew Foemmel. See LICENSE for details.

data/bin/fig

@@ -0,0 +1,187 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rubygems'
+require 'net/ftp'
+
+require 'fig/options'
+require 'fig/environment'
+require 'fig/repository'
+require 'fig/os'
+require 'fig/parser'
+require 'fig/windows'
+
+include Fig
+
+def parse_descriptor(descriptor)
+  # todo should use treetop for these:
+  package_name = descriptor =~ /^([^:\/]+)/ ? $1 : nil
+  config_name = descriptor =~ /:([^:\/]+)/ ? $1 : nil
+  version_name = descriptor =~ /\/([^:\/]+)/ ? $1 : nil  
+  return package_name, config_name, version_name
+end
+
+shell_command = nil
+ARGV.each_with_index do |arg, i|
+  if arg == "-"
+#    $stderr.puts "Use of single dash (-) is deprecated. Use double dash (--) instead"
+#    exit 1 
+  elsif arg == "--"
+    shell_command = ARGV[(i+1)..-1]
+    ARGV.slice!(i..-1)
+    break
+  end
+end
+
+options, argv = parse_options(ARGV)
+
+vars = {}
+ENV.each {|key,value| vars[key]=value }
+
+remote_url = nil
+if options[:update] || options[:publish] || options[:update_if_missing] || options[:list_remote]
+  remote_url = ENV['FIG_REMOTE_URL']
+  if remote_url.nil?
+    $stderr.puts "Please define the FIG_REMOTE_URL environment variable" 
+    exit 1
+  end
+end
+
+remote_user = nil
+if options[:publish]
+#  remote_user = ENV['FIG_REMOTE_USER']
+#  if remote_user.nil?
+#    $stderr.puts "Please define the FIG_REMOTE_USER environment variable" 
+#    exit 1
+#  end
+end
+
+os = OS.new
+repos = Repository.new(os, File.expand_path(File.join(options[:home], 'repos')), remote_url, remote_user, options[:update], options[:update_if_missing])
+env = Environment.new(os, repos, vars)
+
+options[:modifiers].each do |modifier|
+  env.apply_config_statement(nil, modifier)
+end
+
+if File.exist?(".fig")
+  $stderr.puts "The '.fig' file is deprecated. Please rename to 'package.fig'"
+  exit 1
+end
+
+DEFAULT_FIG_FILE = 'package.fig'
+
+input = nil
+if options[:input] == :none
+  # ignore
+elsif options[:input] == '-'
+  input = $stdin.read
+elsif options[:input].nil?
+  input = os.read(DEFAULT_FIG_FILE) if os.exist?(DEFAULT_FIG_FILE)
+else
+  if os.exist?(options[:input])
+    input = os.read(options[:input])
+  else
+    $stderr.puts "File not found: #{options[:input]}"
+    exit 1
+  end
+end
+
+options[:cleans].each do |descriptor|
+  package_name, version_name = descriptor.split('/')
+  repos.clean(package_name, version_name)    
+end
+
+if options[:list]
+  repos.list_packages.sort.each do |item|
+    puts item
+  end
+  exit 0
+end
+
+if options[:list_remote]
+  repos.list_remote_packages.sort.each do |item|
+    puts item
+  end
+  exit 0
+end
+
+if not options[:list_configs].empty?
+  options[:list_configs].each do |descriptor|
+    package_name, version_name = descriptor.split('/')
+    repos.read_local_package(package_name, version_name).configs.each do |config|
+      puts config.name
+    end
+  end
+  exit 0
+end
+
+if input
+  package = Parser.new.parse_package(nil, nil, ".", input)
+  direct_retrieves=[]
+  if options[:retrieve]
+    package.retrieves.each do |var, path|
+      if var =~ /^@([^\/]+)(.*)/
+        direct_retrieves << [$1, $2, path]
+      else
+        env.add_retrieve(var, path)
+      end
+    end
+  end
+  unless options[:publish] || options[:list] || options[:publish_local]
+    env.register_package(package)
+    env.apply_config(package, options[:config])
+    direct_retrieves.each do |info|
+      env.direct_retrieve(info[0], info[1], info[2])
+    end
+  end
+else
+  package = Package.new(nil, nil, ".", [])
+end
+
+if options[:publish] || options[:publish_local]
+  if !argv.empty?
+    puts "Unexpected arguments: #{argv.join(' ')}"
+    exit 10
+  end
+  package_name, config_name, version_name = parse_descriptor(options[:publish] || options[:publish_local])
+  if package_name.nil? || version_name.nil?
+    puts "Please specify a package name and a version name"
+    exit 10
+  end
+  if not options[:modifiers].empty?
+    publish_statements = options[:resources] + options[:archives] + [Configuration.new("default", options[:modifiers])]
+    publish_statements << Publish.new("default","default")
+  elsif not package.statements.empty?
+    publish_statements = package.statements
+  else
+    puts "Nothing to publish"
+    exit 1
+  end
+  if options[:publish]
+    puts "Checking status of #{package_name}/#{version_name}..."
+    if repos.list_remote_packages.include?("#{package_name}/#{version_name}") 
+      puts "#{package_name}/#{version_name} has already been published"
+      if not options[:force]
+        puts "Use the --force option if you really want to overwrite, or us --publish-local for testing"
+        exit 1
+      else
+        puts "Overwriting..."
+      end
+    end
+  end
+  puts "Publishing #{package_name}/#{version_name}"
+  repos.publish_package(publish_statements, package_name, version_name, options[:publish_local])
+elsif options[:echo]
+  puts env[options[:echo]]
+elsif shell_command
+  argv.shift
+  env.execute_shell(shell_command) { |cmd| os.shell_exec cmd }
+elsif argv[0]
+  package_name, config_name, version_name = parse_descriptor(argv.shift)
+  env.include_config(package, package_name, config_name, version_name)
+  env.execute_config(package, package_name, config_name, nil, argv) { |cmd| os.shell_exec cmd }
+elsif input
+  env.execute_config(package, nil, options[:config], nil, argv) { |cmd| os.shell_exec cmd }
+end

data/bin/fig-download

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# todo copied from os.rb
+NOT_MODIFIED = 3
+NOT_FOUND = 4
+SUCCESS = 0
+
+timestamp = ARGV[0].to_i
+path = ARGV[1]
+
+exit NOT_FOUND unless File.exist?(path)
+exit NOT_MODIFIED if File.mtime(path).to_i <= timestamp
+
+File.open(path) do |file|
+  while bytes = file.read(4096) do
+    $stdout.write(bytes)
+  end
+end
+
+exit SUCCESS