low_type 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ef30b8ad7d079a95270a664aacb4b28255cad9dcd743451e1f78b1391549222
-  data.tar.gz: 4e4329460d20826d604b99d1d7e57cee581cb7c3d8e6ffe2621e7ed383967b57
+  metadata.gz: a175f78281d51fe16720ca8231b1790506d2eea0d96660c52ff78f1717689836
+  data.tar.gz: f8615b0754c2a5e30e99e37922311d7d9436a37025f3a1a76334d4b14da21e7d
 SHA512:
-  metadata.gz: c08f01a89a82f293c0320034eceff0831b87a63ec52c45f0bd01ebd23ef067af2099bd8f554c45579ef285284c9afa34713556962a8a2b167d99bf5bc65ce73b
-  data.tar.gz: d90226573c175294ecc61258b1ed013f9b2351b4fdea32672bed0cf0786dbbea64341021710d21c0826feb152257fbaf4fc11d24cf180b9b3ac739523afef74a
+  metadata.gz: 04d69b82160152e0c04cc114e196c68fc5122dc79fa3b622ebafa21106a01ab8d44d7a483df497f2cc51c8280c2038bbf114b680505a2c9e35b73b9cbef2cd04
+  data.tar.gz: f2baaeeeaaec312a7306c12094e3b4cd661a935e3b6072b8824df5451fbd88538ffcacc48ba6beedc06e75ec2d685f015227289c529f051cadd246de127aa033

data/lib/factories/type_factory.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LowType
+  class TypeFactory
+    class << self
+      def complex_type(parent_type)
+        Class.new(parent_type) do
+          def self.match?(value:)
+            return true if value.instance_of?(self.class) || value.instance_of?(superclass)
+
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/interfaces/error_interface.rb

@@ -4,6 +4,12 @@ module LowType
   class ErrorInterface
     attr_reader :file
 
+    def initialize
+      @file = nil
+      @output_mode = LowType.config.output_mode
+      @output_size = LowType.config.output_size
+    end
+
     def error_type
       raise NotImplementedError
     end
@@ -11,5 +17,29 @@ module LowType
     def error_message(value:)
       raise NotImplementedError
     end
+
+    def output(value:)
+      case @output_mode
+      when :type
+        # TODO: Show full type structure in error output instead of just the type of the supertype.
+        value.class
+      when :value
+        value.inspect[0...@output_size]
+      else
+        'REDACTED'
+      end
+    end
+
+    def backtrace(backtrace:, hidden_paths:)
+      # Remove LowType defined method file paths from the backtrace.
+      filtered_backtrace = backtrace.reject { |line| hidden_paths.find { |file_path| line.include?(file_path) } }
+
+      # Add the proxied file to the backtrace.
+      proxy_file_backtrace = "#{file.path}:#{file.line}:in '#{file.scope}'"
+      from_prefix = filtered_backtrace.first.match(/\s+from /)
+      proxy_file_backtrace = "#{from_prefix}#{proxy_file_backtrace}" if from_prefix
+
+      [proxy_file_backtrace, *filtered_backtrace]
+    end
   end
 end

data/lib/low_type.rb

@@ -37,8 +37,8 @@ module LowType
 
   class << self
     def config
-      config = Struct.new(:deep_type_check, :severity_level, :union_type_expressions)
-      @config ||= config.new(false, :error, true)
+      config = Struct.new(:error_mode, :output_mode, :output_size, :deep_type_check, :union_type_expressions)
+      @config ||= config.new(:error, :type, 100, false, true)
     end
 
     def configure

data/lib/proxies/local_proxy.rb

@@ -8,6 +8,8 @@ module LowType
     attr_reader :type_expression, :name
 
     def initialize(type_expression:, name:, file:)
+      super()
+
       @type_expression = type_expression
       @name = name
       @file = file
@@ -18,7 +20,7 @@ module LowType
     end
 
     def error_message(value:)
-      "Invalid variable type #{value.class} in '#{@name.class}' on line #{@file.line}. Valid types: '#{@type_expression.valid_types}'"
+      "Invalid variable type #{output(value:)} in '#{@name.class}' on line #{@file.line}. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/proxies/param_proxy.rb

@@ -8,6 +8,8 @@ module LowType
     attr_reader :type_expression, :name, :type, :position
 
     def initialize(type_expression:, name:, type:, file:, position: nil)
+      super()
+
       @type_expression = type_expression
       @name = name
       @type = type
@@ -20,7 +22,7 @@ module LowType
     end
 
     def error_message(value:)
-      "Invalid argument type '#{value.class}' for parameter '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
+      "Invalid argument type '#{output(value:)}' for parameter '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/proxies/return_proxy.rb

@@ -8,6 +8,8 @@ module LowType
     attr_reader :type_expression, :name
 
     def initialize(type_expression:, name:, file:)
+      super()
+
       @type_expression = type_expression
       @name = name
       @file = file
@@ -18,7 +20,7 @@ module LowType
     end
 
     def error_message(value:)
-      "Invalid return type '#{value.class}' for method '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
+      "Invalid return type '#{output(value:)}' for method '#{@name}'. Valid types: '#{@type_expression.valid_types}'"
     end
   end
 end

data/lib/queries/file_parser.rb

@@ -62,7 +62,7 @@ module LowType
 
       @instance_methods = []
       @class_methods = []
-      @line_numbers = { class_start: 0, class_end: root_node.respond_to?(:end_line) ? root_node.end_line : nil}
+      @line_numbers = { class_start: 0, class_end: root_node.respond_to?(:end_line) ? root_node.end_line : nil }
     end
 
     def visit_def_node(node)

data/lib/queries/file_query.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module LowType
   class FileQuery
     class << self
       def file_path(klass:)
-        includer_line = line_with_class(klass:) || line_with_include || ''
+        includer_line = line_from_class(klass:) || line_from_include || ''
         includer_line.split(':').first || ''
       end
 
       private
 
-      def line_with_class(klass:)
+      def line_from_class(klass:)
         class_name = klass.to_s.split(':').last # Also remove the module namespaces from the class.
         caller.find { |callee| callee.end_with?("<class:#{class_name}>'") }
       end
 
-      def line_with_include
+      def line_from_include
         caller.find { |callee| callee.end_with?("include'") }
       end
     end

data/lib/queries/type_query.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../type_expression'
+
 module LowType
   # TODO: Unit test.
   class TypeQuery
@@ -6,20 +10,26 @@ module LowType
         basic_type?(type:) || complex_type?(type:)
       end
 
-      def basic_type?(type:)
-        type.class == Class
+      def value?(value)
+        !basic_type?(type: value) && !complex_type?(type: value)
       end
 
       def complex_type?(type:)
-        !basic_type?(type:) && typed_hash?(type:)
+        LowType::COMPLEX_TYPES.include?(type) || typed_array?(type:) || typed_hash?(type:)
       end
 
-      def typed_hash?(type:)
-        type.is_a?(::Hash) && basic_type?(type: type.keys.first) && basic_type?(type: type.values.first)
+      private
+
+      def basic_type?(type:)
+        type.instance_of?(Class)
+      end
+
+      def typed_array?(type:)
+        type.is_a?(Array) && (basic_type?(type: type.first) || type.first.is_a?(TypeExpression))
       end
 
-      def value?(expression)
-        !expression.respond_to?(:new) && expression != Integer
+      def typed_hash?(type:)
+        type.is_a?(Hash) && basic_type?(type: type.keys.first) && basic_type?(type: type.values.first)
       end
     end
   end

data/lib/redefiner.rb

@@ -5,8 +5,8 @@ require_relative 'factories/proxy_factory'
 require_relative 'proxies/file_proxy'
 require_relative 'proxies/method_proxy'
 require_relative 'proxies/param_proxy'
-require_relative 'syntax/syntax'
 require_relative 'queries/type_query'
+require_relative 'syntax/syntax'
 require_relative 'type_expression'
 require_relative 'value_expression'
 
@@ -45,9 +45,7 @@ module LowType
             method_start = method_node.respond_to?(:start_line) ? method_node.start_line : nil
             method_end = method_node.respond_to?(:end_line) ? method_node.end_line : nil
 
-            if method_start && method_end && class_end
-              next unless method_start > class_start && method_end <= class_end
-            end
+            next if method_start && method_end && class_end && !(method_start > class_start && method_end <= class_end)
 
             name = method_node.name
 
@@ -108,7 +106,7 @@ module LowType
           }
         RUBY
 
-        # Called with only required args (as nil) and optional args omitted, to evaluate type expressions (stored as default values).
+        # Called with only required args (as nil) and optional args omitted, to evaluate type expressions (from default values).
         eval(typed_method, binding, __FILE__, __LINE__).call(*required_args, **required_kwargs) # rubocop:disable Security/Eval
 
       # TODO: Write spec for this.

data/lib/syntax/syntax.rb

@@ -6,14 +6,16 @@ module LowType
   module Syntax
     refine Array.singleton_class do
       def [](*types)
-        return LowType::TypeExpression.new(type: [*types]) if types.all? { |type| LowType::TypeQuery.type?(type) }
+        return TypeExpression.new(type: [*types]) if types.all? { |type| TypeQuery.type?(type) }
+
         super
       end
     end
 
     refine Hash.singleton_class do
       def [](type)
-        return LowType::TypeExpression.new(type:) if LowType::TypeQuery.type?(type)
+        return TypeExpression.new(type:) if TypeQuery.type?(type)
+
         super
       end
     end

data/lib/syntax/union_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ###
 # Type expressions from union types.
 #

data/lib/type_expression.rb

@@ -5,10 +5,10 @@ require_relative 'queries/type_query'
 
 module LowType
   root_path = File.expand_path(__dir__)
-  file_path = File.expand_path(__FILE__)
   adapter_paths = Dir.chdir(root_path) { Dir.glob('adapters/*') }.map { |path| File.join(root_path, path) }
+  module_paths = %w[instance_types local_types redefiner].map { |path| File.join(root_path, "#{path}.rb") }
 
-  HIDDEN_PATHS = [file_path, *adapter_paths, File.join(root_path, 'redefiner.rb')].freeze
+  HIDDEN_PATHS = [File.expand_path(__FILE__), *adapter_paths, *module_paths].freeze
 
   # Represent types and default values as a series of chainable expressions.
   class TypeExpression
@@ -19,6 +19,8 @@ module LowType
       @types = []
       @types << type unless type.nil?
       @default_value = default_value
+      # TODO: Override per type expression with a config expression.
+      @deep_type_check = LowType.config.deep_type_check
     end
 
     def |(expression)
@@ -45,64 +47,94 @@ module LowType
       end
 
       @types.each do |type|
-        # Example: HTML is a subclass of String and should pass as a String.
-        return true if LowType::TypeQuery.basic_type?(type:) && type <= value.class
-        return true if type.is_a?(::Array) && value.is_a?(::Array) && array_types_match_values?(types: type, values: value)
-        return true if type.is_a?(::Hash) && value.is_a?(::Hash) && hash_types_match_values?(type:, value:)
+        return true if type_matches_value?(type:, value:, proxy:)
+        return true if type.is_a?(Array) && value.is_a?(Array) && array_types_match_values?(types: type, values: value, proxy:)
+        return true if type.is_a?(Hash) && value.is_a?(Hash) && hash_types_match_values?(types: type, values: value)
       end
 
       raise proxy.error_type, proxy.error_message(value:)
     rescue proxy.error_type => e
-      raise proxy.error_type, e.message, backtrace_with_proxy(backtrace: e.backtrace, proxy:)
+      raise proxy.error_type, e.message, proxy.backtrace(backtrace: e.backtrace, hidden_paths: HIDDEN_PATHS)
     end
 
     def valid_types
       types = @types.map do |type|
-        # Remove 'LowType::' namespace in subtypes.
-        if type.is_a?(::Array)
-          "[#{type.map { |subtype| subtype.to_s.delete_prefix('LowType::') }.join(', ')}]"
+        if type.is_a?(Array)
+          "[#{type.map { |subtype| valid_subtype(subtype:) }.join(', ')}]"
         else
           type.inspect.to_s.delete_prefix('LowType::')
         end
       end
 
-      types += ['nil'] if @default_value.nil?
+      types << 'nil' if @default_value.nil?
       types.join(' | ')
     end
 
     private
 
-    def array_types_match_values?(types:, values:)
-      # [T, T, T]
+    def valid_subtype(subtype:)
+      if subtype.is_a?(TypeExpression)
+        types = subtype.types
+        types << 'nil' if subtype.default_value.nil?
+        types.join(' | ')
+      else
+        subtype.to_s.delete_prefix('LowType::')
+      end
+    end
+
+    def array_types_match_values?(types:, values:, proxy:)
+      # [X, Y, Z] An arbitrary amount of elements are arbitrary types in an arbitrary order.
       if types.length > 1
-        types.each_with_index do |type, index|
-          # Example: HTML is a subclass of String and should pass as a String.
-          return false unless type <= values[index].class
-        end
-      # [T]
+        return multiple_types_match_values?(types:, values:, proxy:)
+      # [T] All elements are the same type.
       elsif types.length == 1
-        return false unless types.first == values.first.class
+        return single_type_matches_values?(type: types.first, values:, proxy:)
+      end
+
+      # [] Misconfigured empty Array[] type.
+      true
+    end
+
+    def multiple_types_match_values?(types:, values:, proxy:)
+      types.each_with_index do |type, index|
+        return false unless type_matches_value?(type:, value: values[index], proxy:)
       end
-      # TODO: Deep type check (all elements for [T]).
 
       true
     end
 
-    def hash_types_match_values?(type:, value:)
+    def single_type_matches_values?(type:, values:, proxy:)
+      # [V, ...] Type check all elements.
+      if deep_type_check?
+        return false if values.any? { |value| !type_matches_value?(type:, value:, proxy:) }
+      # [V] Type check the first element.
+      else
+        return false unless type_matches_value?(type:, value: values.first, proxy:)
+      end
+
+      true
+    end
+
+    def hash_types_match_values?(types:, values:)
       # TODO: Shallow validation of hash could be made deeper with user config.
-      type.keys[0] == value.keys[0].class && type.values[0] == value.values[0].class
+      types.keys[0] == values.keys[0].class && types.values[0] == values.values[0].class
     end
 
-    def backtrace_with_proxy(proxy:, backtrace:)
-      # Remove LowType defined method file paths from the backtrace.
-      filtered_backtrace = backtrace.reject { |line| HIDDEN_PATHS.find { |file_path| line.include?(file_path) } }
+    def type_matches_value?(type:, value:, proxy:)
+      if type.instance_of?(Class)
+        return type.match?(value:) if LowType::TypeQuery.complex_type?(type:)
+
+        return type == value.class
+      elsif type.instance_of?(::LowType::TypeExpression)
+        type.validate!(value:, proxy:)
+        return true
+      end
 
-      # Add the proxied file to the backtrace.
-      proxy_file_backtrace = "#{proxy.file.path}:#{proxy.file.line}:in '#{proxy.file.scope}'"
-      from_prefix = filtered_backtrace.first.match(/\s+from /)
-      proxy_file_backtrace = "#{from_prefix}#{proxy_file_backtrace}" if from_prefix
+      false
+    end
 
-      [proxy_file_backtrace, *filtered_backtrace]
+    def deep_type_check?
+      @deep_type_check || LowType.config.deep_type_check || false
     end
   end
 end

data/lib/types/complex_types.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require_relative '../factories/type_factory'
+
 module LowType
-  # TrueClass or FalseClass
-  class Boolean; end
-  class Tuple < Array; end
-  class Status < Integer; end
-  class Headers < Hash; end
-  class HTML < String; end
-  class JSON < String; end
-  class XML < String; end
+  COMPLEX_TYPES = [
+    Boolean = TypeFactory.complex_type(Object),
+    Headers = TypeFactory.complex_type(Hash),
+    HTML = TypeFactory.complex_type(String),
+    JSON = TypeFactory.complex_type(String),
+    Status = TypeFactory.complex_type(Integer),
+    Tuple = TypeFactory.complex_type(Array),
+    XML = TypeFactory.complex_type(String)
+  ].freeze
 end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_type
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - maedi
@@ -21,6 +21,7 @@ files:
 - lib/adapters/sinatra_adapter.rb
 - lib/factories/expression_factory.rb
 - lib/factories/proxy_factory.rb
+- lib/factories/type_factory.rb
 - lib/instance_types.rb
 - lib/interfaces/adapter_interface.rb
 - lib/interfaces/error_interface.rb