p4ruby 2014.2.0.pre3 → 2014.2.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d54de1eb7bb72644ffa5f247b42efda01c22783
-  data.tar.gz: 73b7022b99ad6a17f3b2737be1a38396514429f1
+  metadata.gz: 4b3f978b58597f0b0dceedf7f041fad06099e1b8
+  data.tar.gz: bae0a733de191edef6cfd399c5303b45870d5581
 SHA512:
-  metadata.gz: 5bbd0db7fa7bbe379a63e8c6b9c3522e6227c8c8c8e3a98166e90a6edb8ac9129e7aa6c625f4eb6bcee777dd6d4a058467e9db59685e77e1bb3ca20ba0744dbc
-  data.tar.gz: 7481faabf71db4ec9bbc860cbbf8b1c2ee37af08b534b7baa33f0ec17dd133ca66b52a892f2adc58bd9318fe7592aba3f292272fd6ee044a1cb98ef9b5e76c22
+  metadata.gz: 2ff8ca8759d02cd9242e4b442a56003bfa5f9df2a90134e2337ff0f9fc6f94bdf57f0ad8cf03f2b5a0c7cb5c7df86d1d82d32eb6d1bdf1ee90312bc674619f17
+  data.tar.gz: 8abffff36c41c61349c9bbace9bf5dfe05a7862031d4db41b23d42c6a0bef5d71270fb3b67749227ef12a5a65743400cc51a574897e82713b902f7e05a227617

data/{p4-doc/user/p4rubynotes.txt → README}

@@ -28,18 +28,45 @@ Introduction
 
 Installing P4Ruby
 
+	As of 2014.2, the recommended mechanism for installing P4Ruby is via gems.
+
+	Outside of Windows, p4ruby gem installs must be compiled locally against
+	your installation of Ruby. If you can build the core Ruby distribution
+	locally, you likely can install P4Ruby without incident.
+
+	On Windows, precompiled gems will be made available.
+
     The main command to install p4ruby is via gem or bundle.
 
-        gem install p4ruby
+        gem install p4ruby -- --with-p4api-dir=DIR
 
-    Or, in your Gemfile, specify
+    In this case, the DIR above is the path to the C++ API distribution that
+    should match the major and minor version of P4Ruby. If you omit the
+    --with-p4api-dir option, the gem will attempt to download a version of the
+    API itself from ftp.perforce.com.
 
-        ruby
-        gem 'p4_web_api_client'
+    Alternatively, you can use Bundler (http://bundler.io). In your Gemfile,
+    specify
+
+        gem 'p4_web_api_client', '~> 2014.2'
 
     And then execute:
 
-        bundle
+        bundle --with-p4api-dir=DIR
+
+Installing a prerelease version of P4Ruby
+
+    Prereleases of upcoming versions are available also from RubyGems. The
+    syntax for prereleases typically involves adding the '.preN' suffix to your
+    version string, and indicating it directly.
+
+    For example:
+
+        # gem command line
+    	gem install p4ruby --version=2014.2.0.pre5 -- --with-p4api-dir=DIR
+
+    	# Gemfile, using range syntax
+    	gem 'p4ruby', '~> 2014.2.0.pre'
 
 --------------------------------------------------------------------------
 
@@ -54,9 +81,6 @@ Building P4Ruby from Source
 	              of the Perforce API. Using the 'macos' variant
 	              does not work.
 
-	   Windows users should get the API from the
-	   "bin.mingwx86" platform directory for Ruby 1.8 or 1.9.
-
 	   TODO - Document the correct directory for Ruby 2.0 and 2.1 on
 	   Windows when it is made available.
 	   
@@ -76,15 +100,18 @@ Building P4Ruby from Source
     4. Test your distribution, which relies on a locally installed p4d,
        easily made available via the p4util project:
 
+		# This downloads a matching p4d executable and puts it into the local
+		# path work/p4d. You can replace these commands if you already have
+		# the p4d version you want to test against.
         gem install p4util
         p4util download p4d
+
+        # Run local tests
         rake test
 
-	5. To install P4Ruby, generate the gem:
+	5. Install P4Ruby into your local gem cache:
 
-	    gem build p4ruby.gemspec
-	    gem install p4ruby-<version>.gem \
-	        --with-p4api-dir=<absolute path to Perforce C++ API>
+		rake install
 
 	SSL support
 	-----------
@@ -116,8 +143,9 @@ Compatibility Statements
 
 	Ruby Compatibility
 
-	  The 2014.2 release of P4Ruby is supported building from source
-	  with Ruby 1.9, 2.0, and 2.1.
+	  The 2014.2 release of P4Ruby is supported by installing the gem
+	  with Ruby MRI releases 2.0, 2.1, and 2.2 with shared library
+	  support.
 
 	  For detailed compatibility, please check the following table:
 
@@ -128,12 +156,25 @@ Compatibility Statements
 		     1.9     | 2011.1 or later
              2.0     | 2014.1 or later
              2.1     | 2014.2 or later
-
-	  The 2014.1 P4Ruby Windows installer requires Ruby 1.8 and was
-	  built with RubyInstaller 1.8 and MinGW 32-bit.
-
-	  TODO When MinGW-w64 builds are available, indicate that the
-	  P4Ruby 2014.2 builds do not need the windows installer.
+             2.2     | 2014.2 or later
+
+	  TODO 2014.2.0.pre4 needs mingw-w64 builds to support Ruby on windows
+
+	  It is recommended that you use a Ruby distribution that can deploy
+	  native gems easily, which, outside of Windows means obtaining a source
+	  distribution of ruby and building it locally. This is easily done via RVM,
+	  and can be installed system-wide, with other features (like wrappers) that
+	  allow you to update the local installation of Ruby as security patches are
+	  released. If using RVM, be sure to use --disable-binary when installing
+	  your version of Ruby, to avoid any precompiled distributions that may not
+	  have shared library support configured, which is needed for Ruby
+	  extensions.
+
+	  In general, Ruby VMs installed via package managers are not officially
+	  coordinated with the MRI releases available on ruby-lang.org. You will
+	  have to investigate the reliability of the source of your Ruby
+	  distribution. In general, Ruby web application deployments avoid default
+	  installations of Ruby, though your requirements may vary.
 
 	OpenSSL Compatibility
 
@@ -161,8 +202,8 @@ Compatibility Statements
 	  only on the following platforms:
 
 		Linux 2.6 Intel (x86, x86_64)
-		Windows XP SP2+, 2003, Vista, 7, 2008 Intel (x86)
-		Mac OS X 10.6, 10.7, 10.8 (x86_64), 10.9 (x86_64)
+		Windows XP SP2+, 2003, Vista, 7, 2008 Intel (x86), 8.1
+		Mac OS X 10.6, 10.7, 10.8 (x86_64), 10.9 (x86_64), 10.10 (x86_64)
 		
 	  Note: As of 2012.1, a universal build of the Perforce C/C++
 		API is no longer available for Darwin. P4Ruby is now 
@@ -320,6 +361,34 @@ New functionality in 2014.2
 		Add `enviro_file` property to P4 object, which underneath, uses the
 		new `SetEnviroFile`/`GetEnviroFile` mechanism from the 14.2 C++ API.
 
+Changes in 2014.2.0.pre5
+
+    * Fixed an issue where using the --with-p4api-dir option to gem install
+      would not actually set up the include and lib compilation directory
+      correctly.
+
+    * No longer distributing precompiled builds for linux or OS X due to
+      inadequate information from gem to match the Ruby distribution correctly.
+
+    * No longer embedding the C++ P4API to keep the total file size down to
+      allow the gem to be distributed via RubyGems.org.
+
+    * Changed logic to call p4.charset=nil if charset is already nil or resolves
+      to 'none'. Internally, this will trigger a call to ClientApi::SetTrans(0),
+      which should disable character set autodetection.
+
+Bugs fixed in 2014.2.0.pre4
+
+    * (BUG#77207 / P4RUBY-176)
+        If the user has specified 'P4CHARSET=none' in a configuration file, or
+        has not set p4.charset='auto' (and it's default value was initialized to
+        'none' by the C++ API), automatically disable character set detection.
+        This can cause the API to break when connecting to non-unicode servers
+        even though it appears to be configured to not be a unicode client.
+
+    * The default C++ API version should be included with the gem source, to
+      avoid calls to ftp.perforce.com.
+
 Bugs fixed in 2014.2.0.pre3
 
 	* (BUG#75096 / P4RUBY-168)

data/ext/P4/extconf.rb

@@ -362,6 +362,7 @@ def resolve_p4api_dir
     dir_config('p4api', "#{p4api_dir}/include", "#{p4api_dir}/lib")
   elsif with_config('p4api_dir')
     p4api_dir = with_config('p4api-dir')
+    dir_config('p4api', "#{p4api_dir}/include", "#{p4api_dir}/lib")
   elsif !p4api_dir
     raise '--with-p4api-dir option has not been specified, and --disable-p4api-download is in effect'
   end

data/lib/P4.rb

@@ -133,6 +133,14 @@ class P4
     "servers" => ["server", "Name"],
   }
 
+  def initialize
+    # This will (eventually) call ClientApi::SetTrans(0) which should happen
+    # when we have not set a charset or the environment detects the 'none'
+    # setting. For whatever reason this is not done automatically by the API
+    # logic.
+    self.charset = nil if !self.charset or self.charset == 'none'
+  end
+
   def method_missing( m, *a )
 
     # Generic run_* methods

data/lib/P4/version.rb

@@ -1,3 +1,3 @@
 class P4
-  Version = VERSION = '2014.2.0.pre3'
+  Version = VERSION = '2014.2.0.pre5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: p4ruby
 version: !ruby/object:Gem::Version
-  version: 2014.2.0.pre3
+  version: 2014.2.0.pre5
 platform: ruby
 authors:
 - Perforce Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies: []
 description: Ruby extensions to the C++ Perforce API.
 email: support@perforce.com
@@ -18,6 +18,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- README
 - ext/P4/clientprogressruby.cpp
 - ext/P4/clientprogressruby.h
 - ext/P4/clientuserruby.cpp
@@ -45,7 +46,6 @@ files:
 - ext/P4/undefdups.h
 - lib/P4.rb
 - lib/P4/version.rb
-- p4-doc/user/p4rubynotes.txt
 homepage: http://www.perforce.com/product/components/apis
 licenses:
 - MIT
@@ -56,12 +56,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []