steep 1.3.0 → 1.4.0.dev.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f878620b37610ff6bb38ba9f71c8275ebebf1a119969acca92dae226e9e82371
-  data.tar.gz: e5cfe0950b4cfe16d3ac2aeb0992601b5a0b43315736b637cae05792b0774bb9
+  metadata.gz: 14e9c57b89791ad6d989bddd6439f1ce792ceccf8e17034a1f2ab56c85f2ca41
+  data.tar.gz: dfbe3445dcc72a84a2d4d4e608eb5d74e9da4e1cef03f4979a44e377bf65a917
 SHA512:
-  metadata.gz: c81207ff4dd7893ccc4680b4d6bc1c74b36a59badbfac8c08f02f7ecb6e17f887bc440f40c2dcfe840f219df003c384d0365f54b55340c2ddce771492945b232
-  data.tar.gz: bca9c65b22080f4d8e4f8cf162146a7868f520f4f13e34c22e79a95e5ba81f186b914f422afb89918c6d095d896badcd07832a731d8dd0cd152a908a6f7a71ad
+  metadata.gz: c14673012d5db258399c4f5d7bda6e3fb6aaca0dbc5c241efca52f8c4e947a5a4fd1a60a42ce6a45e87642926b6e44f65d6058bb241581e5a143251a158f383f
+  data.tar.gz: '0889651d16f198063b243aef34cb300325fb04dcbb7165f0d8c972d7f0f2076d86af77393c8c3f0f216d1a42f6fa8bd2c4cbf78d3e0c106d8c7f883d96099839'

data/.github/workflows/ruby-windows.yml

@@ -14,6 +14,7 @@ jobs:
         - "2.7"
         - "3.0"
         - "3.1"
+        - "3.2"
         task:
         - test
         # - test:output  Ignored because the order of diagnostics changes somehow

data/.github/workflows/ruby.yml

@@ -11,10 +11,10 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - "2.6"
         - "2.7"
         - "3.0"
         - "3.1"
+        - "3.2"
         - "master-nightly-focal"
         task:
         - test
@@ -25,10 +25,6 @@ jobs:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v3
-    - name: Reset bundler
-      run: |
-        rm Gemfile.lock Gemfile.steep.lock
-      if: contains(matrix.container_tag, '2.6')
     - name: Run test
       run: |
         git config --global --add safe.directory /__w/steep/steep

data/Gemfile

@@ -3,8 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in steep.gemspec
 gemspec
 
+gem "rbs", "~> 3.0.0"
+
 gem "rake"
-gem "minitest", "~> 5.16"
+gem "minitest", "~> 5.17"
 gem "minitest-hooks"
 group :stackprof, optional: true do
   gem "stackprof"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (1.3.0)
+    steep (1.4.0.dev.2)
       activesupport (>= 5.1)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
@@ -11,6 +11,7 @@ PATH
       logger (>= 1.3.0)
       parallel (>= 1.0.0)
       parser (>= 3.1)
+      pathname (>= 0.2.1)
       rainbow (>= 2.2.2, < 4.0)
       rbs (>= 2.8.0)
       securerandom (>= 0.1)
@@ -20,61 +21,63 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    csv (3.2.5)
+    concurrent-ruby (1.2.2)
+    csv (3.2.6)
     debase (0.2.5.beta2)
       debase-ruby_core_source (>= 0.10.12)
-    debase-ruby_core_source (0.10.16)
+    debase-ruby_core_source (3.2.0)
     ffi (1.15.5)
-    fileutils (1.6.0)
+    fileutils (1.7.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    language_server-protocol (3.17.0.1)
-    listen (3.7.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.5.1)
-    minitest (5.16.3)
+    logger (1.5.3)
+    minitest (5.17.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
       minitest (>= 5.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
+    pathname (0.2.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.8.0)
+    rbs (3.0.1)
     ruby-debug-ide (0.7.3)
       rake (>= 0.8.1)
-    securerandom (0.2.0)
-    stackprof (0.2.22)
-    strscan (3.0.4)
+    securerandom (0.2.2)
+    stackprof (0.2.23)
+    strscan (3.0.6)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   debase (>= 0.2.5.beta2)
-  minitest (~> 5.16)
+  minitest (~> 5.17)
   minitest-hooks
   minitest-slow_test
   rake
+  rbs (~> 3.0.0)
   ruby-debug-ide
   stackprof
   steep!

data/Gemfile.steep

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
-gem 'steep', '~> 1.3.0.pre'
+gem 'steep', '~> 1.4.0.dev'
+gem "rbs", "~> 3.0.0.dev"

data/Gemfile.steep.lock

@@ -8,28 +8,29 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
-    csv (3.2.5)
+    csv (3.2.6)
     ffi (1.15.5)
-    fileutils (1.6.0)
+    fileutils (1.7.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    language_server-protocol (3.17.0.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.5.1)
-    minitest (5.16.3)
+    logger (1.5.3)
+    minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
+    pathname (0.2.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.8.0)
-    securerandom (0.2.0)
-    steep (1.3.0.pre.2)
+    rbs (3.0.0.dev.1)
+    securerandom (0.2.2)
+    steep (1.4.0.dev.1)
       activesupport (>= 5.1)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
@@ -39,23 +40,26 @@ GEM
       logger (>= 1.3.0)
       parallel (>= 1.0.0)
       parser (>= 3.1)
+      pathname (>= 0.2.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.8.0.pre)
+      rbs (>= 2.8.0)
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
-    strscan (3.0.4)
+    strscan (3.0.5)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
-  steep (~> 1.3.0.pre)
+  rbs (~> 3.0.0.dev)
+  steep (~> 1.4.0.dev)
 
 BUNDLED WITH
    2.3.15

data/Steepfile

@@ -10,7 +10,23 @@ target :app do
     hash[D::Ruby::MethodDefinitionMissing] = :hint
   end
 
+  FileUtils.mkpath("tmp")
+  tmp_rbs_dir = File.join("tmp", "rbs-sig")
+
+  definition = Bundler::Definition.build(Pathname("Gemfile"), Pathname("Gemfile.lock"), nil)
+  rbs_dep = definition.dependencies.find {|dep| dep.name == "rbs" }
+  if (source = rbs_dep.source).is_a?(Bundler::Source::Path)
+    unless Pathname(tmp_rbs_dir).exist?
+      FileUtils.ln_s(Pathname.pwd + source.path + "sig", tmp_rbs_dir, force: true)
+    end
+    signature tmp_rbs_dir
+  else
+    FileUtils.rm_f(tmp_rbs_dir)
+    library "rbs"
+  end
+
   library(
+    "rdoc",
     "set",
     "pathname",
     "monitor",

data/bin/rbs

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=$(readlink -f ${BINSTUB_DIR}/../Gemfile.steep)
+COLLECTION=$(readlink -f ${BINSTUB_DIR}/../rbs_collection.steep.yaml)
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/..)
+
+RBS="bundle exec --gemfile=${GEMFILE} rbs --collection=${COLLECTION}"
+
+if type "rbenv" > /dev/null 2>&1; then
+  RBS="rbenv exec ${RBS}"
+else
+  if type "rvm" > /dev/null 2>&1; then
+    if [ -e ${ROOT_DIR}/.ruby-version ]; then
+      RBS="rvm ${ROOT_DIR} do ${RBS}"
+    fi
+  fi
+fi
+
+exec $RBS $@
+

data/bin/setup

@@ -6,4 +6,4 @@ set -vx
 bundle install
 
 bundle install --gemfile=Gemfile.steep
-bundle exec --gemfile=Gemfile.steep rbs --collection=rbs_collection.steep.yaml collection install
+bin/rbs collection install

data/lib/steep/annotation_parser.rb

@@ -20,16 +20,19 @@ module Steep
       attr_reader :source
       attr_reader :location
 
-      def initialize(source:, location:, exn: nil)
+      def initialize(source:, location:, exn: nil, message: nil)
         @source = source
         @location = location
 
-        message = case exn
-                  when RBS::ParsingError
-                    Diagnostic::Signature::SyntaxError.parser_syntax_error_message(exn)
-                  when Exception
-                    exn.message
-                  end
+        if exn
+          message =
+            case exn
+            when RBS::ParsingError
+              Diagnostic::Signature::SyntaxError.parser_syntax_error_message(exn)
+            else
+              exn.message
+            end
+        end
 
         super message
       end
@@ -41,8 +44,25 @@ module Steep
     PARAM = /[A-Z][A-Za-z0-9_]*/
     TYPE_PARAMS = /(\[(?<params>#{PARAM}(,\s*#{PARAM})*)\])?/
 
-    def parse_type(string)
-      factory.type(RBS::Parser.parse_type(string))
+    def parse_type(match, name = :type, location:)
+      string = match[name] or raise
+      st, en = match.offset(name)
+      st or raise
+      en or raise
+      loc = RBS::Location.new(location.buffer, location.start_pos + st, location.start_pos + en)
+
+      type =
+        begin
+          RBS::Parser.parse_type(string)
+        rescue RBS::ParsingError => exn
+          raise SyntaxError.new(source: string, location: loc, exn: exn)
+        end or raise
+
+      unless (type.location || raise).source == string.strip
+        raise SyntaxError.new(source: string, location: loc, message: "Failed to parse a type in annotation")
+      end
+
+      factory.type(type)
     end
 
     def keyword_subject_type(keyword, name)
@@ -59,10 +79,9 @@ module Steep
         Regexp.last_match.yield_self do |match|
           match or raise
           name = match[:name] or raise
-          type = match[:type] or raise
 
           AST::Annotation::VarType.new(name: name.to_sym,
-                                       type: parse_type(type),
+                                       type: parse_type(match, location: location),
                                        location: location)
         end
 
@@ -72,7 +91,7 @@ module Steep
           name = match[:name] or raise
           type = match[:type] or raise
 
-          method_type = factory.method_type(RBS::Parser.parse_method_type(type), method_decls: Set[])
+          method_type = factory.method_type(RBS::Parser.parse_method_type(type) || raise, method_decls: Set[])
 
           AST::Annotation::MethodType.new(name: name.to_sym,
                                           type: method_type,
@@ -83,7 +102,7 @@ module Steep
         Regexp.last_match.yield_self do |match|
           match or raise
           name = match[:name] or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
 
           AST::Annotation::ConstType.new(name: TypeName(name), type: type, location: location)
         end
@@ -92,7 +111,7 @@ module Steep
         Regexp.last_match.yield_self do |match|
           match or raise
           name = match[:name] or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
 
           AST::Annotation::IvarType.new(name: name.to_sym,
                                          type: type,
@@ -102,42 +121,43 @@ module Steep
       when keyword_and_type("return")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
           AST::Annotation::ReturnType.new(type: type, location: location)
         end
 
       when keyword_and_type("block")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
           AST::Annotation::BlockType.new(type: type, location: location)
         end
 
       when keyword_and_type("self")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
           AST::Annotation::SelfType.new(type: type, location: location)
         end
 
       when keyword_and_type("instance")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
           AST::Annotation::InstanceType.new(type: type, location: location)
         end
 
       when keyword_and_type("module")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
           AST::Annotation::ModuleType.new(type: type, location: location)
         end
 
       when keyword_and_type("break")
         Regexp.last_match.yield_self do |match|
           match or raise
-          type = parse_type(match[:type] || raise)
+          type = parse_type(match, location: location)
+
           AST::Annotation::BreakType.new(type: type, location: location)
         end
 

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

@@ -370,19 +370,11 @@ module Steep
         end
 
         def module_name?(type_name)
-          if entry = env.class_decls[type_name]
-            entry.is_a?(RBS::Environment::ModuleEntry)
-          else
-            false
-          end
+          env.module_entry(type_name) ? true : false
         end
 
         def class_name?(type_name)
-          if entry = env.class_decls[type_name]
-            entry.is_a?(RBS::Environment::ClassEntry)
-          else
-            false
-          end
+          env.class_entry(type_name) ? true : false
         end
 
         def env
@@ -434,6 +426,60 @@ module Steep
             nil
           end
         end
+
+        def normalize_type(type)
+          case type
+          when AST::Types::Name::Instance
+            AST::Types::Name::Instance.new(
+              name: env.normalize_module_name(type.name),
+              args: type.args.map {|ty| normalize_type(ty) },
+              location: type.location
+            )
+          when AST::Types::Name::Singleton
+            AST::Types::Name::Singleton.new(
+              name: env.normalize_module_name(type.name),
+              location: type.location
+            )
+          when AST::Types::Any, AST::Types::Boolean, AST::Types::Bot, AST::Types::Nil,
+            AST::Types::Top, AST::Types::Void, AST::Types::Literal, AST::Types::Class, AST::Types::Instance,
+            AST::Types::Self, AST::Types::Var, AST::Types::Logic::Base
+            type
+          when AST::Types::Intersection
+            AST::Types::Intersection.build(
+              types: type.types.map {|type| normalize_type(type) },
+              location: type.location
+            )
+          when AST::Types::Union
+            AST::Types::Union.build(
+              types: type.types.map {|type| normalize_type(type) },
+              location: type.location
+            )
+          when AST::Types::Record
+            AST::Types::Record.new(
+              elements: type.elements.transform_values {|type| normalize_type(type) },
+              location: type.location
+            )
+          when AST::Types::Tuple
+            AST::Types::Tuple.new(
+              types: type.types.map {|type| normalize_type(type) },
+              location: type.location
+            )
+          when AST::Types::Proc
+            type.map_type {|type| normalize_type(type) }
+          when AST::Types::Name::Alias
+            AST::Types::Name::Alias.new(
+              name: type.name,
+              args: type.args.map {|ty| normalize_type(ty) },
+              location: type.location
+            )
+          when AST::Types::Name::Interface
+            AST::Types::Name::Interface.new(
+              name: type.name,
+              args: type.args.map {|ty| normalize_type(ty) },
+              location: type.location
+            )
+          end
+        end
       end
     end
   end

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

@@ -20,6 +20,10 @@ module Steep
           def level
             [0]
           end
+
+          def map_type(&block)
+            self
+          end
         end
 
         class Applying < Base
@@ -87,6 +91,12 @@ module Steep
           def level
             [0] + level_of_children(args)
           end
+
+          def map_type(&block)
+            args = self.args.map(&block)
+
+            _ = self.class.new(name: self.name, args: self.args, location: self.location)
+          end
         end
 
         class Singleton < Base

data/lib/steep/diagnostic/ruby.rb

@@ -783,7 +783,7 @@ module Steep
         end
 
         def header_line
-          "Assertion cannot hold: no relationship between infered type (`#{node_type.to_s}`) and asserted type (`#{assertion_type.to_s}`)"
+          "Assertion cannot hold: no relationship between inferred type (`#{node_type.to_s}`) and asserted type (`#{assertion_type.to_s}`)"
         end
       end
 

data/lib/steep/diagnostic/signature.rb

@@ -381,6 +381,42 @@ module Steep
         end
       end
 
+      class InconsistentClassModuleAliasError < Base
+        attr_reader :decl
+
+        def initialize(decl:)
+          @decl = decl
+          super(location: decl.location&.[](:old_name))
+        end
+
+        def header_line
+          expected_kind =
+            case decl
+            when RBS::AST::Declarations::ModuleAlias
+              "module"
+            when RBS::AST::Declarations::ClassAlias
+              "class"
+            else
+              raise
+            end
+
+          "A #{expected_kind} `#{decl.new_name}` cannot be an alias of `#{decl.old_name}`"
+        end
+      end
+
+      class CyclicClassAliasDefinitionError < Base
+        attr_reader :decl
+
+        def initialize(decl:)
+          @decl = decl
+          super(location: decl.location&.[](:new_name))
+        end
+
+        def header_line
+          "#{decl.new_name} is a cyclic definition"
+        end
+      end
+
       def self.from_rbs_error(error, factory:)
         case error
         when RBS::ParsingError
@@ -475,6 +511,10 @@ module Steep
           )
         when RBS::InheritModuleError
           Diagnostic::Signature::InheritModuleError.new(error.super_decl)
+        when RBS::InconsistentClassModuleAliasError
+          Diagnostic::Signature::InconsistentClassModuleAliasError.new(decl: error.alias_entry.decl)
+        when RBS::CyclicClassAliasDefinitionError
+          Diagnostic::Signature::CyclicClassAliasDefinitionError.new(decl: error.alias_entry.decl)
         else
           raise error
         end