rbs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a83be097e5de26f4541a25fb744a31574d0f0b94d94848e11cae49d095693a
-  data.tar.gz: 4619e6ae9f31e32ac6d2da902b11980644df037b9d254b5919fe2eff1f43bdc7
+  metadata.gz: a5318ae7911a3e7e4e1bed761e0c7b8d1fc248e698b0d53f8a39d388da5617f0
+  data.tar.gz: d90f20d41372bcc852f49b844aa6b6b5367d9d88ec686a13ab00841f1cf1e2ed
 SHA512:
-  metadata.gz: '095abed7b0453d72a545760d8a165bb2a3415e3f741b004926b600b8e1e1260dc752e91d86d33e0c770d3011885bea1fa728708707687c59d3a1ad9707b672c7'
-  data.tar.gz: 94b3f4fc317d701c327b7519068ec590409ceff1208660c44f83440c9d3ed419c83ca29adf7137c10a1fb7c3d7ed7b0808e0a8a5fc5dedd66ca900981674ae90
+  metadata.gz: 702ae082267eb6a087e19c5a37a83aaaeea0f76e83eba7cc984a15cca869745d1b934231bf6910dbbba972a06301948eca740aa2a8fc49c378487a030befe909
+  data.tar.gz: 8f467c52d50c25886965e1762f7c52f246cb90fa313c7d0a9400051f32c7f3603ada0142cf90ebfad4b56ccbaf57bacd5d1467cb8daf20247254c90937b9c599

data/.github/workflows/ruby.yml

@@ -24,5 +24,11 @@ jobs:
         ruby -v
         gem install bundler
         bin/setup
-        bundle exec rake
+        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

data/.gitignore

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

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## master
 
+## 0.5.0 (2020-07-04)
+
+* Signature updates for `Mutex_m`, `IO`, and `Enumerable`.
+* Syntax update. [#307](https://github.com/ruby/rbs/pull/307)
+* AST command prints _absolute_ type names with file name filtering. [#312](https://github.com/ruby/rbs/pull/312)
+* Improve CLI message. [#309](https://github.com/ruby/rbs/pull/309)
+
 ## 0.4.0 (2020-06-15)
 
 * Signature update for `Fiber`, `Encoding`, and `Enumerator`.

data/Gemfile

@@ -3,4 +3,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rbs.gemspec
 gemspec
 
+# Development dependencies
+gem "rake"
+gem "minitest"
+gem "racc"
+gem "rubocop"
+gem "rubocop-rubycw"
+gem "minitest-reporters"
+gem "json"
+gem "json-schema"
+gem 'stackprof'
+
+# Test gems
 gem "rbs-amber", path: "test/assets/test-gem"

data/README.md

@@ -1,79 +1,118 @@
 # RBS
 
-RBS provides syntax and semantics definition for the `Ruby Signature` language, `.rbs` files.
-It consists of a parser, the syntax, and class definition interpreter, the semantics.
+RBS is a language to describe the structure of Ruby programs.
+You can write down the definition of a class or module: methods defined in the class, instance variables and their types, and inheritance/mix-in relations.
+It also allows declaring constants and global variables.
 
-## Build
+The following is a small example of RBS for a chat app.
 
-We haven't published a gem yet.
-You need to install the dependencies, and build its parser with `bin/setup`.
+<!-- run-start:a.rbs:bundle exec rbs -I a.rbs validate -->
+```rbs
+module ChatApp
+  VERSION: String
 
-```
-$ bin/setup
-$ bundle exec exe/rbs
-```
+  class User
+    attr_reader login: String
+    attr_reader email: String
 
-## Usage
+    def initialize: (login: String, email: String) -> void
+  end
 
-```
-$ rbs list
-$ rbs ancestors ::Object
-$ rbs methods ::Object
-$ rbs method ::Object tap
-```
+  class Bot
+    attr_reader name: String
+    attr_reader email: String
+    attr_reader owner: User
 
-### rbs list [--class|--module|--interface]
+    def initialize: (name: String, owner: User) -> void
+  end
 
-```
-$ rbs list
-```
+  class Message
+    attr_reader id: String
+    attr_reader string: String
+    attr_reader from: User | Bot                     # `|` means union types: `#from` can be `User` or `Bot`
+    attr_reader reply_to: Message?                   # `?` means optional type: `#reply_to` can be `nil`
 
-This command lists all of the classes/modules/interfaces defined in `.rbs` files.
+    def initialize: (from: User | Bot, string: String) -> void
 
-### rbs ancestors [--singleton|--instance] CLASS
+    def reply: (from: User | Bot, string: String) -> Message
+  end
 
+  class Channel
+    attr_reader name: String
+    attr_reader messages: Array[Message]
+    attr_reader users: Array[User]
+    attr_reader bots: Array[Bot]
+
+    def initialize: (name: String) -> void
+
+    def each_member: () { (User | Bot) -> void } -> void  # `{` and `}` means block.
+                   | () -> Enumerable[User | Bot, void]   # Method can be overloaded.
+  end
+end
 ```
-$ rbs ancestors Array                    # ([].class.ancestors)
-$ rbs ancestors --singleton Array        # (Array.class.ancestors)
-```
+<!-- run-end -->
 
-This command prints the _ancestors_ of the class.
-The name of the command is borrowed from `Class#ancestors`, but the semantics is a bit different.
-The `ancestors` command is more precise (I believe).
+## Installation
 
-### rbs methods [--singleton|--instance] CLASS
+Install the `rbs` gem. `$ gem install rbs` from the command line, or add a line in your `Gemfile`.
 
-```
-$ rbs methods ::Integer                  # 1.methods
-$ rbs methods --singleton ::Object       # Object.methods
+```rb
+gem "rbs"
 ```
 
-This command prints all methods provided for the class.
+## CLI
 
-### rbs method [--singleton|--instance] CLASS METHOD
+The gem ships with the `rbs` command line tool to demonstrate what it can do and help develop RBS.
 
-```
-$ rbs method ::Integer '+'               # 1+2
-$ rbs method --singleton ::Object tap    # Object.tap { ... }
+```bash
+$ rbs version
+$ rbs list
+$ rbs ancestors ::Object
+$ rbs methods ::Object
+$ rbs method Object then
 ```
 
-This command prints type and properties of the method.
+## Library
 
-### Options
+There are two important concepts, _environment_ and _definition_. 
 
-It accepts two global options, `-r` and `-I`.
+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.
 
-`-r` is for libraries. You can specify the names of libraries.
+A _definition_ gives you the detail of the class. What is the type of the return value of `gsub` method of the `String` class? The _definition_ for `String` class knows the list of methods it provides and their types.
 
-```
-$ rbs -r set list
-```
+The following is a small code to retrieve the definition of the `String#gsub` method.
 
-`-I` is for application signatures. You can specify the name of directory.
+<!-- run-start:a.rb:bundle exec ruby a.rb -->
+```rb
+require "rbs"
 
+loader = RBS::EnvironmentLoader.new()
+
+# loader.add(path: Pathname("sig"))   # Load .rbs files from `sig` directory
+# loader.add(library: "pathname")     # Load pathname library
+
+environment = RBS::Environment.from_loader(loader).resolve_type_names
+
+# ::String
+string = RBS::TypeName.new(name: :String, namespace: RBS::Namespace.root)
+
+# Class declaration for ::String
+decl = environment.class_decls[string]
+
+# Builder provides the translation from `declaration` to `definition`
+builder = RBS::DefinitionBuilder.new(env: environment)
+
+# Definition of instance of String
+instance = builder.build_instance(string)
+# Print the types of `gsub` method
+puts instance.methods[:gsub].method_types.join("\n")
+
+# Definition of singleton of String
+singleton = builder.build_singleton(string)
+# No `gsub` method for String singleton
+puts singleton.methods[:gsub]
 ```
-$ rbs -I sig list
-```
+<!-- run-end -->
 
 ## Guides
 

data/Rakefile

@@ -9,10 +9,23 @@ Rake::TestTask.new(:test) do |t|
   end
 end
 
-multitask :default => [:test, :stdlib_test, :rubocop, :validate]
+multitask :default => [:test, :stdlib_test, :rubocop, :validate, :test_doc]
+
+task :test_doc => :parser do
+  files = Dir.chdir(File.expand_path('..', __FILE__)) 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(" ")}"
+end
 
 task :validate => :parser do
   sh "rbs validate"
+
+  FileList["stdlib/*"].each do |path|
+    next if path =~ %r{stdlib/builtin}
+    sh "rbs -r#{File.basename(path)} validate"
+  end
 end
 
 FileList["test/stdlib/**/*_test.rb"].each do |test|
@@ -41,7 +54,7 @@ namespace :generate do
       raise "Class name is necessary. e.g. rake 'generate:stdlib_test[String]'"
     end
 
-    path = Pathname("test/stdlib/#{klass}_test.rb")
+    path = Pathname(ENV["RBS_GENERATE_TEST_PATH"] || "test/stdlib/#{klass}_test.rb")
     raise "#{path} already exists!" if path.exist?
 
     require "erb"
@@ -53,35 +66,55 @@ namespace :generate do
       def initialize(klass)
         @klass = klass
 
-        @env = Ruby::Signature::Environment.new
-        Ruby::Signature::EnvironmentLoader.new.load(env: @env)
+        loader = RBS::EnvironmentLoader.new
+        Dir['stdlib/*'].each do |lib|
+          next if lib.end_with?('builtin')
+
+          loader.add(library: File.basename(lib))
+        end
+        @env = RBS::Environment.from_loader(loader).resolve_type_names
       end
 
       def call
         ERB.new(<<~ERB, trim_mode: "-").result(binding)
           require_relative "test_helper"
+          require 'rbs/test/test_helper'
+
+          <%- unless class_methods.empty? -%>
+          class <%= klass %>SingletonTest < Minitest::Test
+            include RBS::Test::TypeAssertions
 
-          class <%= klass %>Test < StdlibTest
-            target <%= klass %>
             # library "pathname", "set", "securerandom"     # Declare library signatures to load
-            using hook.refinement
+            testing "singleton(::<%= klass %>)"
+
           <%- class_methods.each do |method_name, definition| %>
-            def test_class_method_<%= test_name_for(method_name) %>
-            <%- definition.method_types.each do |method_type| -%>
-              # <%= method_type %>
-              <%= klass %>.<%= method_name %>
-            <%- end -%>
+            def test_<%= test_name_for(method_name) %>
+          <%- definition.method_types.each do |method_type| -%>
+              assert_send_type  "<%= method_type %>",
+                                <%= klass %>, :<%= method_name %>
+          <%- end -%>
             end
           <%- end -%>
+          end
+          <%- end -%>
+
+          <%- unless instance_methods.empty? -%>
+          class <%= klass %>Test < Minitest::Test
+            include RBS::Test::TypeAssertions
+
+            # library "pathname", "set", "securerandom"     # Declare library signatures to load
+            testing "::<%= klass %>"
+
           <%- instance_methods.each do |method_name, definition| %>
             def test_<%= test_name_for(method_name) %>
-            <%- definition.method_types.each do |method_type| -%>
-              # <%= method_type %>
-              <%= klass %>.new.<%= method_name %>
-            <%- end -%>
+          <%- definition.method_types.each do |method_type| -%>
+              assert_send_type  "<%= method_type %>",
+                                <%= klass %>.new, :<%= method_name %>
+          <%- end -%>
             end
           <%- end -%>
           end
+          <%- end -%>
         ERB
       end
 
@@ -117,18 +150,18 @@ namespace :generate do
       end
 
       def type_name
-        @type_name ||= Ruby::Signature::TypeName.new(name: klass.to_sym, namespace: Ruby::Signature::Namespace.new(path: [], absolute: true))
+        @type_name ||= RBS::TypeName.new(name: klass.to_sym, namespace: RBS::Namespace.new(path: [], absolute: true))
       end
 
       def class_methods
-        @class_methods ||= Ruby::Signature::DefinitionBuilder.new(env: env).build_singleton(type_name).methods.select {|_, definition|
-          definition.implemented_in.name.absolute! == type_name
+        @class_methods ||= RBS::DefinitionBuilder.new(env: env).build_singleton(type_name).methods.select {|_, definition|
+          definition.implemented_in == type_name
         }
       end
 
       def instance_methods
-        @instance_methods ||= Ruby::Signature::DefinitionBuilder.new(env: env).build_instance(type_name).methods.select {|_, definition|
-          definition.implemented_in.name.absolute! == type_name
+        @instance_methods ||= RBS::DefinitionBuilder.new(env: env).build_instance(type_name).methods.select {|_, definition|
+          definition.implemented_in == type_name
         }
       end
     end

data/bin/rbs-prof

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "stackprof"
+
+out = ENV["RBS_STACKPROF_OUT"] || 'tmp/stackprof-cpu-rbs.dump'
+
+StackProf.run(mode: :cpu, out: out) do
+  load File.join(__dir__, "../exe/rbs")
+end

data/bin/run_in_md.rb

@@ -0,0 +1,49 @@
+require "tmpdir"
+require "shellwords"
+
+ARGV.each do |path|
+  puts "~~~~~~~ Checking #{path} ~~~~~~"
+  content = File.read(path)
+
+  snippets = []
+  lines = []
+  content.lines.each.with_index do |line, index|
+    case line
+    when /run-start:/
+      lines = [[line, index+1]]
+    when /run-end/
+      lines << [line, index+1]
+      snippets << lines
+      lines = []
+    else
+      lines << [line, index+1]
+    end
+  end
+
+  snippets.each do |lines|
+    puts ">>> Code detected: "
+    hd, _, *code_lines, _, _ = lines
+
+    head = hd[0]
+    head.gsub!(/^<!-- +/, "").gsub!(/ +-->$/, "")
+    _,name,command = head.split(/:/)
+
+    puts "# command=#{Shellwords.split(command).inspect}"
+    puts "# name=#{name}"
+    puts code_lines.map {|line, i| "#{"%4d" % i}  #{line}" }.join
+
+    code = code_lines.map(&:first).join
+
+    puts ">>> Running..."
+    Dir.mktmpdir do |dir|
+      File.write(File.join(dir, name), code)
+      pid = spawn({ "BUNDLE_GEMFILE" => File.join(__dir__, "../Gemfile") },
+                  *Shellwords.split(command),
+                  chdir: dir)
+
+      _, status = Process.waitpid2(pid)
+
+      status.success? or raise "Failed to execute code: #{code_lines.join}"
+    end
+  end
+end

data/lib/rbs.rb

@@ -32,8 +32,10 @@ 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"
 
 begin
   require "rbs/parser"

data/lib/rbs/ast/declarations.rb

@@ -1,6 +1,9 @@
 module RBS
   module AST
     module Declarations
+      class Base
+      end
+
       class ModuleTypeParams
         attr_reader :params
 
@@ -77,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
@@ -105,6 +154,9 @@ module RBS
           end
         end
 
+        include NestedDeclarationHelper
+        include MixinHelper
+
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
@@ -151,7 +203,10 @@ module RBS
         end
       end
 
-      class Module
+      class Module < Base
+        include NestedDeclarationHelper
+        include MixinHelper
+
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
@@ -198,7 +253,7 @@ module RBS
         end
       end
 
-      class Extension
+      class Extension < Base
         attr_reader :name
         attr_reader :type_params
         attr_reader :extension_name
@@ -245,7 +300,7 @@ module RBS
         end
       end
 
-      class Interface
+      class Interface < Base
         attr_reader :name
         attr_reader :type_params
         attr_reader :members
@@ -288,7 +343,7 @@ module RBS
         end
       end
 
-      class Alias
+      class Alias < Base
         attr_reader :name
         attr_reader :type
         attr_reader :annotations
@@ -327,7 +382,7 @@ module RBS
         end
       end
 
-      class Constant
+      class Constant < Base
         attr_reader :name
         attr_reader :type
         attr_reader :location
@@ -363,7 +418,7 @@ module RBS
         end
       end
 
-      class Global
+      class Global < Base
         attr_reader :name
         attr_reader :type
         attr_reader :location