rlp 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf98346ec86ff3aba23c41e47c045cabb289c3b8
-  data.tar.gz: 812e1c73e84ca3895d8d9ea7d1f8719fbc221ce4
+  metadata.gz: 3a7e6cfb6c2ff329ee45d38680304abe966afa38
+  data.tar.gz: 9a9c72a1be75da655162c63dbc351c10e621aadc
 SHA512:
-  metadata.gz: 6f02f081b0843fa2d37abbba64e46e5d0721c315dfa59033223b9c2308537171948fafca767967d0f49846272391930969824542e338f02a7dd152a1cae20d25
-  data.tar.gz: ce2fff4c4eaa42e0874fe5bfac6743df67c513fbf03f3f5b9843530a85499e7a2e1bd5e34b57b2698e99f16eda8e4c2bc4de2df24ec654d6ecfff362a12abe53
+  metadata.gz: 5ae8922fc6fd5b0b641d03103218ebc2368562156cf1220469ab15dbcbde92436dd8a543473339c036d70e59af227c9f44614df75bc5b36f9bf188b0be20dd5a
+  data.tar.gz: 54c60053ea2ccbb85efa95d0ce310a1415854cf4873f478cc0c163118fceef6b130e005d361b71cf09308f80c3bf757362820249e7fc4cfcff2287ce8a4078a9

data/lib/rlp.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 require 'rlp/constant'
 require 'rlp/data'
 require 'rlp/error'

data/lib/rlp/constant.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Constant
     SHORT_LENGTH_LIMIT = 56
@@ -6,7 +8,7 @@ module RLP
     PRIMITIVE_PREFIX_OFFSET = 0x80
     LIST_PREFIX_OFFSET = 0xc0
 
-    BYTE_ZERO = "\x00".force_encoding('ascii-8bit').freeze
-    BYTE_EMPTY = ''.force_encoding('ascii-8bit').freeze
+    BYTE_ZERO = "\x00".freeze
+    BYTE_EMPTY = ''.freeze
   end
 end

data/lib/rlp/data.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 ##
 # A wrapper to represent already RLP encoded data
 #

data/lib/rlp/decode.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Decode
     include Constant
@@ -14,13 +16,15 @@ module RLP
     # is updated whenever one of its fields changes or prevent such changes
     # entirely ({RLP::Sedes::Serializable} does the latter).
     #
-    # @param sedes [#deserialize] an object implementing a function
-    #   `deserialize(code)` which will be applied after decoding, or `nil` if
-    #   no deserialization should be performed
-    # @param options [Hash] additional keyword arguments that will be passed to
-    #   the deserializer
-    # @param strict [Boolean] if false inputs that are longer than necessary
-    #   don't cause an exception
+    # @param options (Hash) deserialization options:
+    #
+    #   * sedes (Object) an object implementing a function `deserialize(code)`
+    #     which will be applied after decoding, or `nil` if no deserialization
+    #     should be performed
+    #   * strict (Boolean) if false inputs that are longer than necessary don't
+    #     cause an exception
+    #   * (any options left) (Hash) additional keyword arguments passed to the
+    #     deserializer
     #
     # @return [Object] the decoded and maybe deserialized object
     #
@@ -28,8 +32,10 @@ module RLP
     #   the root item and `strict` is true
     # @raise [RLP::Error::DeserializationError] if the deserialization fails
     #
-    def decode(rlp, sedes: nil, strict: true, options: {})
+    def decode(rlp, **options)
       rlp = str_to_bytes(rlp)
+      sedes = options.delete(:sedes)
+      strict = options.has_key?(:strict) ? options.delete(:strict) : true
 
       begin
         item, next_start = consume_item(rlp, 0)
@@ -40,8 +46,7 @@ module RLP
       raise DecodingError.new("RLP string ends with #{rlp.size - next_start} superfluous bytes", rlp) if next_start != rlp.size && strict
 
       if sedes
-        # FIXME: lazy man's kwargs
-        obj = sedes.is_a?(Sedes::Serializable) ?
+        obj = sedes.instance_of?(Class) && sedes.include?(Sedes::Serializable) ?
           sedes.deserialize(item, **options) :
           sedes.deserialize(item)
 
@@ -102,7 +107,7 @@ module RLP
       elsif b0 < LIST_PREFIX_OFFSET + SHORT_LENGTH_LIMIT # short list
         [:list, b0 - LIST_PREFIX_OFFSET, start + 1]
       else # long list
-        raise DecodingError.new('Length starts with zero bytes", rlp') if rlp.slice(start+1) == BYTE_ZERO
+        raise DecodingError.new('Length starts with zero bytes', rlp) if rlp.slice(start+1) == BYTE_ZERO
 
         ll = b0 - LIST_PREFIX_OFFSET - SHORT_LENGTH_LIMIT + 1
         l = big_endian_to_int rlp[(start+1)...(start+1+ll)]

data/lib/rlp/decode_lazy.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module DecodeLazy
     include Decode

data/lib/rlp/encode.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Encode
     include Constant

data/lib/rlp/error.rb

@@ -1,7 +1,9 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Error
 
-    class RLPException < Exception; end
+    class RLPException < StandardError; end
 
     class EncodingError < RLPException
       attr :obj

data/lib/rlp/lazy_list.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
 ##
   # A RLP encoded list which decodes itself when necessary.

data/lib/rlp/sedes.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 require_relative 'sedes/big_endian_int'
 require_relative 'sedes/binary'
 require_relative 'sedes/list'

data/lib/rlp/sedes/big_endian_int.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     class BigEndianInt

data/lib/rlp/sedes/binary.rb

@@ -1,7 +1,10 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     class Binary
-      include RLP::Utils
+      include Error
+      include Utils
 
       Infinity = 1.0 / 0.0
 

data/lib/rlp/sedes/countable_list.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     ##

data/lib/rlp/sedes/list.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     ##
@@ -32,6 +34,9 @@ module RLP
           begin
             result.push sedes.serialize(element)
           rescue SerializationError => e
+            puts "List.serialize"
+            puts e
+            puts e.backtrace[0,20].join("\n")
             raise ListSerializationError.new(obj: obj, element_exception: e, index: i)
           end
         end

data/lib/rlp/sedes/raw.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     ##

data/lib/rlp/sedes/serializable.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Sedes
     ##
@@ -32,6 +34,10 @@ module RLP
           end
         end
 
+        def inherit_serializable_fields!
+          @serializable_fields = superclass.serializable_fields
+        end
+
         def serializable_fields
           @serializable_fields
         end
@@ -50,11 +56,16 @@ module RLP
           begin
             serializable_sedes.serialize(field_values)
           rescue ListSerializationError => e
+            puts "Serializable.serialize"
+            puts e
+            puts e.backtrace[0,20].join("\n")
             raise ObjectSerializationError.new(obj: obj, sedes: self, list_exception: e)
           end
         end
 
-        def deserialize(serial, exclude: nil, extra: {})
+        def deserialize(serial, **options)
+          exclude = options.delete(:exclude)
+
           begin
             values = serializable_sedes.deserialize(serial)
           rescue ListDeserializationError => e
@@ -64,10 +75,18 @@ module RLP
           params = Hash[*serializable_fields.keys.zip(values).flatten(1)]
           params.delete_if {|field, value| exclude.include?(field) } if exclude
 
-          obj = self.new params.merge(extra)
+          obj = self.new params.merge(options)
           obj.instance_variable_set :@_mutable, false
           obj
         end
+
+        ##
+        # Create a new sedes considering only a reduced set of fields.
+        #
+        def exclude(excluded_fields)
+          fields = serializable_fields.dup.delete_if {|k, v| excluded_fields.include?(k) }
+          Class.new(self).tap {|cls| cls.set_serializable_fields fields }
+        end
       end
 
       class <<self
@@ -79,34 +98,49 @@ module RLP
       attr_accessor :_cached_rlp
 
       def initialize(*args)
-        serializable_initialize(*args)
+        serializable_initialize parse_field_args(args)
       end
 
-      def serializable_initialize(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
+      ##
+      # Mimic python's argument syntax, accept both normal arguments and named
+      # arguments. Normal argument overrides named argument.
+      #
+      def parse_field_args(args)
+        h = {}
 
+        options = args.last.is_a?(Hash) ? args.pop : {}
         field_set = self.class.serializable_fields.keys
 
-        self.class.serializable_fields.keys.zip(args).each do |(field, arg)|
-          break unless arg
-          _set_field field, arg
+        fields = self.class.serializable_fields.keys[0,args.size]
+        fields.zip(args).each do |(field, arg)|
+          h[field] = arg
           field_set.delete field
         end
 
         options.each do |field, value|
           if field_set.include?(field)
-            _set_field field, value
+            h[field] = value
             field_set.delete field
           end
         end
 
+        h
+      end
+
+      def serializable_initialize(fields)
+        make_mutable!
+
+        field_set = self.class.serializable_fields.keys
+        fields.each do |field, value|
+          _set_field field, value
+          field_set.delete field
+        end
+
         raise TypeError, "Not all fields initialized" unless field_set.size == 0
       end
 
       def _set_field(field, value)
-        unless instance_variable_defined?(:@_mutable)
-          @_mutable = true
-        end
+        make_mutable! unless instance_variable_defined?(:@_mutable)
 
         if mutable? || !self.class.serializable_fields.has_key?(field)
           instance_variable_set :"@#{field}", value
@@ -125,7 +159,7 @@ module RLP
       end
 
       def make_immutable!
-        @_mutable = true
+        make_mutable!
         self.class.serializable_fields.keys.each do |field|
           ::RLP::Utils.make_immutable! send(field)
         end
@@ -133,6 +167,11 @@ module RLP
         @_mutable = false
         self
       end
+
+      def make_mutable!
+        @_mutable = true
+      end
+
     end
   end
 end

data/lib/rlp/utils.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
   module Utils
     class <<self

data/lib/rlp/version.rb

@@ -1,3 +1,5 @@
+# -*- encoding : ascii-8bit -*-
+
 module RLP
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rlp
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Jan Xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake