rbs 0.3.1 → 0.8.0

data/bin/test_runner.rb

@@ -9,8 +9,6 @@ unless RUBY_27
   exit
 end
 
-require "pathname"
-
 ARGV.each do |arg|
   load arg
 end

data/docs/sigs.md

@@ -16,7 +16,7 @@ See [syntax guide](syntax.md).
 ## Testing signatures
 
 When you finish writing signature, you may want to test the signature.
-ruby-signature provides a feature to test your signature.
+rbs provides a feature to test your signature.
 
 ```
 $ RBS_TEST_TARGET='Foo::*' bundle exec ruby -r rbs/test/setup test/foo_test.rb
@@ -68,7 +68,7 @@ ERROR -- : [Kaigi::Conference#speakers] UnexpectedBlockError: unexpected block i
 ### UnresolvedOverloadingError
 
 The error means there is a type error on overloaded methods.
-The `ruby-signature` test framework tries to the best error message for overloaded methods too, but it reports the `UnresolvedOverloadingError` when it fails.
+The `rbs` test framework tries to the best error message for overloaded methods too, but it reports the `UnresolvedOverloadingError` when it fails.
 
 ## Setting up the test
 
@@ -84,13 +84,13 @@ You can do it using `-r` option through command line argument or the `RUBYOPT` e
 
 ```
 $ ruby -r rbs/test/setup run_tests.rb
-$ RUBYOPT='-rruby/signature/test/setup' rake test
+$ RUBYOPT='-rrbs/test/setup' rake test
 ```
 
 When you are using Bundler, you may need to require `bundler/setup` explicitly.
 
 ```
-$ RUBYOPT='-rbundler/setup -rruby/signature/test/setup' bundle exec rake test
+$ RUBYOPT='-rbundler/setup -rrbs/test/setup' bundle exec rake test
 ```
 
 ### Environment variables
@@ -109,7 +109,7 @@ You need to specify `RBS_TEST_TARGET` to run the test, and you can customize the
 
 `RBS_TEST_SKIP` is to skip some of the classes which matches with `RBS_TEST_TARGET`.
 
-`RBS_TEST_OPT` is to pass the options for ruby signature handling.
+`RBS_TEST_OPT` is to pass the options for rbs handling.
 You may need to specify `-r` or `-I` to load signatures.
 The default is `-I sig`.
 
@@ -131,7 +131,7 @@ $ RBS_TEST_LOGLEVEL=error \
   RBS_TEST_SKIP='Kaigi::MonkeyPatch' \
   RBS_TEST_OPT='-rset -rpathname -Isig -Iprivate' \
   RBS_TEST_RAISE=true \
-  RUBYOPT='-rbundler/setup -rruby/signature/test/setup' \
+  RUBYOPT='-rbundler/setup -rrbs/test/setup' \
   bundle exec rake test
 ```
 

data/docs/stdlib.md

@@ -1,6 +1,6 @@
 # Stdlib Signatures Guide
 
-This is a guide for contributing to `ruby-signature` by writing/revising stdlib signatures.
+This is a guide for contributing to `rbs` by writing/revising stdlib signatures.
 
 The typical steps of writing signatures will be like the following:
 
@@ -17,7 +17,7 @@ To write signatures see [syntax guide](syntax.md).
 
 ## Generating prototypes
 
-`ruby-signature` provides a tool to generate a prototype of signatures, `rbs prototype`.
+`rbs` provides a tool to generate a prototype of signatures, `rbs prototype`.
 It provides several options, `rbi` from Sorbet RBI files, `rb` from Ruby code, and `runtime` from runtime API.
 `runtime` should be the best option for standard libraries because they may be implemented in C, no Ruby source code.
 
@@ -120,7 +120,6 @@ The test scripts would look like the following:
 ```rb
 class StringTest < StdlibTest
   target String
-  using hook.refinement
 
   def test_gsub
     s = "string"
@@ -136,7 +135,6 @@ end
 
 You need two method calls, `target` and `using`.
 `target` method call tells which class is the subject of the class.
-`using hook.refinement` installs a special instrumentation for stdlib, based on refinements.
 And you write the sample programs which calls all of the patterns of overloads.
 
 Note that the instrumentation is based on refinements and you need to write all method calls in the unit class definitions.
@@ -147,6 +145,6 @@ If the execution of the program escape from the class definition, the instrument
 You can run the test with:
 
 ```
-$ bundle exec ruby bin/test_runner.rb         # Run all tests
+$ bundle exec rake stdlib_test                # Run all tests
 $ bundle exec ruby test/stdlib/String_test.rb # Run specific tests
 ```

data/docs/syntax.md

@@ -166,7 +166,7 @@ end
 
 ### Proc type
 
-Proc type denots type of procedures, `Proc` instances.
+Proc type denotes type of procedures, `Proc` instances.
 
 ```
 ^(Integer) -> String                  # A procedure with an `Integer` parameter and returns `String`
@@ -348,7 +348,7 @@ attr_reader id: Integer
 # @id: Integer
 # def id: () -> Integer
 
-# Defines `name=` method and `raw_name` instance variable.
+# Defines `name=` method and `@raw_name` instance variable.
 attr_writer name (@raw_name) : String
 # @raw_name: String
 # def name=: (String) -> String
@@ -408,7 +408,10 @@ _class-decl_ ::= `class` _class-name_ _module-type-parameters_ _members_ `end`
                | `class` _class-name_ _module-type-parameters_ `<` _class-name_ _type-arguments_ _members_ `end`
 
 _module-decl_ ::= `module` _module-name_ _module-type-parameters_ _members_ `end`
-                | `module` _module-name_ _module-type-parameters_ `:` _class-name_ _type-arguments_ _members_ `end`
+                | `module` _module-name_ _module-type-parameters_ `:` _module-self-types_ _members_ `end`
+
+_module-self-types_ ::= _class-name_ _type-arguments_ `,` _module-self-types_            (Class instance)
+                      | _interface-name_ _type-arguments_ `,` _module-self-types_        (Interface)
 
 _interface-decl_ ::= `interface` _interface-name_ _module-type-parameters_ _interface-members_ `end`
 

data/goodcheck.yml

@@ -0,0 +1,65 @@
+rules:
+  - id: rbs.no_mark
+    pattern: 💪👽🚨
+    message: Do you forget to delete `arglists` section?
+    glob:
+      - "stdlib/**/*.rbs"
+    fail:
+      - |
+        # arglists 💪👽🚨 << Delete this section   
+        #    File.absolute_path?(file_name)  ->  true or false    
+        #
+
+  - id: rbs.no_arg
+    pattern: 
+      regexp: arg\d+
+    message: |
+      Stop using parameter names like `arg0` or `arg1`
+
+      The parameter names like `arg0` or `arg1` is not informative enough.
+      Try finding good parameter names from documents or arglists.
+      If you cannot find a good name, just delete the name of the parameters.
+    justification:
+      - Documents (comments) may contain that pattern.
+    glob:
+      - "stdlib/**/*.rbs"
+    fail: 
+      - "def `send`: (String | Symbol arg0, *untyped arg1) -> untyped"
+    pass:
+      - "def `send`: (String | Symbol, *untyped) -> untyped"
+
+  - id: deprecate_stdlib_test
+    pattern:
+      token: < StdlibTest
+    message: |
+      StdlibTest is deprecated
+
+      We recommend writing tests based on `TypeAssertions` and `#assert_send_type`.
+    justification:
+      - When you are updating existing tests.
+      - When you are writing tests for callback, which cannot be done with `#assert_send_type`.
+    glob:
+      - "test/stdlib/**/*_test.rb"
+    fail:
+      - |
+        class IntegerTest < StdlibTest
+          target Integer
+
+          def test_plus
+            1 + 2
+          end
+        end
+    pass:
+      - |
+        class IntegerTest < Minitest::Test
+          include TypeAssertions
+
+          testing "Integer"
+
+          def test_plus
+            assert_send_type "(::Integer) -> ::Integer",
+                             1, :+, 2
+          end
+        end
+
+

data/lib/rbs.rb

@@ -32,8 +32,11 @@ require "rbs/writer"
 require "rbs/prototype/rbi"
 require "rbs/prototype/rb"
 require "rbs/prototype/runtime"
+require "rbs/type_name_resolver"
 require "rbs/environment_walker"
 require "rbs/vendorer"
+require "rbs/validator"
+require "rbs/factory"
 
 begin
   require "rbs/parser"

data/lib/rbs/ast/declarations.rb

@@ -1,10 +1,21 @@
 module RBS
   module AST
     module Declarations
+      class Base
+      end
+
       class ModuleTypeParams
         attr_reader :params
 
-        TypeParam = Struct.new(:name, :variance, :skip_validation, keyword_init: true)
+        TypeParam = Struct.new(:name, :variance, :skip_validation, keyword_init: true) do
+          def to_json(*a)
+            {
+              name: name,
+              variance: variance,
+              skip_validation: skip_validation,
+            }.to_json(*a)
+          end
+        end
 
         def initialize()
           @params = []
@@ -69,7 +80,53 @@ module RBS
         end
       end
 
-      class Class
+      module NestedDeclarationHelper
+        def each_member
+          if block_given?
+            members.each do |member|
+              if member.is_a?(Members::Base)
+                yield member
+              end
+            end
+          else
+            enum_for :each_member
+          end
+        end
+
+        def each_decl
+          if block_given?
+            members.each do |member|
+              if member.is_a?(Declarations::Base)
+                yield member
+              end
+            end
+          else
+            enum_for :each_decl
+          end
+        end
+      end
+
+      module MixinHelper
+        def each_mixin(&block)
+          if block_given?
+            @mixins ||= begin
+                          members.select do |member|
+                            case member
+                            when Members::Include, Members::Extend, Members::Prepend
+                              true
+                            else
+                              false
+                            end
+                          end
+                        end
+            @mixins.each(&block)
+          else
+            enum_for :each_mixin
+          end
+        end
+      end
+
+      class Class < Base
         class Super
           attr_reader :name
           attr_reader :args
@@ -97,6 +154,9 @@ module RBS
           end
         end
 
+        include NestedDeclarationHelper
+        include MixinHelper
+
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
@@ -143,19 +203,60 @@ module RBS
         end
       end
 
-      class Module
+      class Module < Base
+        class Self
+          attr_reader :name
+          attr_reader :args
+          attr_reader :location
+
+          def initialize(name:, args:, location:)
+            @name = name
+            @args = args
+            @location = location
+          end
+
+          def ==(other)
+            other.is_a?(Self) && other.name == name && other.args == args
+          end
+
+          alias eql? ==
+
+          def hash
+            self.class.hash ^ name.hash ^ args.hash ^ location.hash
+          end
+
+          def to_json(*a)
+            {
+              name: name,
+              args: args,
+              location: location
+            }.to_json(*a)
+          end
+
+          def to_s
+            if args.empty?
+              name.to_s
+            else
+              "#{name}[#{args.join(", ")}]"
+            end
+          end
+        end
+
+        include NestedDeclarationHelper
+        include MixinHelper
+
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
         attr_reader :location
         attr_reader :annotations
-        attr_reader :self_type
+        attr_reader :self_types
         attr_reader :comment
 
-        def initialize(name:, type_params:, members:, self_type:, annotations:, location:, comment:)
+        def initialize(name:, type_params:, members:, self_types:, annotations:, location:, comment:)
           @name = name
           @type_params = type_params
-          @self_type = self_type
+          @self_types = self_types
           @members = members
           @annotations = annotations
           @location = location
@@ -166,14 +267,14 @@ module RBS
           other.is_a?(Module) &&
             other.name == name &&
             other.type_params == type_params &&
-            other.self_type == self_type &&
+            other.self_types == self_types &&
             other.members == members
         end
 
         alias eql? ==
 
         def hash
-          self.class.hash ^ name.hash ^ type_params.hash ^ self_type.hash ^ members.hash
+          self.class.hash ^ name.hash ^ type_params.hash ^ self_types.hash ^ members.hash
         end
 
         def to_json(*a)
@@ -182,7 +283,7 @@ module RBS
             name: name,
             type_params: type_params,
             members: members,
-            self_type: self_type,
+            self_types: self_types,
             annotations: annotations,
             location: location,
             comment: comment
@@ -190,7 +291,7 @@ module RBS
         end
       end
 
-      class Extension
+      class Extension < Base
         attr_reader :name
         attr_reader :type_params
         attr_reader :extension_name
@@ -237,7 +338,7 @@ module RBS
         end
       end
 
-      class Interface
+      class Interface < Base
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
@@ -280,7 +381,7 @@ module RBS
         end
       end
 
-      class Alias
+      class Alias < Base
         attr_reader :name
         attr_reader :type
         attr_reader :annotations
@@ -319,7 +420,7 @@ module RBS
         end
       end
 
-      class Constant
+      class Constant < Base
         attr_reader :name
         attr_reader :type
         attr_reader :location
@@ -355,7 +456,7 @@ module RBS
         end
       end
 
-      class Global
+      class Global < Base
         attr_reader :name
         attr_reader :type
         attr_reader :location

data/lib/rbs/ast/members.rb

@@ -1,7 +1,10 @@
 module RBS
   module AST
     module Members
-      class MethodDefinition
+      class Base
+      end
+
+      class MethodDefinition < Base
         attr_reader :name
         attr_reader :kind
         attr_reader :types
@@ -9,8 +12,9 @@ module RBS
         attr_reader :location
         attr_reader :comment
         attr_reader :attributes
+        attr_reader :overload
 
-        def initialize(name:, kind:, types:, annotations:, location:, comment:, attributes:)
+        def initialize(name:, kind:, types:, annotations:, location:, comment:, attributes:, overload:)
           @name = name
           @kind = kind
           @types = types
@@ -18,6 +22,7 @@ module RBS
           @location = location
           @comment = comment
           @attributes = attributes
+          @overload = overload
         end
 
         def ==(other)
@@ -25,13 +30,14 @@ module RBS
             other.name == name &&
             other.kind == kind &&
             other.types == types &&
-            other.attributes == attributes
+            other.attributes == attributes &&
+            other.overload == overload
         end
 
         alias eql? ==
 
         def hash
-          self.class.hash ^ name.hash ^ kind.hash ^ types.hash ^ attributes.hash
+          self.class.hash ^ name.hash ^ kind.hash ^ types.hash ^ attributes.hash ^ overload.hash
         end
 
         def instance?
@@ -42,6 +48,23 @@ module RBS
           kind == :singleton || kind == :singleton_instance
         end
 
+        def overload?
+          overload
+        end
+
+        def update(name: self.name, kind: self.kind, types: self.types, annotations: self.annotations, location: self.location, comment: self.comment, attributes: self.attributes, overload: self.overload)
+          self.class.new(
+            name: name,
+            kind: kind,
+            types: types,
+            annotations: annotations,
+            location: location,
+            comment: comment,
+            attributes: attributes,
+            overload: overload
+          )
+        end
+
         def to_json(*a)
           {
             member: :method_definition,
@@ -50,7 +73,8 @@ module RBS
             annotations: annotations,
             location: location,
             comment: comment,
-            attributes: attributes
+            attributes: attributes,
+            overload: overload
           }.to_json(*a)
         end
       end
@@ -79,7 +103,7 @@ module RBS
         end
       end
 
-      class InstanceVariable
+      class InstanceVariable < Base
         include Var
 
         def to_json(*a)
@@ -93,7 +117,7 @@ module RBS
         end
       end
 
-      class ClassInstanceVariable
+      class ClassInstanceVariable < Base
         include Var
 
         def to_json(*a)
@@ -107,7 +131,7 @@ module RBS
         end
       end
 
-      class ClassVariable
+      class ClassVariable < Base
         include Var
 
         def to_json(*a)
@@ -149,7 +173,7 @@ module RBS
         end
       end
 
-      class Include
+      class Include < Base
         include Mixin
 
         def to_json(*a)
@@ -164,7 +188,7 @@ module RBS
         end
       end
 
-      class Extend
+      class Extend < Base
         include Mixin
 
         def to_json(*a)
@@ -179,7 +203,7 @@ module RBS
         end
       end
 
-      class Prepend
+      class Prepend < Base
         include Mixin
 
         def to_json(*a)
@@ -225,7 +249,7 @@ module RBS
         end
       end
 
-      class AttrReader
+      class AttrReader < Base
         include Attribute
 
         def to_json(*a)
@@ -241,7 +265,7 @@ module RBS
         end
       end
 
-      class AttrAccessor
+      class AttrAccessor < Base
         include Attribute
 
         def to_json(*a)
@@ -257,7 +281,7 @@ module RBS
         end
       end
 
-      class AttrWriter
+      class AttrWriter < Base
         include Attribute
 
         def to_json(*a)
@@ -291,7 +315,7 @@ module RBS
         end
       end
 
-      class Public
+      class Public < Base
         include LocationOnly
 
         def to_json(*a)
@@ -299,7 +323,7 @@ module RBS
         end
       end
 
-      class Private
+      class Private < Base
         include LocationOnly
 
         def to_json(*a)
@@ -307,7 +331,7 @@ module RBS
         end
       end
 
-      class Alias
+      class Alias < Base
         attr_reader :new_name
         attr_reader :old_name
         attr_reader :kind