php-serialize 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d3c32a1fe43d8186acdc93c67320994c69ae8d4
+  data.tar.gz: 2fe820e15442213a58e8c084965583155cada091
+SHA512:
+  metadata.gz: 42a2a80a57cf7c4b57a80f65804172a95407a2d27f5ae9d7daca1a4224ffe3eee926efda691161917639d4959b1870f2e28db9c32add604419855954e1879578
+  data.tar.gz: e656d868b8a3a1d87b8bcb5827021dd31b2fb729539388efab48e8f02938d4ee177046863b9950c7993b15c60a288387ded2b9b2acd9ac2fd3edb6a4ac691024

data/lib/php-serialize.rb

@@ -0,0 +1,2 @@
+# Bunlder auto requires the gemname, so we redirect to the right file.
+require "php_serialize"

data/lib/php_serialize.rb

@@ -1,55 +1,31 @@
-#!/usr/bin/env ruby
-# Copyright (c) 2003-2009 Thomas Hurst <tom@hur.st>
-#
-# 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.
-
-# PHP serialize() and unserialize() workalikes
-#
-# Release History:
-#  1.0.0 - 2003-06-02 - First release.
-#  1.0.1 - 2003-06-16 - Minor bugfixes.
-#  1.0.2 - 2004-09-17 - Switch all {}'s to explicit Hash.new's.
-#  1.1.0 - 2009-04-01 - Pass assoc to recursive calls (thanks to Edward Speyer).
-#                     - Serialize Symbol like String.
-#                     - Add testsuite.
-#                     - Instantiate auto-generated Structs properly (thanks
-#                       to Philip Hallstrom).
-#                     - Unserialize arrays properly in assoc mode.
-#                     - Add PHP session support (thanks to TJ Vanderpoel).
-#                     - Release as tarball and gem.
-#
-# See http://www.php.net/serialize and http://www.php.net/unserialize for
-# details on the PHP side of all this.
+require 'stringio'
+
 module PHP
-# string = PHP.serialize(mixed var[, bool assoc])
-#
-# Returns a string representing the argument in a form PHP.unserialize
-# and PHP's unserialize() should both be able to load.
-#
-# Array, Hash, Fixnum, Float, True/FalseClass, NilClass, String and Struct
-# are supported; as are objects which support the to_assoc method, which
-# returns an array of the form [['attr_name', 'value']..].  Anything else
-# will raise a TypeError.
-#
-# If 'assoc' is specified, Array's who's first element is a two value
-# array will be assumed to be an associative array, and will be serialized
-# as a PHP associative array rather than a multidimensional array.
+	class StringIOReader < StringIO
+		# Reads data from the buffer until +char+ is found. The
+		# returned string will include +char+.
+		def read_until(char)
+			val, cpos = '', pos
+			if idx = string.index(char, cpos)
+				val = read(idx - cpos + 1)
+			end
+			val
+		end
+	end
+
+	# Returns a string representing the argument in a form PHP.unserialize
+	# and PHP's unserialize() should both be able to load.
+	#
+	#   string = PHP.serialize(mixed var[, bool assoc])
+	#
+	# Array, Hash, Fixnum, Float, True/FalseClass, NilClass, String and Struct
+	# are supported; as are objects which support the to_assoc method, which
+	# returns an array of the form [['attr_name', 'value']..].  Anything else
+	# will raise a TypeError.
+	#
+	# If 'assoc' is specified, Array's who's first element is a two value
+	# array will be assumed to be an associative array, and will be serialized
+	# as a PHP associative array rather than a multidimensional array.
 	def PHP.serialize(var, assoc = false) # {{{
 		s = ''
 		case var
@@ -83,7 +59,7 @@ module PHP
 				s << '}'
 
 			when String, Symbol
-				s << "s:#{var.to_s.length}:\"#{var.to_s}\";"
+				s << "s:#{var.to_s.bytesize}:\"#{var.to_s}\";"
 
 			when Fixnum # PHP doesn't have bignums
 				s << "i:#{var};"
@@ -95,7 +71,7 @@ module PHP
 				s << 'N;'
 
 			when FalseClass, TrueClass
-				s << "b:#{var ? 1 :0};"
+				s << "b:#{var ? 1 : 0};"
 
 			else
 				if var.respond_to?(:to_assoc)
@@ -114,10 +90,10 @@ module PHP
 		s
 	end # }}}
 
-# string = PHP.serialize_session(mixed var[, bool assoc])
-#
-# Like PHP.serialize, but only accepts a Hash or associative Array as the root
-# type.  The results are returned in PHP session format.
+	# Like PHP.serialize, but only accepts a Hash or associative Array as the root
+	# type.  The results are returned in PHP session format.
+	#
+	#   string = PHP.serialize_session(mixed var[, bool assoc])
 	def PHP.serialize_session(var, assoc = false) # {{{
 		s = ''
 		case var
@@ -145,38 +121,38 @@ module PHP
 		s
 	end # }}}
 
-# mixed = PHP.unserialize(string serialized, [hash classmap, [bool assoc]])
-#
-# Returns an object containing the reconstituted data from serialized.
-#
-# If a PHP array (associative; like an ordered hash) is encountered, it
-# scans the keys; if they're all incrementing integers counting from 0,
-# it's unserialized as an Array, otherwise it's unserialized as a Hash.
-# Note: this will lose ordering.  To avoid this, specify assoc=true,
-# and it will be unserialized as an associative array: [[key,value],...]
-#
-# If a serialized object is encountered, the hash 'classmap' is searched for
-# the class name (as a symbol).  Since PHP classnames are not case-preserving,
-# this *must* be a .capitalize()d representation.  The value is expected
-# to be the class itself; i.e. something you could call .new on.
-#
-# If it's not found in 'classmap', the current constant namespace is searched,
-# and failing that, a new Struct(classname) is generated, with the arguments
-# for .new specified in the same order PHP provided; since PHP uses hashes
-# to represent attributes, this should be the same order they're specified
-# in PHP, but this is untested.
-#
-# each serialized attribute is sent to the new object using the respective
-# {attribute}=() method; you'll get a NameError if the method doesn't exist.
-#
-# Array, Hash, Fixnum, Float, True/FalseClass, NilClass and String should
-# be returned identically (i.e. foo == PHP.unserialize(PHP.serialize(foo))
-# for these types); Struct should be too, provided it's in the namespace
-# Module.const_get within unserialize() can see, or you gave it the same
-# name in the Struct.new(<structname>), otherwise you should provide it in
-# classmap.
-#
-# Note: StringIO is required for unserialize(); it's loaded as needed
+	# Returns an object containing the reconstituted data from serialized.
+	#
+	#   mixed = PHP.unserialize(string serialized, [hash classmap, [bool assoc]])
+	#
+	# If a PHP array (associative; like an ordered hash) is encountered, it
+	# scans the keys; if they're all incrementing integers counting from 0,
+	# it's unserialized as an Array, otherwise it's unserialized as a Hash.
+	# Note: this will lose ordering.  To avoid this, specify assoc=true,
+	# and it will be unserialized as an associative array: [[key,value],...]
+	#
+	# If a serialized object is encountered, the hash 'classmap' is searched for
+	# the class name (as a symbol).  Since PHP classnames are not case-preserving,
+	# this *must* be a .capitalize()d representation.  The value is expected
+	# to be the class itself; i.e. something you could call .new on.
+	#
+	# If it's not found in 'classmap', the current constant namespace is searched,
+	# and failing that, a new Struct(classname) is generated, with the arguments
+	# for .new specified in the same order PHP provided; since PHP uses hashes
+	# to represent attributes, this should be the same order they're specified
+	# in PHP, but this is untested.
+	#
+	# each serialized attribute is sent to the new object using the respective
+	# {attribute}=() method; you'll get a NameError if the method doesn't exist.
+	#
+	# Array, Hash, Fixnum, Float, True/FalseClass, NilClass and String should
+	# be returned identically (i.e. foo == PHP.unserialize(PHP.serialize(foo))
+	# for these types); Struct should be too, provided it's in the namespace
+	# Module.const_get within unserialize() can see, or you gave it the same
+	# name in the Struct.new(<structname>), otherwise you should provide it in
+	# classmap.
+	#
+	# Note: StringIO is required for unserialize(); it's loaded as needed
 	def PHP.unserialize(string, classmap = nil, assoc = false) # {{{
 		if classmap == true or classmap == false
 			assoc = classmap
@@ -184,33 +160,19 @@ module PHP
 		end
 		classmap ||= {}
 
-		require 'stringio'
-		string = StringIO.new(string)
-		def string.read_until(char)
-			val = ''
-			while (c = self.read(1)) != char
-				val << c
-			end
-			val
+		ret = nil
+		string = StringIOReader.new(string)
+		while string.string[string.pos, 32] =~ /^(\w+)\|/ # session_name|serialized_data
+			ret ||= {}
+			string.pos += $&.size
+			ret[$1] = PHP.do_unserialize(string, classmap, assoc)
 		end
 
-		if string.string =~ /^(\w+)\|/ # session_name|serialized_data
-			ret = Hash.new
-			loop do
-				if string.string[string.pos, 32] =~ /^(\w+)\|/
-					string.pos += $&.size
-					ret[$1] = PHP.do_unserialize(string, classmap, assoc)
-				else
-					break
-				end
-			end
-			ret
-		else
-			PHP.do_unserialize(string, classmap, assoc)
-		end
+		ret ? ret : PHP.do_unserialize(string, classmap, assoc)
 	end
 
-private
+	private
+
 	def PHP.do_unserialize(string, classmap, assoc)
 		val = nil
 		# determine a type
@@ -279,7 +241,7 @@ private
 
 						val = val.new
 					rescue NameError # Nope; make a new Struct
-						classmap[klass] = Struct.new(klass.to_s, *attrs.collect { |v| v[0].to_s })
+						classmap[klass] = val = Struct.new(klass.to_s, *attrs.collect { |v| v[0].to_s })
 						val = val.new
 					end
 				end
@@ -311,4 +273,3 @@ private
 		val
 	end # }}}
 end
-

data/{test.rb → test/php_serialize_test.rb}

@@ -1,8 +1,9 @@
 #!/usr/local/bin/ruby
+# encoding: utf-8
 
 require 'test/unit'
 
-$:.unshift "lib"
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
 require 'php_serialize'
 
 TestStruct = Struct.new(:name, :value)
@@ -57,9 +58,9 @@ class TestPhpSerialize < Test::Unit::TestCase
 	test false, 'b:0;'
 	test true, 'b:1;'
 	test 42, 'i:42;'
-	test -42, 'i:-42;'
+	test(-42, 'i:-42;')
 	test 2147483647, "i:2147483647;", :name => 'Max Fixnum'
-	test -2147483648, "i:-2147483648;", :name => 'Min Fixnum'
+	test(-2147483648, "i:-2147483648;", :name => 'Min Fixnum')
 	test 4.2, 'd:4.2;'
 	test 'test', 's:4:"test";'
 	test :test, 's:4:"test";', :name => 'Symbol'
@@ -72,6 +73,10 @@ class TestPhpSerialize < Test::Unit::TestCase
 	test TestClass.new("Foo", 65), 'O:9:"testclass":2:{s:4:"name";s:3:"Foo";s:5:"value";i:65;}',
 		:name => 'Class'
 
+  # PHP counts multibyte string, not string length
+  def test_multibyte_string
+    assert_equal  "s:6:\"öäü\";", PHP.serialize("öäü")
+  end
 	# Verify assoc is passed down calls.
 	# Slightly awkward because hashes don't guarantee order.
 	def test_assoc
@@ -102,8 +107,11 @@ class TestPhpSerialize < Test::Unit::TestCase
 			assert phps.include?(serialized)
 		end
 	end
-end
-
-require 'test/unit/ui/console/testrunner'
-Test::Unit::UI::Console::TestRunner.run(TestPhpSerialize)
 
+  def test_new_struct_creation
+    assert_nothing_raised do
+      phps = 'O:8:"stdClass":2:{s:3:"url";s:17:"/legacy/index.php";s:8:"dateTime";s:19:"2012-10-24 22:29:13";}'
+      PHP.unserialize(phps)
+    end
+  end
+end

metadata

@@ -1,54 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: php-serialize
-version: !ruby/object:Gem::Version 
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Thomas Hurst
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-04-01 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: "This module provides two methods: PHP.serialize() and PHP.unserialize(), both of which should be compatible with the similarly named functions in PHP.  It can also serialize and unserialize PHP sessions."
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "\t\tThis module provides two methods: PHP.serialize() and PHP.unserialize(),
+  both\n\t\tof which should be compatible with the similarly named functions in PHP.\n\n\t\tIt
+  can also serialize and unserialize PHP sessions.\n"
 email: tom@hur.st
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README
+files:
+- lib/php-serialize.rb
 - lib/php_serialize.rb
-has_rdoc: true
+- test/php_serialize_test.rb
 homepage: http://www.aagh.net/projects/ruby-php-serialize
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib/
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 2.6.11
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: Ruby analogs to PHP's serialize() and unserialize() functions
-test_files: 
-- test.rb
+test_files:
+- test/php_serialize_test.rb

data/README

@@ -1,34 +0,0 @@
-Ruby PHP Serializer
-===================
-
-This module provides two methods: PHP.serialize() and PHP.unserialize(), both
-of which should be compatible with the similarly named functions in PHP.
-
-Basic usage:
-
- require 'php_serialize'
- in = {'foo' => 'bar'}
- php = PHP.serialize(in)
- # pass string to PHP unserialize() to get array('foo' => 'bar')
- out = PHP.unserialize(php) # => {'foo' => 'bar'}
-
-
-PHP.unserialize can also read PHP sessions, which are collections of named
-serialized objects.  These can be reserialized using PHP.serialize_session(),
-which has the same semantics as PHP.serialize(), but which only supports
-Hash and associative Arrays for the root object.
-
-
-Acknowledgements
-================
-
-TJ Vanderpoel, initial PHP serialized session support.
-
-Philip Hallstrom, fix for self-generated Structs on unserialization.
-
-Edward Speyer, fix for assoc serialization in nested structures.
-
-
-
-Author: Thomas Hurst <tom@hur.st>, http://hur.st/
-WWW: http://www.aagh.net/projects/ruby-php-serialize