rbs-patch 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a45288c145d3c26618712866de56ebeebabc1034e29960877834d5fc0518c58
-  data.tar.gz: 12ae5d9f8fcd5721f05bac232b9dd10b8de6a23c47c73eba19801e65b3b33143
+  metadata.gz: ef229a0a3efd1a66cdc57652ef80b173d19311652f376422a06bad6d61d3c7b5
+  data.tar.gz: 364bff243f157949a91b88c936a953e88cf275589312c664df1a9f6cc2d89c40
 SHA512:
-  metadata.gz: b939dc31112ba51d86e88c66b0000ac3abcf7baa9d5b57db79af3ee8003dc2cafbb90e2d6c4d08ffb53c3aebd8bb3c1d2b1bec7609911d03f7ed12105621a2b4
-  data.tar.gz: '00998b3ec8d70b87cf45177244ed9dc0e8bdb572f95eb33e07f422a137a67922a6add9ddb06a00777de1eb00aa69eb787930b2e6b33704b890064e4c1b2683c5'
+  metadata.gz: ad22a7fbeff8115b185977f5d21bfdbd51b53485f1e1896dc0e692fccbf6e8de82b90f499e3702343dbb579798cbe86b4ad871926aa8089763d4e1599d9c29e2
+  data.tar.gz: 2850321317aa8b97317f315b4dce55af70330c724cd279dadbd5f8b0c8f9edc3e4305dbfaeca0aa85365123caa1772b4bb7137487df4b7fbf6c9b6d9ab66c7aa

data/README.md

@@ -27,7 +27,160 @@ gem install rbs-patch
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+```bash
+# Apply patches to RBS files
+rbs-patch base.rbs patch1.rbs patch2.rbs
+
+# Mix files and directories
+rbs-patch lib/types/ sig/patches/
+
+# Output goes to stdout - redirect to save
+rbs-patch base.rbs patch.rbs > output.rbs
+```
+
+### Programmatic Usage
+
+```ruby
+require 'rbs/patch'
+
+p = RBS::Patch.new
+
+# Load from a single file
+p.apply(path: Pathname("sig/user.rbs"))
+
+# Load from a directory (all .rbs files)
+p.apply(path: Pathname("sig/patches"))
+
+# Apply from string
+p.apply(<<~RBS)
+  class User
+    %a{patch:override}
+    def name: () -> String?
+  end
+RBS
+
+puts p.to_s
+```
+
+### Annotation Syntax
+
+All patch operations use RBS annotations with the format `%a{patch:operation}` or `%a{patch:operation:target}`.
+
+#### Method-level Operations
+
+##### `override` - Replace existing method signature
+
+```ruby
+class User
+  %a{patch:override}
+  def name: () -> String?  # Replaces existing method signature at the same position
+end
+```
+
+##### `delete` - Remove method signature
+
+```ruby
+class User
+  %a{patch:delete}
+  def email: () -> String  # Removes this method from the class
+end
+```
+
+##### `append_after(method_name)` - Insert method after specified method
+
+```ruby
+class User
+  %a{patch:append_after(name)}
+  def nickname: () -> String?  # Inserts after the 'name' method
+end
+```
+
+##### `prepend_before(method_name)` - Insert method before specified method
+
+```ruby
+class User
+  %a{patch:prepend_before(name)}
+  def id: () -> Integer  # Inserts before the 'name' method
+end
+```
+
+#### Class/Module-level Operations
+
+##### `override` - Replace entire class/module
+
+```ruby
+%a{patch:override}
+class User
+  def name: () -> String  # Completely replaces the User class definition
+end
+```
+
+##### `delete` - Remove class/module
+
+```ruby
+%a{patch:delete}
+class User
+end  # Removes the entire User class
+```
+
+##### `append_after(ClassName)` - Insert class/module after specified class
+
+```ruby
+%a{patch:append_after(User)}
+class Admin
+  def permissions: () -> Array[String]
+end  # Inserts Admin class after User class
+```
+
+##### `prepend_before(ClassName)` - Insert class/module before specified class
+
+```ruby
+%a{patch:prepend_before(User)}
+class Guest
+  def readonly: () -> bool
+end  # Inserts Guest class before User class
+```
+
+### Working with Nested Modules
+
+Operations work correctly within nested module structures:
+
+```ruby
+module MyApp
+  module Models
+    %a{patch:append_after(User)}
+    class Admin
+      def role: () -> String
+    end
+  end
+end
+```
+
+### Merging Multiple Definitions
+
+Without annotations, multiple class definitions are merged:
+
+```ruby
+p.apply(<<~RBS)
+  class User
+    def name: () -> String
+  end
+RBS
+
+p.apply(<<~RBS)
+  class User
+    def email: () -> String  # Adds to existing User class
+  end
+RBS
+
+# Result:
+# class User
+#   def name: () -> String
+#   def email: () -> String
+# end
+```
 
 ## Development
 

data/lib/rbs/patch/version.rb

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

data/lib/rbs/patch.rb

@@ -8,8 +8,8 @@ module RBS
   class Patch # rubocop:disable Style/Documentation
     ANNOTATION_OVERRIDE       = "patch:override"
     ANNOTATION_DELETE         = "patch:delete"
-    ANNOTATION_APPEND_AFTER   = /\Apatch:append_after:(.*)\Z/
-    ANNOTATION_PREPEND_BEFORE = /\Apatch:prepend_before:(.*)\Z/
+    ANNOTATION_APPEND_AFTER   = /\Apatch:append_after\((.*)\)\Z/
+    ANNOTATION_PREPEND_BEFORE = /\Apatch:prepend_before\((.*)\)\Z/
 
     def initialize
       @decls = []
@@ -55,27 +55,35 @@ module RBS
 
     private
 
+    def extract_name(decl)
+      if decl.is_a?(::RBS::AST::Declarations::AliasDecl) # rubocop:disable Style/CaseLikeIf
+        decl.new_name.to_s
+      elsif decl.is_a?(::RBS::AST::Declarations::Base)
+        decl.name.to_s
+      elsif decl.is_a?(::RBS::AST::Members::LocationOnly)
+        ""
+      elsif decl.is_a?(::RBS::AST::Members::Alias) # rubocop:disable Lint/DuplicateBranch
+        decl.new_name.to_s
+      else # rubocop:disable Lint/DuplicateBranch
+        # ::RBS::AST::Members::t
+        decl.name.to_s
+      end
+    end
+
+    def extract_members(decl)
+      decl.members if decl.is_a?(::RBS::AST::Declarations::NestedDeclarationHelper)
+    end
+
     def walk(decls, name_stack = [], &block)
       decls.each do |decl|
-        name = if decl.is_a?(::RBS::AST::Declarations::AliasDecl) # rubocop:disable Style/CaseLikeIf
-                 decl.new_name.to_s
-               elsif decl.is_a?(::RBS::AST::Declarations::Base)
-                 decl.name.to_s
-               elsif decl.is_a?(::RBS::AST::Members::LocationOnly)
-                 ""
-               elsif decl.is_a?(::RBS::AST::Members::Alias) # rubocop:disable Lint/DuplicateBranch
-                 decl.new_name.to_s
-               else # rubocop:disable Lint/DuplicateBranch
-                 # ::RBS::AST::Members::t
-                 decl.name.to_s
-               end
-        name_stack << name
+        name_stack << extract_name(decl)
         if decl.is_a?(::RBS::AST::Members::Base)
           yield decl, "#{name_stack[..-2]&.join("::")}##{name_stack[-1]}"
         else
           yield decl, name_stack.join("::")
         end
-        walk(decl.members, name_stack, &block) if decl.is_a?(::RBS::AST::Declarations::NestedDeclarationHelper)
+        members = extract_members(decl)
+        walk(members, name_stack, &block) if members
         name_stack.pop
       end
     end
@@ -94,24 +102,32 @@ module RBS
       sep = decl.is_a?(::RBS::AST::Members::Base) ? "#" : "::"
       namespace, = to.rpartition(sep)
 
-      target = namespace.empty? ? @decls : map[namespace]&.members # steep:ignore
+      target = namespace.empty? ? @decls : extract_members(map[namespace])
 
-      # steep:ignore:start
       if target
+        decl.annotations.delete_if { |a| process_annotations([a]) } # steep:ignore
         if after
-          index = target.find_index { |m| m.name.to_s == after }
-          target.insert(index + 1, decl) if index
+          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
         elsif before
-          index = target.find_index { |m| m.name.to_s == before }
-          target.insert(index, decl) if index
+          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
         else
           target << decl
         end
-        decl.annotations.delete_if { |a| process_annotations([a]) }
       else
-        @decls << decl
+        @decls << decl # steep:ignore
       end
-      # steep:ignore:end
     end
 
     def override(name, with:)
@@ -121,19 +137,18 @@ module RBS
       sep = with.is_a?(::RBS::AST::Members::Base) ? "#" : "::"
       namespace, _, name = name.rpartition(sep)
 
-      # steep:ignore:start
       if namespace.empty?
         # top level decl
-        index = @decls.find_index { |d| d.name.to_s == name }
-        @decls[index] = with
+        index = @decls.find_index { |d| extract_name(d) == name }
+        @decls[index] = with # steep:ignore
       else
-        index = map[namespace].members.find_index do |m|
-          m.name.to_s == name
+        members = extract_members(map[namespace])
+        index = members.find_index do |m| # steep:ignore
+          extract_name(m) == name
         end
-        map[namespace].members[index] = with
+        members[index] = with # steep:ignore
       end
-      with.annotations.delete_if { |a| process_annotations([a]) }
-      # steep:ignore:end
+      with.annotations.delete_if { |a| process_annotations([a]) } # steep:ignore
     end
 
     def delete(name)
@@ -143,14 +158,12 @@ module RBS
       sep = name.index("#") ? "#" : "::"
       namespace, _, name = name.rpartition(sep)
 
-      # steep:ignore:start
       if namespace.empty?
         # top level decl
-        @decls.delete_if { |d| d.name.to_s == name }
+        @decls.delete_if { |d| extract_name(d) == name }
       else
-        map[namespace].members.delete_if { |m| m.name.to_s == name }
+        extract_members(map[namespace])&.delete_if { |m| extract_name(m) == name }
       end
-      # steep:ignore:end
     end
 
     def process_annotations(annotations) # steep:ignore

data/sig/rbs/patch.rbs

@@ -22,6 +22,10 @@ module RBS
 
     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]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs-patch
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Koji NAKAMURA