fig 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,66 @@
+Description
+===========
+
+Fig is a utility for dynamically assembling an environment from a set of packages. Shell commands can then be executed in that package, after which the environment goes away. The caller's environment is never affected.
+
+If fig, an "environment" is just a set of environment variables. A "package" is a collection of files, plus some metadata describing how the environment should be modified when the package is included. For example, a package containing an executable might specify that its "bin" directory be appended to the PATH environment variable. A package containing a Java library might specify that its jar files should be added to the CLASSPATH. Etc.
+
+Packages exist in two places: a "local" repository in the user's home directory, and a "remote" repository that is shared by a team. Fig will automatically download packages from the remote repository and install them in the local repository, when needed. In this sense, fig is a lot like other dependency management tools such as Apache Ivy and Debian APT. Unlike those tools, however, fig is meant to be lightweight, platform agnostic, and language agnostic.
+
+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
+
+Then you can install fig:
+
+     $ gem install fig
+
+Usage
+=====
+
+Fig recognizes the following options:
+
+### 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   
+
+Copyright
+=========
+
+Copyright (c) 2009 Matthew Foemmel. See LICENSE for details.

data/bin/fig

@@ -23,8 +23,8 @@ end
 
 ARGV.each_with_index do |arg, i|
   if arg == "-"
-    $stderr.puts "Use of single dash (-) is deprecated. Use double dash (--) instead"
-    exit 1 
+#    $stderr.puts "Use of single dash (-) is deprecated. Use double dash (--) instead"
+#    exit 1 
   elsif arg == "--"
     ARGV[i] = "-"
   end
@@ -54,12 +54,11 @@ if options[:publish]
 end
 
 os = OS.new
-repos = Repository.new(os, File.expand_path("~/.fighome/repos"), remote_url, remote_user)
+repos = Repository.new(os, File.expand_path(File.join(options[:home], 'repos')), remote_url, remote_user)
 env = Environment.new(os, repos, vars)
 
 options[:includes].each do |descriptor|
   package_name, config_name, version_name = parse_descriptor(descriptor)
-  puts "Package: #{package_name}, config_name: #{config_name}, Version: #{version_name}"
   env.include_config(nil, package_name, config_name, version_name)
 end
 
@@ -71,8 +70,24 @@ options[:appends].each do |name_val|
   env.append_variable(nil, name_val[0], name_val[1]) 
 end
 
-if os.exist?("./.fig")
-  package = Parser.new.parse_package(nil, nil, ".", os.read("./.fig"))
+DEFAULT_FIG_FILE = '.fig'
+
+input = nil
+if 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
+
+if input
+  package = Parser.new.parse_package(nil, nil, ".", input)
   if options[:retrieve]
     package.retrieves.each do |var, path|
       env.add_retrieve(var, path)
@@ -86,10 +101,6 @@ else
   package = Package.new(nil, nil, ".", [])
 end
 
-if options[:echo]
-  puts env[options[:echo]]
-end
-
 if options[:list]
   repos.list_packages.sort.each do |item|
     puts item
@@ -102,7 +113,10 @@ if options[:publish]
   if package_name.nil? || version_name.nil?
     raise "Please specify a package name and a version name"
   end
+  fail if package.publish_statements.empty?
   repos.publish_package(package.publish_statements, package_name, version_name)
+elsif options[:echo]
+  puts env[options[:echo]]
 elsif argv[0] == "-"
   argv.shift
   env.execute_shell(argv) { |cmd| exec cmd.join(' ') }

data/lib/fig/options.rb

@@ -39,6 +39,9 @@ module Fig
       options[:appends] = []
       opts.on('-p', '--append VAR=VAL', 'append environment variable') { |var_val| options[:appends] << var_val.split('=') }
 
+      options[:input] = nil
+      opts.on('--input FILE', 'fig file to read (use - for stdin)') { |path| options[:input] = path }
+
       options[:home] = ENV['FIG_HOME'] || File.expand_path("~/.fighome")
     end
 

data/lib/fig/os.rb

@@ -47,6 +47,9 @@ module Fig
            file.write(block)
          end
        end
+     when "ssh"
+       puts "downloading #{url}"
+       fail unless system "ssh #{uri.user + '@' if uri.user}#{uri.host} cat #{uri.path} > #{path}"
      else
        raise "Unknown protocol: #{url}"
      end
@@ -77,8 +80,16 @@ module Fig
    end
 
    def upload(local_file, remote_file, user)
-     puts "uploading #{remote_file}"
+     puts "uploading #{local_file} to #{remote_file}"
+     uri = URI.parse(remote_file)
+     if uri.scheme == "ssh"
+       dir = uri.path[0, uri.path.rindex('/')]
+       cmd = "mkdir -p #{dir} && cat > #{uri.path}"
+       puts local_file
+       fail unless system "cat #{local_file} | ssh #{uri.user + '@' if uri.user}#{uri.host} '#{cmd}'"
+     else
        fail unless system "curl -p -T #{local_file} --create-dirs --ftp-create-dirs #{remote_file}"
+     end
    end
 
    def clear_directory(dir)

data/lib/fig/parser.rb

@@ -17,9 +17,9 @@ module Fig
       result.to_package(package_name, version_name, directory)
     end
 
-    def parse_descriptor(descriptor)
-      puts @parser.methods.sort
-    end
+#    def parse_descriptor(descriptor)
+#      puts @parser.methods.sort
+#    end
   end
 
 end

data/spec/fig_spec.rb

@@ -1,7 +1,67 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+require 'open3'
+require 'fileutils'
+
+FIG_HOME = File.expand_path(File.dirname(__FILE__) + '/../tmp/fighome')
+FileUtils.mkdir_p(FIG_HOME)
+ENV['FIG_HOME'] = FIG_HOME
+
+FIG_REMOTE_DIR = File.expand_path(File.dirname(__FILE__) + '/../tmp/remote')
+FileUtils.mkdir_p(FIG_REMOTE_DIR)
+ENV['FIG_REMOTE_URL'] = "ssh://localhost#{FIG_REMOTE_DIR}"
+puts ENV['FIG_REMOTE_URL']
+
+def fig(args, input=nil)
+  stdin, stdout, stderr = Open3.popen3("fig #{args}")
+  if input
+    stdin.puts input
+    stdin.close
+  end
+  return stdout.read.strip, stderr.read.strip
+end
+
 describe "Fig" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  it "set environment variable from command line" do
+    fig('-s FOO=BAR -g FOO')[0].should == 'BAR'
+    fig('--set FOO=BAR -g FOO')[0].should == 'BAR'
+  end
+
+  it "set environment variable from fig file" do
+    input = <<-END
+      config default
+        set FOO=BAR
+      end
+    END
+    fig('--input - -g FOO', input)[0].should == 'BAR'
+  end
+
+  it "append environment variable from command line" do
+    fig('-p PATH=foo -g PATH').should == ["#{ENV['PATH']}#{File::PATH_SEPARATOR}foo",""]
+  end
+
+  it "append environment variable from fig file" do
+    input = <<-END
+      config default
+        append PATH=foo
+      end
+    END
+    fig('--input - -g PATH', input).should == ["#{ENV['PATH']}#{File::PATH_SEPARATOR}foo",""]
+  end
+
+  it "append empty environment variable" do
+    fig('-p XYZZY=foo -g XYZZY').should == ["foo",""]
+  end
+
+  it "publish to remote repository" do
+    input = <<-END
+      publish
+        config default
+          set FOO=BAR
+        end
+      end
+    END
+    puts fig('--input - --publish foo/1.2.3', input)
+    fig('-i foo/1.2.3 -g FOO').should == ['BAR','']
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fig
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Matthew Foemmel
@@ -54,7 +54,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - bin/fig
 - lib/fig.rb
@@ -66,7 +66,7 @@ files:
 - lib/fig/parser.rb
 - lib/fig/repository.rb
 - LICENSE
-- README.rdoc
+- README.md
 has_rdoc: true
 homepage: http://github.com/mfoemmel/fig
 licenses: []

data/README.rdoc

@@ -1,17 +0,0 @@
-= fig
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Matthew Foemmel. See LICENSE for details.