scale_rb 0.4.1 → 0.5.0

data/lib/type_enforcer.rb

@@ -0,0 +1,170 @@
+require_relative 'custom_assign'
+require 'benchmark'
+
+# rubocop:disable all
+module TypeEnforcer
+
+  def self.extended(base)
+    base.instance_variable_set(:@type_enforcements, {})
+    base.instance_variable_set(:@applying_enforcement, false)
+  end
+
+  def __(method_name, param_types, return_type = nil, level: 1, skip: [])
+    return unless type_enforcement_enabled?
+
+    @type_enforcements[method_name] = {
+      params: param_types,
+      return: return_type,
+      level: level,
+      skip: skip
+    }
+  end
+
+  def method_added(method_name)
+    super
+    apply_enforcement(method_name)
+  end
+
+  private
+
+  def apply_enforcement(method_name)
+    return unless type_enforcement_enabled?
+    return if @applying_enforcement
+    return unless @type_enforcements.key?(method_name)
+
+    @applying_enforcement = true
+    begin
+      result = @type_enforcements[method_name]
+      if result[:level] > type_enforcement_level
+        decorate(method_name, result[:params], result[:return], result[:skip])
+      end
+    ensure
+      @applying_enforcement = false
+    end
+  end
+
+  def type_enforcement_enabled?
+    return true if ENV['ENABLE_TYPE_ENFORCEMENT'] && ENV['ENABLE_TYPE_ENFORCEMENT'] == 'true'
+
+    false
+  end
+
+  def type_enforcement_level
+    ENV['TYPE_ENFORCEMENT_LEVEL'].to_i || 2
+  end
+
+  def decorate(method_name, param_types, return_type, skip)
+    target = self
+    original_method = target.instance_method(method_name)
+    method_parameters = original_method.parameters
+
+    # only support positional args and keyword args for now
+    # TODO: support splat(rest), double splat(keyrest) args, and block
+    target.define_method(method_name) do |*args, **kwargs|
+      ScaleRb.logger.debug("----------------------------------------------------------")
+      ScaleRb.logger.debug("method:          #{method_name}")
+      ScaleRb.logger.debug("params:          args: #{args}, kwargs: #{kwargs}")
+      ScaleRb.logger.debug("param kinds:     #{method_parameters}")
+      ScaleRb.logger.debug("param types:     #{param_types}")
+
+      validated_args = []
+      validated_kwargs = {}
+
+      # build a hash of param_name => value | default_value
+      defaults = method_parameters.each_with_object({}) do |(_param_kind, param_name), memo|
+        type = param_types[param_name]
+        memo[param_name] = type.value if type.respond_to?(:value)
+      end
+      assigned_params = build_assigned_params(original_method, defaults, args, kwargs)
+      ScaleRb.logger.debug("assigned params: #{assigned_params}")
+
+      # validate each param
+      method_parameters.each do |param_kind, param_name|
+        case param_kind
+        when :req, :opt
+          value = assigned_params[param_name]
+          if skip.include?(param_name)
+            validated_args << value
+          else
+            type = param_types[param_name]
+            validated_args << type[value]
+          end
+        when :keyreq, :key
+          value = assigned_params[param_name]
+          if skip.include?(param_name)
+            validated_kwargs[param_name] = value
+          else
+            type = param_types[param_name]
+            validated_kwargs[param_name] = type[value]
+          end
+        when :rest, :keyrest
+          raise NotImplementedError, 'rest and keyrest args not supported'
+        end
+      end
+
+      result = original_method.bind(self).call(*validated_args, **validated_kwargs)
+
+      if skip.include?(:returns) && return_type
+        return_type[result]
+      else
+        result
+      end
+    end
+  end
+end
+
+# require 'dry-types'
+
+# module Types
+#   include Dry.Types()
+# end
+
+# class Example
+#   extend TypeEnforcer
+
+#   __ :add, { a: Types::Strict::Integer, b: Types::Strict::Integer }, Types::Strict::Integer
+#   def self.add(a, b)
+#     a + b
+#   end
+
+#   __ :subtract, { a: Types::Strict::Integer, b: Types::Strict::Integer }, Types::Strict::Integer
+#   def subtract(a, b)
+#     a - b
+#   end
+
+#   __ :my_method, {
+#     a: Types::Strict::Integer,
+#     b: Types::Strict::Integer.default(2),
+#     c: Types::Strict::Integer,
+#     d: Types::Strict::Integer.default(4)
+#   }, Types::Strict::String
+#   def my_method(a, b = 2, c:, d: 4)
+#     "a: #{a}, b: #{b}, c: #{c}, d: #{d}"
+#   end
+# end
+
+# puts Example.add(1, 2) # => 3
+
+# puts Example.new.subtract(3, 1) # => 2
+
+# begin
+#   puts Example.new.subtract(3, '1')
+# rescue StandardError => e
+#   puts e.class # => Dry::Types::ConstraintError
+#   puts e.message # => "1" violates constraints (type?(Integer, "1") failed)
+# end
+
+# puts Example.new.my_method(5, c: 3) # => "a: 5, b: 2, c: 3, d: 4"
+# puts Example.new.my_method(5, 6, c: 3) # => "a: 5, b: 6, c: 3, d: 4"
+# puts Example.new.my_method(5, 6, c: 3, d: 10) # => "a: 5, b: 6, c: 3, d: 10"
+# begin
+#   puts Example.new.my_method(5, 6, c: 3, d: '10')
+# rescue StandardError => e
+#   puts e.class # => Dry::Types::ConstraintError
+#   puts e.message # => "10" violates constraints (type?(Integer, "10") failed)
+# end
+# begin
+#   puts Example.new.my_method(5, 6, d: 10)
+# rescue StandardError => e
+#   puts e.message # => Missing required keyword argument: c
+# end

data/scale_rb.gemspec

@@ -38,4 +38,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'async'
   spec.add_dependency 'async-http', '~> 0.69.0'
   spec.add_dependency 'async-websocket', '~> 0.26.2'
+  # for logger
+  spec.add_dependency 'console'
+  # for types restriction
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'dry-types'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Aki Wu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -94,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.26.2
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem includes a ruby implementation of SCALE Codec, a general Substrate
   Http JSONRPC Client, and, a general Substrate Websocket JSON-RPC Client.
 email:
@@ -103,11 +145,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,24 +167,32 @@ files:
 - examples/ws_client_error_handling.rb
 - exe/metadata
 - lib/address.rb
-- lib/client/client_ext.rb
-- lib/client/http_client.rb
-- lib/client/ws_client.rb
-- lib/codec.rb
-- lib/hasher.rb
-- lib/metadata/metadata.rb
-- lib/metadata/metadata_v10.rb
-- lib/metadata/metadata_v11.rb
-- lib/metadata/metadata_v12.rb
-- lib/metadata/metadata_v13.rb
-- lib/metadata/metadata_v14.rb
-- lib/metadata/metadata_v9.rb
-- lib/monkey_patching.rb
-- lib/portable_codec.rb
-- lib/registry.rb
+- lib/custom_assign.rb
 - lib/scale_rb.rb
+- lib/scale_rb/call_helper.rb
+- lib/scale_rb/client/client_ext.rb
+- lib/scale_rb/client/http_client.rb
+- lib/scale_rb/client/ws_client.rb
+- lib/scale_rb/codec.rb
+- lib/scale_rb/codec_utils.rb
+- lib/scale_rb/decode.rb
+- lib/scale_rb/encode.rb
+- lib/scale_rb/hasher.rb
+- lib/scale_rb/metadata/metadata.rb
+- lib/scale_rb/metadata/metadata_v10.rb
+- lib/scale_rb/metadata/metadata_v11.rb
+- lib/scale_rb/metadata/metadata_v12.rb
+- lib/scale_rb/metadata/metadata_v13.rb
+- lib/scale_rb/metadata/metadata_v14.rb
+- lib/scale_rb/metadata/metadata_v9.rb
+- lib/scale_rb/metadata/registry.rb
+- lib/scale_rb/metadata/type_exp.rb
+- lib/scale_rb/portable_registry.rb
+- lib/scale_rb/storage_helper.rb
+- lib/scale_rb/types.rb
+- lib/scale_rb/utils.rb
 - lib/scale_rb/version.rb
-- lib/storage_helper.rb
+- lib/type_enforcer.rb
 - scale_rb.gemspec
 - tea.yaml
 homepage: https://github.com/wuminzhe/scale_rb
@@ -164,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A Ruby SCALE Codec Library, and, Substrate RPC Client