rbs 3.9.4 → 4.2.0

data/lib/rbs/annotate/rdoc_annotator.rb

@@ -13,25 +13,22 @@ module RBS
         @include_filename = true
       end
 
-      def annotate_file(path, preserve:)
-        content = path.read()
+      def annotate_file(path, preserve: true)
+        buffer, _, decls = Parser.parse_signature(path.read())
 
-        _, _, decls = Parser.parse_signature(content)
+        rewriter = Rewriter.new(buffer)
+        annotate_decls(decls, rewriter)
 
-        annotate_decls(decls)
-
-        path.open("w") do |io|
-          Writer.new(out: io).preserve!(preserve: preserve).write(decls)
-        end
+        path.write(rewriter.string)
       end
 
-      def annotate_decls(decls, outer: [])
+      def annotate_decls(decls, rewriter, outer: [])
         decls.each do |decl|
           case decl
           when AST::Declarations::Class, AST::Declarations::Module
-            annotate_class(decl, outer: outer)
+            annotate_class(decl, rewriter, outer: outer)
           when AST::Declarations::Constant
-            annotate_constant(decl, outer: outer)
+            annotate_constant(decl, rewriter, outer: outer)
           end
         end
       end
@@ -39,7 +36,9 @@ module RBS
       def each_part(subjects, tester:)
         if block_given?
           subjects.each do |subject, docs|
-            Formatter.each_part(subject.comment) do |doc|
+            comment = subject.comment
+            raise if comment.is_a?(String)
+            Formatter.each_part(comment.parse) do |doc|
               if tester.test_path(doc.file || raise)
                 yield [doc, subject]
               end
@@ -242,7 +241,7 @@ module RBS
         end
       end
 
-      def annotate_class(decl, outer:)
+      def annotate_class(decl, rewriter, outer:)
         annots = annotations(decl)
 
         full_name = resolve_name(decl.name, outer: outer)
@@ -250,7 +249,7 @@ module RBS
           text = resolve_doc_source(annots.copy_annotation, tester: annots) { doc_for_class(full_name, tester: annots) }
         end
 
-        replace_comment(decl, text)
+        replace_comment(decl, text, rewriter)
 
         unless annots.skip_all?
           outer_ = outer + [decl.name.to_namespace]
@@ -258,28 +257,28 @@ module RBS
           decl.each_member do |member|
             case member
             when AST::Members::MethodDefinition
-              annotate_method(full_name, member)
+              annotate_method(full_name, member, rewriter)
             when AST::Members::Alias
-              annotate_alias(full_name, member)
+              annotate_alias(full_name, member, rewriter)
             when AST::Members::AttrReader, AST::Members::AttrAccessor, AST::Members::AttrWriter
-              annotate_attribute(full_name, member)
+              annotate_attribute(full_name, member, rewriter)
             end
           end
 
-          annotate_decls(decl.each_decl.to_a, outer: outer_)
+          annotate_decls(decl.each_decl.to_a, rewriter, outer: outer_)
         end
       end
 
-      def annotate_constant(const, outer:)
+      def annotate_constant(const, rewriter, outer:)
         annots = Annotations.new([])
 
         full_name = resolve_name(const.name, outer: outer)
         text = doc_for_constant(full_name, tester: annots)
 
-        replace_comment(const, text)
+        replace_comment(const, text, rewriter)
       end
 
-      def annotate_alias(typename, als)
+      def annotate_alias(typename, als, rewriter)
         annots = annotations(als)
 
         unless annots.skip?
@@ -293,7 +292,7 @@ module RBS
           end
         end
 
-        replace_comment(als, text)
+        replace_comment(als, text, rewriter)
       end
 
       def join_docs(docs, separator: "----")
@@ -309,7 +308,7 @@ module RBS
         end
       end
 
-      def annotate_method(typename, method)
+      def annotate_method(typename, method, rewriter)
         annots = annotations(method)
 
         unless annots.skip?
@@ -335,10 +334,10 @@ module RBS
           }
         end
 
-        replace_comment(method, text)
+        replace_comment(method, text, rewriter)
       end
 
-      def annotate_attribute(typename, attr)
+      def annotate_attribute(typename, attr, rewriter)
         annots = annotations(attr)
 
         unless annots.skip?
@@ -366,18 +365,17 @@ module RBS
           end
         end
 
-        replace_comment(attr, text)
+        replace_comment(attr, text, rewriter)
       end
 
-      def replace_comment(commented, string)
+      def replace_comment(commented, string, rewriter)
         if string
           if string.empty?
-            commented.instance_variable_set(:@comment, nil)
+            rewriter.delete_comment(commented.comment) if commented.comment
+          elsif commented.comment
+            rewriter.replace_comment(commented.comment, content: string)
           else
-            commented.instance_variable_set(
-              :@comment,
-              AST::Comment.new(location: nil, string: string)
-            )
+            rewriter.add_comment(commented.location || raise, *commented.annotations.filter_map(&:location), content: string)
           end
         end
       end

data/lib/rbs/annotate/rdoc_source.rb

@@ -23,7 +23,7 @@ module RBS
         @stores.clear()
 
         RDoc::RI::Paths.each(with_system_dir, with_site_dir, with_home_dir, with_gems_dir ? :latest : false, *extra_dirs.map(&:to_s)) do |path, type|
-          store = RDoc::Store.new(path, type)
+          store = RDoc::Store.new(RDoc::Options.new, path:, type:)
           store.load_all
 
           @stores << store

data/lib/rbs/ast/annotation.rb

@@ -21,7 +21,7 @@ module RBS
         self.class.hash ^ string.hash
       end
 
-      def to_json(state = _ = nil)
+      def to_json(state = nil)
         { string: string, location: location }.to_json(state)
       end
     end

data/lib/rbs/ast/comment.rb

@@ -21,7 +21,7 @@ module RBS
         self.class.hash ^ string.hash
       end
 
-      def to_json(state = _ = nil)
+      def to_json(state = nil)
         { string: string, location: location }.to_json(state)
       end
     end

data/lib/rbs/ast/declarations.rb

@@ -74,7 +74,7 @@ module RBS
             self.class.hash ^ name.hash ^ args.hash
           end
 
-          def to_json(state = _ = nil)
+          def to_json(state = nil)
             {
               name: name,
               args: args,
@@ -130,7 +130,7 @@ module RBS
           self.class.hash ^ name.hash ^ type_params.hash ^ super_class.hash ^ members.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :class,
             name: name,
@@ -163,10 +163,10 @@ module RBS
           alias eql? ==
 
           def hash
-            self.class.hash ^ name.hash ^ args.hash ^ location.hash
+            self.class.hash ^ name.hash ^ args.hash
           end
 
-          def to_json(state = _ = nil)
+          def to_json(state = nil)
             {
               name: name,
               args: args,
@@ -231,7 +231,7 @@ module RBS
           self.class.hash ^ name.hash ^ type_params.hash ^ self_types.hash ^ members.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :module,
             name: name,
@@ -288,7 +288,7 @@ module RBS
           self.class.hash ^ type_params.hash ^ members.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :interface,
             name: name,
@@ -331,7 +331,7 @@ module RBS
           self.class.hash ^ name.hash ^ type_params.hash ^ type.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :alias,
             name: name,
@@ -371,7 +371,7 @@ module RBS
           self.class.hash ^ name.hash ^ type.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :constant,
             name: name,
@@ -409,7 +409,7 @@ module RBS
           self.class.hash ^ name.hash ^ type.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :global,
             name: name,
@@ -445,7 +445,7 @@ module RBS
       end
 
       class ClassAlias < AliasDecl
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :class_alias,
             new_name: new_name,
@@ -457,7 +457,7 @@ module RBS
       end
 
       class ModuleAlias < AliasDecl
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             declaration: :module_alias,
             new_name: new_name,

data/lib/rbs/ast/members.rb

@@ -35,7 +35,7 @@ module RBS
             update(method_type: self.method_type.sub(subst))
           end
 
-          def to_json(state = _ = nil)
+          def to_json(state = nil)
             {
               annotations: annotations,
               method_type: method_type
@@ -103,7 +103,7 @@ module RBS
           )
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :method_definition,
             name: name,
@@ -145,7 +145,7 @@ module RBS
       class InstanceVariable < Base
         include Var
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :instance_variable,
             name: name,
@@ -159,7 +159,7 @@ module RBS
       class ClassInstanceVariable < Base
         include Var
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :class_instance_variable,
             name: name,
@@ -173,7 +173,7 @@ module RBS
       class ClassVariable < Base
         include Var
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :class_variable,
             name: name,
@@ -215,7 +215,7 @@ module RBS
       class Include < Base
         include Mixin
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :include,
             name: name,
@@ -230,7 +230,7 @@ module RBS
       class Extend < Base
         include Mixin
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :extend,
             name: name,
@@ -245,7 +245,7 @@ module RBS
       class Prepend < Base
         include Mixin
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :prepend,
             name: name,
@@ -311,7 +311,7 @@ module RBS
       class AttrReader < Base
         include Attribute
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :attr_reader,
             name: name,
@@ -329,7 +329,7 @@ module RBS
       class AttrAccessor < Base
         include Attribute
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :attr_accessor,
             name: name,
@@ -347,7 +347,7 @@ module RBS
       class AttrWriter < Base
         include Attribute
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :attr_writer,
             name: name,
@@ -383,7 +383,7 @@ module RBS
       class Public < Base
         include LocationOnly
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           { member: :public, location: location }.to_json(state)
         end
       end
@@ -391,7 +391,7 @@ module RBS
       class Private < Base
         include LocationOnly
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           { member: :private, location: location }.to_json(state)
         end
       end
@@ -426,7 +426,7 @@ module RBS
           new_name.hash ^ old_name.hash ^ kind.hash
         end
 
-        def to_json(state = _ = nil)
+        def to_json(state = nil)
           {
             member: :alias,
             new_name: new_name,