steep 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93086efe3704ac8b59a1450fda301b7ab91f409c13c53a679a2ed3b3419ca84
-  data.tar.gz: b00e2030a9ea2171b6f967c78f469204c903cb937d421e5dcab896021fce2919
+  metadata.gz: 0ec77465913e4b2146e068c58f63b7ae8b5c51fd2391f6eb2776dba8372a81c2
+  data.tar.gz: 7528dbaf4873d9eb77728521837ecb0fe43a2010036572be2c3dc017c5b903cc
 SHA512:
-  metadata.gz: 06023d31b509f58efdea8c8f0e13c49b38f3a4936debbe3a0d88bfd84b356e7a761506a8f105c035bd454a4b2f39ae6af13d16b84d29e6d0050d9d58d7062e82
-  data.tar.gz: '0601459d31ad8ca758c95c29215eb237b5bc50490b5133e574057ec1836396d9189c3dd22628244c1d8d432e0f945a746c280ae96ca20b768c063fbae0c696af'
+  metadata.gz: b0426373f8fb9e48ccec48d0676d70d5a674a389a83624df78dc3deacaba23840b02cc94becba92304de35f98c8d8bb3af12ef185161e4e6a6c37600cb61a82d
+  data.tar.gz: 5f3a32240541f116b6299c354fada0c8de398b6139b9d5e275e7b05490ccc401aa1b4f70978af5561e2ce9c6c7bb2587c1c8e43801276c0875000496ed332a5b

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## master
 
+## 0.34.0 (2020-10-27)
+
+* Add `steep stats` command to show method call typing stats ([#246](https://github.com/soutaro/steep/pull/246))
+* Fix attribute assignment typing ([#243](https://github.com/soutaro/steep/pull/243))
+* Let `Range[T]` be covariant ([#242](https://github.com/soutaro/steep/pull/242))
+* Fix constant typing ([#247](https://github.com/soutaro/steep/pull/247), [#248](https://github.com/soutaro/steep/pull/248))
+
 ## 0.33.0 (2020-10-13)
 
 * Make `!` typing flow sensitive ([#240](https://github.com/soutaro/steep/pull/240))

data/lib/steep.rb

@@ -16,6 +16,7 @@ require 'uri'
 
 require "rbs"
 
+require "steep/method_name"
 require "steep/ast/types/helper"
 require "steep/ast/types/any"
 require "steep/ast/types/instance"
@@ -70,6 +71,7 @@ require "steep/type_inference/type_env"
 require "steep/type_inference/local_variable_type_env"
 require "steep/type_inference/logic"
 require "steep/type_inference/logic_type_interpreter"
+require "steep/type_inference/method_call"
 require "steep/ast/types"
 
 require "steep/server/utils"
@@ -91,6 +93,7 @@ require "steep/project/hover_content"
 require "steep/project/completion_provider"
 require "steep/drivers/utils/driver_helper"
 require "steep/drivers/check"
+require "steep/drivers/stats"
 require "steep/drivers/validate"
 require "steep/drivers/annotations"
 require "steep/drivers/watch"

data/lib/steep/annotation_parser.rb

@@ -68,7 +68,7 @@ module Steep
           name = match[:name]
           type = match[:type]
 
-          method_type = factory.method_type(RBS::Parser.parse_method_type(type), self_type: AST::Types::Self.new)
+          method_type = factory.method_type(RBS::Parser.parse_method_type(type), self_type: AST::Types::Self.new, method_decls: Set[])
 
           AST::Annotation::MethodType.new(name: name.to_sym,
                                           type: method_type,

data/lib/steep/ast/types/factory.rb

@@ -149,6 +149,8 @@ module Steep
               type: function_1(type.params, type.return_type),
               location: nil
             )
+          when Logic::Base
+            RBS::Types::Bases::Bool.new(location: nil)
           else
             raise "Unexpected type given: #{type} (#{type.class})"
           end
@@ -178,7 +180,7 @@ module Steep
           )
         end
 
-        def method_type(method_type, self_type:, subst2: nil, method_def: nil)
+        def method_type(method_type, self_type:, subst2: nil, method_decls:)
           fvs = self_type.free_variables()
 
           type_params = []
@@ -209,8 +211,7 @@ module Steep
                                return_type: type(block.type.return_type).subst(subst), location: nil)
               )
             end,
-            method_def: method_def,
-            location: method_def&.member&.location
+            method_decls: method_decls
           )
 
           if block_given?
@@ -344,46 +345,44 @@ module Steep
 
         NilClassName = TypeName("::NilClass")
 
-        def setup_primitives(method_name, method_type)
-          if method_def = method_type.method_def
-            defined_in = method_def.defined_in
-            member = method_def.member
-
-            if member.is_a?(RBS::AST::Members::MethodDefinition)
-              case method_name
-              when :is_a?, :kind_of?, :instance_of?
-                if defined_in == RBS::BuiltinNames::Object.name && member.instance?
-                  return method_type.with(
-                    return_type: AST::Types::Logic::ReceiverIsArg.new(location: method_type.return_type.location)
-                  )
-                end
+        def setup_primitives(method_name, method_def, method_type)
+          defined_in = method_def.defined_in
+          member = method_def.member
 
-              when :nil?
-                case defined_in
-                when RBS::BuiltinNames::Object.name,
-                  NilClassName
-                  return method_type.with(
-                    return_type: AST::Types::Logic::ReceiverIsNil.new(location: method_type.return_type.location)
-                  )
-                end
+          if member.is_a?(RBS::AST::Members::MethodDefinition)
+            case method_name
+            when :is_a?, :kind_of?, :instance_of?
+              if defined_in == RBS::BuiltinNames::Object.name && member.instance?
+                return method_type.with(
+                  return_type: AST::Types::Logic::ReceiverIsArg.new(location: method_type.return_type.location)
+                )
+              end
 
-              when :!
-                case defined_in
-                when RBS::BuiltinNames::BasicObject.name,
-                  RBS::BuiltinNames::TrueClass.name,
-                  RBS::BuiltinNames::FalseClass.name
-                  return method_type.with(
-                    return_type: AST::Types::Logic::Not.new(location: method_type.return_type.location)
-                  )
-                end
+            when :nil?
+              case defined_in
+              when RBS::BuiltinNames::Object.name,
+                NilClassName
+                return method_type.with(
+                  return_type: AST::Types::Logic::ReceiverIsNil.new(location: method_type.return_type.location)
+                )
+              end
 
-              when :===
-                case defined_in
-                when RBS::BuiltinNames::Module.name
-                  return method_type.with(
-                    return_type: AST::Types::Logic::ArgIsReceiver.new(location: method_type.return_type.location)
-                  )
-                end
+            when :!
+              case defined_in
+              when RBS::BuiltinNames::BasicObject.name,
+                RBS::BuiltinNames::TrueClass.name,
+                RBS::BuiltinNames::FalseClass.name
+                return method_type.with(
+                  return_type: AST::Types::Logic::Not.new(location: method_type.return_type.location)
+                )
+              end
+
+            when :===
+              case defined_in
+              when RBS::BuiltinNames::Module.name
+                return method_type.with(
+                  return_type: AST::Types::Logic::ArgIsReceiver.new(location: method_type.return_type.location)
+                )
               end
             end
           end
@@ -433,10 +432,13 @@ module Steep
 
                   interface.methods[name] = Interface::Interface::Entry.new(
                     method_types: method.defs.map do |type_def|
+                      method_name = InstanceMethodName.new(type_name: type_def.implemented_in || type_def.defined_in, method_name: name)
+                      decl = TypeInference::MethodCall::MethodDecl.new(method_name: method_name, method_def: type_def)
                       setup_primitives(
                         name,
+                        type_def,
                         method_type(type_def.type,
-                                    method_def: type_def,
+                                    method_decls: Set[decl],
                                     self_type: self_type,
                                     subst2: subst)
                       )
@@ -460,7 +462,11 @@ module Steep
               definition.methods.each do |name, method|
                 interface.methods[name] = Interface::Interface::Entry.new(
                   method_types: method.defs.map do |type_def|
-                    method_type(type_def.type, method_def: type_def, self_type: self_type, subst2: subst)
+                    decls = Set[TypeInference::MethodCall::MethodDecl.new(
+                      method_name: InstanceMethodName.new(type_name: type_def.implemented_in || type_def.defined_in, method_name: name),
+                      method_def: type_def
+                    )]
+                    method_type(type_def.type, method_decls: decls, self_type: self_type, subst2: subst)
                   end
                 )
               end
@@ -485,10 +491,16 @@ module Steep
 
                 interface.methods[name] = Interface::Interface::Entry.new(
                   method_types: method.defs.map do |type_def|
+                    decl = TypeInference::MethodCall::MethodDecl.new(
+                      method_name: SingletonMethodName.new(type_name: type_def.implemented_in || type_def.defined_in,
+                                                           method_name: name),
+                      method_def: type_def
+                    )
                     setup_primitives(
                       name,
+                      type_def,
                       method_type(type_def.type,
-                                  method_def: type_def,
+                                  method_decls: Set[decl],
                                   self_type: self_type,
                                   subst2: subst)
                     )
@@ -568,8 +580,7 @@ module Steep
                                                       rest_keywords: nil),
                         block: nil,
                         return_type: elem_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     } + aref.method_types
                   )
@@ -588,8 +599,7 @@ module Steep
                                                       rest_keywords: nil),
                         block: nil,
                         return_type: elem_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     } + update.method_types
                   )
@@ -603,8 +613,7 @@ module Steep
                         params: Interface::Params.empty,
                         block: nil,
                         return_type: type.types[0] || AST::Builtin.nil_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     ]
                   )
@@ -618,8 +627,7 @@ module Steep
                         params: Interface::Params.empty,
                         block: nil,
                         return_type: type.types.last || AST::Builtin.nil_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     ]
                   )
@@ -640,6 +648,7 @@ module Steep
                   Interface::Interface::Entry.new(
                     method_types: type.elements.map {|key_value, value_type|
                       key_type = Literal.new(value: key_value, location: nil)
+
                       Interface::MethodType.new(
                         type_params: [],
                         params: Interface::Params.new(required: [key_type],
@@ -650,8 +659,7 @@ module Steep
                                                       rest_keywords: nil),
                         block: nil,
                         return_type: value_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     } + ref.method_types
                   )
@@ -671,8 +679,7 @@ module Steep
                                                       rest_keywords: nil),
                         block: nil,
                         return_type: value_type,
-                        method_def: nil,
-                        location: nil
+                        method_decls: Set[]
                       )
                     } + update.method_types
                   )
@@ -687,8 +694,7 @@ module Steep
                 params: type.params,
                 return_type: type.return_type,
                 block: nil,
-                method_def: nil,
-                location: nil
+                method_decls: Set[]
               )
 
               interface.methods[:[]] = Interface::Interface::Entry.new(method_types: [method_type])

data/lib/steep/cli.rb

@@ -16,7 +16,7 @@ module Steep
     end
 
     def self.available_commands
-      [:init, :check, :validate, :annotations, :version, :project, :watch, :langserver, :vendor]
+      [:init, :check, :validate, :annotations, :version, :project, :watch, :langserver, :vendor, :stats]
     end
 
     def process_global_options
@@ -91,6 +91,19 @@ module Steep
       end.run
     end
 
+    def process_stats
+      Drivers::Stats.new(stdout: stdout, stderr: stderr).tap do |check|
+        OptionParser.new do |opts|
+          opts.banner = "Usage: steep stats [options] [sources]"
+
+          opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
+          handle_logging_options opts
+        end.parse!(argv)
+
+        check.command_line_patterns.push *argv
+      end.run
+    end
+
     def process_validate
       Drivers::Validate.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|

data/lib/steep/drivers/stats.rb

@@ -0,0 +1,85 @@
+require "csv"
+
+module Steep
+  module Drivers
+    class Stats
+      attr_reader :stdout
+      attr_reader :stderr
+      attr_reader :command_line_patterns
+
+      include Utils::DriverHelper
+
+      def initialize(stdout:, stderr:)
+        @stdout = stdout
+        @stderr = stderr
+        @command_line_patterns = []
+      end
+
+      def run
+        project = load_config()
+
+        loader = Project::FileLoader.new(project: project)
+        loader.load_sources(command_line_patterns)
+        loader.load_signatures()
+
+        type_check(project)
+
+        stdout.puts(
+          CSV.generate do |csv|
+            csv << ["Target", "File", "Status", "Typed calls", "Untyped calls", "All calls", "Typed %"]
+
+            project.targets.each do |target|
+              case (status = target.status)
+              when Project::Target::TypeCheckStatus
+                status.type_check_sources.each do |source_file|
+                  case source_file.status
+                  when Project::SourceFile::TypeCheckStatus
+                    typing = source_file.status.typing
+
+                    typed = 0
+                    untyped = 0
+                    total = 0
+                    typing.method_calls.each_value do |call|
+                      case call
+                      when TypeInference::MethodCall::Typed
+                        typed += 1
+                      when TypeInference::MethodCall::Untyped
+                        untyped += 1
+                      end
+
+                      total += 1
+                    end
+
+                    csv << format_stats(target, source_file.path, "success", typed, untyped, total)
+                  when Project::SourceFile::TypeCheckErrorStatus
+                    csv << format_stats(target, source_file.path, "error", 0, 0, 0)
+                  else
+                    csv << format_stats(target, source_file.path, "unknown (#{source_file.status.class.to_s.split(/::/).last})", 0, 0, 0)
+                  end
+                end
+              end
+            end
+          end
+        )
+
+        0
+      end
+
+      def format_stats(target, path, status, typed, untyped, total)
+        [
+          target.name,
+          path.to_s,
+          status,
+          typed,
+          untyped,
+          total,
+          if total.nonzero?
+            format("%.2f", (typed.to_f/total)*100)
+          else
+            0
+          end
+        ]
+      end
+    end
+  end
+end

data/lib/steep/errors.rb

@@ -101,20 +101,6 @@ module Steep
       end
     end
 
-    class IncompatibleBlockParameters < Base
-      attr_reader :node
-      attr_reader :method_type
-
-      def initialize(node:, method_type:)
-        super(node: node)
-        @method_type = method_type
-      end
-
-      def to_s
-        "#{location_to_str}: IncompatibleBlockParameters: method_type=#{method_type}"
-      end
-    end
-
     class BlockParameterTypeMismatch < Base
       attr_reader :expected
       attr_reader :actual
@@ -186,7 +172,7 @@ module Steep
       end
 
       def to_s
-        "#{location_to_str}: RequiredBlockMissing: method_type=#{method_type.location&.source}"
+        "#{location_to_str}: RequiredBlockMissing: method_type=#{method_type.to_s}"
       end
     end
 
@@ -557,5 +543,23 @@ module Steep
         "#{location_to_str}: UnsupportedSyntax: #{msg}"
       end
     end
+
+    class UnexpectedError < Base
+      attr_reader :message
+      attr_reader :error
+
+      def initialize(node:, error:)
+        super(node: node)
+        @error = error
+        @message = error.message
+      end
+
+      def to_s
+        <<-MESSAGE
+#{location_to_str}: UnexpectedError: #{error.class}
+>> #{message}
+        MESSAGE
+      end
+    end
   end
 end