rbs 1.0.0.pre → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd21602800550be064e741db770aa752eaab018ca894238f88d75d1d1e950edd
-  data.tar.gz: 346c39ff339931cf9866e29cd096a0877c620feff86044a2bbb007826276904b
+  metadata.gz: 876e6bbb99faa21b1446731aaa99e9e184952dfff4a74c40278a8e4473ab0153
+  data.tar.gz: dbe783feb6db3cef15000018b0d9120b5761775fa9e635355b75f23783d558c1
 SHA512:
-  metadata.gz: 94651715eeed037f3d899fdae1cc49dc5134f5d3df7da03d06b7ebc7a053d43139adf29680de4a0036446afb16ef824862fae4ad5a6870861ae48bd589799ac6
-  data.tar.gz: ec967eef1ab035d4da2fe66f8a4661523c672eb1bc13f7033ac73ac8593810fd73e52d2d52173f8284abc47273b4442f9a95f4a5325c0e265cdb6a6d6b0321e1
+  metadata.gz: 9bdc0e3cca9cff43bfd69dba8f8635745a5e164c8590c627434075f839fee353173a9f8e829ee5bbcdd3114fe0035fbd5fef54c56d17382135563c3d2e6d8b4b
+  data.tar.gz: ae9c5ca0eae79d4261263235817d031e1541e82e07d70826e6d7cd69fda211cf6fd4c933706b839a39ea221b45ca044cd3381b04ff480df1c3ba06a9ee9c528b

data/CHANGELOG.md

@@ -4,14 +4,18 @@
 
 ## 1.0.0 (Pre released)
 
-* Signature updates for `URI`, `IO`, and `Time` ([#529](https://github.com/ruby/rbs/pull/529), [#521](https://github.com/ruby/rbs/pull/521), [#520](https://github.com/ruby/rbs/pull/520), [#511](https://github.com/ruby/rbs/pull/511), [#517](https://github.com/ruby/rbs/pull/517))
+* Signature updates for `URI`, `IO`, `File`, `Pathname`, `Module`, and `Time` ([#529](https://github.com/ruby/rbs/pull/529), [#521](https://github.com/ruby/rbs/pull/521), [#520](https://github.com/ruby/rbs/pull/520), [#511](https://github.com/ruby/rbs/pull/511), [#517](https://github.com/ruby/rbs/pull/517), [#542](https://github.com/ruby/rbs/pull/542), [#546](https://github.com/ruby/rbs/pull/546), [#540](https://github.com/ruby/rbs/pull/540), [#538](https://github.com/ruby/rbs/pull/538))
 * `rbs prototype runtime` generates `extend`s ([#535](https://github.com/ruby/rbs/pull/535))
 * `rbs prototype runtime` stability improvements ([#533](https://github.com/ruby/rbs/pull/533), [#526](https://github.com/ruby/rbs/pull/526))
-  * Improve runtime type checker compatibility ([#532](https://github.com/ruby/rbs/pull/532), [#528](https://github.com/ruby/rbs/pull/528), )
+* `rbs prototype rb` compatibility improvements ([#545](https://github.com/ruby/rbs/pull/545))
+* Implement method names escape in `RBS::Writer` ([#537](https://github.com/ruby/rbs/pull/537))
+* Improve runtime type checker compatibility ([#532](https://github.com/ruby/rbs/pull/532), [#528](https://github.com/ruby/rbs/pull/528), [#547](https://github.com/ruby/rbs/pull/547))
+* Fix `ruby2_keywords` for `Proc` in Ruby <2.7 ([#513](https://github.com/ruby/rbs/pull/513))
 * Better compatibility for record type attribute names ([#525](https://github.com/ruby/rbs/pull/525), [#524](https://github.com/ruby/rbs/pull/524))
-* Let module-self-types be classes ([#523](https://github.com/ruby/rbs/pull/523))
+* Let module self-types be classes ([#523](https://github.com/ruby/rbs/pull/523))
+* Delete `extension` syntax ([#543](https://github.com/ruby/rbs/pull/543))
 * Method resolution improvements about `alias` and `.new` ([#522](https://github.com/ruby/rbs/pull/522), [#519](https://github.com/ruby/rbs/pull/519), [#516](https://github.com/ruby/rbs/pull/516))
-* Fix `ruby2_keywords` for `Proc` in Ruby <2.7 ([#513](https://github.com/ruby/rbs/pull/513))
+* Better message for `DuplicatedMethodDefinitionError` ([#539](https://github.com/ruby/rbs/pull/539))
 
 ## 0.20.1 (2020-12-06)
 

data/Rakefile

@@ -45,6 +45,14 @@ task :validate => :parser do
       lib << "monitor"
     end
 
+    if lib == ["csv"]
+      lib << "forwardable"
+    end
+
+    if lib == ["prime"]
+      lib << "singleton"
+    end
+
     sh "#{ruby} #{rbs} #{lib.map {|l| "-r #{l}"}.join(" ")} validate --silent"
   end
 end

data/Steepfile

@@ -2,8 +2,9 @@ target :lib do
   signature "sig"
   check "lib"
   ignore "lib/rbs/parser.rb"
+  ignore "lib/rbs/prototype", "lib/rbs/test", "lib/rbs/test.rb"
 
-  library "set", "pathname", "json", "logger"
+  library "set", "pathname", "json", "logger", "monitor", "tsort"
 end
 
 # target :lib do

data/bin/annotate-with-rdoc

@@ -140,10 +140,6 @@ ARGV.map {|f| Pathname(f) }.each do |path|
       comment = comment_for_class(decl, stores: stores)
       decl.instance_variable_set(:@comment, comment)
 
-      print_members stores, decl.name.to_s, decl.members
-    when RBS::AST::Declarations::Extension
-      puts "  Importing documentation for #{decl.name} (#{decl.extension_name})"
-
       print_members stores, decl.name.to_s, decl.members
     end
   end

data/core/file.rbs

@@ -531,6 +531,9 @@ class File < IO
   #
   def self.mtime: (string | _ToPath | IO file_name) -> Time
 
+  # Alias of `File.new`.
+  def self.open: (string | _ToPath | int file_name, ?(string | int) mode, ?int perm) -> instance
+
   # Returns `true` if the named file exists and the effective used id of the
   # calling process is the owner of the file.
   #

data/core/io.rbs

@@ -683,7 +683,12 @@ class IO < Object
 
   def self.write: (String name, _ToS arg0, ?Integer offset, ?external_encoding: String external_encoding, ?internal_encoding: String internal_encoding, ?encoding: String encoding, ?textmode: untyped textmode, ?binmode: untyped binmode, ?autoclose: untyped autoclose, ?mode: String mode) -> Integer
 
-  def self.for_fd: (Integer fd, ?Integer mode, ?Integer opt) -> self
+  def self.for_fd: (int fd, ?(string | int) mode, **untyped opt) -> instance
+
+  alias self.open self.for_fd
+
+  def self.open: [A] (int fd, ?(string | int) mode, **untyped opt) { (instance) -> A } -> A
+               | ...
 
   def bytes: () { (Integer arg0) -> untyped } -> self
            | () -> ::Enumerator[Integer, self]

data/core/module.rbs

@@ -443,6 +443,47 @@ class Module < Object
   #
   def const_set: (Symbol | String arg0, untyped arg1) -> untyped
 
+  # Returns the Ruby source filename and line number containing first definition
+  # of constant specified. If the named constant is not found, `nil` is returned.
+  # If the constant is found, but its source location can not be extracted
+  # (constant is defined in C code), empty array is returned.
+  #
+  # *inherit* specifies whether to lookup in `mod.ancestors` (`true` by default).
+  #
+  #     # test.rb:
+  #     class A
+  #       C1 = 1
+  #     end
+  #
+  #     module M
+  #       C2 = 2
+  #     end
+  #
+  #     class B < A
+  #       include M
+  #       C3 = 3
+  #     end
+  #
+  #     class A # continuation of A definition
+  #     end
+  #
+  #     p B.const_source_location('C3')           # => ["test.rb", 11]
+  #     p B.const_source_location('C2')           # => ["test.rb", 6]
+  #     p B.const_source_location('C1')           # => ["test.rb", 2]
+  #
+  #     p B.const_source_location('C2', false)    # => nil  -- don't lookup in ancestors
+  #
+  #     p Object.const_source_location('B')       # => ["test.rb", 9]
+  #     p Object.const_source_location('A')       # => ["test.rb", 1]  -- note it is first entry, not "continuation"
+  #
+  #     p B.const_source_location('A')            # => ["test.rb", 1]  -- because Object is in ancestors
+  #     p M.const_source_location('A')            # => ["test.rb", 1]  -- Object is not ancestor, but additionally checked for modules
+  #
+  #     p Object.const_source_location('A::C1')   # => ["test.rb", 2]  -- nesting is supported
+  #     p Object.const_source_location('String')  # => []  -- constant is defined in C code
+  #
+  def const_source_location: (Symbol | String name, ?boolish inherit) -> ([String, Integer] | [ ] | nil)
+
   # Returns an array of the names of the constants accessible in *mod*. This
   # includes the names of constants in any included modules (example at start of
   # section), unless the *inherit* parameter is set to `false`.

data/docs/syntax.md

@@ -531,23 +531,6 @@ interface _Foo
 end
 ```
 
-### Extension declaration
-
-Extension is to model _open class_.
-
-```
-extension Kernel (Pathname)
-  def Pathname: (String) -> Pathname
-end
-
-extension Array[A] (ActiveSupport)
-  def to: (Integer) -> Array[A]
-  def from: (Integer) -> Array[A]
-  def second: () -> A?
-  def third: () -> A?
-end
-```
-
 ### Type alias declaration
 
 You can declare an alias of types.

data/goodcheck.yml

@@ -3,7 +3,7 @@ rules:
     pattern: 💪👽🚨
     message: Do you forget to delete `arglists` section?
     glob:
-      - "stdlib/**/*.rbs"
+      - "{core,stdlib}/**/*.rbs"
     fail:
       - |
         # arglists 💪👽🚨 << Delete this section
@@ -22,7 +22,7 @@ rules:
     justification:
       - Documents (comments) may contain that pattern.
     glob:
-      - "stdlib/**/*.rbs"
+      - "{core,stdlib}/**/*.rbs"
     fail:
       - "def `send`: (String | Symbol arg0, *untyped arg1) -> untyped"
     pass:

data/lib/rbs/ast/declarations.rb

@@ -300,53 +300,6 @@ module RBS
         end
       end
 
-      class Extension < Base
-        attr_reader :name
-        attr_reader :type_params
-        attr_reader :extension_name
-        attr_reader :members
-        attr_reader :annotations
-        attr_reader :location
-        attr_reader :comment
-
-        def initialize(name:, type_params:, extension_name:, members:, annotations:, location:, comment:)
-          @name = name
-          @type_params = type_params
-          @extension_name = extension_name
-          @members = members
-          @annotations = annotations
-          @location = location
-          @comment = comment
-        end
-
-        def ==(other)
-          other.is_a?(Extension) &&
-            other.name == name &&
-            other.type_params == type_params &&
-            other.extension_name == extension_name &&
-            other.members == members
-        end
-
-        alias eql? ==
-
-        def hash
-          self.class.hash ^ name.hash ^ type_params.hash ^ extension_name.hash ^ members.hash
-        end
-
-        def to_json(*a)
-          {
-            declaration: :extension,
-            name: name,
-            type_params: type_params,
-            extension_name: extension_name,
-            members: members,
-            annotations: annotations,
-            location: location,
-            comment: comment
-          }.to_json(*a)
-        end
-      end
-
       class Interface < Base
         attr_reader :name
         attr_reader :type_params

data/lib/rbs/definition_builder.rb

@@ -44,7 +44,8 @@ module RBS
 
         ancestors = ancestor_builder.interface_ancestors(type_name)
         Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
-          ancestor_builder.one_interface_ancestors(type_name).included_interfaces.each do |mod|
+          included_interfaces = ancestor_builder.one_interface_ancestors(type_name).included_interfaces or raise
+          included_interfaces.each do |mod|
             defn = build_interface(mod.name)
             subst = Substitution.build(defn.type_params, mod.args)
 
@@ -54,13 +55,17 @@ module RBS
           end
 
           methods = method_builder.build_interface(type_name)
+          one_ancestors = ancestor_builder.one_interface_ancestors(type_name)
+
+          validate_type_params(definition, methods: methods, ancestors: one_ancestors)
+
           methods.each do |defn|
-            method = case defn.original
+            method = case original = defn.original
                      when AST::Members::MethodDefinition
-                       defs = defn.original.types.map do |method_type|
+                       defs = original.types.map do |method_type|
                          Definition::Method::TypeDef.new(
                            type: method_type,
-                           member: defn.original,
+                           member: original,
                            defined_in: type_name,
                            implemented_in: nil
                          )
@@ -73,15 +78,15 @@ module RBS
                          alias_of: nil
                        )
                      when AST::Members::Alias
-                       unless definition.methods.key?(defn.original.old_name)
+                       unless definition.methods.key?(original.old_name)
                          raise UnknownMethodAliasError.new(
-                           original_name: defn.original.old_name,
-                           aliased_name: defn.original.new_name,
-                           location: defn.original.location
+                           original_name: original.old_name,
+                           aliased_name: original.new_name,
+                           location: original.location
                          )
                        end
 
-                       original_method = definition.methods[defn.original.old_name]
+                       original_method = definition.methods[original.old_name]
                        Definition::Method.new(
                          super_method: nil,
                          defs: original_method.defs.map do |defn|
@@ -101,10 +106,14 @@ module RBS
                        end
 
                        definition.methods[defn.name]
+
+                     when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
+                       raise
+
                      end
 
             defn.overloads.each do |overload|
-              defs = overload.types.map do |method_type|
+              overload_defs = overload.types.map do |method_type|
                 Definition::Method::TypeDef.new(
                   type: method_type,
                   member: overload,
@@ -113,7 +122,7 @@ module RBS
                 )
               end
 
-              method.defs.unshift(*defs)
+              method.defs.unshift(*overload_defs)
             end
 
             definition.methods[defn.name] = method
@@ -141,15 +150,21 @@ module RBS
             validate_type_params definition, methods: methods, ancestors: one_ancestors
 
             if super_class = one_ancestors.super_class
-              defn = build_instance(super_class.name)
-              merge_definition(src: defn,
-                               dest: definition,
-                               subst: Substitution.build(defn.type_params, super_class.args),
-                               keep_super: true)
+              case super_class
+              when Definition::Ancestor::Instance
+                build_instance(super_class.name).yield_self do |defn|
+                  merge_definition(src: defn,
+                                  dest: definition,
+                                  subst: Substitution.build(defn.type_params, super_class.args),
+                                  keep_super: true)
+                end
+              else
+                raise
+              end
             end
 
-            if one_ancestors.self_types
-              one_ancestors.self_types.each do |ans|
+            if self_types = one_ancestors.self_types
+              self_types.each do |ans|
                 defn = if ans.name.interface?
                          build_interface(ans.name)
                        else
@@ -164,7 +179,7 @@ module RBS
               end
             end
 
-            one_ancestors.included_modules.each do |mod|
+            one_ancestors.each_included_module do |mod|
               defn = build_instance(mod.name)
               merge_definition(src: defn,
                                dest: definition,
@@ -173,16 +188,20 @@ module RBS
 
             interface_methods = {}
 
-            one_ancestors.included_interfaces.each do |mod|
+            one_ancestors.each_included_interface do |mod|
               defn = build_interface(mod.name)
               subst = Substitution.build(defn.type_params, mod.args)
 
               defn.methods.each do |name, method|
                 if interface_methods.key?(name)
+                  include_member = mod.source
+
+                  raise unless include_member.is_a?(AST::Members::Include)
+
                   raise DuplicatedInterfaceMethodDefinitionError.new(
                     type: self_type,
                     method_name: name,
-                    member: mod.source
+                    member: include_member
                   )
                 end
 
@@ -221,7 +240,7 @@ module RBS
               end
             end
 
-            one_ancestors.prepended_modules.each do |mod|
+            one_ancestors.each_prepended_module do |mod|
               defn = build_instance(mod.name)
               merge_definition(src: defn,
                                dest: definition,
@@ -261,24 +280,28 @@ module RBS
               end
             end
 
-            one_ancestors.extended_modules.each do |mod|
-              defn = build_instance(mod.name)
-              merge_definition(src: defn,
+            one_ancestors.each_extended_module do |mod|
+              mod_defn = build_instance(mod.name)
+              merge_definition(src: mod_defn,
                                dest: definition,
-                               subst: Substitution.build(defn.type_params, mod.args))
+                               subst: Substitution.build(mod_defn.type_params, mod.args))
             end
 
             interface_methods = {}
-            one_ancestors.extended_interfaces.each do |mod|
-              defn = build_interface(mod.name)
-              subst = Substitution.build(defn.type_params, mod.args)
+            one_ancestors.each_extended_interface do |mod|
+              mod_defn = build_interface(mod.name)
+              subst = Substitution.build(mod_defn.type_params, mod.args)
 
-              defn.methods.each do |name, method|
+              mod_defn.methods.each do |name, method|
                 if interface_methods.key?(name)
+                  src_member = mod.source
+
+                  raise unless src_member.is_a?(AST::Members::Extend)
+
                   raise DuplicatedInterfaceMethodDefinitionError.new(
                     type: self_type,
                     method_name: name,
-                    member: mod.source
+                    member: src_member
                   )
                 end
 
@@ -418,6 +441,20 @@ module RBS
       end
     end
 
+    def source_location(source, decl)
+      case source
+      when nil
+        decl.location
+      when :super
+        case decl
+        when AST::Declarations::Class
+          decl.super_class&.location
+        end
+      else
+        source.location
+      end
+    end
+
     def validate_type_params(definition, ancestors:, methods:)
       type_params = definition.type_params_decl
 
@@ -429,19 +466,17 @@ module RBS
         when Definition::Ancestor::Instance
           result = calculator.in_inherit(name: ancestor.name, args: ancestor.args, variables: param_names)
           validate_params_with(type_params, result: result) do |param|
-            location = case source = ancestor.source
-                       when nil
-                         definition.entry.primary.decl.location
-                       when :super
-                         definition.entry.primary.decl.super_class.location
-                       else
-                         source.location
-                       end
+            decl = case entry = definition.entry
+                   when Environment::ModuleEntry, Environment::ClassEntry
+                     entry.primary.decl
+                   when Environment::SingleEntry
+                     entry.decl
+                   end
 
             raise InvalidVarianceAnnotationError.new(
               type_name: definition.type_name,
               param: param,
-              location: location
+              location: source_location(ancestor.source, decl)
             )
           end
         end
@@ -481,8 +516,6 @@ module RBS
                          nil
                        when nil
                          nil
-                       else
-                         raise
                        end
 
         if method_types
@@ -537,11 +570,11 @@ module RBS
           if interface_methods.key?(method_name)
             interface_method = interface_methods[method_name]
 
-            if method_def.original
+            if original = method_def.original
               raise DuplicatedMethodDefinitionError.new(
                 type: definition.self_type,
                 method_name: method_name,
-                members: [method_def.original]
+                members: [original]
               )
             end
 
@@ -561,6 +594,7 @@ module RBS
               )
             end
 
+            # @type var accessibility: RBS::Definition::accessibility
             accessibility = if method_name == :initialize
                               :private
                             else
@@ -640,7 +674,7 @@ module RBS
         end
 
         method_def.overloads.each do |overload|
-          defs = overload.types.map do |method_type|
+          type_defs = overload.types.map do |method_type|
             Definition::Method::TypeDef.new(
               type: method_type,
               member: overload,
@@ -649,7 +683,7 @@ module RBS
             )
           end
 
-          method.defs.unshift(*defs)
+          method.defs.unshift(*type_defs)
         end
 
         definition.methods[method_name] = method