fig 0.1.1 → 0.1.2

data/README.md

@@ -22,7 +22,7 @@ Then you can install fig:
 Usage
 =====
 
-Fig recognizes the following options:
+Fig recognizes the following options (not all are implemented yet):
 
 ### Flags ###
 
@@ -60,6 +60,83 @@ Fig also supports the following options, which don't require a fig environment.
     --publish-local  Install package in local repository only
     --list           List the packages installed in local repository   
 
+Examples
+========
+
+Fig lets you modify environment variables three ways:
+
+* From the command line
+* From a ".fig" file in the current directory
+* From packages loaded 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 newly created environment. We'll set the "PLANET" variable to "NEPTUNE", then run "echo $PLANET" to ensure that the variable was updated:
+
+    $ 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 is never 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, 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 bin -- hello
+    Hello, World
+
+### Fig Files ###
+
+You can also specify environment modifiers in files. Fig looks for a file called ".fig" in the current directory, and automatically processes it. So we can implement the previous example by creating a ".fig" file that looks like:
+        
+    config default
+      set GREETING=Hello
+      append PATH=bin
+    end
+    
+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 you'll need to do is specify the location of your 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/<path to home dir>/figremote
+
+...TODO...
+
+Community
+=========
+
+\#fig on irc.freenode.net
+
+[Fig Mailing List](http://groups.google.com/group/fig-user)
+
 Copyright
 =========
 

data/bin/fig

@@ -107,6 +107,10 @@ if options[:list]
   end
 end
 
+def shell_exec(cmd)
+  exec(ENV['SHELL'], '-c', cmd.join(' '))
+end
+
 if options[:publish]
   raise "Unexpected arguments: #{argv.join(' ')}" if !argv.empty?
   package_name, config_name, version_name = parse_descriptor(options[:publish])
@@ -119,11 +123,11 @@ elsif options[:echo]
   puts env[options[:echo]]
 elsif argv[0] == "-"
   argv.shift
-  env.execute_shell(argv) { |cmd| exec cmd.join(' ') }
+  env.execute_shell(argv) { |cmd| 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) { |cmd| exec((cmd + argv).join(' ')) }
+  env.execute_config(package, package_name, config_name, nil) { |cmd| shell_exec cmd }
 else
-  env.execute_config(package, nil, options[:config], nil) { |cmd| exec((cmd + argv).join(' ')) }
+  env.execute_config(package, nil, options[:config], nil) { |cmd| shell_exec cmd }
 end

data/lib/fig/os.rb

@@ -85,7 +85,6 @@ module Fig
      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}"

data/spec/fig_spec.rb

@@ -12,8 +12,11 @@ FileUtils.mkdir_p(FIG_REMOTE_DIR)
 ENV['FIG_REMOTE_URL'] = "ssh://localhost#{FIG_REMOTE_DIR}"
 puts ENV['FIG_REMOTE_URL']
 
+FIG_EXE = File.expand_path(File.dirname(__FILE__) + '/../bin/fig')
+
 def fig(args, input=nil)
-  stdin, stdout, stderr = Open3.popen3("fig #{args}")
+  args = "--input - #{args}" if input
+  stdin, stdout, stderr = Open3.popen3("#{FIG_EXE} #{args}")
   if input
     stdin.puts input
     stdin.close
@@ -33,7 +36,7 @@ describe "Fig" do
         set FOO=BAR
       end
     END
-    fig('--input - -g FOO', input)[0].should == 'BAR'
+    fig('-g FOO', input)[0].should == 'BAR'
   end
 
   it "append environment variable from command line" do
@@ -46,7 +49,7 @@ describe "Fig" do
         append PATH=foo
       end
     END
-    fig('--input - -g PATH', input).should == ["#{ENV['PATH']}#{File::PATH_SEPARATOR}foo",""]
+    fig('-g PATH', input).should == ["#{ENV['PATH']}#{File::PATH_SEPARATOR}foo",""]
   end
 
   it "append empty environment variable" do
@@ -61,7 +64,7 @@ describe "Fig" do
         end
       end
     END
-    puts fig('--input - --publish foo/1.2.3', input)
+    puts fig('--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.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Matthew Foemmel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-29 00:00:00 -06:00
+date: 2009-12-30 00:00:00 -06:00
 default_executable: fig
 dependencies: 
 - !ruby/object:Gem::Dependency