rbs 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db07b9abb1ed59e789d6a13145e33503f20e37a908826c3c8ba8222f9cf79ec6
-  data.tar.gz: a42440c8542489fd70f24139f24e718b106caa99925a437857867141f730ed9a
+  metadata.gz: 391c185c91da1e233ce83cf4c9cd37f3624bfef9fbb96aa636bf9b42348bd62a
+  data.tar.gz: 21163b54afaf9e6d5a4b7638e29433511bbb3b26c62892ca4a22053d64675baa
 SHA512:
-  metadata.gz: 606289f49ac2d2934808add204997b7828708b05f2b3d60c10f8de6106cbca06527fd628de445511dfa537976fab551e878a45b5ab03ac41374cf242f90b6244
-  data.tar.gz: 5de0b5b93fd872a69fe25d62eaf72fba3fc4d93b57f04f5da311fc66d3b6eeebe53fb654cea4361da32124861ac21c1ad9547bf9e7c0012b6db704e98164a8d9
+  metadata.gz: 19aa7220827ebae3cbc653622a1041d3a65b463edacd045800d5247e2a3e30cd30cfcd5ce9296abeb03232a0497693803ed84c3e910cd9c62d104a0f59097043
+  data.tar.gz: 8eebfa6339124dc466c23a75fe6b1a90728ce916e8eab4dd8d7442055d2d2bf22fafb696ace169202b6a15888e1a059ac2f6dca25db3953e75b6e88f2b729934

data/.github/workflows/ruby.yml

@@ -12,23 +12,23 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - master-nightly-bionic 
+        - master-nightly-bionic
         - 2.6.5-bionic
         - 2.7.0-bionic
+        job:
+        - test
+        - stdlib_test
+        - rubocop validate test_doc build test_generate_stdlib
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v1
-    - name: Run test
+    - name: Install
       run: |
         ruby -v
         gem install bundler
         bin/setup
-        bundle exec rake test
-        bundle exec rake stdlib_test
-        bundle exec rake rubocop
-        bundle exec rake validate
-        bundle exec rake test_doc
-        bundle exec rake build
-        RBS_GENERATE_TEST_PATH=/tmp/Array_test.rb bundle exec rake 'generate:stdlib_test[Array]'
-        ruby -c /tmp/Array_test.rb
+    - name: Run test
+      run: |
+        bundle exec rake ${{ matrix.job }}
+      if: "!(matrix.job == 'stdlib_test' && contains(matrix.container_tag, '2.6.5'))"

data/.gitignore

@@ -6,7 +6,6 @@
 /spec/reports/
 /tmp/
 /.ruby-version
-/lib/rbs/parser.rb
 /lib/rbs/parser.output
 /vendor/sigs
 /Gemfile.lock

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master
 
+## 0.14.0 (2020-10-17)
+
+* Allow keyword names ending with `?` and `!` ([#417](https://github.com/ruby/rbs/pull/417))
+* Make `Range[T]` covariant ([#418](https://github.com/ruby/rbs/pull/418))
+
+## 0.13.1 (2020-10-09)
+
+* Fix test for CI of ruby/ruby ([#412](https://github.com/ruby/rbs/pull/412))
+
+## 0.13.0 (2020-10-09)
+
+* Signature updates for `URI` classes.
+* Fix tests ([#410](https://github.com/ruby/rbs/pull/410))
+* Add `--silent` option for `rbs validate` ([#411](https://github.com/ruby/rbs/pull/411))
+
+## 0.12.2 (2020-09-17)
+
+* Minor signature update for `pty`
+* Fix `PTY` stdlib test
+
+## 0.12.1 (2020-09-16)
+
+This version is to improve Ruby 3 testing compatibility. Nothing changed for users.
+
 ## 0.12.0 (2020-09-15)
 
 * Signature updates for `forwardable`, `struct`, `set`, `URI::Generic`, `URI::File`, and `BigDecimal`.

data/Gemfile

@@ -19,3 +19,6 @@ gem "goodcheck"
 # Test gems
 gem "rbs-amber", path: "test/assets/test-gem"
 
+group :ide, optional: true do
+  gem "ruby-debug-ide"
+end

data/README.md

@@ -74,7 +74,7 @@ $ rbs method Object then
 
 ## Library
 
-There are two important concepts, _environment_ and _definition_. 
+There are two important concepts, _environment_ and _definition_.
 
 An _environment_ is a dictionary that keeps track of all declarations. What is the declaration associated with `String` class? An _environment_ will give you the answer.
 
@@ -104,8 +104,14 @@ builder = RBS::DefinitionBuilder.new(env: environment)
 
 # Definition of instance of String
 instance = builder.build_instance(string)
-# Print the types of `gsub` method
+
+# Print the types of `gsub` method:
 puts instance.methods[:gsub].method_types.join("\n")
+# Ouputs =>
+#  (::Regexp | ::string pattern, ::string replacement) -> ::String
+#  (::Regexp | ::string pattern, ::Hash[::String, ::String] hash) -> ::String
+#  (::Regexp | ::string pattern) { (::String match) -> ::_ToS } -> ::String
+#  (::Regexp | ::string pattern) -> ::Enumerator[::String, self]
 
 # Definition of singleton of String
 singleton = builder.build_singleton(string)

data/Rakefile

@@ -25,19 +25,19 @@ task :test_doc => :parser do
 end
 
 task :validate => :parser do
-  sh "#{ruby} #{rbs} validate"
+  sh "#{ruby} #{rbs} validate --silent"
 
   FileList["stdlib/*"].each do |path|
     next if path =~ %r{stdlib/builtin}
-    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate"
+    sh "#{ruby} #{rbs} -r#{File.basename(path)} validate --silent"
   end
 end
 
 FileList["test/stdlib/**/*_test.rb"].each do |test|
-  multitask test => :parser do
+  task test => :parser do
     sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test}"
   end
-  multitask stdlib_test: test
+  task stdlib_test: test
 end
 
 task :rubocop do
@@ -176,4 +176,9 @@ namespace :generate do
   end
 end
 
+task :test_generate_stdlib do
+  sh "RBS_GENERATE_TEST_PATH=/tmp/Array_test.rb rake 'generate:stdlib_test[Array]'"
+  sh "ruby -c /tmp/Array_test.rb"
+end
+
 CLEAN.include("lib/rbs/parser.rb")

data/Steepfile

@@ -1,6 +1,7 @@
 target :lib do
   signature "sig"
   check "lib"
+  ignore "lib/rbs/parser.rb"
 
   vendor stdlib: "stdlib"
   library "set", "pathname", "json", "logger"

data/bin/annotate-with-rdoc

@@ -14,7 +14,7 @@ def format_comment(comment)
   out = RDoc::Markup::Document.new
   out << comment
   formatter = RDoc::Markup::ToMarkdown.new
-  out.accept(formatter)
+  out.accept(formatter).lines.map(&:rstrip).join("\n")
 end
 
 def comment_for_constant(decl, stores:)

data/bin/setup

@@ -6,5 +6,3 @@ set -vx
 bundle install --jobs 4 --retry 3
 
 # Do any other automated setup that you need to do here
-
-bundle exec rake parser

data/bin/test_runner.rb

@@ -2,16 +2,13 @@
 
 $LOAD_PATH << File.join(__dir__, "../lib")
 
-STDLIB_TEST = Gem::Version.new(RUBY_VERSION).yield_self do |ruby_version|
+IS_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')
 end
 
-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
+unless IS_RUBY_27
+  STDERR.puts "⚠️⚠️⚠️⚠️ stdlib test assumes Ruby 2.7 but RUBY_VERSION==#{RUBY_VERSION} ⚠️⚠️⚠️⚠️"
 end
 
 ARGV.each do |arg|

data/docs/CONTRIBUTING.md

@@ -17,6 +17,7 @@
     - Use `rbs prototype runtime --merge CLASS_NAME` command to generate the missing method definitions.
     - Committing the auto generated signatures is recommended.
 5. Annotate with RDoc.
+    - You'll need RDoc installed. Rvm users should use `rvm docs generate` first.
     - Use `bin/annotate-with-rdoc stdlib/path/to/signature.rbs` to annotate the RBS files.
     - Committing the generated annotations is recommended.
 6. Fix method types and comments.

data/goodcheck.yml

@@ -6,12 +6,12 @@ rules:
       - "stdlib/**/*.rbs"
     fail:
       - |
-        # arglists 💪👽🚨 << Delete this section   
-        #    File.absolute_path?(file_name)  ->  true or false    
+        # arglists 💪👽🚨 << Delete this section
+        #    File.absolute_path?(file_name)  ->  true or false
         #
 
   - id: rbs.no_arg
-    pattern: 
+    pattern:
       regexp: arg\d+
     message: |
       Stop using parameter names like `arg0` or `arg1`
@@ -23,7 +23,7 @@ rules:
       - Documents (comments) may contain that pattern.
     glob:
       - "stdlib/**/*.rbs"
-    fail: 
+    fail:
       - "def `send`: (String | Symbol arg0, *untyped arg1) -> untyped"
     pass:
       - "def `send`: (String | Symbol, *untyped) -> untyped"
@@ -62,4 +62,21 @@ rules:
           end
         end
 
-
+  - id: no_trailing_whitespace
+    pattern:
+      regexp: '[ \t]+$'
+    message: |
+      Trim trailing whitespaces
+    glob:
+      - '**/*.rb'
+      - '**/*.rbs'
+      - '**/*.md'
+    justification:
+      - Let the maintainers know if it is an autogenerated files.
+    pass:
+      - "Hello world"
+      - "Hello\nworld"
+      - "Hello\n\nworld"
+    fail:
+      - "Hello world  "
+      - "Hello \nworld"

data/lib/rbs/ast/comment.rb

@@ -23,7 +23,7 @@ module RBS
         { string: string, location: location }.to_json(*a)
       end
 
-      def concat(string:, location:)  
+      def concat(string:, location:)
         @string.concat string
 
         if loc = @location

data/lib/rbs/cli.rb

@@ -1,3 +1,4 @@
+require "open3"
 require "optparse"
 require "shellwords"
 
@@ -383,6 +384,11 @@ Examples:
 
   $ rbs validate
 EOU
+
+        opts.on("--silent") do
+          require "stringio"
+          @stdout = StringIO.new
+        end
       end.parse!(args)
 
       loader = EnvironmentLoader.new()
@@ -488,7 +494,7 @@ Show paths to directories where the RBS files are loaded from.
 Examples:
 
   $ rbs paths
-  $ tbs -r set paths
+  $ rbs -r set paths
 EOU
       end.parse!(args)
 
@@ -543,7 +549,7 @@ EOU
 Usage: rbs prototype runtime [options...] [pattern...]
 
 Generate RBS prototype based on runtime introspection.
-It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern]. 
+It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern].
 
 Examples:
 
@@ -808,8 +814,10 @@ EOB
         'RBS_TEST_TARGET' => (targets.join(',') unless targets.empty?)
       }
 
-      system(env_hash, *args)
-      $?
+      out, err, status = Open3.capture3(env_hash, *args)
+      stdout.print(out)
+      stderr.print(err)
+      status
     end
   end
 end

data/lib/rbs/constant.rb

@@ -2,7 +2,7 @@ module RBS
   class Constant
     attr_reader :name
     attr_reader :type
-    attr_reader :declaration
+    attr_reader :entry
 
     def initialize(name:, type:, entry:)
       @name = name

data/lib/rbs/constant_table.rb

@@ -47,6 +47,8 @@ module RBS
 
       head, *tail = split_name(name)
 
+      raise unless head
+
       head_constant = case
                       when name.absolute?
                         name_to_constant(TypeName.new(name: head, namespace: Namespace.root))
@@ -57,11 +59,13 @@ module RBS
                           resolve_constant_reference_inherit(head, scopes: constant_scopes(context.first.to_type_name))
                       end
 
-      if head_constant
-        tail.inject(head_constant) do |constant, name|
-          resolve_constant_reference_inherit name,
-                                             scopes: constant_scopes(constant.name),
-                                             no_object: constant.name != BuiltinNames::Object.name
+      tail.inject(head_constant) do |constant, name|
+        if constant
+          resolve_constant_reference_inherit(
+            name,
+            scopes: constant_scopes(constant.name),
+            no_object: constant.name != BuiltinNames::Object.name
+          )
         end
       end
     end
@@ -150,9 +154,6 @@ module RBS
       when Environment::ModuleEntry
         constant_scopes0 BuiltinNames::Module.name, scopes: scopes
         constant_scopes_module name, scopes: scopes
-
-      else
-        raise "Unexpected declaration: #{name} (#{entry.class})"
       end
 
       scopes

data/lib/rbs/definition_builder.rb

@@ -40,7 +40,7 @@ module RBS
           if s = super_class
             yield s
           end
-          
+
           self_types&.each(&block)
           included_modules&.each(&block)
           prepended_modules&.each(&block)
@@ -303,7 +303,7 @@ module RBS
             mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
             ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
           end
-        end  
+        end
       end
 
       ancestors.unshift(self_ancestor)
@@ -316,7 +316,7 @@ module RBS
             mod_ancestors = instance_ancestors(name, building_ancestors: building_ancestors)
             ancestors.unshift(*mod_ancestors.apply(arg_types, location: entry.primary.decl.location))
           end
-        end  
+        end
       end
 
       building_ancestors.pop
@@ -814,8 +814,7 @@ module RBS
 
       methods.each do |name, method|
         method.method_types.each do |method_type|
-          case method_type
-          when MethodType
+          unless name == :initialize
             result = calculator.in_method_type(method_type: method_type, variables: param_names)
 
             validate_params_with type_params, result: result do |param|

data/lib/rbs/environment.rb

@@ -13,7 +13,7 @@ module RBS
       def context
         @context ||= begin
                        (outer + [decl]).each.with_object([Namespace.root]) do |decl, array|
-                         first = array.first or raise 
+                         first = array.first or raise
                          array.unshift(first + decl.name.to_namespace)
                        end
                      end
@@ -258,6 +258,8 @@ module RBS
                 outer: outer_,
                 prefix: prefix_
               )
+            else
+              raise
             end
           end,
           location: decl.location,
@@ -288,6 +290,8 @@ module RBS
                 outer: outer_,
                 prefix: prefix_
               )
+            else
+              raise
             end
           end,
           location: decl.location,

data/lib/rbs/environment_loader.rb

@@ -9,14 +9,14 @@ module RBS
       end
     end
 
-    LibraryPath = Struct.new(:name, :path, keyword_init: true)
-    GemPath = Struct.new(:name, :version, :path, keyword_init: true)
+    LibraryPath = _ = Struct.new(:name, :path, keyword_init: true)
+    GemPath = _ = Struct.new(:name, :version, :path, keyword_init: true)
 
     attr_reader :paths
     attr_reader :stdlib_root
     attr_reader :gem_vendor_path
 
-    STDLIB_ROOT = Pathname(__dir__) + "../../stdlib"
+    STDLIB_ROOT = Pathname(_ = __dir__) + "../../stdlib"
 
     def self.gem_sig_path(name, version)
       Pathname(Gem::Specification.find_by_name(name, version).gem_dir) + "sig"
@@ -50,22 +50,20 @@ module RBS
     end
 
     def self.parse_library(lib)
-      lib.split(/:/)
+      _ = lib.split(/:/)
     end
 
     def stdlib?(name)
-      if stdlib_root
-        path = stdlib_root + name
-        if path.directory?
-          path
-        end
+      path = stdlib_root + name
+      if path.directory?
+        path
       end
     end
 
     def gem?(name, version)
-      if gem_vendor_path
+      if path = gem_vendor_path
         # Try vendored RBS first
-        gem_dir = gem_vendor_path + name
+        gem_dir = path + name
         if gem_dir.directory?
           return gem_dir
         end
@@ -76,7 +74,7 @@ module RBS
     end
 
     def each_signature(path, immediate: true, &block)
-      if block_given?
+      if block
         case
         when path.file?
           if path.extname == ".rbs" || immediate
@@ -116,6 +114,7 @@ module RBS
 
     def each_decl
       if block_given?
+        # @type var signature_files: Array[[path | :stdlib, Pathname]]
         signature_files = []
 
         unless no_builtin?
@@ -142,6 +141,7 @@ module RBS
     end
 
     def load(env:)
+      # @type var loadeds: Array[[AST::Declarations::t, Pathname, path | :stdlib]]
       loadeds = []
 
       each_decl do |decl, buffer, file_path, lib_path|