pmsrb 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.0.1 2008-04-14
+
+* 3 major enhancements:
+  * Downloading
+  * Extracting
+  * Uploading

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/pmsrb.rb
+lib/pmsrb/platform.rb
+lib/pmsrb/progressbar.rb
+lib/pmsrb/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/pmsrb_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,73 @@
+= pmsrb
+
+http://pmsrb.rubyforge.org
+
+== DESCRIPTION:
+
+pmsrb is a binary (p)ackage (m)anagement (s)ystem meant for gracefully handling the differences in binary distribution on different platforms.  This is useful when you rely on a large C/C++ library and would like to distribute the binaries in a cross-platform way.
+
+For example different linux distros use RPM, deb, etc.  OSX often needs to compile an xcode project to install a binary.  Windows is actually much cleaner in this occasion.
+
+We could rely on the user installing these binary packages, but often times problems arise when someone installs version 1.4.6 by mistake, and your bindings are built against 1.4.7.
+
+On top of this there are sometimes issues you need to hack around when using swig on source libraries.  That means that the binaries you distribute may be different than the ones that are publicly available.
+
+This library handles all these edge cases, and automates maintenance on upgrading, platform support, etc.
+
+== FEATURES/PROBLEMS:
+
+There are no problems whatsoever.  But let me know if you find some.
+
+PMS supports: 
+ *downloading from ftp/http 
+ *uploading via scp,ftp
+ *extracting to .tgz, .zip
+ *archiving to .tgz, .zip
+ *building(via shell commands)
+ *delicious low fat Platform
+
+== SYNOPSIS:
+
+    PMS::vendor do
+      working_directory File.dirname(__FILE__)+"/tmp"
+      if Platform.windows?
+        download "http://bullet.googlecode.com/files/bullet-#{Bulletrb::VERSION::VENDOR}.zip"
+      else
+        download "http://bullet.googlecode.com/files/bullet-#{Bulletrb::VERSION::VENDOR}.tgz"
+      end
+      extract
+      build "./configure", "jam" if Platform.linux? || Platform.mac?
+    end
+
+== REQUIREMENTS:
+
+Windows, Mac, or Linux.  Ruby 1.8.
+
+== INSTALL:
+
+sudo gem install pmsrb
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'pmsrb/version'
+
+AUTHOR = ['Martyn Garcia', 'Mikkel Garcia']  # can also be an array of Authors
+EMAIL = ""
+DESCRIPTION = "pmsrb is a binary (p)ackage (m)anagement (s)ystem meant for gracefully handling the differences in binary distribution on different platforms."
+GEM_NAME = 'pmsrb' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'pmsrb' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Pmsrb::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'pmsrb documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  
+  # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [['archive-tar-minitar', '>= 0.5.2'],
+                  ['rubyzip', '>= 0.9.1']]   
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'pmsrb'

data/lib/pmsrb.rb

@@ -0,0 +1,310 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'pmsrb/platform'
+require 'pmsrb/progressbar'
+
+require 'net/ftp'
+require 'open-uri'
+
+require 'rubygems'
+require 'fileutils'
+
+require 'zlib'
+require 'archive/tar/minitar'
+
+require 'zip/zipfilesystem'
+
+module PMS
+  def vendor(&block)
+    vendor = Vendor.new
+    vendor.run(&block)
+    return vendor
+  end
+
+  class Vendor
+    def run(&block)
+      instance_eval(&block)
+    end
+    
+    def download(url, storage_dir=nil)
+      working_directory(storage_dir) unless storage_dir.nil?
+      raise Exception.new("Working directory not defined") if @working_directory.nil?
+      
+      filename = url.split("/")[-1]
+      
+      unless(File.exists?@working_directory+"/"+filename)      
+        puts "downloading #{url}"
+        FileUtils.mkdir_p @working_directory
+          
+        pbar = nil
+        
+        # Called before file transfer
+        content_length_proc = lambda do |size|
+          if size && 0 < size
+            pbar = ProgressBar.new("Download", size)
+            pbar.file_transfer_mode
+          end
+        end
+        
+        # Called during file transfer
+        progress_proc = lambda do |bytes_transferred|
+          pbar.set(bytes_transferred) if pbar
+        end
+        
+        open(url,:content_length_proc => content_length_proc,:progress_proc => progress_proc) do |result|
+          File.open(@working_directory+"/"+filename, "wb") do |file|
+            result.each do |bytes|
+              file.write(bytes)
+            end
+          end  
+          pbar.finish if pbar
+        end
+
+      end
+            
+      @current_file = @working_directory+"/"+filename
+    end
+    
+    def extract
+      puts "extracting #{@current_file}"
+      extract_tgz if /.tar.gz$/ === @current_file || /.tgz$/ === @current_file
+      extract_zip if /.zip$/ === @current_file 
+    end
+    
+    def extract_tgz
+      pwd = File.expand_path(FileUtils.pwd)
+      FileUtils.cd @working_directory
+      
+      #This is breaking on a large tar archive unfortunately.  So we resort to cli
+      #file = File.open(@current_file, 'rb')
+      #tgz = Zlib::GzipReader.new(file)
+      #Archive::Tar::Minitar.unpack tgz, @working_directory
+      
+      `tar xzvf #{@current_file[(@working_directory.length+1)..-1]}`
+    
+      FileUtils.cd pwd
+    end
+    
+    def extract_zip
+      Zip::ZipFile.open(@current_file) do |zipfile|
+        zipfile.each do |file|
+          fpath = File.join(@working_directory, file.name)
+          FileUtils.mkdir_p(File.dirname(fpath))
+          zipfile.extract file, fpath
+        end
+      end
+    end
+      
+    def working_directory(dir)
+      @working_directory = dir
+    end
+    
+    def cd(dir)
+      @working_directory += "/#{dir}"
+    end
+    
+    def build(*commands)
+      pwd = File.expand_path(FileUtils.pwd)
+      FileUtils.cd @working_directory
+      
+      puts "running #{commands.join(' && ')}"
+  
+      output = system(commands.join(" &&"))
+      FileUtils.cd pwd
+      
+      return output      
+    end
+    
+    def cp(pattern, newdir)
+      newdir = "#{@working_directory}/#{newdir}"
+      files = Dir["#{@working_directory}/#{pattern}"]
+     
+      if files.length == 1
+        file = files[0]
+        FileUtils.mkdir_p File.dirname(newdir)
+        FileUtils.cp_r file, newdir unless FileTest.directory? file
+      else        
+        files.each do |file|
+          dest = newdir + (File.dirname(file))[@working_directory.length..-1]
+          FileUtils.mkdir_p dest
+          FileUtils.cp file, dest unless FileTest.directory? file
+        end
+      end
+    end
+    
+    def install(pattern, newdir)
+      FileUtils.rm_r "#{@working_directory}/#{newdir}" if File.exists? "#{@working_directory}/#{newdir}" 
+      cp pattern, newdir
+    end
+    
+    def touch(file)
+      FileUtils.touch(File.join(@working_directory,file))
+    end
+    
+    def rm(file)
+      FileUtils.rm(File.join(@working_directory, file))
+    end
+    
+    def upload(filename, &block)
+      raise Exception.new("Working directory not defined") if @working_directory.nil?
+      
+      fullpath = File.join(@working_directory, filename)
+      raise Exception.new("No file '#{filename}' found in '#{@working_directory}'") unless File.exists?(fullpath)
+      
+      transfer = FTPTransfer.new
+      transfer.run(&block)
+      transfer.upload(fullpath, filename)
+    end
+    
+    def expand_filelist filelist
+      retv = nil
+      pwd = File.expand_path(FileUtils.pwd)
+      FileUtils.cd @working_directory
+      if filelist.is_a? Array
+        retv = filelist
+      else
+        retv = Dir.glob(filelist)
+      end
+      FileUtils.cd pwd
+      return retv
+    end
+    
+    def archive(filelist, archive)
+      filelist = expand_filelist filelist
+      puts "archiving #{filelist}"
+      if /.tgz$/ === archive || /.tar.gz$/ === archive
+        archive_tgz filelist, archive
+      elsif /.zip$/ === archive
+        archive_zip filelist, archive
+      else
+        raise Exception.new("archive type '#{archive}' is not supported")
+      end
+    end
+    
+    def archive_tgz(filelist, archive)
+      verify_archive_files(filelist, archive)
+      
+      pwd = File.expand_path(FileUtils.pwd)
+      FileUtils.cd @working_directory
+      File.open("#{archive}", 'wb') do |archivefile|
+        tgz = Zlib::GzipWriter.new(archivefile)
+        Archive::Tar::Minitar.pack filelist, tgz 
+      end
+      FileUtils.cd pwd
+    end
+    
+    def archive_zip(filelist, archive)
+      verify_archive_files(filelist, archive)
+      
+      zf = Zip::ZipFile.new(File.join(FileUtils.pwd, @working_directory, archive), true) 
+
+      filelist.each do |file|
+        full_path_to_file = File.join(FileUtils.pwd, @working_directory,file)
+        if File.file? full_path_to_file
+          zf.add(file, full_path_to_file)
+        end
+      end
+      
+      zf.close
+    end
+    
+    def verify_archive_files(filelist, archive)
+      raise Exception.new("archive '#{archive}' already exists") if File.exists?(File.join(@working_directory,archive))
+      filelist.each do |file|
+         raise Exception.new("file '#{file}' in filelist for archive '#{archive}' does not exist") unless File.exists?(File.join(@working_directory,file))
+      end
+    end
+  end
+  
+  class FTPTransfer
+    def run(&block)
+      instance_eval(&block)
+    end
+
+    #Credential files are very simple, in the form of:
+    #  username <user>
+    #  password <password>
+    def credentials(filename)
+      credentials = Credentials.new(filename)
+      @user = credentials.user
+      @pass = credentials.pass
+      return credentials
+    end
+
+    def username(name)
+      @user = name
+    end
+    
+    def password(pass)
+      @pass = pass
+    end
+    
+    def host(host)
+      @host = host
+    end
+    
+    def target_directory(path)
+      @target_directory = path
+    end
+    
+    def cd(ftp, dir)
+      ftp.chdir dir
+    end
+    
+    def mkdir_p(ftp, dir)
+      path = dir.split("/")
+      pwd = ftp.pwd
+      path.each do |dir|
+        begin
+          ftp.mkdir dir
+          cd ftp, dir
+        rescue Net::FTPPermError
+          cd ftp, dir
+        end
+      end
+      cd ftp, pwd
+    end
+  
+    def upload(fullpath, filename)
+      Net::FTP.open(@host) do |ftp|
+        puts "uploading #{fullpath}"
+        pbar = ProgressBar.new("Upload", File.size(fullpath))
+        pbar.file_transfer_mode
+        ftp.login(@user,@pass)
+        mkdir_p ftp, @target_directory
+        cd ftp, @target_directory
+        ftp.putbinaryfile(fullpath, filename, 1024) do |data|
+          pbar.set(pbar.current+data.length)
+        end
+        pbar.finish
+      end
+    end
+    
+  end
+  
+  class Credentials
+    attr_reader :user, :pass
+    def initialize(filename)
+      filepath=ENV["HOME"]+"/"+filename
+      if(File.exists?(filepath))
+        File.open(filepath).each do |line|
+          line.chomp!
+          op, arg = line.split(" ")
+          if op.strip =~ /user/
+            @user = arg
+          elsif op.strip == 'password'
+            @pass = arg
+          end
+        end
+      else
+        # pmsrb file not defined
+        puts "'#{filepath}' not found.  Create it to autoconnect with '#{@host}': \n  username <user>\n  password <pass>\nto skip this dialog."
+        puts "Username for #{@host}'s ftp:"
+        @user = gets.chomp
+        puts "password: "
+        @pass = gets.chomp
+      end
+    end
+  end
+  
+end