low_type 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a59004f5c707ad93a543ad18cfe56525d8dfc878ea76f83f8b5bddee0190ded8
-  data.tar.gz: 8dd19cda1ae90570b2b0005d862f9d59a9387d7f50f2d10ebcbdda7132133eda
+  metadata.gz: 6e3e1dca0d960082a4de505f3422e00c648f660306c22d24db65590db0543f5e
+  data.tar.gz: a87156e750aee311a9afb2a95166a9d00f99a744c05fc1dac0d9ab7120882760
 SHA512:
-  metadata.gz: 8ae9ca6844f6701f0f8ff7e666d9ebb6a8fd652a58bcffd8e72d38e862637c0f98d037c864f0082bcd351dda83dd0487215f2ee7d722bbd49f2b27551ca1064b
-  data.tar.gz: c305a84e9b71612b8ec803ab1bce909e83721127fd2bce3caddea3daa7a5a2bb964c7821e8098def80b9323a50d2a72f9e80cc8ace0a9975bc9c18bdea58b315
+  metadata.gz: f8e3054ab427c0635aa27f78ae966e3a90c9f78ec660651d6025956ddc83582a1b46f66268e7a335d8ff72ed87bf92a09672a38509067d42d3b79253a97e8d49
+  data.tar.gz: 4698ae94c57a2de408ba085029f18b1bc100375972f3f253294dfcef71741d959da1db6773544f4bf55133d5a95d3e2eee44f274f167c503e7f462489e247153

data/lib/factories/expression_factory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../type_expression'
+require_relative '../value_expression'
+
+module LowType
+  class ExpressionFactory
+    class << self
+      def type_expression_with_value(type:)
+        TypeExpression.new(default_value: ValueExpression.new(value: type))
+      end
+    end
+  end
+end

data/lib/factories/proxy_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../proxies/return_proxy'
-require_relative '../file_parser'
+require_relative '../queries/file_parser'
 require_relative '../type_expression'
 
 module LowType

data/lib/instance_types.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'proxies/return_proxy'
+require_relative 'queries/type_query'
 require_relative 'type_expression'
 
 module LowType
@@ -50,7 +51,7 @@ module LowType
     def type_expression(expression)
       if expression.instance_of?(TypeExpression)
         expression
-      elsif ::LowType.type?(expression)
+      elsif ::LowType::TypeQuery.type?(expression)
         TypeExpression.new(type: expression)
       end
     end

data/lib/interfaces/error_interface.rb

@@ -4,6 +4,23 @@ 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 output(value:)
+      case @output_mode
+      when :type
+        value.class
+      when :value
+        value.inspect[0...@output_size]
+      else
+        'REDACTED'
+      end
+    end
+
     def error_type
       raise NotImplementedError
     end

data/lib/local_types.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'factories/expression_factory'
 require_relative 'proxies/file_proxy'
 require_relative 'proxies/local_proxy'
 require_relative 'types/error_types'
-require_relative 'type_expression'
-require_relative 'value_expression'
 
 module LowType
   module LocalTypes
@@ -26,7 +25,7 @@ module LowType
     alias low_type type
 
     def value(type)
-      LowType.value(type:)
+      ExpressionFactory.type_expression_with_value(type:)
     end
     alias low_value value
   end

data/lib/low_type.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'adapters/adapter_loader'
+require_relative 'syntax/syntax'
 require_relative 'types/complex_types'
+require_relative 'queries/file_parser'
+require_relative 'queries/file_query'
 require_relative 'instance_types'
 require_relative 'local_types'
 require_relative 'redefiner'
-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.
@@ -20,14 +20,14 @@ module LowType
       end
     end
 
-    file_path = LowType.file_path
+    file_path = FileQuery.file_path(klass:)
     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:, line_numbers:, file_path:)
-    klass.singleton_class.prepend LowType::Redefiner.redefine(method_nodes: parser.class_methods, klass:, line_numbers:, file_path:)
+    klass.prepend Redefiner.redefine(method_nodes: parser.instance_methods, klass:, line_numbers:, file_path:)
+    klass.singleton_class.prepend Redefiner.redefine(method_nodes: parser.class_methods, klass:, line_numbers:, file_path:)
 
     if (adapter = Adapter::Loader.load(klass:, parser:, file_path:))
       adapter.process
@@ -36,47 +36,13 @@ module LowType
   end
 
   class << self
-    # Public API.
-
     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
       yield(config)
     end
-
-    # Internal API.
-
-    def file_path
-      includer_file = caller.find { |callee| callee.end_with?("include'") }
-      includer_file.split(':').first
-    end
-
-    # TODO: Unit test.
-    def type?(type)
-      LowType.basic_type?(type:) || LowType.complex_type?(type:)
-    end
-
-    def basic_type?(type:)
-      type.class == Class
-    end
-
-    def complex_type?(type:)
-      !basic_type?(type:) && LowType.typed_hash?(type:)
-    end
-
-    def typed_hash?(type:)
-      type.is_a?(::Hash) && LowType.basic_type?(type: type.keys.first) && LowType.basic_type?(type: type.values.first)
-    end
-
-    def value?(expression)
-      !expression.respond_to?(:new) && expression != Integer
-    end
-
-    def value(type:)
-      TypeExpression.new(default_value: ValueExpression.new(value: type))
-    end
   end
 end

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/{file_parser.rb → 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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module LowType
+  class FileQuery
+    class << self
+      def file_path(klass:)
+        includer_line = line_from_class(klass:) || line_from_include || ''
+        includer_line.split(':').first || ''
+      end
+
+      private
+
+      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_from_include
+        caller.find { |callee| callee.end_with?("include'") }
+      end
+    end
+  end
+end

data/lib/queries/type_query.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LowType
+  # TODO: Unit test.
+  class TypeQuery
+    class << self
+      def type?(type)
+        basic_type?(type:) || complex_type?(type:)
+      end
+
+      def basic_type?(type:)
+        type.instance_of?(Class)
+      end
+
+      def complex_type?(type:)
+        !basic_type?(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)
+      end
+
+      def value?(expression)
+        !expression.respond_to?(:new) && expression != Integer
+      end
+    end
+  end
+end

data/lib/redefiner.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'factories/expression_factory'
 require_relative 'factories/proxy_factory'
 require_relative 'proxies/file_proxy'
 require_relative 'proxies/method_proxy'
 require_relative 'proxies/param_proxy'
+require_relative 'queries/type_query'
 require_relative 'syntax/syntax'
 require_relative 'type_expression'
+require_relative 'value_expression'
 
 module LowType
   # Redefine methods to have their arguments and return values type checked.
@@ -42,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
 
@@ -96,7 +97,7 @@ module LowType
 
               if expression.is_a?(TypeExpression)
                 param_proxies << ParamProxy.new(type_expression: expression, name:, type:, position:, file:)
-              elsif ::LowType.type?(expression)
+              elsif ::LowType::TypeQuery.type?(expression)
                 param_proxies << ParamProxy.new(type_expression: TypeExpression.new(type: expression), name:, type:, position:, file:)
               end
             end
@@ -139,7 +140,7 @@ module LowType
 
       # Value expressions are eval()'d in the context of this module class (the instance doesn't exist yet) so alias API.
       def value(type)
-        LowType.value(type:)
+        ExpressionFactory.type_expression_with_value(type:)
       end
     end
   end

data/lib/syntax/syntax.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
+require_relative '../queries/type_query'
+
 module LowType
   module Syntax
     refine Array.singleton_class do
       def [](*types)
-        return LowType::TypeExpression.new(type: [*types]) if types.all? { |type| LowType.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.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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'proxies/param_proxy'
+require_relative 'queries/type_query'
 
 module LowType
   root_path = File.expand_path(__dir__)
@@ -24,7 +25,7 @@ module LowType
       if expression.instance_of?(::LowType::TypeExpression)
         @types += expression.types
         @default_value = expression.default_value
-      elsif ::LowType.value?(expression)
+      elsif ::LowType::TypeQuery.value?(expression)
         @default_value = expression
       else
         @types << expression
@@ -45,7 +46,7 @@ module LowType
 
       @types.each do |type|
         # Example: HTML is a subclass of String and should pass as a String.
-        return true if LowType.basic_type?(type:) && type <= value.class
+        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:)
       end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_type
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - maedi
@@ -19,8 +19,8 @@ extra_rdoc_files: []
 files:
 - lib/adapters/adapter_loader.rb
 - lib/adapters/sinatra_adapter.rb
+- lib/factories/expression_factory.rb
 - lib/factories/proxy_factory.rb
-- lib/file_parser.rb
 - lib/instance_types.rb
 - lib/interfaces/adapter_interface.rb
 - lib/interfaces/error_interface.rb
@@ -31,6 +31,9 @@ files:
 - lib/proxies/method_proxy.rb
 - lib/proxies/param_proxy.rb
 - lib/proxies/return_proxy.rb
+- lib/queries/file_parser.rb
+- lib/queries/file_query.rb
+- lib/queries/type_query.rb
 - lib/redefiner.rb
 - lib/syntax/syntax.rb
 - lib/syntax/union_types.rb