rbs 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe2c03d38ca9869e7c7bdf283f56e61e5ccbad3831b524ba14c6fd31941985e2
-  data.tar.gz: d9cc6563f7eb3173410209daeda05a8216d2ade261a3f05d3f258d0782a08e64
+  metadata.gz: db07b9abb1ed59e789d6a13145e33503f20e37a908826c3c8ba8222f9cf79ec6
+  data.tar.gz: a42440c8542489fd70f24139f24e718b106caa99925a437857867141f730ed9a
 SHA512:
-  metadata.gz: fb4391906260a8414e2c2ef44ded8fda974c495830fb6c2335204052cba67260f1f0d0fd44dd560c3c05b7cdcaffa20ee24d7d16a529c37f900689bb084ce198
-  data.tar.gz: 68cb88ea29edbce815a6887b716f20c640b651628b55b9b3e660e6bc93c218081464888632f9df7bc42da49700c253bc74fb9d01970f7bf13a2425742890431e
+  metadata.gz: 606289f49ac2d2934808add204997b7828708b05f2b3d60c10f8de6106cbca06527fd628de445511dfa537976fab551e878a45b5ab03ac41374cf242f90b6244
+  data.tar.gz: 5de0b5b93fd872a69fe25d62eaf72fba3fc4d93b57f04f5da311fc66d3b6eeebe53fb654cea4361da32124861ac21c1ad9547bf9e7c0012b6db704e98164a8d9

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master
 
+## 0.12.0 (2020-09-15)
+
+* Signature updates for `forwardable`, `struct`, `set`, `URI::Generic`, `URI::File`, and `BigDecimal`.
+* Define `.new` methods from `initialize` included from modules [#390](https://github.com/ruby/rbs/pull/390)
+
 ## 0.11.0 (2020-08-31)
 
 * Signature update for `date/datetime` [#367](https://github.com/ruby/rbs/pull/367)

data/Rakefile

@@ -1,5 +1,10 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rbconfig"
+
+ruby = ENV["RUBY"] || RbConfig.ruby
+rbs = File.join(__dir__, "exe/rbs")
+bin = File.join(__dir__, "bin")
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -16,21 +21,21 @@ task :test_doc => :parser do
     `git ls-files -z`.split("\x0").select do |file| Pathname(file).extname == ".md" end
   end
 
-  sh "ruby bin/run_in_md.rb #{files.join(" ")}"
+  sh "#{ruby} #{__dir__}/bin/run_in_md.rb #{files.join(" ")}"
 end
 
 task :validate => :parser do
-  sh "rbs validate"
+  sh "#{ruby} #{rbs} validate"
 
   FileList["stdlib/*"].each do |path|
     next if path =~ %r{stdlib/builtin}
-    sh "rbs -r#{File.basename(path)} validate"
+    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate"
   end
 end
 
 FileList["test/stdlib/**/*_test.rb"].each do |test|
   multitask test => :parser do
-    sh "ruby bin/test_runner.rb #{test}"
+    sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test}"
   end
   multitask stdlib_test: test
 end

data/Steepfile

@@ -0,0 +1,28 @@
+target :lib do
+  signature "sig"
+  check "lib"
+
+  vendor stdlib: "stdlib"
+  library "set", "pathname", "json", "logger"
+end
+
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+# end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

data/bin/steep

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+GEMFILE=$(cd $(dirname $0); pwd)/../steep/Gemfile
+bundle exec --gemfile=${GEMFILE} steep $*

data/bin/test_runner.rb

@@ -1,12 +1,17 @@
 #!/usr/bin/env ruby
 
-RUBY_27 = Gem::Version.new(RUBY_VERSION).yield_self do |ruby_version|
-  Gem::Version.new('2.7.0') <= ruby_version && ruby_version < Gem::Version.new("2.8.0")
+$LOAD_PATH << File.join(__dir__, "../lib")
+
+STDLIB_TEST = Gem::Version.new(RUBY_VERSION).yield_self do |ruby_version|
+  Gem::Version.new('2.7.0') <= ruby_version &&
+    ruby_version <= Gem::Version.new('2.8.0')
 end
 
-unless RUBY_27
-  STDERR.puts "🚨🚨🚨 stdlib test requires Ruby 2.7 but RUBY_VERSION==#{RUBY_VERSION}, exiting... 🚨🚨🚨"
-  exit
+unless STDLIB_TEST
+  unless ENV["FORCE_STDLIB_TEST"]
+    STDERR.puts "🚨🚨🚨 stdlib test requires Ruby 2.7 or later but RUBY_VERSION==#{RUBY_VERSION}, exiting... 🚨🚨🚨"
+    exit
+  end
 end
 
 ARGV.each do |arg|

data/lib/rbs/ast/comment.rb

@@ -25,7 +25,13 @@ module RBS
 
       def concat(string:, location:)  
         @string.concat string
-        @location.concat location
+
+        if loc = @location
+          loc.concat location
+        else
+          @location = location
+        end
+
         self
       end
     end

data/lib/rbs/ast/declarations.rb

@@ -7,7 +7,7 @@ module RBS
       class ModuleTypeParams
         attr_reader :params
 
-        TypeParam = Struct.new(:name, :variance, :skip_validation, keyword_init: true) do
+        TypeParam = _ = Struct.new(:name, :variance, :skip_validation, keyword_init: true) do
           def to_json(*a)
             {
               name: name,
@@ -47,7 +47,11 @@ module RBS
         end
 
         def each(&block)
-          params.each(&block)
+          if block
+            params.each(&block)
+          else
+            params.each
+          end
         end
 
         def self.empty
@@ -55,11 +59,13 @@ module RBS
         end
 
         def variance(name)
-          self[name].variance
+          var = self[name] or raise
+          var.variance
         end
 
         def skip_validation?(name)
-          self[name].skip_validation
+          var = self[name] or raise
+          var.skip_validation
         end
 
         def empty?
@@ -85,7 +91,7 @@ module RBS
           if block_given?
             members.each do |member|
               if member.is_a?(Members::Base)
-                yield member
+                yield(_ = member)
               end
             end
           else
@@ -96,8 +102,8 @@ module RBS
         def each_decl
           if block_given?
             members.each do |member|
-              if member.is_a?(Declarations::Base)
-                yield member
+              if member.is_a?(Base)
+                yield(_ = member)
               end
             end
           else
@@ -108,9 +114,9 @@ module RBS
 
       module MixinHelper
         def each_mixin(&block)
-          if block_given?
+          if block
             @mixins ||= begin
-                          members.select do |member|
+                          _ = members.select do |member|
                             case member
                             when Members::Include, Members::Extend, Members::Prepend
                               true

data/lib/rbs/buffer.rb

@@ -23,7 +23,7 @@ module RBS
 
     def pos_to_loc(pos)
       index = ranges.bsearch_index do |range|
-        pos < range.end
+        pos < range.end ? true : false
       end
 
       if index

data/lib/rbs/definition.rb

@@ -47,9 +47,9 @@ module RBS
         end
 
         def overload?
-          case member
+          case mem = member
           when AST::Members::MethodDefinition
-            member.overload?
+            mem.overload?
           else
             false
           end
@@ -69,11 +69,17 @@ module RBS
       end
 
       def defined_in
-        @defined_in ||= defs.last.defined_in
+        @defined_in ||= begin
+          last_def = defs.last or raise
+          last_def.defined_in
+        end
       end
 
       def implemented_in
-        @implemented_in ||= defs.last.implemented_in
+        @implemented_in ||= begin
+          last_def = defs.last or raise
+          last_def.implemented_in
+        end
       end
 
       def method_types
@@ -81,7 +87,7 @@ module RBS
       end
 
       def comments
-        @comments ||= defs.map(&:comment).compact
+        @comments ||= _ = defs.map(&:comment).compact
       end
 
       def annotations
@@ -126,8 +132,8 @@ module RBS
     end
 
     module Ancestor
-      Instance = Struct.new(:name, :args, keyword_init: true)
-      Singleton = Struct.new(:name, keyword_init: true)
+      Instance = _ = Struct.new(:name, :args, keyword_init: true)
+      Singleton = _ = Struct.new(:name, keyword_init: true)
     end
 
     class InstanceAncestors
@@ -219,7 +225,10 @@ module RBS
     end
 
     def interface?
-      entry.is_a?(Environment::SingleEntry) && entry.decl.is_a?(AST::Declarations::Interface)
+      case en = entry
+      when Environment::SingleEntry
+        en.decl.is_a?(AST::Declarations::Interface)
+      end
     end
 
     def class_type?
@@ -239,16 +248,16 @@ module RBS
     end
 
     def type_params_decl
-      case entry
+      case en = entry
       when Environment::ClassEntry, Environment::ModuleEntry
-        entry.type_params
+        en.type_params
       when Environment::SingleEntry
-        entry.decl.type_params
+        en.decl.type_params
       end
     end
 
     def sub(s)
-      definition = self.class.new(type_name: type_name, self_type: self_type.sub(s), ancestors: ancestors, entry: entry)
+      definition = self.class.new(type_name: type_name, self_type: _ = self_type.sub(s), ancestors: ancestors, entry: entry)
 
       definition.methods.merge!(methods.transform_values {|method| method.sub(s) })
       definition.instance_variables.merge!(instance_variables.transform_values {|v| v.sub(s) })
@@ -268,7 +277,7 @@ module RBS
     end
 
     def each_type(&block)
-      if block_given?
+      if block
         methods.each_value do |method|
           if method.defined_in == type_name
             method.method_types.each do |method_type|

data/lib/rbs/definition_builder.rb

@@ -36,8 +36,11 @@ module RBS
       end
 
       def each_ancestor(&block)
-        if block_given?
-          yield super_class if super_class
+        if block
+          if s = super_class
+            yield s
+          end
+          
           self_types&.each(&block)
           included_modules&.each(&block)
           prepended_modules&.each(&block)
@@ -108,7 +111,7 @@ module RBS
       return if with_super_classes.size <= 1
 
       super_types = with_super_classes.map do |d|
-        super_class = d.decl.super_class
+        super_class = d.decl.super_class or raise
         Types::ClassInstance.new(name: super_class.name, args: super_class.args, location: nil)
       end
 
@@ -159,10 +162,10 @@ module RBS
 
         entry.self_types.each do |module_self|
           NoSelfTypeFoundError.check!(module_self, env: env)
-          ancestors.self_types.push Definition::Ancestor::Instance.new(name: module_self.name, args: module_self.args)
+
+          self_types = ancestors.self_types or raise
+          self_types.push Definition::Ancestor::Instance.new(name: module_self.name, args: module_self.args)
         end
-      else
-        raise "Unexpected entry for: #{type_name}"
       end
 
       mixin_ancestors(entry,
@@ -208,9 +211,6 @@ module RBS
           type_name: type_name,
           super_class: Definition::Ancestor::Instance.new(name: BuiltinNames::Module.name, args: [])
         )
-
-      else
-        raise "Unexpected entry for: #{type_name}"
       end
 
       mixin_ancestors(entry,
@@ -285,33 +285,38 @@ module RBS
 
       case entry
       when Environment::ClassEntry
-        if one_ancestors.super_class
-          super_name = one_ancestors.super_class.name
-          super_args = one_ancestors.super_class.args
+        if super_class = one_ancestors.super_class
+          # @type var super_class: Definition::Ancestor::Instance
+          super_name = super_class.name
+          super_args = super_class.args
 
           super_ancestors = instance_ancestors(super_name, building_ancestors: building_ancestors)
           ancestors.unshift(*super_ancestors.apply(super_args, location: entry.primary.decl.location))
         end
       end
 
-      one_ancestors.included_modules.each do |mod|
-        if mod.name.class?
-          name = mod.name
-          args = mod.args
-          mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
-          ancestors.unshift(*mod_ancestors.apply(args, location: entry.primary.decl.location))
-        end
+      if included_modules = one_ancestors.included_modules
+        included_modules.each do |mod|
+          if mod.name.class?
+            name = mod.name
+            arg_types = mod.args
+            mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
+            ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
+          end
+        end  
       end
 
       ancestors.unshift(self_ancestor)
 
-      one_ancestors.prepended_modules.each do |mod|
-        if mod.name.class?
-          name = mod.name
-          args = mod.args
-          mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
-          ancestors.unshift(*mod_ancestors.apply(args, location: entry.primary.decl.location))
-        end
+      if prepended_modules = one_ancestors.prepended_modules
+        prepended_modules.each do |mod|
+          if mod.name.class?
+            name = mod.name
+            arg_types = mod.args
+            mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
+            ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
+          end
+        end  
       end
 
       building_ancestors.pop
@@ -338,22 +343,23 @@ module RBS
 
       ancestors = []
 
-      case one_ancestors.super_class
+      case super_class = one_ancestors.super_class
       when Definition::Ancestor::Instance
-        super_name = one_ancestors.super_class.name
-        super_args = one_ancestors.super_class.args
+        super_name = super_class.name
+        super_args = super_class.args
 
         super_ancestors = instance_ancestors(super_name, building_ancestors: building_ancestors)
         ancestors.unshift(*super_ancestors.apply(super_args, location: entry.primary.decl.location))
 
       when Definition::Ancestor::Singleton
-        super_name = one_ancestors.super_class.name
+        super_name = super_class.name
 
         super_ancestors = singleton_ancestors(super_name, building_ancestors: [])
         ancestors.unshift(*super_ancestors.ancestors)
       end
 
-      one_ancestors.extended_modules.each do |mod|
+      extended_modules = one_ancestors.extended_modules or raise
+      extended_modules.each do |mod|
         if mod.name.class?
           name = mod.name
           args = mod.args
@@ -406,17 +412,17 @@ module RBS
                                                location: nil)
 
           definition_pairs = ancestors.ancestors.map do |ancestor|
+            # @type block: [Definition::Ancestor::t, Definition]
             case ancestor
             when Definition::Ancestor::Instance
               [ancestor, build_one_instance(ancestor.name)]
             when Definition::Ancestor::Singleton
               [ancestor, build_one_singleton(ancestor.name)]
-            else
-              raise
             end
           end
 
-          if entry.is_a?(Environment::ModuleEntry)
+          case entry
+          when Environment::ModuleEntry
             entry.self_types.each do |module_self|
               ancestor = Definition::Ancestor::Instance.new(name: module_self.name, args: module_self.args)
               definition_pairs.push(
@@ -433,9 +439,6 @@ module RBS
           end
 
           merge_definitions(type_name, definition_pairs, entry: entry, self_type: self_type, ancestors: ancestors)
-
-        else
-          raise
         end
       end
     end
@@ -456,6 +459,7 @@ module RBS
           )
 
           definition_pairs = ancestors.ancestors.map do |ancestor|
+            # @type block: [Definition::Ancestor::t, Definition]
             case ancestor
             when Definition::Ancestor::Instance
               [ancestor, build_one_instance(ancestor.name)]
@@ -474,20 +478,18 @@ module RBS
                 ancestor,
                 definition
               ]
-            else
-              raise
             end
           end
 
           merge_definitions(type_name, definition_pairs, entry: entry, self_type: self_type, ancestors: ancestors)
-        else
-          raise
         end
       end
     end
 
     def method_definition_members(type_name, entry, kind:)
+      # @type var interface_methods: Hash[Symbol, [Definition::Method, AST::Members::t]]
       interface_methods = {}
+      # @type var methods: Hash[Symbol, Array[[AST::Members::MethodDefinition, Definition::accessibility]]]
       methods = {}
 
       entry.decls.each do |d|
@@ -534,11 +536,14 @@ module RBS
         end
       end
 
+      # @type var result: Hash[Symbol, member_detail]
       result = {}
 
       interface_methods.each do |name, pair|
         method_definition, _ = pair
-        result[name] = [:public, method_definition]
+        # @type var detail: member_detail
+        detail = [:public, method_definition, nil, []]
+        result[name] = detail
       end
 
       methods.each do |method_name, array|
@@ -562,12 +567,12 @@ module RBS
             )
           end
 
-          result[method_name] += array.map(&:first)
+          result[method_name][3].push(*array.map(&:first))
         else
           case
           when array.size == 1 && !array[0][0].overload?
             member, visibility = array[0]
-            result[method_name] = [visibility, nil, member]
+            result[method_name] = [visibility, nil, member, []]
 
           else
             visibilities = array.group_by {|pair| pair[1] }
@@ -582,7 +587,7 @@ module RBS
             end
 
             overloads, primary = array.map(&:first).partition(&:overload?)
-            result[method_name] = [array[0][1], nil, *primary, *overloads]
+            result[method_name] = [array[0][1], nil, primary[0], overloads]
           end
         end
       end
@@ -601,7 +606,13 @@ module RBS
 
         Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
           method_definition_members(type_name, entry, kind: :instance).each do |method_name, array|
-            visibility, method_def, *members = array
+            visibility, method_def, primary_member, overload_members = array
+
+            members = if primary_member
+              [primary_member, *overload_members]
+            else
+              overload_members
+            end
 
             m = if method_def
                   Definition::Method.new(
@@ -770,9 +781,9 @@ module RBS
 
       errors = []
 
-      if decl.is_a?(AST::Declarations::Class)
-        if decl.super_class
-          super_class = decl.super_class
+      case decl
+      when AST::Declarations::Class
+        if super_class = decl.super_class
           result = calculator.in_inherit(name: super_class.name, args: super_class.args, variables: param_names)
 
           validate_params_with type_params, result: result do |param|
@@ -783,6 +794,8 @@ module RBS
         end
       end
 
+      # @type var result: VarianceCalculator::Result
+
       decl.members.each do |member|
         case member
         when AST::Members::Include
@@ -830,7 +843,13 @@ module RBS
 
         Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
           method_definition_members(type_name, entry, kind: :singleton).each do |method_name, array|
-            visibility, method_def, *members = array
+            visibility, method_def, primary_member, overload_members = array
+
+            members = if primary_member
+              [primary_member, *overload_members]
+            else
+              overload_members
+            end
 
             m = Definition::Method.new(
               super_method: nil,
@@ -882,7 +901,7 @@ module RBS
           end
 
           unless definition.methods.key?(:new)
-            instance = build_one_instance(type_name)
+            instance = build_instance(type_name)
             initialize = instance.methods[:initialize]
 
             if initialize
@@ -957,7 +976,7 @@ module RBS
 
     def merge_definitions(type_name, pairs, entry:, self_type:, ancestors:)
       Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
-        pairs.reverse_each do |(ancestor, current_definition)|
+        pairs.reverse_each do |ancestor, current_definition|
           sub = case ancestor
                 when Definition::Ancestor::Instance
                   Substitution.build(current_definition.type_params, ancestor.args)
@@ -965,6 +984,7 @@ module RBS
                   Substitution.build([], [])
                 end
 
+          # @type var kind: method_kind
           kind = case ancestor
                  when Definition::Ancestor::Instance
                    :instance
@@ -1015,7 +1035,7 @@ module RBS
     end
 
     def try_cache(type_name, cache:)
-      cached = cache[type_name]
+      cached = _ = cache[type_name]
 
       case cached
       when Definition
@@ -1027,9 +1047,11 @@ module RBS
         begin
           cache[type_name] = yield
         rescue => ex
-          cache[type_name] = nil
+          cache.delete(type_name)
           raise ex
         end
+      else
+        raise
       end
     end
 
@@ -1067,7 +1089,9 @@ module RBS
             mixin = build_interface(member.name)
 
             args = member.args
-            type_params = mixin.entry.decl.type_params
+            # @type var interface_entry: Environment::SingleEntry[TypeName, AST::Declarations::Interface]
+            interface_entry = _ = mixin.entry
+            type_params = interface_entry.decl.type_params
 
             InvalidTypeApplicationError.check!(
               type_name: type_name,