fig 0.1.12 → 0.1.13

data/README.md

@@ -19,6 +19,18 @@ Fig can be installed via rubygems. The gems are hosted at [Gemcutter](http://gem
     $ 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

data/bin/fig

@@ -10,6 +10,7 @@ require 'fig/environment'
 require 'fig/repository'
 require 'fig/os'
 require 'fig/parser'
+require 'fig/windows'
 
 include Fig
 
@@ -118,23 +119,27 @@ end
 
 if input
   package = Parser.new.parse_package(nil, nil, ".", input)
+  direct_retrieves=[]
   if options[:retrieve]
     package.retrieves.each do |var, path|
-      env.add_retrieve(var, path)
+      if var =~ /^@([^\/]+)(.*)/
+        direct_retrieves << [$1, $2, path]
+      else
+        env.add_retrieve(var, path)
+      end
     end
   end
   unless options[:publish] || options[:list]
     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
 
-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])
@@ -154,12 +159,11 @@ elsif options[:echo]
   puts env[options[:echo]]
 elsif shell_command
   argv.shift
-  env.execute_shell(shell_command) { |cmd| shell_exec cmd }
+  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| shell_exec cmd }
+  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| shell_exec cmd }
+  env.execute_config(package, nil, options[:config], nil, argv) { |cmd| os.shell_exec cmd }
 end
-

data/lib/fig/environment.rb

@@ -74,6 +74,12 @@ module Fig
       apply_config(package, config_name || "default")
     end
 
+    def direct_retrieve(package_name, source_path, target_path)
+      package = lookup_package(package_name, nil)
+      FileUtils.mkdir_p(target_path)
+      FileUtils.cp_r(File.join(package.directory, source_path, '.'), target_path)
+    end
+
     private 
 
     def set_variable(base_package, name, value)
@@ -82,7 +88,16 @@ module Fig
 
     def append_variable(base_package, name, value)
       value = expand_value(base_package, name, value)
-      prev = @variables[name]
+      # TODO: converting all environment variables to upcase is not a robust
+      #       comparison. It also assumes all env vars will be in upcase
+      #       in package.fig
+      prev = nil
+      @variables.each do |key, val|
+        if key.upcase == name.upcase
+          name = key
+          prev = val
+        end
+      end
       if prev
         @variables[name] = value + File::PATH_SEPARATOR + prev
       else
@@ -100,7 +115,6 @@ module Fig
       end
     end
 
-
     def lookup_package(package_name, version_name)
       package = @packages[package_name]
       if package.nil?

data/lib/fig/grammar.treetop

@@ -32,7 +32,7 @@ grammar Fig
   end
 
   rule retrieve
-    "retrieve" ws var:[a-zA-Z0-9]+ "->" path:[a-zA-Z0-9/\.-\[\]]+ ws {
+    "retrieve" ws var:[@a-zA-Z0-9/\._]+ "->" path:[a-zA-Z0-9/\.-\[\]]+ ws {
       def to_package_statement
         Retrieve.new(var.text_value, path.text_value)
       end

data/lib/fig/os.rb

@@ -1,6 +1,11 @@
 require 'fileutils'
+# Must specify absolute path of ::Archive when using
+# this module to avoid conflicts with Fig::Package::Archive
+require 'libarchive_ruby'
 require 'uri'
 require 'net/http'
+require 'net/ssh'
+require 'net/sftp'
 require 'tempfile'
 
 module Fig
@@ -80,35 +85,9 @@ module Fig
       when "ssh"
         # TODO need better way to do conditional download
         #       timestamp = `ssh #{uri.user + '@' if uri.user}#{uri.host} "ruby -e 'puts File.mtime(\\"#{uri.path}\\").to_i'"`.to_i
-        out = nil
         timestamp = File.exist?(path) ? File.mtime(path).to_i : 0 
-        tempfile = Tempfile.new("tmp")
-        IO.popen("ssh #{uri.user + '@' if uri.user}#{uri.host} \"fig-download #{timestamp} #{uri.path}\"") do |io|
-          first = true 
-          while bytes = io.read(4096)
-            if first
-              $stderr.puts "downloading #{url}"
-              first = false
-            end
-            tempfile << bytes
-          end
-        end
-        tempfile.close
-        case $?.exitstatus
-        when NOT_MODIFIED
-          tempfile.delete
-          return false
-        when NOT_FOUND
-          tempfile.delete
-          raise "File not found: #{uri}"
-        when SUCCESS
-          FileUtils.mv(tempfile.path, path)
-          return true
-        else
-          tempfile.delete
-          $stderr.puts "Unable to download file: #{$?.exitstatus}"
-          exit 1
-        end
+        cmd = "fig-download #{timestamp} #{uri.path}"
+        ssh_download(uri.user, uri.host, path, cmd)
       else
         raise "Unknown protocol: #{url}"
       end
@@ -126,13 +105,13 @@ module Fig
       download(url, path)
       case basename
       when /\.tar\.gz$/
-        fail unless system "tar -C #{dir} -zxf #{path}"
+        unpack_archive(dir, path)
      when /\.tgz$/
-        fail unless system "tar -C #{dir} -zxf #{path}"
+        unpack_archive(dir, path)
       when /\.tar\.bz2$/
-        fail unless system "tar -C #{dir} -jxf #{path}"       
+        unpack_archive(dir, path)
       when /\.zip$/
-        fail unless system "unzip -q -d #{dir} #{path}"
+        unpack_archive(dir, path)
       else
         raise "Unknown archive type: #{basename}"
       end
@@ -143,9 +122,7 @@ module Fig
       uri = URI.parse(remote_file)
       case uri.scheme
       when "ssh"
-        dir = uri.path[0, uri.path.rindex('/')]
-       cmd = "mkdir -p #{dir} && cat > #{uri.path}"
-        fail unless system "cat #{local_file} | ssh #{uri.user + '@' if uri.user}#{uri.host} '#{cmd}'"
+        ssh_upload(uri.user, uri.host, local_file, remote_file)
       when "ftp"
         #      fail unless system "curl -T #{local_file} --create-dirs --ftp-create-dirs #{remote_file}"
        require 'net/ftp'
@@ -172,8 +149,6 @@ module Fig
           end
           ftp.putbinaryfile(local_file)
         end
-      else
-        fail unless system "curl -p -T #{local_file} --create-dirs --ftp-create-dirs #{remote_file}"
       end
     end
     
@@ -184,16 +159,128 @@ module Fig
 
     def exec(dir,command)
       Dir.chdir(dir) { raise "Command failed" unless system command }
-   end
+    end
     
     def copy(source, target)
       FileUtils.mkdir_p(File.dirname(target))
       FileUtils.copy_file(source, target)
       target
     end
+
+    def move_file(dir, from, to)
+      Dir.chdir(dir) { FileUtils.mv(from, to, :force => true) }
+    end
     
     def log_info(msg)
       puts msg
     end
+
+    # Expects files_to_archive as an Array of filenames.
+    def create_archive(archive_name, files_to_archive)
+      # TODO: Need to verify files_to_archive exists.
+      ::Archive.write_open_filename(archive_name, ::Archive::COMPRESSION_GZIP, ::Archive::FORMAT_TAR) do |ar|
+        files_to_archive.each do |fn|
+          ar.new_entry do |entry|
+            entry.copy_stat(fn)
+            entry.pathname = fn
+            ar.write_header(entry)
+            if !entry.directory?
+              ar.write_data(open(fn) {|f| f.read })
+            end
+          end
+        end
+      end
+    end
+
+    # This method can handle the following archive types:
+    # .tar.bz2
+    # .tar.gz
+    # .tgz
+    # .zip
+    def unpack_archive(dir, file)
+      Dir.chdir(dir) do
+        ::Archive.read_open_filename(file) do |ar|
+          while entry = ar.next_header
+            ar.extract(entry)
+          end
+        end
+      end
+    end
+
+    def self.windows?
+      Config::CONFIG['host_os'] =~ /mswin/
+    end
+
+    def self.unix?
+      !windows?
+    end
+
+    def shell_exec(cmd)
+      if OS.windows?
+        Windows.shell_exec_windows(cmd)
+      else
+        shell_exec_unix(cmd)
+      end
+    end
+
+    private
+
+    def shell_exec_unix(cmd)
+      Kernel.exec(ENV['SHELL'], '-c', cmd.join(' '))
+    end
+
+    def shell_exec_windows(cmd)
+      #command = ["C:/WINDOWS/system32/cmd.exe", "/C", "call"] + cmd
+      command = ["cmd.exe", "/C"] + cmd
+      command = command.join(' ')
+      Kernel.exec(command)
+    end
+
+    # path = The local path the file should be downloaded to.
+    # cmd = The command to be run on the remote host.
+    def ssh_download(user, host, path, cmd)
+      return_code = nil
+      tempfile = Tempfile.new("tmp")
+      Net::SSH.start(host, user) do |ssh|
+        ssh.open_channel do |channel|
+          channel.exec(cmd)
+          channel.on_data() { |ch, data| tempfile << data }
+          channel.on_extended_data() { |ch, type, data| $stderr.puts "SSH Download ERROR: #{data}" }
+          channel.on_request("exit-status") { |ch, request|
+            return_code = request.read_long
+          }
+        end
+      end
+
+      tempfile.close()
+
+      case return_code
+      when NOT_MODIFIED
+        tempfile.delete
+        return false
+      when NOT_FOUND
+        tempfile.delete
+        raise "File not found: #{uri}"
+      when SUCCESS
+        FileUtils.mv(tempfile.path, path)
+        return true
+      else
+        tempfile.delete
+        $stderr.puts "Unable to download file: #{return_code}"
+        exit 1
+      end
+    end
+
+    def ssh_upload(user, host, local_file, remote_file)
+      uri = URI.parse(remote_file)
+      dir = uri.path[0, uri.path.rindex('/')]
+      Net::SSH.start(host, user) do |ssh|
+        ssh.exec!("mkdir -p #{dir}")
+      end
+      Net::SFTP.start(host, user) do |sftp|
+        sftp.upload!(local_file, uri.path)
+      end
+    end
+
   end
 end

data/lib/fig/repository.rb

@@ -86,7 +86,7 @@ module Fig
       end
       if resources.size > 0
         file = "resources.tar.gz"
-        file unless system "tar -zcf #{file} #{resources.join(' ')}"
+        @os.create_archive(file, resources.join(' '))
         new_package_statements.unshift(Archive.new(file))
         at_exit { File.delete(file) }
       end
@@ -179,7 +179,7 @@ module Fig
         @os.clear_directory(local_dir)
         # some packages contain no files, only a fig file.
         if not (package.archive_urls.empty? && package.resource_urls.empty?)
-          @os.exec(temp_dir, "mv * #{local_dir}/")
+          FileUtils.mv(Dir.glob(File.join(temp_dir, "*")), local_dir)
         end
         write_local_package(package_name, version_name, package)
       rescue

data/lib/fig/windows.rb

@@ -0,0 +1,46 @@
+# Keeping Windows-specific implementation details here.
+
+require 'erb'
+require 'fileutils'
+
+# I don't know how to set environment variables so that a sub-shell will
+# be able to use them.  Therefore, I'm punting, and creating a batch script
+# on the fly to run a user supplied command.
+
+module Fig
+  class Windows
+
+    BATCH_SCRIPT_TEMPLATE = <<EOF
+@echo off
+% ENV.each do |k,v|
+set <%= k %>=<%= v %>
+% end
+
+cmd /C <%= command %>
+EOF
+
+
+    def self.with_generated_batch_script(cmd)
+      command = cmd.join(' ')
+      template = ERB.new(BATCH_SCRIPT_TEMPLATE, 0, "%")
+      output = template.result(binding)
+      begin
+        tf = File.new("C:/tmp/fig_command.bat", "w")
+        FileUtils.chmod(0755, tf.path)
+        File.open(tf.path, "w") do |fh|
+          fh.puts output
+        end
+        tf.close
+        yield tf.path
+      ensure
+#        tf.delete
+      end
+    end
+
+    def self.shell_exec_windows(cmd)
+      with_generated_batch_script(cmd) do |f|
+        Kernel.exec(f)
+      end
+    end
+  end
+end

data/spec/fig_spec.rb

@@ -1,17 +1,34 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'rubygems'
-require 'open4'
+require 'fig/os'
 require 'fileutils'
 
+class Popen
+  if Fig::OS.windows?
+    require 'win32/open3'
+    def self.popen(*cmd)
+      Open3.popen3(*cmd) { |stdin,stdout,stderr|
+        yield stdin, stdout, stderr
+      }
+    end
+  else
+    require 'open4'
+    def self.popen(*cmd)
+      Open4::popen4(*cmd) { |pid, stdin, stdout, stderr|
+        yield stdin, stdout, stderr
+      }
+    end
+  end
+end
+
 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']
+ENV['FIG_REMOTE_URL'] = "ssh://#{ENV['USER']}@localhost#{FIG_REMOTE_DIR}"
 
 FIG_EXE = File.expand_path(File.dirname(__FILE__) + '/../bin/fig')
 
@@ -19,7 +36,7 @@ def fig(args, input=nil)
   args = "--file - #{args}" if input
   out = nil
   err = nil
-  status = Open4::popen4("#{FIG_EXE} #{args}") do |pid, stdin, stdout, stderr|
+  Popen.popen("#{FIG_EXE} #{args}") do |stdin, stdout, stderr|
     if input
       stdin.puts input
       stdin.close

data/spec/win_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'fig/os'
+require 'fig/windows'
+
+
+# Only run on Windows...
+if Fig::OS.windows?
+  describe "Fig on Windows" do
+    it "batch script should exist" do
+      Fig::Windows.with_generated_batch_script(["echo", "Hello World"]) do |filename|
+        File.exist?(filename).should == true
+      end
+    end
+
+    it "batch script should say 'Hello World' when executed" do
+      Fig::Windows.with_generated_batch_script(["echo", "Hello World"]) do |filename|
+        %x[#{filename}].should == "Hello World\n"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fig
 version: !ruby/object:Gem::Version 
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors: 
 - Matthew Foemmel
@@ -9,9 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-09 00:00:00 +00:00
+date: 2010-02-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libarchive
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.15
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: polyglot
   type: :runtime
@@ -73,6 +103,7 @@ files:
 - lib/fig/package.rb
 - lib/fig/parser.rb
 - lib/fig/repository.rb
+- lib/fig/windows.rb
 - LICENSE
 - README.md
 has_rdoc: true
@@ -104,5 +135,6 @@ signing_key:
 specification_version: 3
 summary: Fig is a utility for configuring environments and managing dependencies across a team of developers..
 test_files: 
-- spec/spec_helper.rb
 - spec/fig_spec.rb
+- spec/spec_helper.rb
+- spec/win_spec.rb