p4ruby 0.5.0

data/README

@@ -0,0 +1,113 @@
+
+= P4Ruby -- Ruby interface to the Perforce API
+
+This is only an installer for the P4Ruby package by Perforce Software.
+
+P4Ruby was recently included as an official package supported by
+Perforce, with minor changes.  Tony Smith's original P4Ruby public
+depot is here
+http://public.perforce.com/guest/tony_smith/perforce/API/Ruby/index.html
+with documentation
+http://public.perforce.com/guest/tony_smith/perforce/API/Ruby/main/doc/index.html.
+Changes in the new package are described here
+http://perforce.com/perforce/doc.081/user/p4rubynotes.txt.
+
+<b>Note:</b> For Windows platforms, the only available Perforce API
+libraries are Cygwin ones (as of version 2008.1).  Therefore
+Cygwin-ruby is currently required under Windows.  After launching the
+the Cygwin installer (http://cygwin.com), select the ruby package
+along with g++ (in the Devel category).
+
+Users may be interested in a simplified interface to Perforce at
+http://perforce.rubyforge.org (shameless plug, sorry).
+
+=== Install
+
+  % gem install p4ruby
+
+Or if you are installing from the regular (non-gem) package,
+
+  % ruby install.rb
+
+This downloads P4Ruby and the Perforce API, compiles P4Ruby, and
+installs it.  Some options are available,
+
+  % ruby install.rb --help
+
+  Usage: ruby install.rb [options]
+    --version NN.N       Version to download, e.g. 08.1. Default finds latest.
+    --list-versions      List available versions.
+    --platform PLATFORM  Perforce-named platform to download. Default guesses.
+    --list-platforms     List available platforms for the given version.
+    --gem                Gem configuration (for the gem installer).
+    --uninstall          Uninstall.
+
+=== Note
+
+If you are on a case-sensitive filesystem, be aware that 'P4' must be
+capitalized in the <em>require</em> line,
+
+  require 'P4'
+
+=== Download (this installer only)
+
+* http://rubyforge.org/frs/?group_id=6957
+
+=== Repository (this installer only)
+
+* http://github.com/quix/p4ruby
+
+=== Credits
+
+==== P4Ruby
+ 
+ Copyright (c) 1997-2007, Perforce Software, Inc.  All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE
+ SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ 
+==== Installer and Gem
+ 
+ This ruby package (install.rb and associated files) was written by
+ James M. Lawrence, Copyright (c) 2008 ImaginEngine, Inc.  Distributed
+ under the MIT license.
+ 
+ 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,83 @@
+
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+
+require 'rbconfig'
+
+gemspec = eval(File.read("p4ruby.gemspec"))
+installer = './install.rb'
+readme = "README"
+
+ruby = File.join(
+  Config::CONFIG["bindir"],
+  Config::CONFIG["RUBY_INSTALL_NAME"])
+    
+#
+# default task compiles for the gem
+#
+task :default do
+  sh(ruby, installer, "--gem")
+end
+
+task :clean => :clobber do
+  rm_rf ["work", "lib/P4.rb", "ext", "html"]
+end
+
+task :update_docs do
+  help = "--help"
+  command = "ruby #{File.basename(installer)} #{help}"
+  output = `#{ruby} #{installer} #{help}`
+
+  # insert help output into README
+  replace_file(readme) { |contents|
+    contents.sub(%r!#{command}.*?==!m) {
+      command + "\n\n  " +
+      output + "\n=="
+    }
+  }
+end
+
+task :doc => :update_docs
+task :doc => :rdoc
+
+task :package => [:clean, :doc]
+task :gem => :clean
+
+Rake::RDocTask.new { |t|
+  t.main = readme
+  t.rdoc_files.include([readme])
+  t.rdoc_dir = "html"
+  t.title = "P4Ruby: #{gemspec.summary}"
+}
+
+Rake::GemPackageTask.new(gemspec) { |t| 
+  t.need_tar = true 
+} 
+
+task :publish => :doc do
+  Rake::RubyForgePublisher.new('p4ruby', 'quix').upload
+end
+
+task :release => [:package, :publish]
+
+##################################################
+# util
+
+unless respond_to? :tap
+  module Kernel
+    def tap
+      yield self
+      self
+    end
+  end
+end
+
+def replace_file(file)
+  old_contents = File.read(file)
+  yield(old_contents).tap { |new_contents|
+    File.open(file, "w") { |output|
+      output.print(new_contents)
+    }
+  }
+end

data/install.rb

@@ -0,0 +1,385 @@
+#
+# Author: James M. Lawrence <quixoticsycophant@gmail.com>.
+#
+
+require 'net/ftp'
+require 'rbconfig'
+require 'ostruct'
+require 'fileutils'
+require 'optparse'
+
+class Installer
+  include FileUtils
+
+  def parse_command_line
+    OptionParser.new("Usage: ruby install.rb [options]", 24, "") { |parser|
+      parser.on("--version NN.N",
+                "Version to download, e.g. 08.1. Default finds latest.") {
+        |version|
+        @s.version = version
+      }
+      parser.on("--list-versions", "List available versions.") {
+        @s.list_versions = true
+      }
+      parser.on(
+        "--platform PLATFORM",
+        "Perforce-named platform to download. Default guesses.") {
+        |platform|
+        @s.platform = platform
+      }
+      parser.on("--list-platforms",
+                "List available platforms for the given version.") {
+        @s.list_platforms = true
+      }
+      parser.on("--gem", "Gem configuration (for the gem installer).") {
+        @s.gem = true
+      }
+      parser.on("--uninstall", "Uninstall.") {
+        @s.uninstall = true
+      }
+      parser.parse(ARGV)
+    }
+  end
+
+  def run
+    @s = LazyStruct.new
+    parse_command_line
+    config
+    if @s.uninstall
+      uninstall
+    elsif @s.list_platforms
+      list_platforms
+    elsif @s.list_versions
+      list_versions
+    elsif @s.platform
+      rm_rf(@s.work_dir)
+      fetch
+      build
+      install
+    else
+      platform_fail
+    end
+  end
+
+  def config
+    @s.server = "ftp.perforce.com"
+    @s.server_top_dir = "perforce"
+
+    @s.work_dir = "work"
+    @s.distfiles_dir = "#{@s.work_dir}/distfiles"
+    @s.build_dir = "#{@s.work_dir}/build"
+
+    @s.p4api =  LazyStruct.new.tap { |t| t.file = "p4api.tgz" }
+    @s.p4ruby = LazyStruct.new.tap { |t| t.file = "p4ruby.tgz" }
+    @s.specs = [ @s.p4ruby, @s.p4api ]
+    @s.specs.each { |spec|
+      spec.local = "#{@s.distfiles_dir}/#{spec.file}"
+    }
+    
+    unless @s.platform
+      @s.attribute(:platform) {
+        guess_platform
+      }
+    end
+
+    unless @s.version
+      @s.attribute(:version) {
+        latest_version
+      }
+    end
+
+    @s.attribute(:version_dir) {
+      "#{@s.server_top_dir}/r#{@s.version}"
+    }
+    @s.p4api.attribute(:remote) {
+      "#{@s.version_dir}/bin.#{@s.platform}/#{@s.p4api.file}"
+    }
+    @s.p4ruby.attribute(:remote) {
+      "#{@s.version_dir}/tools/#{@s.p4ruby.file}"
+    }
+    @s.attribute(:ftp) {
+      Net::FTP.new(@s.server).tap { |t| t.passive = true ; t.login }
+    }
+  end
+
+  def guess_platform
+    case RUBY_PLATFORM
+    when %r!cygwin!i
+      "cygwinx86"
+    when %r!darwin!i
+      case RUBY_PLATFORM
+      when %r!ppc!i
+        "darwin80ppc"
+      when %r!64!
+        "darwin80x86_64"
+      else
+        "darwin80x86"
+      end
+    when %r!linux!i
+      case RUBY_PLATFORM
+      when %r!2\.6!
+        case RUBY_PLATFORM
+        when %r!ia!i
+          "linux26xia64"
+        when %r!64!
+          "linux26x86_64"
+        else
+          "linux26x86"
+        end
+      else
+        "linux24x86"
+      end
+    when %r!freebsd!i
+      case RUBY_PLATFORM
+      when %r!5\.4!
+        case RUBY_PLATFORM
+        when %r!64!
+          "freebsd54x86_64"
+        else
+          "freebsd54x86"
+        end
+      else
+        case RUBY_PLATFORM
+        when %r!64!
+          "freebsd60x86_64"
+        else
+          "freebsd60x86"
+        end
+      end
+    else
+      nil
+    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}
+  
+      Copy it to #{@s.p4api.local} and run install.rb again.
+    }.gsub(%r!^ +(?=\S)!, "")
+
+    mkdir_p(@s.distfiles_dir)
+    puts message
+  end
+
+  def sys(*args)
+    system(*args).tap { |result|
+      unless result
+        raise "system() failed: #{args.join(" ")}"
+      end
+    }
+  end
+
+  def unpack(distfile, target_dir)
+    sys("tar", "zxvf", distfile, "-C", target_dir)
+  end
+
+  def fetch
+    @s.specs.each { |spec|
+      mkdir_p(File.dirname(spec.local))
+      puts "downloading ftp://#{@s.server}/#{spec.remote} ..."
+      @s.ftp.getbinaryfile(spec.remote, spec.local)
+    }
+  end
+
+  def remote_files_matching(dir, regex)
+    @s.ftp.ls(dir).map { |entry|
+      if match = entry.match(regex)
+        yield match
+      else
+        nil
+      end
+    }.reject { |entry|
+      entry.nil?
+    }
+  end
+
+  def platforms
+    remote_files_matching(@s.version_dir, %r!bin\.(\w+)!) { |match|
+      match.captures.first
+    }.reject { |platform|
+      platform =~ %r!java!
+    }.sort
+  end
+
+  def versions
+    remote_files_matching(@s.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
+
+  def fix_makefile
+    replace_file("Makefile") { |contents|
+      contents.sub(%r!^LIBS = .*?$!) { |match|
+        match + " -lruby"
+      }
+    }
+  end
+
+  def build
+    ruby = File.join(
+      Config::CONFIG["bindir"],
+      Config::CONFIG["RUBY_INSTALL_NAME"])
+
+    mkdir_p(@s.build_dir)
+
+    @s.specs.each { |spec|
+      unpack(spec.local, @s.build_dir)
+    }
+
+    Dir.chdir(@s.build_dir) {
+      api_dir = Dir["p4api*"].last
+      p4ruby_dir = Dir["p4ruby*"].last
+      Dir.chdir(p4ruby_dir) {
+        sys(ruby, "p4conf.rb", "--apidir", "../#{api_dir}")
+        fix_makefile
+        make
+      }
+      @s.p4ruby_build_dir = "#{@s.build_dir}/#{p4ruby_dir}"
+    }
+  end
+
+  def make(*args)
+    exe = 
+      if RUBY_PLATFORM =~ %r!mswin!i
+        "nmake"
+      else
+        "make"
+      end
+    sys(exe, *args)
+  end
+
+  def install
+    if @s.gem
+      rb_file = "lib/P4.rb"
+      rm_f(rb_file)
+      mkdir_p(File.dirname(rb_file))
+      cp("#{@s.p4ruby_build_dir}/#{rb_file}", rb_file)
+
+      dlext = Config::CONFIG["DLEXT"]
+      so_file = "ext/P4.#{dlext}"
+      rm_f(so_file)
+      mkdir_p(File.dirname(so_file))
+      cp("#{@s.p4ruby_build_dir}/#{File.basename(so_file)}", so_file)
+    else
+      Dir.chdir(@s.p4ruby_build_dir) {
+        make "install"
+      }
+    end
+  end
+
+  def installed_p4ruby_files
+    [ File.join(Config::CONFIG["sitelibdir"], "P4.rb") ] +
+    Dir[File.join(Config::CONFIG["sitearchdir"], "P4.*")]
+  end
+
+  def uninstall
+    installed_p4ruby_files.each { |file|
+      if File.exist? file
+        puts "delete #{file}"
+        rm_f(file)
+      end
+    }
+  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.
+#
+class LazyStruct < OpenStruct
+  #
+  # For mixing into an existing OpenStruct instance singleton class.
+  #
+  module Mixin
+    #
+    # &block is evaluated when this attribute is requested.  The
+    # same result is returned for subsquent calls, until the field
+    # is assigned a different value.
+    #
+    def attribute(reader, &block)
+      singleton = (class << self ; self ; end)
+      singleton.instance_eval {
+        #
+        # Define a special reader method in the singleton class.
+        #
+        define_method(reader) {
+          block.call.tap { |value|
+            #
+            # The value has been computed.  Replace this method with a
+            # one-liner giving the value.
+            #
+            singleton.instance_eval {
+              remove_method(reader)
+              define_method(reader) { value }
+            }
+          }
+        }
+        
+        #
+        # Revert to the old OpenStruct behavior when the writer is called.
+        #
+        writer = "#{reader}=".to_sym
+        define_method(writer) { |value|
+          singleton.instance_eval {
+            remove_method(reader)
+            remove_method(writer)
+          }
+          method_missing(writer, value)
+        }
+      }
+    end
+  end
+  
+  include Mixin
+end
+
+def replace_file(file)
+  old_contents = File.read(file)
+  yield(old_contents).tap { |new_contents|
+    File.open(file, "w") { |output|
+      output.print(new_contents)
+    }
+  }
+end
+
+Installer.new.run

data/p4ruby.gemspec

@@ -0,0 +1,32 @@
+
+Gem::Specification.new { |t| 
+  t.name = "p4ruby"
+  t.version = "0.5.0"
+  t.summary = "Ruby interface to the Perforce API"
+  t.author = "Perforce Software (ruby gem by James M. Lawrence)"
+  t.email = "quixoticsycophant@gmail.com"
+  t.homepage = "p4ruby.rubyforge.org"
+  t.rubyforge_project = "p4ruby"
+  t.extensions << "Rakefile"
+  t.require_paths << "ext"
+
+  t.files = %w{
+    README
+    Rakefile
+    install.rb
+    p4ruby.gemspec
+  }
+
+  rdoc_exclude = %w{
+    P4.rb
+    install\.rb
+  }
+  t.has_rdoc = true
+  t.extra_rdoc_files = ["README"]
+  t.rdoc_options += ["--title", "P4Ruby: #{t.summary}"] +
+    %w{--main README} +
+    rdoc_exclude.inject(Array.new) { |acc, pattern|
+      acc + ["--exclude", pattern]
+    }
+}
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: p4ruby
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Perforce Software (ruby gem by James M. Lawrence)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-07 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: quixoticsycophant@gmail.com
+executables: []
+
+extensions: 
+- Rakefile
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- install.rb
+- p4ruby.gemspec
+has_rdoc: true
+homepage: p4ruby.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- "P4Ruby: Ruby interface to the Perforce API"
+- --main
+- README
+- --exclude
+- P4.rb
+- --exclude
+- install\.rb
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: p4ruby
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the Perforce API
+test_files: []
+