rbs-patch 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be7a77838d494748f9f51925c7d26a78a70aee45fb143942b71630c79fa31518
-  data.tar.gz: 67ad4d7de09a5a558924e609894dc19c9e2266f7b3f311008e8300f7d41c43e8
+  metadata.gz: 84022bf98bc54075dedb17f137e45f0a1f7571146987d4efc899fe65a4c71d46
+  data.tar.gz: 6743bda0891b9fee83b1dcd39b795d69cda6d75f6a47a342e4c4c6819affd900
 SHA512:
-  metadata.gz: 632f15418e48dca1b7a4f5202665a1b9248720ea267b6f49de41e3b8c3696ac3bc23f6010e22b3e9be8a551b593db3310be8ce6a93b27170590fd83c3b814637
-  data.tar.gz: 86fda57bc6b66c158b7c67c9b58dcc9f9bb4d13433204e0587e60338f8220aea9a52b386025ca48ab20eee27954b5779a2b54ab9382a05ad243918c5281610bf
+  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.6"
+    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,47 +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
 
-    def update(decl, location:)
-      if decl.respond_to?(:update)
-        # steep:ignore:start
-        decl.update(location:)
-        # steep:ignore:end
-      elsif decl.is_a?(AST::Declarations::Constant)
+    #: (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: decl.comment, annotations: decl.annotations
+          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: decl.comment, annotations: decl.annotations
+          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: decl.comment
+          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: decl.comment,
+          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: decl.comment
+          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: decl.comment
+          location: location, comment: comment || decl.comment
         )
-      else
+      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)
@@ -125,6 +137,7 @@ module RBS
       end
     end
 
+    #: () -> Hash[String, t]
     def decl_map
       # @type var map: Hash[String, ::RBS::Patch::t]
       map = {}
@@ -132,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)
@@ -142,7 +156,7 @@ module RBS
       target = namespace.empty? ? @decls : extract_members(map[namespace])
 
       unless target
-        @decls << decl # steep:ignore
+        @decls << decl if decl.is_a?(AST::Declarations::Base)
         return
       end
 
@@ -181,10 +195,16 @@ module RBS
       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)
 
@@ -202,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)
@@ -217,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,43 +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 update: (t decl, location: untyped) -> t
-
-    def walk: (Array[t] decls, ?Array[String] name_stack) { (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.6
+  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: []