rbs 2.4.0 → 2.5.0

data/ext/rbs_extension/lexer.h

@@ -69,7 +69,8 @@ enum TokenType {
   tBANGIDENT,       /* Identifiers ending with `!` */
   tEQIDENT,         /* Identifiers ending with `=` */
   tQIDENT,          /* Quoted identifier */
-  tOPERATOR,         /* Operator identifier */
+  pAREF_OPR,        /* [] */
+  tOPERATOR,        /* Operator identifier */
 
   tCOMMENT,         /* Comment */
   tLINECOMMENT,     /* Comment of all line */

data/ext/rbs_extension/lexer.re

@@ -19,7 +19,7 @@ start:
 
       word = [a-zA-Z0-9_];
 
-      operator = "/" | "~" | "[]" | "[]=" | "!" | "!=" | "!~" | "-" | "-@" | "+" | "+@"
+      operator = "/" | "~" | "[]=" | "!" | "!=" | "!~" | "-" | "-@" | "+" | "+@"
                | "==" | "===" | "=~" | "<<" | "<=" | "<=>" | ">" | ">=" | ">>" | "%";
 
       "("   { return next_token(state, pLPAREN); }
@@ -45,6 +45,7 @@ start:
       ":"   { return next_token(state, pCOLON); }
       "::"  { return next_token(state, pCOLON2); }
       "<"   { return next_token(state, pLT); }
+      "[]"  { return next_token(state, pAREF_OPR); }
       operator  { return next_token(state, tOPERATOR); }
 
       number = [0-9] [0-9_]*;

data/ext/rbs_extension/lexstate.c

@@ -68,6 +68,7 @@ static const char *RBS_TOKENTYPE_NAMES[] = {
   "tBANGIDENT",
   "tEQIDENT",
   "tQIDENT",          /* Quoted identifier */
+  "pAREF_OPR",        /* [] */
   "tOPERATOR",        /* Operator identifier */
 
   "tCOMMENT",

data/ext/rbs_extension/parser.c

@@ -662,6 +662,10 @@ static VALUE parse_proc_type(parserstate *state) {
 VALUE parse_record_attributes(parserstate *state) {
   VALUE hash = rb_hash_new();
 
+  if (state->next_token.type == pRBRACE) {
+    return hash;
+  }
+
   while (true) {
     VALUE key;
     VALUE type;
@@ -919,6 +923,9 @@ static VALUE parse_simple(parserstate *state) {
 
     return rbs_tuple(types, rbs_new_location(state->buffer, rg));
   }
+  case pAREF_OPR: {
+    return rbs_tuple(rb_ary_new(), rbs_new_location(state->buffer, state->current_token.range));
+  }
   case pLBRACE: {
     position start = state->current_token.range.start;
     VALUE fields = parse_record_attributes(state);
@@ -1376,6 +1383,7 @@ VALUE parse_method_name(parserstate *state, range *range) {
   case pSTAR:
   case pSTAR2:
   case pLT:
+  case pAREF_OPR:
   case tOPERATOR:
     *range = state->current_token.range;
     return ID2SYM(INTERN_TOKEN(state, state->current_token));

data/lib/rbs/ast/members.rb

@@ -68,6 +68,7 @@ module RBS
         def to_json(state = _ = nil)
           {
             member: :method_definition,
+            name: name,
             kind: kind,
             types: types,
             annotations: annotations,

data/lib/rbs/cli.rb

@@ -590,7 +590,7 @@ EOU
 
       case format
       when "rbi", "rb"
-        decls = run_prototype_file(format, args)
+        run_prototype_file(format, args)
       when "runtime"
         require_libs = []
         relative_libs = []
@@ -638,6 +638,9 @@ EOU
         end
 
         decls = Prototype::Runtime.new(patterns: args, env: env, merge: merge, owners_included: owners_included).decls
+
+        writer = Writer.new(out: stdout)
+        writer.write decls
       else
         stdout.puts <<EOU
 Usage: rbs prototype [generator...] [args...]
@@ -653,13 +656,6 @@ Examples:
 EOU
         exit 1
       end
-
-      if decls
-        writer = Writer.new(out: stdout)
-        writer.write decls
-      else
-        exit 1
-      end
     end
 
     def run_prototype_file(format, args)
@@ -667,6 +663,11 @@ EOU
                        "\n** This command does not work on this interpreter (#{RUBY_ENGINE}) **\n"
                      end
 
+      # @type var output_dir: Pathname?
+      output_dir = nil
+      # @type var base_dir: Pathname?
+      base_dir = nil
+
       opts = OptionParser.new
       opts.banner = <<EOU
 Usage: rbs prototype #{format} [files...]
@@ -680,7 +681,21 @@ Examples:
 
   $ rbs prototype rb lib/foo.rb
   $ rbs prototype rbi sorbet/rbi/foo.rbi
+
+You can run the tool in *batch* mode by passing `--out-dir` option.
+
+  $ rbs prototype rb --out-dir=sig lib/foo.rb
+  $ rbs prototype rbi --out-dir=sig/models --base-dir=app/models app/models
 EOU
+
+      opts.on("--out-dir=DIR", "Specify the path to save the generated RBS files") do |path|
+        output_dir = Pathname(path)
+      end
+
+      opts.on("--base-dir=DIR", "Specify the path to calculate the relative path to save the generated RBS files") do |path|
+        base_dir = Pathname(path)
+      end
+
       opts.parse!(args)
 
       unless has_parser?
@@ -693,18 +708,80 @@ EOU
         return nil
       end
 
-      parser = case format
-               when "rbi"
-                 Prototype::RBI.new()
-               when "rb"
-                 Prototype::RB.new()
-               end
-
-      args.each do |file|
-        parser.parse Pathname(file).read
+      new_parser = -> do
+        case format
+        when "rbi"
+          Prototype::RBI.new()
+        when "rb"
+          Prototype::RB.new()
+        end
       end
 
-      parser.decls
+      input_paths = args.map {|arg| Pathname(arg) }
+
+      if output_dir
+        # batch mode
+        input_paths.each do |path|
+          stdout.puts "Processing `#{path}`..."
+          ruby_files =
+            if path.file?
+              [path]
+            else
+              path.glob("**/*.rb").sort
+            end
+
+          ruby_files.each do |file_path|
+            stdout.puts "  Generating RBS for `#{file_path}`..."
+
+            relative_path =
+              if base_dir
+                file_path.relative_path_from(base_dir)
+              else
+                if top = file_path.descend.first
+                  case
+                  when top == Pathname("lib")
+                    file_path.relative_path_from(top)
+                  when top == Pathname("app")
+                    file_path.relative_path_from(top)
+                  else
+                    file_path
+                  end
+                else
+                  file_path
+                end
+              end
+            relative_path = relative_path.cleanpath()
+
+            if relative_path.absolute? || relative_path.descend.first&.to_s == ".."
+              stdout.puts "  ⚠️  Cannot write the RBS to outside of the output dir: `#{relative_path}`"
+              next
+            end
+
+            output_path = (output_dir + relative_path).sub_ext(".rbs")
+
+            parser = new_parser[]
+            parser.parse file_path.read()
+
+            stdout.puts "  Writing RBS to `#{output_path}`..."
+
+            (output_path.parent).mkpath
+            output_path.open("w") do |io|
+              writer = Writer.new(out: io)
+              writer.write(parser.decls)
+            end
+          end
+        end
+      else
+        # file mode
+        parser = new_parser[]
+
+        input_paths.each do |file|
+          parser.parse file.read()
+        end
+
+        writer = Writer.new(out: stdout)
+        writer.write parser.decls
+      end
     end
 
     def run_vendor(args, options)

data/lib/rbs/prototype/rb.rb

@@ -85,9 +85,14 @@ module RBS
         case node.type
         when :CLASS
           class_name, super_class, *class_body = node.children
+          super_class_name = const_to_name(super_class)
+          if super_class_name.nil?
+            # Give up detect super class e.g. `class Foo < Struct.new(:bar)`
+            super_class = nil
+          end
           kls = AST::Declarations::Class.new(
             name: const_to_name(class_name),
-            super_class: super_class && AST::Declarations::Class::Super.new(name: const_to_name(super_class), args: [], location: nil),
+            super_class: super_class && AST::Declarations::Class::Super.new(name: super_class_name, args: [], location: nil),
             type_params: [],
             members: [],
             annotations: [],
@@ -485,7 +490,7 @@ module RBS
         case node.type
         when :STR
           lit = node.children[0]
-          if lit.match?(/\A[ -~]+\z/)
+          if lit.ascii_only?
             Types::Literal.new(literal: lit, location: nil)
           else
             BuiltinNames::String.instance_type
@@ -506,7 +511,7 @@ module RBS
           lit = node.children[0]
           case lit
           when Symbol
-            if lit.match?(/\A[ -~]+\z/)
+            if lit.to_s.ascii_only?
               Types::Literal.new(literal: lit, location: nil)
             else
               BuiltinNames::Symbol.instance_type
@@ -518,15 +523,15 @@ module RBS
             Types::ClassInstance.new(name: type_name, args: [], location: nil)
           end
         when :ZLIST, :ZARRAY
-          BuiltinNames::Array.instance_type([untyped])
+          BuiltinNames::Array.instance_type(untyped)
         when :LIST, :ARRAY
           elem_types = node.children.compact.map { |e| literal_to_type(e) }
           t = types_to_union_type(elem_types)
-          BuiltinNames::Array.instance_type([t])
+          BuiltinNames::Array.instance_type(t)
         when :DOT2, :DOT3
           types = node.children.map { |c| literal_to_type(c) }
           type = range_element_type(types)
-          BuiltinNames::Range.instance_type([type])
+          BuiltinNames::Range.instance_type(type)
         when :HASH
           list = node.children[0]
           if list
@@ -554,7 +559,7 @@ module RBS
           else
             key_type = types_to_union_type(key_types)
             value_type = types_to_union_type(value_types)
-            BuiltinNames::Hash.instance_type([key_type, value_type])
+            BuiltinNames::Hash.instance_type(key_type, value_type)
           end
         when :CALL
           receiver, method_name, * = node.children

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/schema/members.json

@@ -8,6 +8,9 @@
           "type": "string",
           "enum": ["method_definition"]
         },
+        "name": {
+          "type": "string"
+        },
         "kind": {
           "enum": ["instance", "singleton", "singleton_instance"]
         },
@@ -42,7 +45,7 @@
           "enum": ["public", "private", null]
         }
       },
-      "required": ["member", "kind", "types", "comment", "annotations", "location", "visibility"]
+      "required": ["member", "name", "kind", "types", "comment", "annotations", "location", "visibility"]
     },
     "variable": {
       "title": "Declaration for instance variables and class variables",

data/steep/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.4)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,8 +23,8 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.3.2)
-    steep (0.52.2)
+    rbs (2.4.0)
+    steep (1.0.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
@@ -46,4 +46,4 @@ DEPENDENCIES
   steep
 
 BUNDLED WITH
-   2.2.22
+   2.3.14

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.