rbs 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddacdf6b9e8b5297a7a5845aa715ffc9202fa42a6a81b492e40cbeeabbc4c311
-  data.tar.gz: f79a70c89b49abc949dfb9d168bac9684d90036b4ef496c839ec24c20be4d972
+  metadata.gz: 77a83be097e5de26f4541a25fb744a31574d0f0b94d94848e11cae49d095693a
+  data.tar.gz: 4619e6ae9f31e32ac6d2da902b11980644df037b9d254b5919fe2eff1f43bdc7
 SHA512:
-  metadata.gz: e6beaa6a9cb76ff862057a2bc8be4260e804c3b2737ccf0d1811b0c2d5aa5aa35b3832c01d936de76ee5f2ef6d64b2182b9830dc2ae178d54971332360e190b4
-  data.tar.gz: ce16ec8b1174d15f5f0acf6fc9285abede6554bb036252f5ad4efab162e8a1976b9eefa37f1136a2e6b6d18e5f11505204f7fe15edf4f3c9d64a72329c9db63a
+  metadata.gz: '095abed7b0453d72a545760d8a165bb2a3415e3f741b004926b600b8e1e1260dc752e91d86d33e0c770d3011885bea1fa728708707687c59d3a1ad9707b672c7'
+  data.tar.gz: 94b3f4fc317d701c327b7519068ec590409ceff1208660c44f83440c9d3ed419c83ca29adf7137c10a1fb7c3d7ed7b0808e0a8a5fc5dedd66ca900981674ae90

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## master
 
+## 0.4.0 (2020-06-15)
+
+* Signature update for `Fiber`, `Encoding`, and `Enumerator`.
+* Fix syntax error for underscore and `!` `?` [#304](https://github.com/ruby/rbs/pull/304)
+* Improved return type inference in `rbs prototype rb` [#303](https://github.com/ruby/rbs/pull/303)
+* Skip anonymous modules/classes in `rbs prototype runtime` [#302](https://github.com/ruby/rbs/pull/302)
+* Fix `--require-relative` option in `rbs prototype runtime` [#299](https://github.com/ruby/rbs/pull/299)
+* Add JSON schema for `rbs ast` [#295](https://github.com/ruby/rbs/pull/295)
+
 ## 0.3.1 (2020-05-22)
 
 * Fix constant resolution again [#289](https://github.com/ruby/rbs/pull/289)

data/COPYING

@@ -1,4 +1,4 @@
-ruby-signature is copyrighted free software by Soutaro Matsumoto <matsumoto@soutaro.com>.
+rbs is copyrighted free software by Soutaro Matsumoto <matsumoto@soutaro.com>.
 You can redistribute it and/or modify it under either the terms of the
 2-clause BSDL (see the file BSDL), or the conditions below:
 

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in ruby-signature.gemspec
+# Specify your gem's dependencies in rbs.gemspec
 gemspec
 
-gem "ruby-signature-amber", path: "test/assets/test-gem"
+gem "rbs-amber", path: "test/assets/test-gem"

data/README.md

@@ -22,7 +22,7 @@ $ rbs methods ::Object
 $ rbs method ::Object tap
 ```
 
-### rbs [--class|--module|interface] list
+### rbs list [--class|--module|--interface]
 
 ```
 $ rbs list
@@ -90,4 +90,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/ruby-signature.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/rbs.

data/Rakefile

@@ -45,7 +45,7 @@ namespace :generate do
     raise "#{path} already exists!" if path.exist?
 
     require "erb"
-    require "ruby/signature"
+    require "rbs"
 
     class TestTemplateBuilder
       attr_reader :klass, :env

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.
 
@@ -147,6 +147,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/lib/rbs/ast/declarations.rb

@@ -4,7 +4,15 @@ module RBS
       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 = []

data/lib/rbs/cli.rb

@@ -372,7 +372,7 @@ module RBS
     end
 
     def run_version(args, options)
-      stdout.puts "ruby-signature #{VERSION}"
+      stdout.puts "rbs #{VERSION}"
     end
 
     def run_paths(args, options)
@@ -449,7 +449,7 @@ module RBS
         end
 
         relative_libs.each do |lib|
-          require(lib)
+          eval("require_relative(lib)", binding, "rbs")
         end
 
         decls = Prototype::Runtime.new(patterns: args, env: env, merge: merge, owners_included: owners_included).decls

data/lib/rbs/parser.y

@@ -500,13 +500,13 @@ rule
     | tQUOTEDIDENT
     | tWRITE_ATTR
 
-  method_name0: tUIDENT | tLIDENT | identifier_keywords
+  method_name0: tUIDENT | tLIDENT | tINTERFACEIDENT | identifier_keywords
 
   identifier_keywords:
       kCLASS | kVOID | kNIL | kTRUE | kFALSE | kANY | kUNTYPED | kTOP | kBOT | kINSTANCE | kBOOL | kSINGLETON
     | kTYPE | kMODULE | kPRIVATE | kPUBLIC | kEND | kINCLUDE | kEXTEND | kPREPEND
     | kATTRREADER | kATTRACCESSOR | kATTRWRITER | kDEF | kEXTENSION | kSELF | kINCOMPATIBLE
-    | kUNCHECKED
+    | kUNCHECKED | kINTERFACE | kSUPER | kALIAS | kOUT | kIN
 
   module_type_params:
       { result = nil }

data/lib/rbs/prototype/rb.rb

@@ -328,7 +328,19 @@ module RBS
         body = node.children[2]
         return Types::Bases::Nil.new(location: nil) unless body
 
-        literal_to_type(body)
+        if body.type == :BLOCK
+          return_stmts = any_node?(body) do |n|
+            n.type == :RETURN
+          end&.map do |return_node|
+            returned_value = return_node.children[0]
+            returned_value ? literal_to_type(returned_value) : Types::Bases::Nil.new(location: nil)
+          end || []
+          last_node = body.children.last
+          last_evaluated =  last_node ? literal_to_type(last_node) : Types::Bases::Nil.new(location: nil)
+          types_to_union_type([*return_stmts, last_evaluated])
+        else
+          literal_to_type(body)
+        end
       end
 
       def literal_to_type(node)
@@ -393,7 +405,7 @@ module RBS
             value_types << literal_to_type(v)
           end
 
-          if key_types.all? { |t| t.is_a?(Types::Literal) }
+          if !key_types.empty? && key_types.all? { |t| t.is_a?(Types::Literal) }
             fields = key_types.map { |t| t.literal }.zip(value_types).to_h
             Types::Record.new(fields: fields, location: nil)
           else
@@ -408,9 +420,11 @@ module RBS
 
       def types_to_union_type(types)
         return untyped if types.empty?
-        return untyped if types.include?(untyped)
 
-        Types::Union.new(types: types.uniq, location: nil)
+        uniq = types.uniq
+        return uniq.first if uniq.size == 1
+
+        Types::Union.new(types: uniq, location: nil)
       end
 
       def range_element_type(types)

data/lib/rbs/prototype/runtime.rb

@@ -281,6 +281,11 @@ module RBS
           value = mod.const_get(name)
 
           next if value.is_a?(Class) || value.is_a?(Module)
+          unless value.class.name
+            RBS.logger.warn("Skipping constant #{name} #{value} of #{mod} as an instance of anonymous class")
+            next
+          end
+
           type = case value
                  when true, false
                    Types::Bases::Bool.new(location: nil)
@@ -306,6 +311,9 @@ module RBS
         type_name = to_type_name(mod.name)
         super_class = if mod.superclass == ::Object
                         nil
+                      elsif mod.superclass.name.nil?
+                        RBS.logger.warn("Skipping anonymous superclass #{mod.superclass} of #{mod}")
+                        nil
                       else
                         AST::Declarations::Class::Super.new(name: to_type_name(mod.superclass.name), args: [])
                       end
@@ -321,6 +329,11 @@ module RBS
         )
 
         each_mixin(mod.included_modules, *mod.superclass.included_modules, *mod.included_modules.flat_map(&:included_modules)) do |included_module|
+          unless included_module.name
+            RBS.logger.warn("Skipping anonymous module #{included_module} included in #{mod}")
+            next
+          end
+
           module_name = to_type_name(included_module.name)
           if module_name.namespace == type_name.namespace
             module_name = TypeName.new(name: module_name.name, namespace: Namespace.empty)
@@ -343,6 +356,11 @@ module RBS
       end
 
       def generate_module(mod)
+        unless mod.name
+          RBS.logger.warn("Skipping anonymous module #{mod}")
+          return
+        end
+
         type_name = to_type_name(mod.name)
 
         decl = AST::Declarations::Module.new(
@@ -356,6 +374,11 @@ module RBS
         )
 
         each_mixin(mod.included_modules, *mod.included_modules.flat_map(&:included_modules), namespace: type_name.namespace) do |included_module|
+          unless included_module.name
+            RBS.logger.warn("Skipping anonymous module #{included_module} included in #{mod}")
+            next
+          end
+
           module_name = to_type_name(included_module.name)
           if module_name.namespace == type_name.namespace
             module_name = TypeName.new(name: module_name.name, namespace: Namespace.empty)

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/rbs.gemspec

@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rubycw"
   spec.add_development_dependency "minitest-reporters", "~> 1.3.6"
   spec.add_development_dependency "json", "~> 2.3.0"
+  spec.add_development_dependency "json-schema", "~> 2.8"
 end

data/schema/annotation.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Annotation associated to a declaration or a member: `%a{rbs:test}`, `%a{steep:deprecated}`, ...",
+  "type": "object",
+  "properties": {
+    "string": {
+      "type": "string"
+    },
+    "location": {
+      "$ref": "location.json"
+    }
+  },
+  "required": ["string", "location"]
+}

data/schema/comment.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "definitions": {
+    "comment": {
+      "type": "object",
+      "properties": {
+        "string": {
+          "type": "string"
+        },
+        "location": {
+          "$ref": "location.json"
+        }
+      },
+      "required": ["string", "location"]
+    }
+  },
+  "title": "Comment associated with a declaration or a member",
+  "oneOf": [
+    {
+      "$ref": "#/definitions/comment"
+    },
+    {
+      "type": "null"
+    }
+  ]
+}

data/schema/decls.json

@@ -0,0 +1,327 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "definitions": {
+    "alias": {
+      "title": "Type alias declaration: `type foo = Integer`, ...",
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "type": "string",
+          "enum": ["alias"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "types.json"
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "$ref": "annotation.json"
+          }
+        },
+        "location": {
+          "$ref": "location.json"
+        },
+        "comment": {
+          "$ref": "comment.json"
+        }
+      },
+      "required": ["declaration", "name", "type", "annotations", "location", "comment"]
+    },
+    "constant": {
+      "title": "Constant declaration: `VERSION: String`, ...",
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "type": "string",
+          "enum": ["constant"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "types.json"
+        },
+        "location": {
+          "$ref": "location.json"
+        },
+        "comment": {
+          "$ref": "comment.json"
+        }
+      },
+      "required": ["declaration", "name", "type", "comment", "location"]
+    },
+    "global": {
+      "title": "Global declaration: `$DEBUG: bool`, ...",
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "type": "string",
+          "enum": ["global"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "types.json"
+        },
+        "location": {
+          "$ref": "location.json"
+        },
+        "comment": {
+          "$ref": "comment.json"
+        }
+      },
+      "required": ["declaration", "name", "type", "comment", "location"]
+    },
+    "moduleTypeParam": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "variance": {
+          "enum": ["covariant", "contravariant", "invariant"]
+        },
+        "skip_validation": {
+          "type": "boolean"
+        }
+      },
+      "required": ["name", "variance", "skip_validation"]
+    },
+    "classMember": {
+      "oneOf": [
+        {
+          "$ref": "members.json#/definitions/methodDefinition"
+        },
+        {
+          "$ref": "members.json#/definitions/variable"
+        },
+        {
+          "$ref": "members.json#/definitions/include"
+        },
+        {
+          "$ref": "members.json#/definitions/extend"
+        },
+        {
+          "$ref": "members.json#/definitions/prepend"
+        },
+        {
+          "$ref": "members.json#/definitions/attribute"
+        },
+        {
+          "$ref": "members.json#/definitions/visibility"
+        },
+        {
+          "$ref": "members.json#/definitions/alias"
+        }
+      ]
+    },
+    "class": {
+      "title": "Class declaration",
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "enum": ["class"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type_params": {
+          "type": "object",
+          "properties": {
+            "params": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/moduleTypeParam"
+              }
+            }
+          },
+          "required": ["params"]
+        },
+        "members": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/classMember"
+          }
+        },
+        "super_class": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "args": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "types.json"
+                  }
+                }
+              },
+              "required": ["name", "args"]
+            }
+          ]
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "$ref": "annotation.json"
+          }
+        },
+        "comment": {
+          "$ref": "comment.json"
+        },
+        "location": {
+          "$ref": "location.json"
+        }
+      },
+      "required": ["declaration", "name", "type_params", "members", "super_class", "annotations", "comment", "location"]
+    },
+    "module": {
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "enum": ["module"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type_params": {
+          "type": "object",
+          "properties": {
+            "params": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/moduleTypeParam"
+              }
+            }
+          },
+          "required": ["params"]
+        },
+        "members": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/classMember"
+          }
+        },
+        "self_type": {
+          "oneOf": [
+            {
+              "$ref": "types.json"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "$ref": "annotation.json"
+          }
+        },
+        "comment": {
+          "$ref": "comment.json"
+        },
+        "location": {
+          "$ref": "location.json"
+        }
+      },
+      "required": ["declaration", "name", "type_params", "members", "self_type", "annotations", "location", "comment"]
+    },
+    "interfaceMember": {
+      "oneOf": [
+        {
+          "allOf": [
+            {
+              "$ref": "members.json#/definitions/methodDefinition"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "enum": ["instance"]
+                }
+              }
+            }
+          ]
+        },
+        {
+          "$ref": "members.json#/definitions/include"
+        },
+        {
+          "$ref": "members.json#/definitions/alias"
+        }
+      ]
+    },
+    "interface": {
+      "type": "object",
+      "properties": {
+        "declaration": {
+          "enum": ["interface"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "type_params": {
+          "type": "object",
+          "properties": {
+            "params": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/moduleTypeParam"
+              }
+            }
+          },
+          "required": ["params"]
+        },
+        "members": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/interfaceMember"
+          }
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "$ref": "annotation.json"
+          }
+        },
+        "comment": {
+          "$ref": "comment.json"
+        },
+        "location": {
+          "$ref": "location.json"
+        }
+      },
+      "required": ["declaration", "name", "type_params", "members", "annotations", "comment", "location"]
+    }
+  },
+  "oneOf": [
+    {
+      "$ref": "#/definitions/alias"
+    },
+    {
+      "$ref": "#/definitions/constant"
+    },
+    {
+      "$ref": "#/definitions/global"
+    },
+    {
+      "$ref": "#/definitions/class"
+    },
+    {
+      "$ref": "#/definitions/module"
+    },
+    {
+      "$ref": "#/definitions/interface"
+    }
+  ]
+}