p4util 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45a2fa04d57ee5b6aca04b509acc1705dffb1f35
-  data.tar.gz: 0561143880e7350548859aa309f2c499d3ac3d70
+  metadata.gz: 8e13e10a9b31fb12e34d23ee7f6495eca21ce5e6
+  data.tar.gz: 2bf3006c190afaf1d19d0c2e216c6812d585f28f
 SHA512:
-  metadata.gz: 1c01e49961c05d2fe79b25c504e7748349e014407ef0975c6f1dc1434b24e02a344512d840758f68601fcb3dcd434769bcd2281eb36ed5e700de064a25039292
-  data.tar.gz: d4e3bc148311ae182387bfe3db5541d10e5a1dae0c26fe8d8bd12a432f8749d181adfcbfc5ac27b766b18b0d38b07645f15bfd0e22267eec613254c63d8f1be2
+  metadata.gz: 621d7626122bd7e2517191a45570c6f0e62bc93ecbb989f4f61cd475b4236c37259c624fad705e208b30897810a095b148383edae583eea109cb5e4988b6c936
+  data.tar.gz: d8882a9dedc2b56fa15f4ea1a3fc6c81181785b5542548c57546060eff3e0a17f0bd53fbe6dfd46920e237f60eabe67fb28839004ba1da0e1ef5341935a451e8

data/README.md

@@ -35,6 +35,8 @@ Or install it yourself as:
 
 ## Changes
 
+* 0.1.1: Added documentation for Rake tasks and version string output
+
 * 0.1.0: Added `p4util init` command that can do some common p4d configurations,
   like setting unicode and security settings, along with users and basic 
   adds and edits of files.

data/lib/commands/help.rb

@@ -25,6 +25,10 @@ module Commands
         init - Seed the local p4d instance using local configuration files
         kill - Shutdown p4d processes using SIGTERM
         start - Spawn the p4d process in your working directory
+
+      Additional 'commands' you can use for more information:
+        version - Print the version string
+        rake - Some notes on how to use the Rake tasks
     END
   end
 end

data/lib/commands/rake.rb

@@ -0,0 +1,38 @@
+
+module Commands
+
+  def Commands.rake(options)
+    print_rake_help
+  end
+
+  private
+
+  def Commands.print_rake_help
+    puts <<-END.gsub(/^ {6}/, '')
+      Use rake to drive p4util commands
+
+      Example usage in your Rakefile:
+
+          require 'p4util/tasks'
+
+          P4Util::Tasks.new do |p4util|
+            p4util.version = 'r14.2'
+            p4util.p4_init_dir = 'spec/init.base'
+          end
+
+      This defines three tasks for you:
+
+      * `p4init` - See 'p4util help init'
+      * `p4kill` - See 'p4util help kill'
+      * `p4reset` - Calls p4kill then removes the work/p4droot folder
+
+      (This assumes you have installed p4util or setup the p4util gem dependency.)
+
+      The `version` property specifies the version of p4d to download and run.
+      It mirrors the version directory names of ftp.perforce.com at the moment.
+
+      The `p4_init_dir` property indicates a directory of ruby scripts that
+      define the script files for the p4util init command.
+    END
+  end
+end

data/lib/commands/version.rb

@@ -0,0 +1,17 @@
+
+require 'p4util/version'
+
+module Commands
+
+  def Commands.version(options)
+    print_version_help
+  end
+
+  private
+
+  def Commands.print_version_help
+    puts <<-END.gsub(/^ {6}/, '')
+      p4util #{P4Util::VERSION}
+    END
+  end
+end

data/lib/commands.rb

@@ -2,4 +2,6 @@ require 'commands/download'
 require 'commands/init'
 require 'commands/help'
 require 'commands/kill'
-require 'commands/start'
+require 'commands/rake'
+require 'commands/start'
+require 'commands/version'

data/lib/p4util/version.rb

@@ -1,3 +1,3 @@
 module P4Util
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: p4util
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tristan Juricek
@@ -92,8 +92,10 @@ files:
 - "./lib/commands/init/system_settings_model.rb"
 - "./lib/commands/init/user_model.rb"
 - "./lib/commands/kill.rb"
+- "./lib/commands/rake.rb"
 - "./lib/commands/start.rb"
 - "./lib/commands/util.rb"
+- "./lib/commands/version.rb"
 - "./lib/conventions.rb"
 - "./lib/osutil.rb"
 - "./lib/p4util.rb"