typeguard 1.0.0

data/lib/typeguard/wrapper.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Typeguard
+  module Validation
+    class Wrapper
+      include Typeguard::TypeModel::Definitions
+
+      def initialize(definitions, config)
+        @definitions = definitions
+        @config = config
+      end
+
+      def wrap!
+        @definitions.each { |definition| wrap_definition(definition) }
+      end
+
+      def wrap_definition(definition)
+        case definition
+        when ModuleDefinition, ClassDefinition
+          mod = Object.const_get(definition.name)
+          definition.children.each do |child|
+            if child.is_a?(MethodDefinition)
+              wrap_method(mod, child)
+            else
+              # Wrap nested modules
+              wrap_definition(child)
+            end
+          end
+        when MethodDefinition
+          # Method defined in root, as a private instance method of Object
+          wrap_method(Object, definition)
+        else raise "Unexpected definition for '#{definition}'"
+        end
+      end
+
+      def wrap_method(mod, sig)
+        return if unsafe_method?(sig)
+
+        target = sig.scope == :class ? mod.singleton_class : mod
+        method_name = sig.name
+        original_method = target.instance_method(method_name)
+        check_arity(mod, sig, original_method)
+        actual_visibility = check_visibility(target, mod, sig, method_name)
+        Validator.exhaustive_path(mod, original_method, sig)
+        target.send(actual_visibility, method_name)
+      end
+
+      def unsafe_method?(sig)
+        # It is unsafe to redefine these methods because
+        # the return type is not always the same: assignment
+        # vs method call
+        sig.name == :initialize || sig.name.to_s =~ /=$/
+      end
+
+      def check_arity(mod, sig, original_method)
+        expected_arity = sig.parameters.size
+        actual_arity = original_method.parameters.count
+        return if expected_arity == actual_arity
+
+        log = Metrics.report(mod, sig, :unexpected_arity, expected_arity, actual_arity)
+        raise Metrics.format_log(log) if @config.raise_on_unexpected_arity
+      end
+
+      def check_visibility(target, mod, sig, method_name)
+        expected_visibility = sig.visibility
+        actual_visibility =
+          if target.public_instance_methods(false).include?(method_name)
+            :public
+          elsif target.protected_instance_methods(false).include?(method_name)
+            :protected
+          elsif target.private_instance_methods(false).include?(method_name)
+            :private
+          else
+            :public
+          end
+
+        error = false
+        unless expected_visibility.nil? || expected_visibility == actual_visibility
+          if expected_visibility == :public && actual_visibility == :private
+            if sig.name == :initialize
+              # Initialize is private by default, ignore
+            elsif mod == Object
+              # Methods on Object (root) are private by default, ignore
+            else
+              error = true
+            end
+          else
+            error = true
+          end
+        end
+
+        if error
+          log = Metrics.report(mod, sig, :unexpected_visibility, expected_visibility, actual_visibility)
+          raise Metrics.format_log(log) if @config.raise_on_unexpected_visibility
+        end
+
+        actual_visibility
+      end
+    end
+  end
+end

data/lib/typeguard.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'typeguard/type_model/definitions'
+require_relative 'typeguard/type_model/builder'
+require_relative 'typeguard/version'
+require_relative 'typeguard/configuration'
+require_relative 'typeguard/resolver'
+require_relative 'typeguard/metrics'
+require_relative 'typeguard/types'
+require_relative 'typeguard/validator'
+require_relative 'typeguard/wrapper'

data/sig/typeguard/bin/example.rbs

@@ -0,0 +1,77 @@
+# Custom constant
+class Foo
+end
+
+# Nested modules and classes
+module One
+  class OneClass
+  end
+
+  module Two
+    class TwoClass
+    end
+
+    module Three
+      # Nested class
+      class ThreeClass
+        # _@param_ `one`
+        # 
+        # _@param_ `two`
+        def nested_fn: (One::OneClass one, One::Two::TwoClass two) -> [One::OneClass, One::Two::TwoClass, One::Two::Three::ThreeClass]
+      end
+    end
+  end
+end
+
+# Yardoc validation example
+class Example
+  # _@return_ — a regular type
+  def regular0: () -> Object
+
+  # _@return_ — Ruby literal 'true'
+  def literal0: () -> bool
+
+  # sord duck - #push looks like a duck type, replacing with untyped
+  # _@return_ — duck-type: responds to :push
+  def duck0: () -> untyped
+
+  # _@param_ `a` — Integer to double
+  # 
+  # _@return_ — double of a
+  def double1: (Integer a) -> Integer
+
+  # _@param_ `a`
+  # 
+  # _@param_ `b`
+  # 
+  # _@return_ — generic array of numbers
+  def generic_array2: (Integer a, Integer b) -> ::Array[(Integer | Float)]
+
+  # _@param_ `a`
+  # 
+  # _@return_ — fixed array with order Symbol -> Integer
+  def fixed_array1: (Integer a) -> [Symbol, Integer]
+
+  # sord warn - Invalid hash, must have exactly two types: "Hash{Symbol => Integer, Float}".
+  # _@param_ `a`
+  # 
+  # _@return_ — special hash syntax with 1 key and 2 value types
+  def special_hash1: (Integer a) -> untyped
+
+  # sord duck - #push looks like a duck type, replacing with untyped
+  # sord warn - Invalid hash, must have exactly two types: "Hash{Symbol, String => Boolean, Array<Array(Foo, #push, Set<Integer>)>}".
+  # _@param_ `a`
+  # 
+  # _@return_ — complex types
+  def complex1: (Integer a) -> untyped
+
+  # sord warn - Invalid hash, must have exactly two types: "{Symbol => Integer, Symbol}".
+  # _@param_ `a`
+  # 
+  # _@return_ — shorthands for collections
+  def shorthands1: (Integer a) -> [[Integer, Float], ::Array[Symbol], untyped]
+
+  def nested_modules0: () -> [One::OneClass, One::Two::TwoClass, One::Two::Three::ThreeClass]
+
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: typeguard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tesorion
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  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: rbs
+  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: yard
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+email:
+- QmanageDevelopment@tesorion.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/typeguard.rb
+- lib/typeguard/configuration.rb
+- lib/typeguard/metrics.rb
+- lib/typeguard/resolver.rb
+- lib/typeguard/type_model/builder.rb
+- lib/typeguard/type_model/builder/rbs_builder.rb
+- lib/typeguard/type_model/builder/yard_builder.rb
+- lib/typeguard/type_model/definitions.rb
+- lib/typeguard/type_model/mapper/rbs_mapper.rb
+- lib/typeguard/type_model/mapper/yard_mapper.rb
+- lib/typeguard/types.rb
+- lib/typeguard/validator.rb
+- lib/typeguard/version.rb
+- lib/typeguard/wrapper.rb
+- sig/typeguard/bin/example.rbs
+homepage: https://github.com/tesorion/typeguard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tesorion/typeguard
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Validate YARD and RBS type signatures
+test_files: []