borsh-rb 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a38414ba8064cc0a4a90dec06b813df3ac2c4e32b5c4149549241e2a27219f
-  data.tar.gz: 2e6b833cd730150c00220aa5744d5809f0f522bceb098575a1336d7bedefa75f
+  metadata.gz: ea49443bda65351efb2ff82517e0cfa3659e37bcc6037cc97039422eff6d32fc
+  data.tar.gz: 459b4eee287216c01fef51d05ff438fb08e3f68c5bae49ff23785c6ffb2d471a
 SHA512:
-  metadata.gz: 629392b88fe0415ffa6d8c23bfc75a553f38d126124306dff1bae6e45ac54a58a6c3aaefaaafd5f7434f2940552722cf03346f0a476bfc3964ced3339b4ccc19
-  data.tar.gz: c81268f0de8fa467af9dd808d826e2616aff387c8d8919377d68cb626771f3e539cc42bf97c592317148d935f05d8b632c4aa97cd197b76c76ae80150864f980
+  metadata.gz: 7049e920545c7c5f166258eeec49cee85a6e35e63b4f0ae2c1826eea7f45e3c88d221407bc0c0d9169fefaf22859eb132bee907a209549b47589edcfb294c31c
+  data.tar.gz: c6aad3cfe4175b5a8f181623eb204d9fcd396b9a0a12d6462f9ffc490f31e4d0cf7aec60535aeedfb42e5df5f1e6f437c65965ed686e2ea4e047f7c3969074ea

data/Gemfile

@@ -6,5 +6,3 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,12 +1,17 @@
 PATH
   remote: .
   specs:
-    borsh-rb (0.1.0)
+    borsh-rb (0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -27,8 +32,9 @@ PLATFORMS
 
 DEPENDENCIES
   borsh-rb!
+  pry
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.10)
 
 BUNDLED WITH
    2.2.25

data/README.md

@@ -1,8 +1,6 @@
 # Borsh::Rb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/borsh/rb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Unofficial implementation of Borsh serializer https://borsh.io/
 
 ## Installation
 
@@ -22,17 +20,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+include `Borsh` module and define serialisation schema 
 
-## Development
+```
+class User
+  include Borsh
+  
+  borsh id: :string, type: :u8, key: 32, admin: :borsh
+  
+  def id
+    'test'
+  end
+  
+  def type
+    1
+  end
+  
+  def key
+    'abcd'
+  end
+  
+  admin
+    return unless admin?
+    
+    User.new
+  end  
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Serialize as: `User.new.to_borsh`
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Supported types: `:string, :u8, :u16, :u32, :u64, :u128, Integer, Array, :borsh`
+Integer as a type is supported to validate preserialized value length (for ex. public key)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/borsh-rb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/2rba/borsh-rb.
 
 ## License
 

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "borsh/rb"
+require "borsh"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/borsh-rb.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "lib/borsh/rb/version"
+require_relative "lib/borsh/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "borsh-rb"
-  spec.version       = Borsh::Rb::VERSION
+  spec.version       = Borsh::VERSION
   spec.authors       = ["Serg Tyatin"]
   spec.email         = ["700@2rba.com"]
 
   spec.summary       = "https://borsh.io implementation for ruby"
   spec.description   = ""
-  spec.homepage      = "https://github.com/2rba/borsh-rb"
+  spec.homepage      = "https://github.com/near-rails-guide/borsh-rb"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.4.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/2rba/borsh-rb"
-  spec.metadata["changelog_uri"] = "https://github.com/2rba/borsh-rb"
+  spec.metadata["source_code_uri"] = "https://github.com/near-rails-guide/borsh-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/near-rails-guide/borsh-rb"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "pry"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/borsh/argument_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Borsh
+  class ArgumentError < ::ArgumentError; end
+end

data/lib/borsh/byte_string.rb

@@ -0,0 +1,16 @@
+class Borsh::ByteString
+  def initialize(value, length)
+    @value = value
+    @length = length
+  end
+
+  def to_borsh
+    raise Borsh::ArgumentError, 'ByteString length mismatch' if value.size != length
+
+    value
+  end
+
+  private
+
+  attr_reader :value, :length
+end

data/lib/borsh/integer.rb

@@ -0,0 +1,34 @@
+class Borsh::Integer
+  def initialize(value, type)
+    @value = value
+    @type = type
+  end
+
+  def to_borsh
+    pack_arg = case type
+               when :u8
+                 'C'
+               when :u16
+                 'S<'
+               when :u32
+                 'L<'
+               when :u64
+                'Q<'
+               when :u128
+                 lower = value & 0xFFFFFFFFFFFFFFFF
+                 higher = (value >> 64) & 0xFFFFFFFFFFFFFFFF
+                 return [lower, higher].pack('Q<*')
+               else
+                 raise Borsh::ArgumentError, "unknown type #{type}"
+               end
+
+    result = [value].pack(pack_arg)
+    raise Borsh::ArgumentError, 'Integer serialization failure' if result.unpack(pack_arg) != [value]
+
+    result
+  end
+
+  private
+
+  attr_reader :value, :type
+end

data/lib/borsh/{rb/version.rb → serializer.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Borsh
-  module Rb
-    VERSION = "0.1.0"
+  class Serializer
+
   end
 end

data/lib/borsh/string.rb

@@ -0,0 +1,16 @@
+class Borsh::String
+  def initialize(value)
+    @value = value
+  end
+
+  def to_borsh
+    length = [value.length].pack('V')
+    raise Borsh::ArgumentError, 'string too long' if length.unpack('V') != [value.length]
+
+    length + value
+  end
+
+  private
+
+  attr_reader :value
+end

data/lib/borsh/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Borsh
+    VERSION = "0.1.3"
+end

data/lib/borsh.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'borsh/version'
+require_relative 'borsh/argument_error'
+require_relative 'borsh/string'
+require_relative 'borsh/integer'
+require_relative 'borsh/byte_string'
+
+module Borsh
+  def self.included(base)
+    base.extend ParentClassMethods
+  end
+
+  def to_borsh
+    to_borsh_schema(self, self.class.instance_variable_get(:@borsh_schema))
+  end
+
+  private
+
+  def to_borsh_schema(value, schema)
+    case schema
+    when :string
+      String.new(value).to_borsh
+    when :u8, :u16, :u32, :u64, :u128
+      Integer.new(value, schema).to_borsh
+    when ::Integer
+      Borsh::ByteString.new(value, schema).to_borsh
+    when ::Hash
+      schema.map do |entry_source, entry_schema|
+        to_borsh_schema(value.send(entry_source), entry_schema)
+      rescue Borsh::ArgumentError => e
+        raise Borsh::ArgumentError.new("#{entry_source} => #{e.message}")
+      end.join
+    when ::Array
+      Integer.new(value.count, :u32).to_borsh + \
+      value.flat_map do |item|
+        schema.map{ |entry_schema| to_borsh_schema(item, entry_schema) }
+      end.join
+    when :borsh
+      value.to_borsh
+    else
+      raise ArgumentError, "unknown serializer #{schema}, supported serializers: :string, :u8, :u16, :u32, :u64, :u128, :borsh"
+    end
+  end
+
+  module ParentClassMethods
+    def borsh(schema)
+      @borsh_schema = schema
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: borsh-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Serg Tyatin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - 700@2rba.com
@@ -27,15 +55,20 @@ files:
 - bin/console
 - bin/setup
 - borsh-rb.gemspec
-- lib/borsh/rb.rb
-- lib/borsh/rb/version.rb
-homepage: https://github.com/2rba/borsh-rb
+- lib/borsh.rb
+- lib/borsh/argument_error.rb
+- lib/borsh/byte_string.rb
+- lib/borsh/integer.rb
+- lib/borsh/serializer.rb
+- lib/borsh/string.rb
+- lib/borsh/version.rb
+homepage: https://github.com/near-rails-guide/borsh-rb
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/2rba/borsh-rb
-  source_code_uri: https://github.com/2rba/borsh-rb
-  changelog_uri: https://github.com/2rba/borsh-rb
+  homepage_uri: https://github.com/near-rails-guide/borsh-rb
+  source_code_uri: https://github.com/near-rails-guide/borsh-rb
+  changelog_uri: https://github.com/near-rails-guide/borsh-rb
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -51,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: https://borsh.io implementation for ruby

data/lib/borsh/rb.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rb/version"
-
-module Borsh
-  module Rb
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end