uinit-sig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7316f9bbb53f246138e12879366589e154a01a2a135c858fe84c90815cf1d14e
+  data.tar.gz: f35d84939f6bb218161c587aa12bdb7d84abe7d6a9b91c705909e8eafb64816a
+SHA512:
+  metadata.gz: d2ad9d556fab68adad980b85c8692ee1a68bfcbcaa4dc4213b907774bce254e06e337cbb53599367e95ec73b80266f48138c9f3640bb17d9a77dc229c1b9c12b
+  data.tar.gz: 18eb82848d896f79bf755f4015bcaea66a5d0e2c5f5b8de33c7c09b10b24513ffbf7ed78af3aaaa0d6a9d4da783d44013ecc07b3b36a10c65b9c17933cb22096

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kimoja
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# Uinit::Sig
+
+Signed methods
+
+WIP
+
+## TODO
+- une class spéciale pour les Proc, comme SignedProc, prenant en param un liste de type (non nommée) 
+  Une methode bind prenant une proc à liéer et retournant une SignedBindedProc ou du genre 
+  Au call, check les type et call la proc bindée

data/lib/uinit/sig/method.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/EmptyLinesAroundAttributeAccessor
+module Uinit
+  module Sig
+    class Method < Uinit::Struct
+      include Memoizable
+
+      struct do
+        attr(:base, Class | Module)
+        attr(:class_method, bool)
+
+        attr(:parameters, [Parameter]).init(false)
+
+        attr(:return_type, none | Uinit::Type::Base) do
+          set { |type| Uinit::Type.from(type) unless type.nil? }
+          init(false)
+        end
+
+        attr(:signed_name, Symbol) do
+          default { (0...30).map { ('a'..'z').to_a[rand(26)] }.join.to_sym }
+          init(false)
+        end
+
+        attr(:method_name, Symbol).init(false)
+        attr(:checker, Proc).init(false)
+      end
+
+      def returns(return_type)
+        self.return_type = return_type
+
+        self
+      end
+
+      def for(method_name)
+        self.method_name = method_name
+        add_parameters_types
+        MethodCompiler.compile(method: self)
+      end
+
+      def return_is!(value)
+        return_type.is!(value)
+      rescue Type::Error => e
+        raise ReturnTypeError.new(self, e)
+      end
+
+      private
+
+      memo def method_origin
+        return base.instance_method(method_name) unless class_method
+
+        base.singleton_class.instance_method(method_name)
+      end
+
+      def add_parameters_types
+        method_origin.parameters.each_with_index do |(parameter_type, name), _i|
+          parameter = parameters.find { _1.name == name }
+          raise ArgumentError, "Unable to retrieve parameter '#{name}'" unless parameter
+
+          parameter.parameter_type = parameter_type
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Layout/EmptyLinesAroundAttributeAccessor

data/lib/uinit/sig/method_compiler.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Uinit
+  module Sig
+    class MethodCompiler < Uinit::Struct
+      def self.compile(...)
+        new(...).compile
+      end
+
+      struct do
+        attr(:method, Method)
+      end
+
+      def compile
+        compile_arguments_check_method
+        compile_wrapped_method
+      end
+
+      def compile_arguments_check_method
+        compile_method(<<~RUBY, __FILE__, __LINE__ + 1)
+          def __check_#{method.method_name}(#{compile_parameters_sig})
+            __method__ = _signed_methods.#{method.signed_name}
+            #{compile_parameters_check}
+          end
+        RUBY
+      end
+
+      def compile_wrapped_method
+        compile_method(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{method.method_name}(...)
+            method = _signed_methods.#{method.signed_name}
+            __check_#{method.method_name}(...)
+            #{compile_original_method_call}
+          end
+        RUBY
+      end
+
+      private
+
+      def compile_method(str, file, line)
+        puts str.gsub(/^$\s*\n/, '').gsub(/\s+$/, '')
+        puts '----------------------------------------------------------------'
+
+        method.base.class_eval(str.gsub(/^$\s*\n/, '').gsub(/\s+$/, ''), file, line)
+      end
+
+      def compile_parameters_sig
+        method.parameters.map { compile_parameter_sig(_1).to_s.strip }.join(', ')
+      end
+
+      def compile_parameter_sig(parameter)
+        return parameter.name if parameter.req_arg?
+        return "#{parameter.name} = Uinit::Sig::UNDEFINED" if parameter.opt_arg?
+        return "*#{parameter.name}" if parameter.rest_arg?
+
+        return "#{parameter.name}:" if parameter.req_kwarg?
+        return "#{parameter.name}: Uinit::Sig::UNDEFINED" if parameter.opt_kwarg?
+
+        "**#{parameter.name}" if parameter.rest_kwarg?
+      end
+
+      def compile_parameters_check
+        parameters_check = method.parameters.map.with_index do |parameter, index|
+          compile_parameter_check(parameter, index).to_s.strip
+        end
+
+        parameters_check.join("\n")
+      end
+
+      def compile_parameter_check(parameter, index)
+        return unless parameter.typed?
+
+        if parameter.opt?
+          return <<~RUBY
+            unless #{parameter.name} == Uinit::Sig::UNDEFINED
+              __method__.parameters[#{index}].is!(#{parameter.name})
+            end
+          RUBY
+        end
+
+        <<~RUBY
+          __method__.parameters[#{index}].is!(#{parameter.name})
+        RUBY
+      end
+
+      def compile_original_method_call
+        unless method.return_type
+          return <<~RUBY
+            method.method_origin.bind_call(self, ...)
+          RUBY
+        end
+
+        <<~RUBY
+          ret = method.method_origin.bind_call(self, ...)
+          method.return_is!(ret)
+          ret
+        RUBY
+      end
+    end
+  end
+end
+
+# class A
+#   def jo(...)
+#     e = proc do |a, b = "ok"|
+#       pp a, b
+#     end
+#     e.call(...)
+#   end
+# end
+
+# def si(...)
+#   a = A.new
+#   A.instance_method(:jo).bind_call(a, ...)
+# end

data/lib/uinit/sig/parameter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Uinit
+  module Sig
+    class Parameter < Uinit::Struct
+      struct do
+        attr(:name, Symbol)
+
+        attr(:type, none | Uinit::Type::Base).set { |type| Uinit::Type.from(type) unless type.nil? }
+        attr(:method, Method)
+
+        attr(:parameter_type, any_of(:req, :opt, :rest, :keyreq, :key, :keyrest)).init(false)
+      end
+
+      def req_arg?
+        parameter_type == :req
+      end
+
+      def opt_arg?
+        parameter_type == :opt
+      end
+
+      def rest_arg?
+        parameter_type == :rest
+      end
+
+      def req_kwarg?
+        parameter_type == :keyreq
+      end
+
+      def opt_kwarg?
+        parameter_type == :key
+      end
+
+      def rest_kwarg?
+        parameter_type == :keyrest
+      end
+
+      def opt?
+        opt_arg? || opt_kwarg?
+      end
+
+      def typed?
+        !type.nil?
+      end
+
+      def is!(value)
+        type.is!(value)
+      rescue Type::Error => e
+        raise ParameterTypeError.new(self, e)
+      end
+    end
+  end
+end

data/lib/uinit/sig/parameter_type_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Uinit
+  module Sig
+    class ParameterTypeError < StandardError
+      def initialize(parameter, type_error)
+        super()
+
+        @parameter = parameter
+        @type_error = type_error
+
+        set_backtrace(type_error.backtrace)
+      end
+
+      attr_reader :parameter, :type_error
+
+      def message
+        method = parameter.method
+        file, line = method.method_origin.source_location
+
+        "Type error on parameter '#{parameter.name}' " \
+          "in method '#{method.method_name}' at '#{file}:#{line}', detail:\n#{type_error.message}"
+      end
+    end
+  end
+end

data/lib/uinit/sig/return_type_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Uinit
+  module Sig
+    class ReturnTypeError < StandardError
+      def initialize(method, type_error)
+        super()
+
+        @method = method
+        @type_error = type_error
+
+        set_backtrace(type_error.backtrace)
+      end
+
+      attr_reader :method, :type_error
+
+      def message
+        file, line = method.method_origin.source_location
+
+        "Return type error in method '#{method.method_name}' " \
+          "at '#{file}:#{line}', detail:\n#{type_error.message}"
+      end
+    end
+  end
+end

data/lib/uinit/sig/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Uinit
+  module Sig
+    VERSION = '0.1.0'
+  end
+end

data/lib/uinit/sig.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+
+require 'uinit/type'
+require 'uinit/structure'
+
+module Uinit; end
+
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.push_dir(__dir__, namespace: Uinit)
+  loader.setup
+end
+
+module Uinit
+  module Sig
+    include Memoizable
+
+    UNDEFINED = Class.new.new
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    class SignedMethods; end
+
+    module ClassMethods
+      include Memoizable
+      include Type::Context
+
+      memo def signed_methods
+        if respond_to?(:superclass) && superclass.respond_to?(:signed_methods)
+          return Class.new(superclass.signed_methods.class).new
+        end
+
+        Class.new(SignedMethods).new
+      end
+
+      def sig(**params)
+        build_method(false, **params)
+      end
+
+      def sig_self(**params)
+        build_method(true, **params)
+      end
+
+      private
+
+      def build_method(class_method, **params)
+        method = Method.new(base: self, class_method:)
+
+        parameters = params.map { |name, type| Parameter.new(name:, type:, method:) }
+        method.parameters = parameters
+
+        signed_methods.class.define_method(method.signed_name) { method }
+
+        method
+      end
+    end
+
+    private
+
+    memo def _signed_methods = self.class.signed_methods
+  end
+end

data/uinit-sig.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'uinit/sig/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'uinit-sig'
+  spec.version = Uinit::Sig::VERSION
+  spec.authors = ['Kimoja']
+  spec.email = ['joakim.carrilho@cheerz.com']
+
+  spec.summary = 'Signed methods'
+  spec.description = 'Signed methods'
+  spec.homepage = 'https://github.com/Kimoja/uinit-sig'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.1'
+  spec.files = Dir['CHANGELOG.md', 'LICENSE.txt', 'README.md', 'uinit-sig.gemspec', 'lib/**/*']
+  spec.require_paths = ['lib']
+  spec.executables = []
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['source_code_uri'] = 'https://github.com/Kimoja/uinit-sig'
+  spec.metadata['changelog_uri'] = 'https://github.com/Kimoja/uinit-sig/blob/main/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/Kimoja/uinit-sig/issues'
+
+  spec.add_runtime_dependency 'zeitwerk', '~> 2.6'
+
+  spec.add_dependency 'uinit-memoizable', '~> 0.1.0'
+  spec.add_dependency 'uinit-structure', '~> 0.1.0'
+  spec.add_dependency 'uinit-type', '~> 0.1.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: uinit-sig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kimoja
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: uinit-memoizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: uinit-structure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: uinit-type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Signed methods
+email:
+- joakim.carrilho@cheerz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/uinit/sig.rb
+- lib/uinit/sig/method.rb
+- lib/uinit/sig/method_compiler.rb
+- lib/uinit/sig/parameter.rb
+- lib/uinit/sig/parameter_type_error.rb
+- lib/uinit/sig/return_type_error.rb
+- lib/uinit/sig/version.rb
+- uinit-sig.gemspec
+homepage: https://github.com/Kimoja/uinit-sig
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Kimoja/uinit-sig
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/Kimoja/uinit-sig
+  changelog_uri: https://github.com/Kimoja/uinit-sig/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Kimoja/uinit-sig/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Signed methods
+test_files: []