canoser 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605cb23e469f4b87cd405b7c68232bbf4370efb17a3f9ee08f5835ede36b2e2d
-  data.tar.gz: dc1d93b906f7d3d56346038c671e756d0e10e7887b6ca8c6f688659d11fa0e84
+  metadata.gz: 89fbb5634526ecc83a890a3f2598d834938028b509c0a0500eef8f17707cb178
+  data.tar.gz: 99b14d822421d7bf26b5eddff461c68efeddceb0c36511a1c34d594bc1699fd7
 SHA512:
-  metadata.gz: c9d5d29d35b7682ac3932f3320c176b2230a427ec154a1107826820daf994d77c241bdac1e82786540b9f8e470e6c52276e727b273e2bffcafdc147afd4dac61
-  data.tar.gz: fd1d4aa6c2bc971dc2502b1bf264cc7065f1c703e637696c0865e494aa91f84edfee21d12daf72c9aad4c0d281024a259ce087b899df56ec3fcf658dd17940dc
+  metadata.gz: 70f34f92da5ba6330baabbd7d37e2ce1070f2d8216fb47a6ca04314d49920c9aaed91b4906a872eddbbed64ceac983dd94be7e2468874e1b97f93d9b5b7d0590
+  data.tar.gz: 2b105656dea17c9a1692da8cae2d82349d1e6b9780da33cae8e99f46c8a9221caca635bce96ba1473f8279f3253ef89ad35b70eb392068de1b36d6964f7b5402

data/.gitignore

@@ -6,5 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+Thumbs.db
+*.sublime-workspace
 .byebug_history
+.idea
 

data/README-CN.md

@@ -107,7 +107,7 @@ Map里的数据，如果没有定义类型，那么缺省是字节数组。下
     define_field :addr, {}
   end
   class Map2 < Canoser::Struct
-    define_field :addr, {[Canoser::Uint8], [Canoser::Uint8]}
+    define_field :addr, {[Canoser::Uint8] => [Canoser::Uint8]}
   end  
 ```  
 
@@ -144,4 +144,11 @@ bytes = obj.serialize
 #反序列化
 obj = AccountResource.deserialize(bytes)
 ```
+### 从Struct对象中读取字段的值
+对于所有通过define_field方法定义的字段，可以通过[field_name]获取该字段的值。比如：
+
+```ruby
+obj[:authentication_key]
+```
+
 

data/README.md

@@ -114,7 +114,7 @@ The default data type (if not defined) in the map is an array of Uint8. The foll
     define_field :addr, {}
   end
   class Map2 < Canoser::Struct
-    define_field :addr, {[Canoser::Uint8], [Canoser::Uint8]}
+    define_field :addr, {[Canoser::Uint8] => [Canoser::Uint8]}
   end  
 ```  
 
@@ -146,13 +146,23 @@ This example refers to the test code from canonical serialization in libra.
 After defining Canoser::Struct, you don't need to implement serialization and deserialization code yourself, you can directly call the default implementation of the base class. Take the AccountResource structure as an example:
 
 ```ruby
-#序列化
+# serialize an object
 obj = AccountResource.new(authentication_key:[...],...)
 bytes = obj.serialize
-#反序列化
+
+# deserialize an object form bytes
 obj = AccountResource.deserialize(bytes)
 ```
 
+### Get field value form object 
+For all fields defined by the "define_field" method, the value of this field of an object can be obtained via [field_name]. such as:
+
+```ruby
+obj[:authentication_key]
+#or
+obj["authentication_key"]
+```
+
 
 ## Development
 

data/canoser.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["yuanxinyu.hangzhou@gmail.com"]
 
   spec.summary       = %q{A ruby implementation of the canonical serialization for the Libra network.}
-  spec.description   = %q{A ruby implementation of the canonical serialization for the Libra network.}
-  spec.homepage      = "https://github.com/yuanxinyu/canoser.git"
+  spec.description   = %q{A ruby implementation of the canonical serialization for the Libra network. Canonical serialization guarantees byte consistency when serializing an in-memory data structure. It is useful for situations where two parties want to efficiently compare data structures they independently maintain. It happens in consensus where independent validators need to agree on the state they independently compute. A cryptographic hash of the serialized data structure is what ultimately gets compared. In order for this to work, the serialization of the same data structures must be identical when computed by independent validators potentially running different implementations of the same spec in different languages.}
+  spec.homepage      = "https://github.com/yuanxinyu/canoser-ruby.git"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
     spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/yuanxinyu/canoser.git"
-    spec.metadata["changelog_uri"] = "https://github.com/yuanxinyu/canoser.git"
+    spec.metadata["source_code_uri"] = "https://github.com/yuanxinyu/canoser-ruby.git"
+    spec.metadata["changelog_uri"] = "https://github.com/yuanxinyu/canoser-ruby.git"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

data/canoser.sublime-project

@@ -0,0 +1,16 @@
+{
+  "folders":
+  [
+    {
+      "path": ".",
+      "folder_exclude_patterns": [".bundle",".idea","certs","coverage","tmp","log","pkg"],
+      "file_exclude_patterns": ["*.sublime-workspace","*.sqlite3","spec/examples.txt",".byebug_history",".DS_Store"]
+    }
+  ],
+  "settings":
+  {
+    "translate_tabs_to_spaces": true,
+    "trim_trailing_white_space_on_save": true,
+    "tab_size": 2
+  }
+}

data/lib/canoser/version.rb

@@ -1,3 +1,3 @@
 module Canoser
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - yuan xinyu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '11.0'
 description: A ruby implementation of the canonical serialization for the Libra network.
+  Canonical serialization guarantees byte consistency when serializing an in-memory
+  data structure. It is useful for situations where two parties want to efficiently
+  compare data structures they independently maintain. It happens in consensus where
+  independent validators need to agree on the state they independently compute. A
+  cryptographic hash of the serialized data structure is what ultimately gets compared.
+  In order for this to work, the serialization of the same data structures must be
+  identical when computed by independent validators potentially running different
+  implementations of the same spec in different languages.
 email:
 - yuanxinyu.hangzhou@gmail.com
 executables: []
@@ -84,19 +92,20 @@ files:
 - bin/console
 - bin/setup
 - canoser.gemspec
+- canoser.sublime-project
 - lib/canoser.rb
 - lib/canoser/cursor.rb
 - lib/canoser/field.rb
 - lib/canoser/struct.rb
 - lib/canoser/version.rb
-homepage: https://github.com/yuanxinyu/canoser.git
+homepage: https://github.com/yuanxinyu/canoser-ruby.git
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/yuanxinyu/canoser.git
-  source_code_uri: https://github.com/yuanxinyu/canoser.git
-  changelog_uri: https://github.com/yuanxinyu/canoser.git
+  homepage_uri: https://github.com/yuanxinyu/canoser-ruby.git
+  source_code_uri: https://github.com/yuanxinyu/canoser-ruby.git
+  changelog_uri: https://github.com/yuanxinyu/canoser-ruby.git
 post_install_message: 
 rdoc_options: []
 require_paths: