perforce 0.5.0

data/README

@@ -0,0 +1,58 @@
+
+= Perforce - Streamlined wrapper for p4ruby.
+
+The classes Perforce and Perforce::Changelist present a simplified
+interface to the Perforce API.  They encapsulate all the functionality
+I needed for scripting Perforce in a recent project.
+
+These are small classes implemented atop P4, the class installed by
+the P4Ruby package.  The underlying P4 object is always available
+with Perforce#p4.  See http://p4ruby.rubyforge.org.
+
+==== Install
+
+  % gem install perforce
+
+Or for the regular (non-gem) .tgz package,
+
+  % ruby install.rb [--uninstall]
+
+==== Download
+
+* http://rubyforge.org/frs/?group_id=6958
+
+==== Repository
+
+* http://github.com/quix/perforce
+
+==== Credits
+
+  P4Ruby and the Perforce API are Copyright (c) 1997-2008 Perforce
+  Software.  All rights reserved.
+  
+  This ruby package (perforce.rb and associated files) was written by
+  James M. Lawrence, Copyright (c) 2008 ImaginEngine, Inc.
+  Distributed under the MIT license.  This package contains no code
+  owned by Perforce Software, in whole or in part.  The following
+  license pertains to this package only.
+  
+  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/install.rb

@@ -0,0 +1,18 @@
+
+require 'rbconfig'
+require 'fileutils'
+
+include FileUtils
+
+source = "lib/perforce.rb"
+dest = File.join(Config::CONFIG["sitelibdir"], File.basename(source))
+
+if ARGV.include? "--uninstall"
+  if File.exist? dest
+    puts "delete #{dest}"
+    rm_f dest
+  end
+else
+  puts "#{source} --> #{dest}"
+  install source, dest
+end

data/lib/perforce.rb

@@ -0,0 +1,396 @@
+
+require 'thread'
+require 'P4'
+
+# 
+# Perforce -- class representing a connection to a perforce server.
+#
+class Perforce
+  CYGWIN = (RUBY_PLATFORM =~ %r!cygwin!) #:nodoc:
+
+  #
+  # Connect to a perforce depot.
+  #
+  # The argument <em>spec</em> is a hash of <em>(method, value)</em>
+  # pairs sent to the underlying P4 object.
+  #
+  # The given values override the P4PORT, P4CLIENT, etc. environment
+  # variables.
+  #
+  # Example:
+  #
+  #   #
+  #   # This calls P4#user=, P4#password=, P4#client=, P4#port= with
+  #   # these values, then calls P4#connect.
+  #   #
+  #   Perforce.new(
+  #     :user => "iggy_fenton",
+  #     :password => "<password or ticket number>",
+  #     :client => "iggy_fenton_project",
+  #     :port => "server_name:1666")
+  #
+  def initialize(spec = {})
+    #
+    # Remove PWD during creation to avoid some troubles.  The user
+    # probably wants perforce to use the absolute path of the current
+    # directory, not a path infected by symlinks.
+    # 
+    # Since ~/project was a symlink to my perforce-based project,
+    # perforce would not run when I got there via "cd project" from my
+    # home directory.
+    #
+    @p4 = 
+      if self.class.use_pwd_symlinks
+        P4.new
+      else
+        Thread.exclusive {
+          previous_pwd = ENV["PWD"]
+          ENV.delete("PWD")
+          begin
+            P4.new
+          ensure
+            if previous_pwd
+              ENV["PWD"] = previous_pwd
+            end
+          end
+        }
+      end
+    spec.each_pair { |key, value|
+      @p4.send("#{key}=", value)
+    }
+    unless spec.has_key?(:user)
+      # guess user
+      @p4.user = [
+        ENV["USER"],
+        ENV["USERNAME"],
+      ].select { |name|
+        name != nil and name != ""
+      }.first.tap { |user|
+        unless user 
+          raise "Could not determine username"
+        end
+      }
+    end
+    @p4.exception_level = P4::RAISE_ERRORS
+    @p4.connect
+  end
+
+  #
+  # The underlying P4 object from the P4Ruby package.
+  #
+  def p4
+    @p4
+  end
+
+  #
+  # Create a Changelist with the given description (a string).
+  #
+  def new_changelist(desc)
+    input = {
+      "Change" => "new",
+      "Description" => desc,
+    }
+
+    number =
+      run_with_input(input, "change", "-i").
+      first.
+      match(%r!\AChange (\d+) created\.!).
+      captures.
+      first
+
+    Changelist.new(self, number)
+  end
+  
+  #
+  # Revert these files.
+  #
+  def revert_files(files)
+    unless files.empty?
+      run("revert", *files)
+    end
+  end
+
+  #
+  # Return the pending changelists (as Changelist objects).
+  #
+  def pending_changelists
+    command = %W(changelists -u #{@p4.user} -c #{@p4.client} -s pending)
+    run(*command).map { |elem|
+      Changelist.new(self, elem["change"].to_i)
+    }
+  end
+
+  #
+  # Delete all empty changelists.
+  #
+  def delete_empty_changelists
+    pending_changelists.each { |changelist|
+      changelist.delete
+    }
+  end
+
+  #
+  # Calls <code>run("sync", *args)</code>
+  #
+  def sync(*args)
+    run("sync", *args)
+  end
+
+  #
+  # Edit and submit files in one step.
+  #
+  # Example:
+  #   perforce.edit_and_submit("remove trailing whitespace", files) {
+  #     #
+  #     # Do stuff with the files.
+  #     # ...
+  #     #
+  #   }
+  #   #
+  #   # Changes are submitted when the block ends.
+  #   #
+  #
+  def edit_and_submit(changelist_description, files)
+    changelist = new_changelist(changelist_description)
+    changelist.add_files(files)
+    yield
+    changelist.submit
+  end
+
+  #
+  # Client root directory.
+  #
+  def root
+    dir = run(*%w(client -o)).first["Root"]
+    if CYGWIN
+      unix_dir = Util.unix_path(dir)
+      if dir != unix_dir
+        add_unix_root
+      end
+      unix_dir
+    else
+      dir
+    end
+  end
+
+  if CYGWIN
+    #
+    # <em>Cygwin-only.</em>
+    #
+    # Add a UNIX-style AltRoot.
+    #
+    # This allows P4Win and cygwin to work in the same client spec.
+    #
+    def add_unix_root #:nodoc:
+      client = run(*%w(client -o)).first
+      alt_roots = client["AltRoots"]
+      if alt_roots and alt_roots.include?(Util.unix_path(client["Root"]))
+        # has proper alt root
+      else
+        client["AltRoots"] =
+          alt_roots.to_a + [Util.unix_path(client["Root"])]
+        run_with_input(client, "client", "-i")
+        puts("Note: added unix AltRoot to client")
+      end
+    end
+  end
+
+  #
+  # Change working directory (locally and remotely).
+  #
+  def chdir(dir)
+    previous_dir = File.expand_path(".")
+    Dir.chdir(dir) {
+      @p4.cwd = File.expand_path(".")
+      yield
+    }
+    @p4.cwd = previous_dir
+  end
+
+  #
+  # Call P4#input(input) and then P4#run(*args)
+  #
+  def run_with_input(input, *args)
+    @p4.input = input
+    run(*args)
+  end
+
+  #
+  # Run a general p4 command.
+  #
+  # Example:
+  #   puts "Your server version is: "
+  #   puts perforce.run("info").first["serverVersion"]
+  #
+  def run(*args)
+    go = lambda {
+      @p4.run(*args).tap {
+        puts(@p4.warnings)
+      }
+    }
+    if CYGWIN
+      begin
+        go.call
+      rescue P4Exception
+        if @p4.connected?
+          # maybe unix root is not present; try again
+          add_unix_root
+          go.call
+        else
+          raise
+        end
+      end
+    else
+      # not CYGWIN
+      go.call
+    end
+  end
+
+  if CYGWIN
+    module Util #:nodoc:
+      def unix_path(dos_path) #:nodoc:
+        escaped_path = dos_path.sub(%r!\\+\Z!, "").gsub("\\", "\\\\\\\\")
+        `cygpath #{escaped_path}`.chomp
+      end
+      extend self
+    end
+  end
+
+  @use_pwd_symlinks = true
+  class << self
+    #
+    # Whether the current directory as reported to the perforce server
+    # can contain symlinks.  Default is false.
+    #
+    attr_accessor :use_pwd_symlinks
+  end
+
+  #
+  # A Perforce changelist.
+  #
+  # Use Perforce#new_changelist to create a new changelist.
+  #
+  class Changelist
+    def initialize(perforce, number) #:nodoc:
+      @perforce = perforce
+      @number = number
+    end
+
+    #
+    # Changelist number.
+    # 
+    attr_reader :number
+
+    # 
+    # Add files to this Changelist.
+    # 
+    # This is used for both editing files and adding new files.
+    # 
+    def add_files(files)
+      unless files.empty?
+        @perforce.run("edit", "-c", @number, *files)
+        @perforce.run("add", "-c", @number, *files)
+      end
+    end
+    
+    # 
+    # Revert these files in this changelist.
+    # 
+    def revert_files(files)
+      unless files.empty?
+        @perforce.run("revert", "-c", @number, *files)
+      end
+    end
+
+    # 
+    # Open files for deletion.  This action is added to the changelist.
+    # 
+    def delete_files(files)
+      unless files.empty?
+        @perforce.run("delete", "-c", @number, *files)
+      end
+    end
+
+    # 
+    # Submit this Changelist.
+    # 
+    def submit
+      revert_unchanged_files
+      if empty?
+        delete
+      else
+        @perforce.run("submit", "-c", @number)
+      end
+    end
+
+    # 
+    # True if there are no files in this Changelist.
+    # 
+    def empty?
+      not @perforce.run("describe", @number).first.has_key?("depotFile")
+    end
+
+    # 
+    # If empty, delete this Changelist.
+    # 
+    def delete
+      if empty?
+        @perforce.run("change", "-d", @number)
+      end
+    end
+
+    # 
+    # Info hash for this Changelist.
+    # 
+    def info
+      @perforce.run("change", "-o", @number).first
+    end
+    
+    # 
+    # Files in this Changelist.
+    # 
+    def files
+      info["Files"].to_a
+    end
+
+    # 
+    # Description of this changelist
+    # 
+    def description
+      info["Description"]
+    end
+
+    # 
+    # Status of this changelist
+    # 
+    def status
+      info["Status"]
+    end
+
+    # 
+    # Revert unchanged files in this Changelist.
+    # 
+    def revert_unchanged_files(in_files = nil)
+      files =
+        if in_files.nil?
+          self.files
+        else
+          in_files
+        end
+
+      unless files.empty?
+        @perforce.run("revert", "-a", "-c", @number, *files)
+      end
+    end
+  end
+end
+
+# version < 1.8.7 compatibility
+unless respond_to? :tap
+  module Kernel #:nodoc:
+    def tap #:nodoc:
+      yield self
+      self
+    end
+  end
+end

data/perforce.gemspec

@@ -0,0 +1,22 @@
+
+Gem::Specification.new { |t| 
+  t.name = "perforce"
+  t.version = "0.5.0"
+  t.summary = "Streamlined wrapper for p4ruby"
+  t.author = "James M. Lawrence"
+  t.email = "quixoticsycophant@gmail.com"
+  t.rubyforge_project = "perforce"
+  t.homepage = "perforce.rubyforge.org"
+  t.has_rdoc = true
+  t.extra_rdoc_files = ['README']
+  t.rdoc_options += %w{--title Perforce --main README}
+  t.add_dependency('p4ruby')
+  t.files = %w{
+    README
+    perforce.gemspec
+    install.rb
+    lib/perforce.rb
+    test/test_main.rb
+  }
+}
+

data/test/test_main.rb

@@ -0,0 +1,84 @@
+
+require 'rubygems'
+require 'perforce'
+require 'pp'
+
+def report(desc)
+  if block_given?
+    puts "#{desc}:"
+    pp yield
+  else
+    puts "#{desc}."
+  end
+  puts
+end
+
+def with_dummy_file(file)
+  File.open(file, "w") { |out| out.puts "test" }
+  begin
+    yield file
+  ensure
+    File.unlink(file)
+  end
+end
+
+perforce = Perforce.new
+
+report("Server info") {
+  perforce.run("info").first
+}
+
+root = perforce.root
+
+report("Client root") {
+  root
+}
+
+report("Pending changelists") {
+  perforce.pending_changelists
+}
+
+perforce.chdir(root) {
+  changelist = perforce.new_changelist("**RUBY TEST**")
+
+  report("Created test changelist: ##{changelist.number}")
+
+  report("Pending changelists") {
+    perforce.pending_changelists
+  }
+
+  with_dummy_file("dummy-test-file-for-ruby-perforce.txt") { |file|
+    changelist.add_files([file])
+
+    report("Added a dummy file to the changelist")
+    
+    report("Files in changelist") {
+      changelist.files
+    }
+    
+    report("Description for this changelist") {
+      changelist.description
+    }
+    
+    report("Status of this changelist") {
+      changelist.status
+    }
+    
+    changelist.revert_files([file])
+    
+    report("Reverted the dummy file")
+    
+    report("Files in changelist") {
+      changelist.files
+    }
+
+    changelist.delete
+    
+    report("Deleted changelist")
+    
+    report("Pending changelists") {
+      perforce.pending_changelists
+    }
+  }
+}
+  

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: perforce
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- James M. Lawrence
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: p4ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: quixoticsycophant@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- perforce.gemspec
+- install.rb
+- lib/perforce.rb
+- test/test_main.rb
+has_rdoc: true
+homepage: perforce.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- Perforce
+- --main
+- README
+require_paths: 
+- lib
+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: perforce
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Streamlined wrapper for p4ruby
+test_files: []
+