p4ruby 1.0.3 → 1.0.5

data/README

@@ -25,16 +25,13 @@ installs it.  Some options are available,
     --uninstall          Uninstall.
     --local              Use the local files in work/distfiles (for manual download)
 
-== Download (this installer only)
-
-* http://rubyforge.org/frs/?group_id=6957
-
 == Links
 
-* Tony Smith's original P4Ruby {public depot}[http://public.perforce.com/guest/tony_smith/perforce/API/Ruby/index.html] and {documentation}[http://public.perforce.com/guest/tony_smith/perforce/API/Ruby/main/doc/index.html].
-* Changes[http://perforce.com/perforce/doc.081/user/p4rubynotes.txt] in the Perforce P4Ruby official package.
-* {Repository (this installer only)}[http://github.com/quix/p4ruby]
-* Users may be interested in a simplified interface to P4Ruby at http://perforce.rubyforge.org.
+* Download (this installer only): http://rubyforge.org/frs/?group_id=6957
+* Simplified wrapper for P4Ruby: http://perforce.rubyforge.org
+* P4Ruby documentation 2008.1: http://perforce.com/perforce/doc.081/manuals/p4script/p4script.pdf
+* Perforce documentation: http://perforce.com/perforce/technical.html
+* Repository (this installer only): http://github.com/quix/p4ruby
 
 == Credits
 

data/install.rb

@@ -9,13 +9,42 @@ require 'fileutils'
 require 'optparse'
 require 'pathname'
 
+def main
+  Installer.new.run
+end
+
 class Installer
   include FileUtils
 
   CONFIG = Config::CONFIG
+  BIT64 = (1.size == 8)
+
+  RB_BASENAME = Pathname.new "P4.rb"
+  SO_BASENAME = Pathname.new "P4.#{CONFIG['DLEXT']}"
+
+  RAW_INSTALL_FILES = [
+    Pathname.new(CONFIG["sitelibdir"]) + RB_BASENAME,
+    Pathname.new(CONFIG["sitearchdir"]) + SO_BASENAME,
+  ]
+
+  GEM_INSTALL_FILES = [
+    Pathname.new("lib") + RB_BASENAME,
+    Pathname.new("ext") + SO_BASENAME,
+  ]
+
+  SERVER = "ftp.perforce.com"
+  SERVER_TOP_DIR = Pathname.new "perforce"
+
+  P4API_REMOTE_BASENAME = Pathname.new "p4api.tgz"
+  P4RUBY_REMOTE_BASENAME = Pathname.new "p4ruby.tgz"
+
+  WORK_DIR = Pathname.new "work"
+  DISTFILES_DIR = WORK_DIR + "distfiles"
+  BUILD_DIR = WORK_DIR + "build"
 
   def parse_command_line
-    OptionParser.new("Usage: ruby install.rb [options]", 24, "") { |parser|
+    OptionParser.new("Usage: ruby install.rb [options]", 24, "") {
+      |parser|
       parser.on(
         "--version NN.N",
         "Version to download, e.g. 08.1. Default finds latest.") {
@@ -64,19 +93,18 @@ class Installer
     if @s.uninstall
       uninstall
     elsif @s.list_platforms
-      list_platforms
+      puts platforms
     elsif @s.list_versions
-      list_versions
-    elsif @s.platform
-      if @s.platform =~ %r!\Ant!
-        windows_install
-      else
-        fetch
-        build
-        unix_install
-      end
-    else
+      puts versions
+    elsif @s.platform.nil?
       platform_fail
+    elsif @s.platform =~ %r!\Ant!
+      windows_install
+    else
+      fetch
+      build
+      install
+      verify_install
     end
   end
 
@@ -84,19 +112,19 @@ class Installer
     if CONFIG["LIBRUBYARG_SHARED"].empty?
       raise "error: ruby must be configured with --enable-shared"
     end
-    @s.server = "ftp.perforce.com"
-    @s.server_top_dir = Pathname.new "perforce"
 
-    @s.work_dir = Pathname.new "work"
-    @s.distfiles_dir = @s.work_dir + "distfiles"
-    @s.build_dir = @s.work_dir + "build"
+    @s.p4api =  LazyStruct.new.tap { |t|
+      t.basename = P4API_REMOTE_BASENAME
+    }
+
+    @s.p4ruby = LazyStruct.new.tap { |t|
+      t.basename = P4RUBY_REMOTE_BASENAME
+    }
 
-    @s.p4api =  LazyStruct.new.tap { |t| t.file = Pathname.new "p4api.tgz" }
-    @s.p4ruby = LazyStruct.new.tap { |t| t.file = Pathname.new "p4ruby.tgz" }
     @s.specs = [ @s.p4ruby, @s.p4api ]
     @s.specs.each { |spec|
       spec.attribute(:local) {
-        @s.distfiles_dir + spec.file
+        DISTFILES_DIR + spec.basename
       }
     }
     
@@ -113,29 +141,57 @@ class Installer
     end
 
     @s.attribute(:version_dir) {
-      @s.server_top_dir + "r#{@s.version}"
+      SERVER_TOP_DIR + "r#{@s.version}"
     }
+
     @s.p4api.attribute(:remote) {
-      @s.version_dir + "bin.#{@s.platform}" + @s.p4api.file
+      @s.version_dir + "bin.#{@s.platform}" + @s.p4api.basename
     }
     @s.p4ruby.attribute(:remote) {
-      @s.version_dir + "tools" + @s.p4ruby.file
+      @s.version_dir + "tools" + @s.p4ruby.basename
     }
+
     @s.attribute(:ftp) {
-      Net::FTP.new(@s.server).tap { |t| t.passive = true ; t.login }
+      Net::FTP.new(SERVER).tap { |t|
+        t.passive = true
+        t.login
+      }
     }
   end
 
-  def find_os_version(os)
+  def guess_cpu
+    case CONFIG["target_cpu"]
+    when %r!ia!i
+      "ia64"
+    when %r!86!
+      # note: with '_'
+      "x86" + (BIT64 ? "_64" : "")
+    when %r!(ppc|sparc)!i
+      # note: without '_'
+      $1 + (BIT64 ? "64" : "")
+    else
+      ""
+    end
+  end
+
+  def guess_version(os)
     if match = `uname -a`.match(%r!#{os}\s+\S+\s+(\d+)\.(\d+)!i)
-      match.captures.join
+      version = match.captures.join
+      cpu = guess_cpu
+      platforms = self.platforms
+      (0..version.to_i).map { |n|
+        [os, n.to_s, cpu].join
+      }.select { |platform|
+        platforms.include? platform
+      }.last
+    else
+      nil
     end
   end
 
   def guess_platform(opts = {})
     config_os = CONFIG["target_os"].downcase
-    bit64 = (1.size == 8)
-    windows_cpu = (bit64 ? "x64" : "x86")
+    windows_cpu = BIT64 ? "x64" : "x86"
 
     if config_os =~ %r!cygwin!i
       "cygwin" + windows_cpu
@@ -144,63 +200,44 @@ class Installer
     elsif @s.local
       "<local>"
     else
-      if (match = config_os.match(%r!\A\D+!)).nil?
-        nil
+      if match = config_os.match(%r!\A\D+!)
+        guess_version(match[0])
       else
-        os = match[0]
-        version = find_os_version(os)
-        if version.nil?
-          nil
-        else
-          cpu = 
-            case CONFIG["target_cpu"]
-            when %r!ia!i
-              "ia64"
-            when %r!86!
-              "x86" + (bit64 ? "_64" : "") # note: with '_'
-            when %r!(ppc|sparc)!i
-              $1 + (bit64 ? "64" : "")     # note: without '_'
-            else
-              ""
-            end
-          
-          available_platforms = platforms
-          platform = nil
-          version.to_i.downto(0) { |n|
-            platform = [os, n.to_s, cpu].join
-            if available_platforms.include? platform
-              break
-            end
-          }
-          platform
-        end
+        nil
       end
     end
   end
 
   def platform_fail
-    @s.version = "<VERSION>"
-    @s.platform = "<PLATFORM>"
-    message = %Q{
-      Auto-fetch not yet handled for this platform.  Run:
-  
-      \truby install.rb --list-platforms
-  
-      to see the available platforms, then run
-  
-      \truby install.rb --platform PLATFORM
-  
-      with your platform.
-  
-      If all of the above fails, manually fetch
-  
-      \tftp://#{@s.server}/#{@s.p4api.remote}
+    install_fail {
+      @s.version = "<version>"
+      @s.platform = "<platform>"
+      message = %Q{
+        Auto-fetch not yet handled for this platform.  Run:
+    
+        \truby install.rb --list-platforms
+    
+        to see the available platforms, then run
+    
+        \truby install.rb --platform PLATFORM
+    
+        with your platform.
+    
+        If all of the above fails, manually fetch
+    
+        \tftp://#{SERVER}/#{@s.p4api.remote}
+    
+        Copy it to #{@s.p4api.local} and run install.rb --local.
+      }.gsub(%r!^ +(?=\S)!, "")
   
-      Copy it to #{@s.p4api.local} and run install.rb --local.
-    }.gsub(%r!^ +(?=\S)!, "")
+      mkdir_p(DISTFILES_DIR)
+      puts message
+    }
+  end
 
-    mkdir_p(@s.distfiles_dir)
-    puts message
+  def install_fail
+    yield
+    exit(1)
   end
 
   def sys(*args)
@@ -217,8 +254,8 @@ class Installer
 
   def fetch_spec(spec)
     unless @s.local
-      mkdir_p(File.dirname(spec.local))
-      puts "downloading ftp://#{@s.server}/#{spec.remote} ..."
+      mkdir_p(spec.local.dirname)
+      puts "downloading ftp://#{SERVER}/#{spec.remote} ..."
       @s.ftp.getbinaryfile(spec.remote, spec.local)
     end
   end
@@ -250,23 +287,11 @@ class Installer
   end
 
   def versions
-    remote_files_matching(@s.server_top_dir, %r!r([0-8]\d\.\d)!) { |match|
+    remote_files_matching(SERVER_TOP_DIR, %r!r([0-8]\d\.\d)!) { |match|
       match.captures.first
     }.sort
   end
 
-  def list_platforms
-    platforms.each { |platform|
-      puts platform
-    }
-  end
-
-  def list_versions
-    versions.each { |version|
-      puts version
-    }
-  end
-
   def latest_version
     versions.last
   end
@@ -276,79 +301,105 @@ class Installer
   end
 
   def ruby(*args)
-    exe = File.join(
-      CONFIG["bindir"],
-      CONFIG["RUBY_INSTALL_NAME"])
+    exe = Pathname.new(CONFIG["bindir"]) + CONFIG["RUBY_INSTALL_NAME"]
     sys(exe, *args)
   end
 
   def build
-    rm_rf(@s.build_dir)
-    mkdir_p(@s.build_dir)
+    rm_rf(BUILD_DIR)
+    mkdir_p(BUILD_DIR)
 
     @s.specs.each { |spec|
-      unpack(spec.local, @s.build_dir)
+      unpack(spec.local, BUILD_DIR)
     }
 
-    Dir.chdir(@s.build_dir) {
+    Dir.chdir(BUILD_DIR) {
       api_dir = Pathname.glob("p4api*").last
       p4ruby_dir = Pathname.glob("p4ruby*").last
       Dir.chdir(p4ruby_dir) {
         ruby("p4conf.rb", "--apidir", "../#{api_dir}")
         make
       }
-      @s.p4ruby_build_dir = @s.build_dir + p4ruby_dir
+      @s.p4ruby_build_dir = BUILD_DIR + p4ruby_dir
     }
   end
 
-  def unix_install
+  def raw_install_to_gem_install
+    RAW_INSTALL_FILES.each_with_index { |source, index|
+      dest = GEM_INSTALL_FILES[index]
+      mkdir_p(dest.dirname)
+      puts "move #{source} --> #{dest}"
+      mv(source, dest)
+    }
+  end
+
+  def install
+    Dir.chdir(@s.p4ruby_build_dir) {
+      make("install")
+    }
     if @s.gem_config
-      rb_file = Pathname.new("lib") + "P4.rb"
-      rm_f(rb_file)
-      mkdir_p(File.dirname(rb_file))
-      cp(@s.p4ruby_build_dir + rb_file, rb_file)
-
-      dlext = CONFIG["DLEXT"]
-      so_file = Pathname.new("ext") + "P4.#{dlext}"
-      rm_f(so_file)
-      mkdir_p(File.dirname(so_file))
-      cp(@s.p4ruby_build_dir + so_file.basename, so_file)
+      raw_install_to_gem_install
+    end
+  end
+
+  def verify_install(on_error = nil)
+    files =
+      if @s.gem_config
+        GEM_INSTALL_FILES
+      else
+        RAW_INSTALL_FILES
+      end.map { |t| t.expand_path }
+
+    if files.all? { |t| t.exist? }
+      puts "Installed files:"
+      puts files
+    elsif on_error
+      install_fail(&on_error)
     else
-      Dir.chdir(@s.p4ruby_build_dir) {
-        make "install"
+      install_fail {
+        puts "These files were supposed to be installed, but were not:"
+        puts files
+        puts "Install failed!"
       }
     end
   end
 
   def windows_install
     #
-    # p4ruby is where the p4api is located on the perforce server
-    # -- switcharoo --
+    # For Windows, p4ruby is located in the p4api directory on the
+    # perforce server -- switcharoo --
     #
     spec = @s.p4api
     
     version = [CONFIG["MAJOR"], CONFIG["MINOR"]].join
-    spec.file = "p4ruby#{version}.exe"
+    spec.basename = "p4ruby#{version}.exe"
     fetch_spec(spec)
 
+    error = lambda {
+      puts "The Perforce Windows P4Ruby installer failed!"
+      puts "Re-run it manually here: "
+      puts spec.local.expand_path
+    }
+
     if system(spec.local, "/S", "/v/qn")
-      puts "Installed files:"
-      puts installed_p4ruby_files
+      if @s.gem_config
+        sleep(1)
+        raw_install_to_gem_install
+        sleep(1)
+        unless system(spec.local, "/V", "/x", "/S", "/v/qn")
+          # We don't much care if this fails; just write to the log
+          puts "Note: the Perforce Windows P4Ruby uninstaller failed."
+        end
+      end
+      verify_install(error)
     else
-      puts "**** The P4Ruby installer failed!"
-      puts "**** Re-run it manually here: "
-      puts File.expand_path(spec.local)
+      install_fail(&error)
     end
   end
 
-  def installed_p4ruby_files
-    [ Pathname.new(CONFIG["sitelibdir"]) + "P4.rb" ] +
-    Pathname.glob(Pathname.new(CONFIG["sitearchdir"]) + "P4.*")
-  end
-
   def uninstall
-    installed_p4ruby_files.each { |file|
-      if File.exist? file
+    RAW_INSTALL_FILES.each { |file|
+      if file.exist?
         puts "delete #{file}"
         rm_f(file)
       end
@@ -356,16 +407,6 @@ class Installer
   end
 end
 
-# version < 1.8.7 compatibility
-module Kernel
-  unless respond_to? :tap
-    def tap
-      yield self
-      self
-    end
-  end
-end
-
 #
 # An OpenStruct with optional lazy-evaluated fields.
 #
@@ -416,5 +457,14 @@ class LazyStruct < OpenStruct
   include Mixin
 end
 
-STDOUT.sync = true
-Installer.new.run
+# version < 1.8.7 compatibility
+module Kernel
+  unless respond_to? :tap
+    def tap
+      yield self
+      self
+    end
+  end
+end
+
+main

data/p4ruby.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new { |t| 
   t.name = "p4ruby"
-  t.version = "1.0.3"
+  t.version = "1.0.5"
   t.summary = "Ruby interface to the Perforce API"
   t.author = "Perforce Software (ruby gem by James M. Lawrence)"
   t.email = "quixoticsycophant@gmail.com"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p4ruby
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors: 
 - Perforce Software (ruby gem by James M. Lawrence)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-03 00:00:00 -04:00
+date: 2008-10-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -56,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: p4ruby
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Ruby interface to the Perforce API