rbs 3.3.0.pre.2 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc5c4dc317f2e52f4626a4fec99d333422d69e6e18ec9fcad02d710bf17a212
-  data.tar.gz: e9da32752089f0d923e82ee304e36751f28263adeb5893860d4f0f84f5b62caf
+  metadata.gz: 5578e86c15b544b7609720ca682e2d27015777e0a337b31cf2e5635ad8f055bc
+  data.tar.gz: e29e44859fca53e8698b4eeade30b7b9d9e0f4d17766d9d2195d24b53dc20ecb
 SHA512:
-  metadata.gz: eb722e98a22685907310de9465590da330bf86f4387fc40e65ce692a9fbbd6839d850a706ca7f489954048d40555d3040e83ffddb452494529febfcd98dbeff5
-  data.tar.gz: 2ed8a1e9a4bbb28341f5c578903a94a23ea3b6bcc95721308dcfddce514f269755f0f7baaaf2cb0a4511c7895fc39992fe2cdfe95ad33e66f045971cb137587e
+  metadata.gz: df94b11063185c3728d4590a6ca9bc46a5efd707956956f1a46cacb1c06f80e4fc4d1d92180700f6411b2a4903406f0ca328a726019895c1fdcd74deea3e3647
+  data.tar.gz: 534f7db84014b9c7030862248115cc6f263de3d7cd0d3e3349a416052c2ee0764b35925756362c0d0adc5da0330f2937c6ca0544be666b8dad8b86d5e117e36e

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 ## master
 
+## 3.3.1 (2023-11-21)
+
+### Library changes
+
+* Allow to use RBS in symlinked tree ([#1624](https://github.com/ruby/rbs/pull/1624))
+* Should escape if param name include not simple-word ([#1618](https://github.com/ruby/rbs/pull/1618))
+
+#### rbs collection
+
+* Load Bundler lazily ([#1612](https://github.com/ruby/rbs/pull/1612))
+
+### Miscellaneous
+
+* Stop using `bundle` command ([#1619](https://github.com/ruby/rbs/pull/1619))
+
+## 3.3.0 (2023-11-09)
+
+### Library changes
+
+* Stop exiting with error when syntax error detected during validation ([#1603](https://github.com/ruby/rbs/pull/1603))
+* [rbs diff] Load dependencies from manifest.yaml ([#1602](https://github.com/ruby/rbs/pull/1602))
+* [rbs diff] Resolve constants name ([#1601](https://github.com/ruby/rbs/pull/1601))
+
 ## 3.3.0.pre.2 (2023-11-02)
 
 ### Signature updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (3.3.0.pre.2)
+    rbs (3.3.1)
       abbrev
 
 PATH
@@ -83,7 +83,7 @@ GEM
     stackprof (0.2.25)
     stringio (3.0.7)
     strong_json (2.1.2)
-    tempfile (0.1.3)
+    tempfile (0.2.0)
     test-unit (3.6.1)
       power_assert
     timeout (0.4.0)

data/README.md

@@ -77,6 +77,53 @@ $ rbs methods ::Object
 $ rbs method Object then
 ```
 
+An end user of `rbs` will probably find `rbs prototype` the most useful. This command generates boilerplate signature declarations for ruby files. For example, say you have written the below ruby script.
+
+```ruby
+# person.rb
+class Person
+  attr_reader :name
+  attr_reader :contacts
+
+  def initialize(name:)
+    @name = name
+    @contacts = []
+  end
+
+  def speak
+    "I'm #{@name} and I love Ruby!"
+  end
+end
+```
+
+Running prototype on the above will automatically generate
+
+```
+$ rbs prototype rb person.rb
+class Person
+  @name: untyped
+
+  @contacts: untyped
+
+  attr_reader name: untyped
+
+  attr_reader contacts: untyped
+
+  def initialize: (name: untyped) -> void
+
+  def speak: () -> ::String
+end
+```
+
+It prints signatures for all methods, classes, instance variables, and constants.
+This is only a starting point, and you should edit the output to match your signature more accurately.
+
+`rbs prototpe` offers three options.
+
+- `rb` generates from just the available Ruby code
+- `rbi` generates from Sorbet RBI
+- `runtime` generates from runtime API
+
 ## Library
 
 There are two important concepts, _environment_ and _definition_.

data/Steepfile

@@ -8,8 +8,7 @@ target :lib do
     "lib/rbs/test.rb"
   )
 
-  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'abbrev', 'prettyprint'
-  signature 'stdlib/yaml/0'
+  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'abbrev', 'prettyprint', 'yaml'
   signature "stdlib/strscan/0/"
   signature "stdlib/optparse/0/"
   signature "stdlib/rdoc/0/"

data/lib/rbs/cli.rb

@@ -445,6 +445,7 @@ EOU
 
     def run_validate(args, options)
       stdout = stdout()
+      exit_error = false
 
       OptionParser.new do |opts|
         opts.banner = <<EOU
@@ -460,6 +461,9 @@ EOU
         opts.on("--silent") do
           stdout = StringIO.new
         end
+        opts.on("--[no-]exit-error-on-syntax-error", "exit(1) if syntax error is detected") {|bool|
+          exit_error = bool
+        }
       end.parse!(args)
 
       loader = options.loader()
@@ -632,7 +636,7 @@ EOU
         syntax_errors.each do |message|
           self.stdout.puts message
         end
-        exit(1)
+        exit 1 if exit_error
       end
     end
 
@@ -1242,6 +1246,8 @@ EOB
     end
 
     def run_collection(args, options)
+      require 'bundler'
+
       opts = collection_options(args)
       params = {}
       opts.order args.drop(1), into: params

data/lib/rbs/collection/config/lockfile_generator.rb

@@ -83,7 +83,7 @@ module RBS
         private def validate_gemfile_lock_path!(lock:, gemfile_lock_path:)
           return unless lock
           return unless lock.gemfile_lock_fullpath
-          unless lock.gemfile_lock_fullpath == gemfile_lock_path
+          unless File.realpath(lock.gemfile_lock_fullpath) == File.realpath(gemfile_lock_path)
             raise GemfileLockMismatchError.new(expected: lock.gemfile_lock_fullpath, actual: gemfile_lock_path)
           end
         end

data/lib/rbs/collection.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'bundler'
 
 require_relative './collection/sources'
 require_relative './collection/config'

data/lib/rbs/diff.rb

@@ -12,13 +12,13 @@ module RBS
     def each_diff(&block)
       return to_enum(:each_diff) unless block
 
-      before_instance_methods, before_singleton_methods, before_constant_decls = build_methods(@before_path)
-      after_instance_methods, after_singleton_methods, after_constant_decls = build_methods(@after_path)
+      before_instance_methods, before_singleton_methods, before_constant_children = build_methods(@before_path)
+      after_instance_methods, after_singleton_methods, after_constant_children = build_methods(@after_path)
 
       each_diff_methods(:instance, before_instance_methods, after_instance_methods, &block)
       each_diff_methods(:singleton, before_singleton_methods, after_singleton_methods, &block)
 
-      each_diff_constants(before_constant_decls, after_constant_decls, &block)
+      each_diff_constants(before_constant_children, after_constant_children, &block)
     end
 
     private
@@ -34,11 +34,11 @@ module RBS
       end
     end
 
-    def each_diff_constants(before_constant_decls, after_constant_decls)
-      all_keys = before_constant_decls.keys.to_set + after_constant_decls.keys.to_set
+    def each_diff_constants(before_constant_children, after_constant_children)
+      all_keys = before_constant_children.keys.to_set + after_constant_children.keys.to_set
       all_keys.each do |key|
-        before = constant_to_s(key, before_constant_decls[key]) or next
-        after = constant_to_s(key, after_constant_decls[key]) or next
+        before = constant_to_s(before_constant_children[key]) or next
+        after = constant_to_s(after_constant_children[key]) or next
         next if before == after
 
         yield before, after
@@ -52,25 +52,42 @@ module RBS
       instance_methods = begin
         builder.build_instance(@type_name).methods
       rescue => e
-        RBS.logger.warn("#{path}: #{e.message}")
-        {}
+        RBS.logger.warn("#{path}: (#{e.class}) #{e.message}")
+        {} #: Hash[Symbol, Definition::Method]
       end
       singleton_methods = begin
         builder.build_singleton(@type_name).methods
       rescue => e
-        RBS.logger.warn("#{path}: #{e.message}")
-        {}
+        RBS.logger.warn("#{path}: (#{e.class}) #{e.message}")
+        {} #: Hash[Symbol, Definition::Method]
       end
-      type_name_to_s = @type_name.to_s
-      constant_decls = env.constant_decls.select { |key| key.to_s.start_with?(type_name_to_s) }
 
-      [ instance_methods, singleton_methods, constant_decls ]
+      constant_children = begin
+        constant_resolver = RBS::Resolver::ConstantResolver.new(builder: builder)
+        constant_resolver.children(@type_name)
+      rescue => e
+        RBS.logger.warn("#{path}: (#{e.class}) #{e.message}")
+        {} #: Hash[Symbol, Constant]
+      end
+
+      [ instance_methods, singleton_methods, constant_children ]
     end
 
     def build_env(path)
       loader = @library_options.loader()
       path&.each do |dir|
-        loader.add(path: Pathname(dir))
+        dir_pathname = Pathname(dir)
+        loader.add(path: dir_pathname)
+
+        manifest_pathname = dir_pathname / 'manifest.yaml'
+        if manifest_pathname.exist?
+          manifest = YAML.safe_load(manifest_pathname.read)
+          if manifest['dependencies']
+            manifest['dependencies'].each do |dependency|
+              loader.add(library: dependency['name'], version: nil)
+            end
+          end
+        end
       end
       Environment.from_loader(loader)
     end
@@ -84,7 +101,8 @@ module RBS
         prefix = kind == :instance ? "" : "self."
 
         if definition_method.alias_of
-          "alias #{prefix}#{key} #{prefix}#{definition_method.alias_of.defs.first.member.name}"
+          first_def = definition_method.alias_of.defs.first #: Definition::Method::TypeDef
+          "alias #{prefix}#{key} #{prefix}#{first_def.member.name}"
         else
           "def #{prefix}#{key}: #{definition_method.method_types.join(" | ")}"
         end
@@ -93,9 +111,9 @@ module RBS
       end
     end
 
-    def constant_to_s(key, constant)
+    def constant_to_s(constant)
       if constant
-        "#{key}: #{constant.decl.type}"
+        "#{constant.name.name}: #{constant.type}"
       else
         +"-"
       end

data/lib/rbs/prototype/runtime/value_object_generator.rb

@@ -33,7 +33,9 @@ module RBS
         # def self.members: () -> [ :foo, :bar ]
         # def members: () -> [ :foo, :bar ]
         def build_s_members
-          [:singleton, :instance].map do |kind|
+          (
+            [:singleton, :instance] #: Array[AST::Members::MethodDefinition::kind]
+          ).map do |kind|
             AST::Members::MethodDefinition.new(
               name: :members,
               overloads: [

data/lib/rbs/resolver/constant_resolver.rb

@@ -22,7 +22,7 @@ module RBS
 
             unless name.namespace.empty?
               parent = name.namespace.to_type_name
-              table = children_table[parent] or raise
+              table = children_table[parent] or raise "#{parent} not found by #{name}"
             else
               table = toplevel
             end

data/lib/rbs/types.rb

@@ -883,7 +883,11 @@ module RBS
 
         def to_s
           if name
-            "#{type} #{name}"
+            if name.match?(/\A[a-zA-Z0-9_]+\z/)
+              "#{type} #{name}"
+            else
+              "#{type} `#{name}`"
+            end
           else
             "#{type}"
           end

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.3.0.pre.2"
+  VERSION = "3.3.1"
 end

data/sig/diff.rbs

@@ -15,9 +15,12 @@ module RBS
     def each_diff: () { (String before, String after) -> void } -> void
 
     private def each_diff_by: (Symbol kind, Hash[::Symbol, Definition::Method] before_methods, Hash[::Symbol, Definition::Method] after_methods) { (String before, String after) -> void } -> void
-    private def build_methods: (Array[String] path) -> [ Hash[::Symbol, Definition::Method], Hash[::Symbol, Definition::Method] ]
+    private def build_methods: (Array[String] path) -> [ Hash[::Symbol, Definition::Method], Hash[::Symbol, Definition::Method] , Hash[Symbol, Constant]]
     private def build_env: (Array[String] path) -> Environment
     private def build_builder: (Environment env) -> DefinitionBuilder
     private def definition_method_to_s: (Symbol key, Symbol kind, Definition::Method definition_method) -> String?
+    private def each_diff_methods: (Symbol kind, Hash[Symbol, Definition::Method], Hash[Symbol, Definition::Method]) { (String before, String after) -> void } -> void
+    private def each_diff_constants: (Hash[Symbol, Constant] before_constants, Hash[Symbol, Constant] after_constants) { (String before, String after) -> void } -> void
+    private def constant_to_s: (Constant?) -> String
   end
 end

data/sig/prototype/runtime.rbs

@@ -2,12 +2,17 @@ module RBS
   module Prototype
     class Runtime
       module Reflection
+        self.@object_class: UnboundMethod
         def self.object_class: (Module value) -> Class
 
+        self.@constants_of: UnboundMethod
         def self.constants_of: (Module mod, ?bool inherit) -> Array[Symbol]
       end
 
       module Helpers
+        @module_name_method: UnboundMethod
+        @untyped: Types::Bases::Any
+
         private
 
         def const_name: (Module const) -> String?
@@ -19,12 +24,15 @@ module RBS
 
         def to_type_name: (String name, ?full_name: bool) -> TypeName
 
-        def untyped: () -> untyped
+        def untyped: () -> Types::Bases::Any
       end
 
       class ValueObjectBase
         include Helpers
 
+        # @target_class stores the singleton object of `Data` or `Struct` subclass
+        @target_class: untyped
+
         def build_decl: () -> AST::Declarations::Class
 
         private
@@ -33,6 +41,10 @@ module RBS
 
         def build_s_members: () -> Array[AST::Members::MethodDefinition]
 
+        def build_super_class: () -> AST::Declarations::Class::Super
+
+        def add_decl_members: (AST::Declarations::Class) -> void
+
         def initialize: (Class target_class) -> void
       end
 
@@ -77,9 +89,9 @@ module RBS
 
         def skip_mixin?: (type_name: TypeName, module_name: TypeName, mixin_class: mixin_class) -> bool
 
-        def skip_singleton_method?: (module_name: TypeName, name: Symbol) -> bool
+        def skip_singleton_method?: (module_name: TypeName, method: UnboundMethod, accessibility: Definition::accessibility) -> bool
 
-        def skip_instance_method?: (module_name: TypeName, name: Symbol) -> bool
+        def skip_instance_method?: (module_name: TypeName, method: UnboundMethod, accessibility: Definition::accessibility) -> bool
 
         def skip_constant?: (module_name: String, name: Symbol) -> bool
 
@@ -147,6 +159,8 @@ module RBS
 
       def generate_module: (Module mod) -> void
 
+      def generate_mixin: (Module mod, AST::Declarations::Class | AST::Declarations::Module, TypeName, TypeName) -> void
+
       # Generate/find outer module declarations
       # This is broken down into another method to comply with `DRY`
       # This generates/finds declarations in nested form & returns the last array of declarations
@@ -158,6 +172,8 @@ module RBS
 
       def block_from_ast_of: (UnboundMethod method) -> Types::Block?
 
+      def block_from_body: (RubyVM::AbstractSyntaxTree::Node) -> Types::Block?
+
       def can_alias?: (Module, UnboundMethod) -> bool
 
       def type_params: (Module) -> Array[AST::TypeParam]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 3.3.0.pre.2
+  version: 3.3.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abbrev
@@ -505,9 +505,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: