unpickle 0.0.1 → 0.0.2

data/README.md

@@ -7,9 +7,9 @@ This is a very limited tool to unpickle python 'pickle' objects.
     require 'unpickle'
     
     fh = File.open('some.pickle')
-    o = unpickle(fh.read)
+    o = Unpickle.loads(fh.read)
 
-unpickle() will raise Unpickle::UnpickleException if it doesn't support an
+loads() will raise Unpickle::UnpickleException if it doesn't support an
 opcode in the picklestream, or encounters some kind of problem or invalid 
 sequence.
 
@@ -28,9 +28,6 @@ None will be returned as nil.
 
  * Support more of protocol 0.
  * Support newer protocols.
- * Test object identity mapping.
- * Package as a gem
- * fix namespace.
 
 # Author
 

data/lib/unpickle.rb

@@ -1,17 +1,21 @@
-# unpickle.rb
-# 
-# baby-unpickler to handle limited protocol 0 crap.
-#
-# vim:et sts=4 sw=4 ts=8:
+# Library to handle a limited subset of python objects
+# picked using protocol 0.
 #
+# Author:: Chris Collins (mailto:kuroneko-rubygems@sysadninjas.net)
+# Copyright:: Copyright (c) 2012 Chris Collins, Anchor Systems Pty Ltd
 module Unpickle
+    # UnpickleException is the superclass for all exceptions thrown by
+    # the unpickler.
+    # 
+    # Currently this gets thrown directly, but future versions may 
+    # subclass this to provide better granularity in error reporting.
     class UnpickleException < RuntimeError
     end
 
-    class Mark
+    class Mark #:nodoc:
     end
 
-    class PickleMachine
+    class PickleMachine #:nodoc: all
         def initialize(input)
             @stack = []
             @memo = {}
@@ -201,13 +205,10 @@ module Unpickle
     # (dicts, lists, tuples, strings, ints, bools, None) and only with
     # protocol 0.
     # 
-    # Object uniqueness should obey the python semantics but is largely 
-    # untested.
-    #
     # Raises an UnpickleException if anything goes wrong.
     def Unpickle.loads(str)
         p = Unpickle::PickleMachine.new(str)
         return p.unpickle
     end
 end
-
+# vim:et sts=4 sw=4 ts=8:

data/test/test_unpickle.rb

@@ -1,6 +1,5 @@
-# tests for Unpickle.loads.rb
+# tests for lib/unpickle.rb
 #
-# vim:et sts=4 sw=4 ts=8:
 require 'test/unit'
 require 'unpickle'
 
@@ -97,3 +96,4 @@ class UnpickleTests < Test::Unit::TestCase
         assert(o.object_id == o['b']['a'].object_id)
     end
 end
+# vim:et sts=4 sw=4 ts=8:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unpickle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: