ciri-rlp 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9c3349059c761090b9c9fd81eea54c8247d5ea7fa5b33d879822c12b3f0a1f0
-  data.tar.gz: 3646c2b7ddcac8185eb4875c71c9a4ed802198f616155144c2f45466f1816399
+  metadata.gz: 9d767ee2b245808b3803b1de37c0560e8180b3ca4f5346caf268e0abf90d2b85
+  data.tar.gz: 4f7787004fdc1d205c9667cfa1b099291948996c37eae8fe4bdae00d6dc03f6b
 SHA512:
-  metadata.gz: e7e175ab3452d4eda0487008a5cd1f6f3f6b14f922413d37672aa0f622cb76e0468feee44e558b00d4744c14499ffa6d7582b3fef005e603dadb3e01987e3c1e
-  data.tar.gz: 35739e554737cc4314878f3e92c603a30dd984cbd6f788839071891de75bcdcb4052526154a3e1025466fa4bcd3d4b233471b152f5d6d8067535057ac55ec2eb
+  metadata.gz: 007ee152a9ba605c2499c8f7f55e204ce0674626de104985c300073f0ed135794cf6339616ca0fa7cfae5de80017bb2752e3dd93807ea7e8c15b969abc96ce0a
+  data.tar.gz: 727f98939b3c91f644cddbbcd94d5782c4fbf55659babddfe8441f997d4c0885578fb6d82acb0eba2ebc76574883ea79085b6f7cd7b162a6c8c8a075bef31ebf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ciri-rlp (0.2.2)
+    ciri-rlp (1.0.0)
       ciri-utils (~> 0.2.1)
 
 GEM

data/README.md

@@ -34,17 +34,18 @@ Structure:
 ```ruby
 # declare a RLP structure
 class Doge
+  include Ciri
   include Ciri::RLP::Serializable
   
   # RLP is a low level encoding format, only support string(bytes) and list.
   # so we use a list to present structure data
   # we also need to declare column type clearly if column is not string
-  schema [
-    :name,
-    {age: Integer}, # declare age is a Integer type
-    :gender,
-    {has_master: Ciri::RLP::Bool} # dechare bool
-  ]
+  schema(
+    name: RLP::Bytes, # declare name a Bytes type, represent as normal ruby string
+    age: Integer, # declare age as a Integer type
+    gender: RLP::Bytes,
+    has_master: Ciri::RLP::Bool # dechare bool
+  )
 end
 
 doge = Doge.new(name: 'neo doge', age: 5, gender: "boy", has_master: false)

data/lib/ciri/rlp/decode.rb

@@ -73,13 +73,13 @@ module Ciri
               i += 1
             end
           end
-        elsif type == RawString
+        elsif type == Bytes
           str = decode_stream(s)
-          raise RLP::InvalidError.new "decode #{str.class} from RawString" unless str.is_a?(String)
+          raise RLP::InvalidError.new "decode #{str.class} from Bytes" unless str.is_a?(String)
           str
-        elsif type == RawList
+        elsif type == List
           list = decode_stream(s)
-          raise RLP::InvalidError.new "decode #{list.class} from RawList" unless list.is_a?(Array)
+          raise RLP::InvalidError.new "decode #{list.class} from List" unless list.is_a?(Array)
           list
         elsif type == Raw
           decode_stream(s)

data/lib/ciri/rlp/encode.rb

@@ -74,10 +74,10 @@ module Ciri
           end
         elsif type == Raw
           encode_raw(item)
-        elsif type == RawString
+        elsif type == Bytes
           raise RLP::InvalidError.new "expect String, got #{item.class}" unless item.is_a?(String)
           encode_raw(item)
-        elsif type == RawList
+        elsif type == List
           raise RLP::InvalidError.new "expect Array, got #{item.class}" unless item.is_a?(Array)
           encode_raw(item)
         else

data/lib/ciri/rlp/serializable.rb

@@ -30,24 +30,21 @@ module Ciri
     class Raw
     end
 
+    # represent Bytes
     class Bytes
     end
 
-    RawString = Bytes 
-
+    # represent List
     class List
     end
 
-    RawList = List
-
     # Serializable module allow ruby objects serialize/deserialize to or from RLP encoding.
     # See Ciri::RLP::Serializable::TYPES for supported type.
     #
     # schema method define ordered data structure for class, and determine how to encoding objects.
     #
     # schema follow `{attr_name: type}` format,
-    # if attr is raw type(string or array of string), you can just use `:attr_name` to define it
-    # schema simple types include Integer, Bool, String, Array...
+    # schema support simple types: Integer, RLP::Bool, RLP::Bytes, RLP::List...
     #
     # schema also support complex types: array and serializable.
     #
@@ -59,21 +56,22 @@ module Ciri
     #
     #   class AuthMsgV4
     #     include Ciri::RLP::Serializable
+    #     include Ciri
     #
     #     # define schema
-    #     schema [
-    #              :signature, # raw type: string
-    #              {initiator_pubkey: MySerializableKey}, # this attr is a RLP serializable object
-    #              {nonce: [Integer]},
-    #              {version: Integer}
-    #            ]
+    #     schema(
+    #       signature: RLP::Bytes, # raw type: string
+    #       initiator_pubkey: MySerializableKey, # this attr is a RLP serializable object
+    #       nonce: [Integer],
+    #       version: Integer
+    #     )
     #
     #     # default values
-    #     default_data(got_plain: false)
+    #     default_data(version: 1)
     #   end
     #
     #   msg = AuthMsgV4.new(signature: "\x00", initiator_pubkey: my_pubkey, nonce: [1, 2, 3], version: 4)
-    #   encoded = msg.rlp_encode
+    #   encoded = AuthMsgV4.rlp_encode(msg)
     #   msg2 = AuthMsgV4.rlp_decode(encoded)
     #   msg == msg2 # true
     #
@@ -93,24 +91,16 @@ module Ciri
         # keys return data columns array
         attr_reader :keys
 
-        KeySchema = Struct.new(:type, :options, keyword_init: true)
+        KeySchema = Struct.new(:type, keyword_init: true)
 
         def initialize(schema)
           keys = []
           @_schema = {}
 
-          schema.each do |key|
-            if key.is_a?(Hash)
-              options = [:optional].map {|o| [o, key.delete(o)]}.to_h
-              raise InvalidSchemaError.new("include unknown options #{key}") unless key.size == 1
-              key, type = key.to_a[0]
-            else
-              options = {}
-              type = Raw
-            end
+          schema.each do |key, type|
             raise InvalidSchemaError.new("incorrect type on key #{key}, #{type} is not a valid RLP class") unless check_key_type(type)
             keys << key
-            @_schema[key] = KeySchema.new(type: type, options: options)
+            @_schema[key] = KeySchema.new(type: type)
           end
 
           @_schema.freeze
@@ -141,7 +131,6 @@ module Ciri
           data_list = []
           used_keys.each do |key|
             value = data[key]
-            next if value.nil? && self[key].options[:optional]
             data_list << encode_with_type(value, self[key].type)
           end
           encode_list(data_list)
@@ -151,7 +140,6 @@ module Ciri
           values = decode_list(input) do |list, stream|
             keys.each do |key|
               # decode data by type
-              next if stream.eof? && self[key].options[:optional]
               list << decode_with_type(stream, self[key].type)
             end
           end

data/lib/ciri/rlp/version.rb

@@ -1,5 +1,5 @@
 module Ciri
   module RLP
-    VERSION = "0.2.2"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ciri-rlp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jiang Jinyang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ciri-utils