low_type 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d845917e9ed4afc79db302fe7f5a2955a4e299d7bd415e82e2f26af3b14cd25f
-  data.tar.gz: f9213b5731f3805ebf1e99efa0ccdd741b955464403842aeaa171d0b41fff146
+  metadata.gz: 1e76dff27cdb0b8d263e8204299df281bd1e05b2097039b1045aa85f98134568
+  data.tar.gz: a6775344f9cd73a4275e0dad7d510bae20a3257922a702d938f0c2506363a1bf
 SHA512:
-  metadata.gz: 6066f8c29073720201a83438c58067ef37d2b02b493f108e31bee624069b68a7049e3a64aebe20da851f7b8e13e7d599c02deb1adbb9050ccd271a895933c6c2
-  data.tar.gz: 16c144045ae7666c1ab42610e641d9b4946b14cc9adf22023239a55dbfcbc5a8da714b53c94972a883249008512bcc56a60b465ce9ba9da1908a0151856afa7c
+  metadata.gz: 6a0e1d2c4d89357e1add9051be9be3c0bd972d1aa737c1c5ff6f7ff5ca22fbf4590dc08b52f72f9f6fe252678ce89cbd16a8eee892255f55d4a04218323cd254
+  data.tar.gz: 4e9d03cd8588500dfafadeb423f06641e2981532106c342366a90f7fe36a8dcb96ef4191f3231f7f3cb5f21492d7bf61f790d020af31d224bea8d459d902de1b

data/lib/interfaces/{proxy_interface.rb → error_interface.rb}

@@ -1,10 +1,12 @@
 module LowType
-  class ProxyInterface
-    def error_type(value:)
+  class ErrorInterface
+    attr_reader :file
+
+    def error_type
       raise NotImplementedError
     end
 
-    def error_message(value:, line: nil)
+    def error_message(value:)
       raise NotImplementedError
     end
   end

data/lib/low_type.rb

@@ -34,11 +34,12 @@ module LowType
       end
     end
 
-    parser = Parser.new(file_path: LowType.file_path(klass:))
+    file_path = LowType.file_path(klass:)
+    parser = Parser.new(file_path:)
     private_start_line = parser.private_start_line
 
-    klass.prepend LowType::Redefiner.redefine_methods(method_nodes: parser.instance_methods, private_start_line:, klass:)
-    klass.singleton_class.prepend LowType::Redefiner.redefine_methods(method_nodes: parser.class_methods, private_start_line:, klass:)
+    klass.prepend LowType::Redefiner.redefine_methods(method_nodes: parser.instance_methods, klass:, private_start_line:, file_path:)
+    klass.singleton_class.prepend LowType::Redefiner.redefine_methods(method_nodes: parser.class_methods, klass:, private_start_line:, file_path:)
   ensure
     Array.define_singleton_method('[]', array_class_method)
     Hash.define_singleton_method('[]', hash_class_method)

data/lib/proxies/file_proxy.rb

@@ -0,0 +1,11 @@
+module LowType
+  class FileProxy
+    attr_reader :path, :line, :scope
+
+    def initialize(path:, line:, scope:)
+      @path = path
+      @line = line
+      @scope = scope
+    end
+  end
+end

data/lib/proxies/local_proxy.rb

@@ -1,21 +1,22 @@
-require_relative '../interfaces/proxy_interface'
+require_relative '../interfaces/error_interface'
 require_relative '../errors'
 
 module LowType
-  class LocalProxy < ProxyInterface
+  class LocalProxy < ErrorInterface
     attr_reader :type_expression, :name
 
-    def initialize(type_expression:, name:)
+    def initialize(type_expression:, name:, file:)
       @type_expression = type_expression
       @name = name
+      @file = file
     end
 
-    def error_type(value:)
+    def error_type
       LocalTypeError
     end
 
-    def error_message(value:, line:)
-      "Invalid variable type #{value.class} in '#{@name.class}' on line #{line}. Valid types: '#{@type_expression.valid_types.join(', ')}'"
+    def error_message(value:)
+      "Invalid variable type #{value.class} in '#{@name.class}' on line #{@file.line}. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/proxies/param_proxy.rb

@@ -1,26 +1,24 @@
-require_relative '../interfaces/proxy_interface'
+require_relative '../interfaces/error_interface'
 require_relative '../errors'
 
 module LowType
-  class ParamProxy < ProxyInterface
+  class ParamProxy < ErrorInterface
     attr_reader :type_expression, :name, :type, :position
 
-    def initialize(type_expression:, name:, type:, position: nil)
+    def initialize(type_expression:, name:, type:, position: nil, file:)
       @type_expression = type_expression
       @name = name
       @type = type
       @position = position
+      @file = file
     end
 
-    def error_type(value:)
-      return ArgumentError if value.nil?
+    def error_type
       ArgumentTypeError
     end
 
-    def error_message(value:, line: nil)
-      return "Missing argument for parameter '#{@name}'. Position: #{@position}" if value.nil?
-
-      "Invalid argument type '#{value.class}' for parameter '#{@name}'. Valid types: '#{@type_expression.valid_types.join(', ')}'"
+    def error_message(value:)
+      "Invalid argument type '#{value.class}' for parameter '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/proxies/return_proxy.rb

@@ -1,21 +1,22 @@
-require_relative '../interfaces/proxy_interface'
+require_relative '../interfaces/error_interface'
 require_relative '../errors'
 
 module LowType
-  class ReturnProxy < ProxyInterface
+  class ReturnProxy < ErrorInterface
     attr_reader :type_expression, :name
 
-    def initialize(type_expression:, name:)
+    def initialize(type_expression:, name:, file:)
       @type_expression = type_expression
       @name = name
+      @file = file
     end
 
-    def error_type(value:)
+    def error_type
       ReturnTypeError
     end
 
-    def error_message(value:, line: nil)
-      "Invalid return type '#{value.class}' for method '#{@name}'. Valid types: '#{@type_expression.valid_types.join(', ')}'"
+    def error_message(value:)
+      "Invalid return type '#{value.class}' for method '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/redefiner.rb

@@ -1,3 +1,4 @@
+require_relative 'proxies/file_proxy'
 require_relative 'proxies/method_proxy'
 require_relative 'proxies/param_proxy'
 require_relative 'proxies/return_proxy'
@@ -6,13 +7,16 @@ require_relative 'type_expression'
 
 module LowType
   class Redefiner
+    FILE_PATH = File.expand_path(__FILE__)
+
     class << self
-      def redefine_methods(method_nodes:, private_start_line:, klass:)
+      def redefine_methods(method_nodes:, klass:, private_start_line:, file_path:)
         Module.new do
           method_nodes.each do |method_node|
             name = method_node.name
-            params = Redefiner.params_with_type_expressions(method_node:)
-            return_proxy = Redefiner.return_proxy(method_node:)
+            file = FileProxy.new(path: file_path, line: method_node.start_line, scope: "#{klass}##{method_node.name}")
+            params = Redefiner.params_with_type_expressions(method_node:, file:)
+            return_proxy = Redefiner.return_proxy(method_node:, file:)
 
             klass.low_methods[name] = MethodProxy.new(name:, params:, return_proxy:)
 
@@ -45,7 +49,7 @@ module LowType
         end
       end
 
-      def params_with_type_expressions(method_node:)
+      def params_with_type_expressions(method_node:, file:)
         return [] if method_node.parameters.nil?
 
         params = method_node.parameters.slice
@@ -64,9 +68,9 @@ module LowType
                 expression = binding.local_variable_get(name)
 
                 if expression.class == TypeExpression
-                  param_proxies << ParamProxy.new(type_expression: expression, name:, type:, position:)
+                  param_proxies << ParamProxy.new(type_expression: expression, name:, type:, position:, file:)
                 elsif ::LowType.type?(expression)
-                  param_proxies << ParamProxy.new(type_expression: TypeExpression.new(type: expression), name:, type:, position:)
+                  param_proxies << ParamProxy.new(type_expression: TypeExpression.new(type: expression), name:, type:, position:, file:)
                 end
               end
 
@@ -83,14 +87,14 @@ module LowType
         raise ArgumentError, "Incorrect param syntax: #{e.message}"
       end
 
-      def return_proxy(method_node:)
+      def return_proxy(method_node:, file:)
         return_node = Parser.return_node(method_node:)
         return nil if return_node.nil?
 
         expression = eval(return_node.slice).call
         expression = TypeExpression.new(type: expression) unless expression.is_a?(TypeExpression)
 
-        ReturnProxy.new(type_expression: expression, name: method_node.name)
+        ReturnProxy.new(type_expression: expression, name: method_node.name, file:)
       end
 
       private

data/lib/type_assignment.rb

@@ -1,3 +1,4 @@
+require_relative 'proxies/file_proxy'
 require_relative 'proxies/local_proxy'
 require_relative 'type_expression'
 require_relative 'value_expression'
@@ -12,15 +13,17 @@ module TypeAssignment
       raise AssignmentError, "Single-instance objects like #{object} are not supported"
     end
 
-    local_proxy = LowType::LocalProxy.new(type_expression:, name: self)
+    last_caller = caller_locations(1, 1).first
+    file = LowType::FileProxy.new(path: last_caller.path, line: last_caller.lineno, scope: 'local type')
+    local_proxy = LowType::LocalProxy.new(type_expression:, name: self, file:)
     object.instance_variable_set('@local_proxy', local_proxy)
 
-    type_expression.validate!(value: object, proxy: local_proxy, line: caller_locations(1, 1).first.lineno)
+    type_expression.validate!(value: object, proxy: local_proxy)
 
     def object.with_type=(value)
       local_proxy = self.instance_variable_get('@local_proxy')
       type_expression = local_proxy.type_expression
-      type_expression.validate!(value:, proxy: local_proxy, line: caller_locations(1, 1).first.lineno)
+      type_expression.validate!(value:, proxy: local_proxy)
 
       # We can't reassign self in Ruby so we reassign instance variables instead.
       value.instance_variables.each do |variable|

data/lib/type_expression.rb

@@ -2,6 +2,8 @@ require_relative 'proxies/param_proxy'
 
 module LowType
   class TypeExpression
+    FILE_PATH = File.expand_path(__FILE__)
+
     attr_reader :types, :default_value
 
     def initialize(type: nil, default_value: :LOW_TYPE_UNDEFINED)
@@ -27,10 +29,10 @@ module LowType
       @default_value == :LOW_TYPE_UNDEFINED
     end
 
-    def validate!(value:, proxy:, line: nil)
+    def validate!(value:, proxy:)
       if value.nil?
         return true if @default_value.nil?
-        raise proxy.error_type(value:), proxy.error_message(value:, line:) if required?
+        raise proxy.error_type, proxy.error_message(value:) if required?
       end
 
       @types.each do |type|
@@ -42,13 +44,24 @@ module LowType
         end
       end
 
-      raise proxy.error_type(value:), proxy.error_message(value:, line:)
+      raise proxy.error_type, proxy.error_message(value:)
+    rescue proxy.error_type => e
+      # Remove LowType file paths from the backtrace.
+      internal_file_paths = [FILE_PATH, LowType::Redefiner::FILE_PATH]
+      external_backtrace = e.backtrace.reject { |line| internal_file_paths.include?(line.split(':').first) }
+
+      # Add the proxied file to the backtrace.
+      file = proxy.file
+      proxy_file_backtrace = "#{file.path}:#{file.line}:in '#{file.scope}'"
+
+      raise proxy.error_type, e.message, [proxy_file_backtrace, *external_backtrace]
     end
 
     def valid_types
       types = @types.map { |type| type.inspect.to_s }
-      return types + ['nil'] if @default_value.nil?
-      types
+      types = types + ['nil'] if @default_value.nil?
+
+      types.join(' | ')
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_type
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - maedi
@@ -18,9 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/errors.rb
-- lib/interfaces/proxy_interface.rb
+- lib/interfaces/error_interface.rb
 - lib/low_type.rb
 - lib/parser.rb
+- lib/proxies/file_proxy.rb
 - lib/proxies/local_proxy.rb
 - lib/proxies/method_proxy.rb
 - lib/proxies/param_proxy.rb