rbs-patch 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef229a0a3efd1a66cdc57652ef80b173d19311652f376422a06bad6d61d3c7b5
-  data.tar.gz: 364bff243f157949a91b88c936a953e88cf275589312c664df1a9f6cc2d89c40
+  metadata.gz: 84022bf98bc54075dedb17f137e45f0a1f7571146987d4efc899fe65a4c71d46
+  data.tar.gz: 6743bda0891b9fee83b1dcd39b795d69cda6d75f6a47a342e4c4c6819affd900
 SHA512:
-  metadata.gz: ad22a7fbeff8115b185977f5d21bfdbd51b53485f1e1896dc0e692fccbf6e8de82b90f499e3702343dbb579798cbe86b4ad871926aa8089763d4e1599d9c29e2
-  data.tar.gz: 2850321317aa8b97317f315b4dce55af70330c724cd279dadbd5f8b0c8f9edc3e4305dbfaeca0aa85365123caa1772b4bb7137487df4b7fbf6c9b6d9ab66c7aa
+  metadata.gz: f1280e5b1e1cce06a9af9ca899d95c8896d5c14f21c0e0e46e5ac59b09795da27f78b425efe5cff1900f566612883851f48e78696eaf9d3fb3dc93ea2fde7866
+  data.tar.gz: 35be3d68b8dcdc4ab10ac4999adf87e1b17662d68f583c9084cbf1ead2325da84ca0ebc7825430d5939722dcf72c29e12da8ba8076ddf4af1b7de81920800e62

data/README.md

@@ -143,6 +143,45 @@ class Guest
 end  # Inserts Guest class before User class
 ```
 
+### Comment Handling in `override`
+
+When `override` replaces a method, class, or module, the comment on the two sides is merged rather than always taken from one side:
+
+- If the overriding declaration has a comment, it replaces the original comment.
+- If the overriding declaration has no comment, the original comment (if any) is kept.
+
+```ruby
+p.apply(<<~RBS)
+  class User
+    # The user's display name.
+    def name: () -> String
+  end
+RBS
+
+p.apply(<<~RBS)
+  class User
+    %a{patch:override}
+    def name: () -> String?  # No comment here, so the original one is kept
+  end
+RBS
+
+# Result:
+# class User
+#   # The user's display name.
+#   def name: () -> String?
+# end
+```
+
+There is currently no way to explicitly clear an existing comment through `override` — omitting the comment always keeps the original one.
+
+> **Note:** In RBS syntax, a comment must be written *before* the annotation, not after it:
+>
+> ```ruby
+> # This comment is attached to the method
+> %a{patch:override}
+> def name: () -> String?
+> ```
+
 ### Working with Nested Modules
 
 Operations work correctly within nested module structures:

data/Steepfile

@@ -5,4 +5,5 @@ target :lib do
 
   check "lib"
   library "rbs"
+  library "prism"
 end

data/lib/rbs/patch/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   class Patch
-    VERSION = "0.1.4"
+    VERSION = "0.1.7"
   end
 end

data/lib/rbs/patch.rb

@@ -6,15 +6,21 @@ require_relative "patch/version"
 
 module RBS
   class Patch # rubocop:disable Style/Documentation
+    # @rbs! type t = ::RBS::AST::Declarations::t | ::RBS::AST::Members::t
+
     ANNOTATION_OVERRIDE       = "patch:override"
     ANNOTATION_DELETE         = "patch:delete"
     ANNOTATION_APPEND_AFTER   = /\Apatch:append_after\((.*)\)\Z/
     ANNOTATION_PREPEND_BEFORE = /\Apatch:prepend_before\((.*)\)\Z/
 
+    # @rbs @decls: Array[::RBS::AST::Declarations::t]
+
+    #: -> void
     def initialize
       @decls = []
     end
 
+    #: -> String
     def to_s
       io = ::StringIO.new
       ::RBS::Writer.new(out: io).write(@decls)
@@ -22,6 +28,7 @@ module RBS
       io.read || ""
     end
 
+    #: (?untyped? String, ?path: Pathname?) -> void
     def apply(source = nil, path: nil)
       unless path.nil?
         files = Set[]
@@ -55,6 +62,7 @@ module RBS
 
     private
 
+    #: (t decl) -> String
     def extract_name(decl)
       if decl.is_a?(::RBS::AST::Declarations::AliasDecl) # rubocop:disable Style/CaseLikeIf
         decl.new_name.to_s
@@ -70,10 +78,51 @@ module RBS
       end
     end
 
+    #: (t decl) -> (Array[AST::Declarations::Class::member] | Array[AST::Declarations::Module::member] | nil)
     def extract_members(decl)
       decl.members if decl.is_a?(::RBS::AST::Declarations::NestedDeclarationHelper)
     end
 
+    #: (t decl, ?location: untyped, ?comment: untyped) -> t
+    def update(decl, location: decl.location, comment: nil)
+      if decl.is_a?(AST::Declarations::Constant) # rubocop:disable Style/CaseLikeIf
+        AST::Declarations::Constant.new(
+          name: decl.name, type: decl.type, location: location, comment: comment || decl.comment,
+          annotations: decl.annotations
+        )
+      elsif decl.is_a?(AST::Declarations::Global)
+        AST::Declarations::Global.new(
+          name: decl.name, type: decl.type, location: location, comment: comment || decl.comment,
+          annotations: decl.annotations
+        )
+      elsif decl.is_a?(AST::Declarations::TypeAlias)
+        AST::Declarations::TypeAlias.new(
+          name: decl.name, type_params: decl.type_params, type: decl.type, annotations: decl.annotations,
+          location: location, comment: comment || decl.comment
+        )
+      elsif decl.is_a?(AST::Declarations::AliasDecl)
+        decl.class.new(
+          new_name: decl.new_name, old_name: decl.old_name, location: location, comment: comment || decl.comment,
+          annotations: decl.annotations
+        )
+      elsif decl.is_a?(AST::Members::Mixin)
+        decl.class.new(
+          name: decl.name, args: decl.args, annotations: decl.annotations, location: location,
+          comment: comment || decl.comment
+        )
+      elsif decl.is_a?(AST::Members::Alias)
+        decl.class.new(
+          new_name: decl.new_name, old_name: decl.old_name, kind: decl.kind, annotations: decl.annotations,
+          location: location, comment: comment || decl.comment
+        )
+      elsif decl.is_a?(AST::Members::Var) || decl.is_a?(AST::Members::LocationOnly)
+        decl
+      else
+        decl.update(location: location, comment: comment || decl.comment)
+      end
+    end
+
+    #: (Array[t] decls, ?Array[String] name_stack) { (t, String) -> void } -> void
     def walk(decls, name_stack = [], &block)
       decls.each do |decl|
         name_stack << extract_name(decl)
@@ -88,6 +137,7 @@ module RBS
       end
     end
 
+    #: () -> Hash[String, t]
     def decl_map
       # @type var map: Hash[String, ::RBS::Patch::t]
       map = {}
@@ -95,6 +145,7 @@ module RBS
       map
     end
 
+    #: (t decl, to: String, ?after: String?, ?before: String?) -> void
     def add(decl, to:, after: nil, before: nil)
       map = decl_map
       return if map.key?(to)
@@ -104,36 +155,56 @@ module RBS
 
       target = namespace.empty? ? @decls : extract_members(map[namespace])
 
-      if target
+      unless target
+        @decls << decl if decl.is_a?(AST::Declarations::Base)
+        return
+      end
+
+      if decl.is_a?(AST::Members::Var)
+        # AST::Members::Var does not support annotations.
+        index = target.rindex { |m| m.is_a?(decl.class) }
+        if index
+          decl = update(decl, location: target[index].location.dup)
+          target.insert(index + 1, decl)
+        else
+          index = target.find_index { |m| m.is_a?(AST::Members::MethodDefinition) }
+          if index
+            decl = update(decl, location: target[index].location.dup)
+            target.insert(index, decl)
+          else
+            target << decl
+          end
+        end
+      else
         decl.annotations.delete_if { |a| process_annotations([a]) } # steep:ignore
         if after
           index = target.find_index { |m| extract_name(m) == after }
-          if index
-            # steep:ignore:start
-            decl = decl.update(location: target[index].location.dup) if decl.respond_to?(:update) # rubocop:disable Style/RedundantSelfAssignment
-            # steep:ignore:end
-            target.insert(index + 1, decl)
-          end
+          return unless index
+
+          decl = update(decl, location: target[index].location.dup)
+          target.insert(index + 1, decl)
         elsif before
           index = target.find_index { |m| extract_name(m) == before }
-          if index
-            # steep:ignore:start
-            decl = decl.update(location: target[index].location.dup) if decl.respond_to?(:update) # rubocop:disable Style/RedundantSelfAssignment
-            # steep:ignore:end
-            target.insert(index, decl)
-          end
+          return unless index
+
+          decl = update(decl, location: target[index].location.dup)
+          target.insert(index, decl)
         else
           target << decl
         end
-      else
-        @decls << decl # steep:ignore
       end
     end
 
+    #: (String name, with: t) -> void
     def override(name, with:)
       map = decl_map
       return unless map.key?(name)
 
+      old = map[name]
+      # No way to explicitly clear a comment via override: an override without a
+      # comment always keeps the overridden one. Revisit if that's ever needed.
+      with = update(with, comment: old.comment) if with.comment.nil? && old.comment # steep:ignore
+
       sep = with.is_a?(::RBS::AST::Members::Base) ? "#" : "::"
       namespace, _, name = name.rpartition(sep)
 
@@ -151,6 +222,7 @@ module RBS
       with.annotations.delete_if { |a| process_annotations([a]) } # steep:ignore
     end
 
+    #: (String name) -> void
     def delete(name)
       map = decl_map
       return unless map.key?(name)
@@ -166,6 +238,11 @@ module RBS
       end
     end
 
+    # @rbs (Array[AST::Annotation] annotations) -> ([:override, nil]
+    #                                             | [:delte, nil]
+    #                                             | [:append_after, String]
+    #                                             | [:prepend_before, String]
+    #                                             | nil)
     def process_annotations(annotations) # steep:ignore
       if annotations.any? { |a| a.string == ANNOTATION_OVERRIDE }
         [:override, nil]

data/sig/generated/rbs/patch.rbs

@@ -0,0 +1,59 @@
+# Generated from lib/rbs/patch.rb with RBS::Inline
+
+module RBS
+  class Patch
+    type t = ::RBS::AST::Declarations::t | ::RBS::AST::Members::t
+
+    ANNOTATION_OVERRIDE: ::String
+
+    ANNOTATION_DELETE: ::String
+
+    ANNOTATION_APPEND_AFTER: ::Regexp
+
+    ANNOTATION_PREPEND_BEFORE: ::Regexp
+
+    @decls: Array[::RBS::AST::Declarations::t]
+
+    # : -> void
+    def initialize: () -> void
+
+    # : -> String
+    def to_s: () -> String
+
+    # : (?untyped? String, ?path: Pathname?) -> void
+    def apply: (?untyped? String, ?path: Pathname?) -> void
+
+    private
+
+    # : (t decl) -> String
+    def extract_name: (t decl) -> String
+
+    # : (t decl) -> (Array[AST::Declarations::Class::member] | Array[AST::Declarations::Module::member] | nil)
+    def extract_members: (t decl) -> (Array[AST::Declarations::Class::member] | Array[AST::Declarations::Module::member] | nil)
+
+    # : (t decl, ?location: untyped, ?comment: untyped) -> t
+    def update: (t decl, ?location: untyped, ?comment: untyped) -> t
+
+    # : (Array[t] decls, ?Array[String] name_stack) { (t, String) -> void } -> void
+    def walk: (Array[t] decls, ?Array[String] name_stack) { (t, String) -> void } -> void
+
+    # : () -> Hash[String, t]
+    def decl_map: () -> Hash[String, t]
+
+    # : (t decl, to: String, ?after: String?, ?before: String?) -> void
+    def add: (t decl, to: String, ?after: String?, ?before: String?) -> void
+
+    # : (String name, with: t) -> void
+    def override: (String name, with: t) -> void
+
+    # : (String name) -> void
+    def delete: (String name) -> void
+
+    # @rbs (Array[AST::Annotation] annotations) -> ([:override, nil]
+    #                                             | [:delte, nil]
+    #                                             | [:append_after, String]
+    #                                             | [:prepend_before, String]
+    #                                             | nil)
+    def process_annotations: (Array[AST::Annotation] annotations) -> ([ :override, nil ] | [ :delte, nil ] | [ :append_after, String ] | [ :prepend_before, String ] | nil)
+  end
+end

data/sig/rbs/patch.rbs

@@ -1,41 +1,5 @@
 module RBS
   class Patch
     VERSION: String
-
-    @decls: ::Array[::RBS::AST::Declarations::t]
-
-    ANNOTATION_OVERRIDE: "patch:override"
-
-    ANNOTATION_DELETE: "patch:delete"
-
-    ANNOTATION_APPEND_AFTER: ::Regexp
-
-    ANNOTATION_PREPEND_BEFORE: ::Regexp
-
-    def initialize: () -> void
-
-    def to_s: () -> String
-
-    def apply: (?untyped? String, ?path: Pathname?) -> void
-
-    type t = ::RBS::AST::Declarations::t | ::RBS::AST::Members::t
-
-    private
-
-    def extract_name: (t decl) -> String
-
-    def extract_members: (t decl) -> (Array[::RBS::AST::Declarations::Class::member] | Array[::RBS::AST::Declarations::Module::member] | nil)
-
-    def walk: (Array[t] decls, ?Array[String] name_stack) { (::RBS::AST::Declarations::t | ::RBS::AST::Members::t, String) -> void } -> void
-
-    def decl_map: () -> Hash[String, t]
-
-    def add: (t decl, to: String, ?after: String?, ?before: String?) -> void
-
-    def override: (String name, with: t) -> void
-
-    def delete: (String name) -> void
-
-    def process_annotations: (Array[::RBS::AST::Annotation] annotations) -> ([:override, nil] | [:delte, nil] | [:append_after, String] | [:prepend_before, String] | nil)
   end
 end

data/typeprof.conf.jsonc

@@ -0,0 +1,6 @@
+{
+  "typeprof_version": "experimental",
+  "rbs_dir": "sig/",
+  "analysis_unit_dirs": ["lib"]
+  // "diagnostic_severity": "warning"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs-patch
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Koji NAKAMURA
@@ -13,16 +13,16 @@ dependencies:
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: RBS::Patch manages RBS (Ruby Signature) type definitions through patches.
   It applies incremental changes to existing RBS signatures.
 email:
@@ -39,7 +39,9 @@ files:
 - exe/rbs-patch
 - lib/rbs/patch.rb
 - lib/rbs/patch/version.rb
+- sig/generated/rbs/patch.rbs
 - sig/rbs/patch.rbs
+- typeprof.conf.jsonc
 homepage: https://github.com/kozy4324/rbs-patch
 licenses:
 - MIT
@@ -63,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.14
 specification_version: 4
 summary: RBS::Patch manages RBS type definitions through patches.
 test_files: []