php-serial 0.9.0 → 0.9.5

data/README.md

@@ -1,6 +1,7 @@
-# Php::Serial
+# Php-Serial
 
-TODO: Write a gem description
+PHP serialization library.  Reads and writes PHP's serialization format.
+Also has support for reading and writing PHP sessions.
 
 ## Installation
 
@@ -18,7 +19,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This library provides 4 public methods:
+Php.serialize
+
+    Php.serilialize ['string', 100]
+    => "a:2:{i:0;s:6:\"string\";i:1;i:100;}"
+Php.unserialize
+
+    Php.unserialize "a:2:{i:0;s:6:\"string\";i:1;i:100;}"
+    => ["string", 100]
+Php.serialize_session
+
+    Php.unserialize_session "var_a|s:6:\"string\";var_b|d:3.14"
+    => {"var_a"=>"string", "var_b"=>3.14}
+Php.unserialize_session
+
+    Php.unserialize_session {"var_a"=>"string", "var_b"=>3.14}
+    => "var_a|s:6:\"string\";var_b|d:3.14"
 
 ## Contributing
 

data/lib/php-serial.rb

@@ -1,6 +1,63 @@
 require "php-serial/version"
 
 module Php
+  # Serializes a ruby object into PHP serialized format
+  #
+  # Params:
+  #   Mixed var
+  # Returns: string
+  def self.serialize(var)
+    val = ''
+    case var.class.to_s
+      when 'NilClass'
+        val = 'N;'
+      when 'Fixnum'
+        val = 'i:' + var.to_s + ';'
+      when 'Float'
+        val = 'd:' + var.to_s + ';'
+      when 'TrueClass'
+        val = 'b:1' + ';'
+      when 'FalseClass'
+        val = 'b:0' + ';'
+      when 'String', 'Symbol'
+        val = 's:' + var.length.to_s + ':' + '"' + var.to_s + '";'
+      when 'Array'
+        val = 'a:' + var.length.to_s + ':' + '{'
+        var.length.times do |index|
+          val += serialize(index) + serialize(var[index])
+        end
+        val += '}'
+      when 'Hash'
+        val = 'a:' + var.length.to_s + ':' + '{'
+        var.each do |item_key, item_value|
+          val += serialize(item_key) + serialize(item_value)
+        end
+        val += '}'
+      else
+        klass = var.class.to_s
+        val = "O:#{klass.length.to_s}:\"#{klass}\":#{var.instance_variables.length}:{"
+        var.instance_variables.each do |ivar|
+          ivar = ivar.to_s
+          ivar.slice!(0)
+          val += serialize(ivar) + serialize(var.send(ivar))
+        end
+        val += '}'
+    end
+    val
+  end
+
+  # Serializes a hash into PHP session
+  #
+  # Params:
+  #   Hash hash
+  # Returns: string
+  def self.serialize_session(hash)
+    serialized_session = ''
+    hash.each do |key,value|
+      serialized_session += key.to_s + "|" + serialize(value)
+    end
+    serialized_session
+  end
 
   # Unserializes a PHP session
   # 
@@ -13,7 +70,7 @@ module Php
     
     while !data.empty? do
       key = extract_until!(data, "|")
-      hash[key] = unserialize(data)
+      hash[key] = unserialize!(data)
     end
     hash
   end
@@ -24,6 +81,17 @@ module Php
   #   String data
   # Returns: mixed
   def self.unserialize(data='')
+    unserialize!(data.strip)
+  end
+
+  private
+
+  # Unserializes recursively.  Consumes the input string.
+  # 
+  # Params:
+  #   String data
+  # Returns: mixed
+  def self.unserialize!(data='')
     var_type = data.slice!(0)
     data.slice!(0)
     case var_type
@@ -45,8 +113,8 @@ module Php
         length = extract_until!(data, ":").to_i
         extract_until!(data, '{')
         length.times do
-          key = unserialize(data)
-          value[key] = unserialize(data)
+          key = unserialize!(data)
+          value[key] = unserialize!(data)
         end
         extract_until!(data, "}")
         # if keys are sequential numbers, return array        
@@ -60,72 +128,13 @@ module Php
         length = extract_until!(data, ":").to_i
         extract_until!(data, '{')
         length.times do
-          key = unserialize(data)
-          value[key] = unserialize(data)
+          key = unserialize!(data)
+          value[key] = unserialize!(data)
         end
     end
     value
   end
 
-  # Serializes a hash into PHP session
-  #
-  # Params:
-  #   Hash hash
-  # Returns: string
-  def self.serialize_session(hash)
-    serialized_session = ''
-    hash.each do |key,value|
-      serialized_session += key.to_s + "|" + serialize(value)
-    end
-    serialized_session
-  end
-
-
-  # Serializes a ruby object into PHP serialized format
-  #
-  # Params:
-  #   Mixed var
-  # Returns: string
-  def self.serialize(var)
-    val = ''
-    case var.class.to_s
-      when 'NilClass'
-        val = 'N;'
-      when 'Fixnum'
-        val = 'i:' + var.to_s + ';'
-      when 'Float'
-        val = 'd:' + var.to_s + ';'
-      when 'TrueClass'
-        val = 'b:1' + ';'
-      when 'FalseClass'
-        val = 'b:0' + ';'
-      when 'String', 'Symbol'
-        val = 's:' + var.length.to_s + ':' + '"' + var.to_s + '";'
-      when 'Array'
-        val = 'a:' + var.length.to_s + ':' + '{'
-        var.length.times do |index|
-          val += serialize(index) + serialize(var[index])
-        end
-        val += '}'
-      when 'Hash'
-        val = 'a:' + var.length.to_s + ':' + '{'
-        var.each do |item_key, item_value|
-          val += serialize(item_key) + serialize(item_value)
-        end
-        val += '}'
-      else
-        klass = var.class.to_s
-        val = "O:#{klass.length.to_s}:\"#{klass}\":#{var.instance_variables.length}:{"
-        var.instance_variables.each do |ivar|
-          ivar = ivar.to_s
-          ivar.slice!(0)
-          val += serialize(ivar) + serialize(var.send(ivar))
-        end
-        val += '}'
-    end
-    val
-  end
-
   # Return all characters up to the first occurrence of char
   # Truncates those characters from input string
   # 

data/lib/php-serial/version.rb

@@ -1,5 +1,5 @@
 module Php
   module Serial
-    VERSION = "0.9.0"
+    VERSION = "0.9.5"
   end
 end

data/test/php_serial_test.rb

@@ -126,6 +126,12 @@ describe 'Unserialize' do
     expected = {"class" => "Person", "first_name" => "John", "last_name" => "Doe"}
     Php.unserialize(input).must_equal expected
   end
+
+  it 'should not alter the input' do
+    input = "serialized data"
+    Php.unserialize(input)
+    input.must_equal "serialized data"
+  end
 end
 
 
@@ -167,4 +173,10 @@ describe 'Unserialize Session' do
     }
     Php.unserialize_session(input).must_equal expected
   end
+
+  it 'should not alter the input' do
+    input = "serialized data"
+    Php.unserialize_session(input)
+    input.must_equal "serialized data"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: php-serial
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-17 00:00:00.000000000 Z
 dependencies: []
 description: PHP serialization/unserialization with session support
 email: