low_type 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3541ef39f820d9554a2493481686ad0692f66d36a31920d2c4304a62cb55bbb9
-  data.tar.gz: 19bebceb57fff771317130dae93e5caf86962028db3e81321b03855ccf3c42cb
+  metadata.gz: 5eeeaaa196eb1b1b9d4f4408ec91e5716c6d9d19599e78d9f3f1ddaff9c08181
+  data.tar.gz: 47259a30a8855c530f530ba10f03c298c29dbf5018146b5432a4b4c0b95ac491
 SHA512:
-  metadata.gz: 61dace65facc045407b0300157a9e66e6269b14a3414ed943ed3bb5bd817ab313d4c10fd184cad0c2f6803c50a03c6c7d5929253ce68ba89b909a49f55d79fcb
-  data.tar.gz: 207f390f476e60af068bffc5bed65c0f76f20bc4997e1d76905496779e63aeaf9022405fe95576d4d8f14ad35107ea6c07f8a98fb4ddfb447d50eff35a1a6921
+  metadata.gz: 4331980b4a8ab95a1bcf806a575580c05a9f8386da572cc16e0e978b68376f5609fadac585436e072bbd3d1dc77e09892e53abec6710dff77dbe67f165fb0eff
+  data.tar.gz: 6c62cd38cf093e6beef4c66bfa0cad1286da8d86feaa5bf6f2f229124ece2bcddb6ffc9acb216cc6b6c24f9b4935deeca39726c9f29ca27f38d0ed8ca97a508d

data/lib/file_parser.rb

@@ -4,25 +4,25 @@ require 'prism'
 
 module LowType
   class FileParser
-    attr_reader :parent_map, :instance_methods, :class_methods, :private_start_line
+    attr_reader :parent_map, :instance_methods, :class_methods, :line_numbers
 
-    def initialize(file_path:)
+    def initialize(klass:, file_path:)
       @root_node = Prism.parse_file(file_path).value
 
       parent_mapper = ParentMapper.new
       parent_mapper.visit(@root_node)
       @parent_map = parent_mapper.parent_map
 
-      method_visitor = MethodDefVisitor.new(@parent_map)
+      method_visitor = MethodDefVisitor.new(root_node: @root_node, parent_map:, klass:)
       @root_node.accept(method_visitor)
 
       @instance_methods = method_visitor.instance_methods
       @class_methods = method_visitor.class_methods
-      @private_start_line = method_visitor.private_start_line
+      @line_numbers = method_visitor.line_numbers
     end
 
     def method_calls(method_names:)
-      block_visitor = MethodCallVisitor.new(parent_map: @parent_map, method_names:)
+      block_visitor = MethodCallVisitor.new(parent_map:, method_names:)
       @root_node.accept(block_visitor)
       block_visitor.method_calls
     end
@@ -54,14 +54,15 @@ module LowType
   end
 
   class MethodDefVisitor < Prism::Visitor
-    attr_reader :class_methods, :instance_methods, :private_start_line
+    attr_reader :class_methods, :instance_methods, :line_numbers
 
-    def initialize(parent_map)
+    def initialize(root_node:, parent_map:, klass:)
       @parent_map = parent_map
+      @klass = klass
 
       @instance_methods = []
       @class_methods = []
-      @private_start_line = nil
+      @line_numbers = { class_start: 0, class_end: root_node.end_line }
     end
 
     def visit_def_node(node)
@@ -75,7 +76,23 @@ module LowType
     end
 
     def visit_call_node(node)
-      @private_start_line = node.start_line if node.name == :private && node.respond_to?(:start_line)
+      start_line = node.name == :private && node.respond_to?(:start_line) && node.start_line || nil
+      class_start = @line_numbers[:class_start]
+      class_end = @line_numbers[:class_end]
+
+      if start_line && class_start && class_end && start_line > class_start && start_line < class_end
+        @line_numbers[:private_start] = node.start_line
+      end
+
+      super
+    end
+
+    def visit_class_node(node)
+      if node.name == @klass.to_s.to_sym
+        @line_numbers = { class_start: node.class_keyword_loc.start_line, class_end: node.end_keyword_loc.end_line }
+      end
+
+      super
     end
 
     private

data/lib/low_type.rb

@@ -5,27 +5,29 @@ require_relative 'types/complex_types'
 require_relative 'instance_types'
 require_relative 'local_types'
 require_relative 'redefiner'
-require_relative 'syntax'
+require_relative 'syntax/syntax'
 require_relative 'type_expression'
 require_relative 'value_expression'
 
 module LowType
   # We do as much as possible on class load rather than on instantiation to be thread-safe and efficient.
   def self.included(klass)
+    require_relative 'syntax/union_types' if LowType.config.union_type_expressions
+
     class << klass
       def low_methods
         @low_methods ||= {}
       end
     end
 
-    file_path = LowType.file_path(klass:)
-    parser = FileParser.new(file_path:)
-    private_start_line = parser.private_start_line
+    file_path = LowType.file_path
+    parser = FileParser.new(klass:, file_path:)
+    line_numbers = parser.line_numbers
 
     klass.extend InstanceTypes
     klass.include LocalTypes
-    klass.prepend LowType::Redefiner.redefine(method_nodes: parser.instance_methods, klass:, private_start_line:, file_path:)
-    klass.singleton_class.prepend LowType::Redefiner.redefine(method_nodes: parser.class_methods, klass:, private_start_line:, file_path:)
+    klass.prepend LowType::Redefiner.redefine(method_nodes: parser.instance_methods, klass:, line_numbers:, file_path:)
+    klass.singleton_class.prepend LowType::Redefiner.redefine(method_nodes: parser.class_methods, klass:, line_numbers:, file_path:)
 
     if (adapter = Adapter::Loader.load(klass:, parser:, file_path:))
       adapter.process
@@ -37,8 +39,8 @@ module LowType
     # Public API.
 
     def config
-      config = Struct.new(:deep_type_check, :severity_level)
-      @config ||= config.new(false, :error)
+      config = Struct.new(:deep_type_check, :severity_level, :union_type_expressions)
+      @config ||= config.new(false, :error, true)
     end
 
     def configure
@@ -47,11 +49,9 @@ module LowType
 
     # Internal API.
 
-    def file_path(klass:)
-      # Remove module namespaces from class.
-      class_name = klass.to_s.split(':').last
-      # The first class found regardless of namespace will be the class that did the include.
-      caller.find { |callee| callee.end_with?("<class:#{class_name}>'") }.split(':').first
+    def file_path
+      includer_file = caller.find { |callee| callee.end_with?("in 'Module#include'") || callee.end_with?("in 'include'") }
+      includer_file.split(':').first
     end
 
     # TODO: Unit test.
@@ -60,7 +60,7 @@ module LowType
     end
 
     def basic_type?(type:)
-      type.respond_to?(:new) || type == Integer || type == Symbol
+      type.class == Class
     end
 
     def complex_type?(type:)

data/lib/redefiner.rb

@@ -4,7 +4,7 @@ require_relative 'factories/proxy_factory'
 require_relative 'proxies/file_proxy'
 require_relative 'proxies/method_proxy'
 require_relative 'proxies/param_proxy'
-require_relative 'syntax'
+require_relative 'syntax/syntax'
 require_relative 'type_expression'
 
 module LowType
@@ -13,9 +13,9 @@ module LowType
     using Syntax
 
     class << self
-      def redefine(method_nodes:, klass:, private_start_line:, file_path:)
+      def redefine(method_nodes:, klass:, line_numbers:, file_path:)
         create_proxies(method_nodes:, klass:, file_path:)
-        define_methods(method_nodes:, private_start_line:)
+        define_methods(method_nodes:, line_numbers:)
       end
 
       private
@@ -32,13 +32,20 @@ module LowType
         end
       end
 
-      def define_methods(method_nodes:, private_start_line:) # rubocop:disable Metrics
+      def define_methods(method_nodes:, line_numbers:) # rubocop:disable Metrics
+        class_start = line_numbers[:class_start]
+        class_end = line_numbers[:class_end]
+        private_start = line_numbers[:private_start]
+
         Module.new do
           method_nodes.each do |method_node|
+            method_start = method_node.start_line
+            next unless method_start > class_start && method_node.end_line <= class_end
+
             name = method_node.name
 
             define_method(name) do |*args, **kwargs|
-              method_proxy = instance_of?(Class) ? low_methods[name] : self.class.low_methods[name]
+              method_proxy = instance_of?(Class) ? low_methods[name] : self.class.low_methods[name] || Object.low_methods[name]
 
               method_proxy.params.each do |param_proxy|
                 # Get argument value or default value.
@@ -61,7 +68,7 @@ module LowType
               super(*args, **kwargs)
             end
 
-            private name if private_start_line && method_node.start_line > private_start_line
+            private name if private_start && method_start > private_start
           end
         end
       end

data/lib/syntax/syntax.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LowType
+  module Syntax
+    refine Array.singleton_class do
+      def [](*types)
+        return LowType::TypeExpression.new(type: [*types]) if types.all? { |type| LowType.type?(type) }
+        super
+      end
+    end
+
+    refine Hash.singleton_class do
+      def [](type)
+        return LowType::TypeExpression.new(type:) if LowType.type?(type)
+        super
+      end
+    end
+  end
+end

data/lib/{syntax.rb → syntax/union_types.rb}

@@ -1,26 +1,10 @@
-# frozen_string_literal: true
-
-module LowType
-  module Syntax
-    refine Array.singleton_class do
-      def [](*types)
-        return LowType::TypeExpression.new(type: [*types]) if types.all? { |type| LowType.type?(type) }
-
-        super
-      end
-    end
-
-    refine Hash.singleton_class do
-      def [](type)
-        return LowType::TypeExpression.new(type:) if LowType.type?(type)
-
-        super
-      end
-    end
-  end
-end
-
-# Refine doesn't support inheritence.
+###
+# Type expressions from union types.
+#
+# The "|" pipe syntax requires a monkey-patch but can be disabled if you don't need union types with default values.
+# This is the only monkey-patch in the entire library and is a relatively harmless one.
+# @see LowType.config.union_type_expressions
+###
 class Object
   # For "Type | [type_expression/type/value]" situations, redirecting to or generating a type expression from types.
   # "|" is not defined on Object class and this is the most compute-efficient way to achieve our goal (world peace).

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LowType
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_type
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - maedi
@@ -32,7 +32,8 @@ files:
 - lib/proxies/param_proxy.rb
 - lib/proxies/return_proxy.rb
 - lib/redefiner.rb
-- lib/syntax.rb
+- lib/syntax/syntax.rb
+- lib/syntax/union_types.rb
 - lib/type_expression.rb
 - lib/types/complex_types.rb
 - lib/types/error_types.rb