rbs-patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7383464ff429fa44f0303636511ef7eb418a9426122e155c787931e7d356ce79
+  data.tar.gz: 8ba1b4760aebb8fb6b9883ab7d083958a2ea042ad53cc50f765b1c303cf5d37e
+SHA512:
+  metadata.gz: 2c0e2041a6e5248c336110ffddb1fc543f9d60c7658b6b9c6e91ec9f9dff9253fb02a7791b2616c3d0d00cffa64f8fd4e879149a36599b92ea57fdd204fdb75f
+  data.tar.gz: f46c3da340a1d7e3075fb78778563cd0d7dda7ad387308baf2de32d2b90e0d063d39941c1f5ed0efd7ab3a4c17cc0a5dd87e9f0c60c9d0537f44bae5157776b4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Koji NAKAMURA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# RBS::Patch
+
+RBS::Patch manages RBS (Ruby Signature) type definitions through patches. It applies incremental changes to existing RBS signatures.
+
+## Supported Operations
+
+- **`override`**: Replace an existing method signature
+- **`delete`**: Remove a method signature
+- **`append_after`**: Insert a method signature after a specified method
+- **`prepend_before`**: Insert a method signature before a specified method
+
+All operations use RBS annotations (e.g., `%a{patch:override}`), keeping patch files valid RBS syntax.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rbs-patch
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rbs-patch
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kozy4324/rbs-patch.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/rbs-patch

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(__dir__, "../lib")
+require "rbs/patch"
+require "pathname"
+
+if ARGV.empty?
+  puts "Usage: rbs-patch RBS_FILE_PATH [RBS_FILE_PATH ...]"
+  puts ""
+  puts "Examples:"
+  puts "  rbs-patch lib/types/ sig/patches/"
+  puts "  rbs-patch base.rbs patch1.rbs patch2.rbs"
+  exit 1
+end
+
+patch = RBS::Patch.new
+ARGV.each do |arg|
+  patch.apply(path: Pathname(arg))
+end
+puts patch

data/lib/rbs/patch/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RBS
+  class Patch
+    VERSION = "0.1.0"
+  end
+end

data/lib/rbs/patch.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "rbs"
+require "stringio"
+require_relative "patch/version"
+
+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/
+
+    def initialize
+      @env = ::RBS::Environment.new
+    end
+
+    def apply(source = nil, path: nil)
+      unless path.nil?
+        files = Set[]
+        ::RBS::FileFinder.each_file(path, skip_hidden: true) do |path|
+          next if files.include?(path)
+
+          files << path
+          apply Buffer.new(name: path, content: path.read(encoding: "UTF-8"))
+        end
+        return
+      end
+
+      _, dirs, decls = ::RBS::Parser.parse_signature(source)
+      @env.add_source(::RBS::Source::RBS.new(source, dirs, decls))
+      @env.class_decls.each_value.map do |class_entry|
+        class_entry.context_decls.map { _2 }.inject do |decl_a, decl_b|
+          decl_b.members.delete_if do |member_b|
+            ope, arg = if member_b.annotations.any? { |a| a.string == ANNOTATION_OVERRIDE }
+                         [:override, nil]
+                       elsif member_b.annotations.any? { |a| a.string == ANNOTATION_DELETE }
+                         [:delete, nil]
+                       elsif (anno = member_b.annotations.find { |a| a.string.match(ANNOTATION_APPEND_AFTER) })
+                         [:append_after, anno.string.match(ANNOTATION_APPEND_AFTER)[1]]
+                       elsif (anno = member_b.annotations.find { |a| a.string.match(ANNOTATION_PREPEND_BEFORE) })
+                         [:prepend_before, anno.string.match(ANNOTATION_PREPEND_BEFORE)[1]]
+                       end
+
+            next unless ope
+
+            case ope
+            when :override
+              index = decl_a.members.find_index { |member_a| member_a.name == member_b.name }
+              if index
+                decl_a.members[index] = decl_a.members[index].update(overloads: member_b.overloads)
+                true
+              else
+                false
+              end
+            when :delete
+              decl_a.members.reject! { |member_a| member_a.name == member_b.name }
+            when :append_after, :prepend_before
+              target_name = arg.to_sym
+              index = decl_a.members.find_index { |member_a| member_a.name == target_name }
+              if index
+                if ope == :append_after
+                  offset = 1
+                  annotations = member_b.annotations.reject { |a| a.string.match(ANNOTATION_APPEND_AFTER) }
+                else
+                  offset = 0
+                  annotations = member_b.annotations.reject { |a| a.string.match(ANNOTATION_PREPEND_BEFORE) }
+                end
+                decl_a.members.insert(index + offset, member_b.update(annotations:))
+                true
+              else
+                false
+              end
+            end
+          end
+          decl_a
+        end
+      end
+    end
+
+    def to_s
+      decls = @env.class_decls.each_value.map do |class_entry|
+        decls = class_entry.context_decls.map { _2 }
+        decls.each_with_object(decls.first.update(members: [])) do |decl, new_decl|
+          # merge multiple class decls into a single one
+          new_decl.members.concat decl.members
+        end
+      end
+
+      io = ::StringIO.new
+      RBS::Writer.new(out: io).write(decls)
+      io.rewind
+      io.read
+    end
+  end
+end

data/sig/rbs/patch.rbs

@@ -0,0 +1,13 @@
+module RBS
+  class Patch
+    VERSION: String
+
+    @env: untyped
+
+    def initialize: () -> void
+
+    def apply: (String source?, path: Pathname?) -> void
+
+    def to_s: () -> String
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rbs-patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji NAKAMURA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.dev.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.dev.5
+description: RBS::Patch manages RBS (Ruby Signature) type definitions through patches.
+  It applies incremental changes to existing RBS signatures.
+email:
+- kozy4324@gmail.com
+executables:
+- rbs-patch
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/rbs-patch
+- lib/rbs/patch.rb
+- lib/rbs/patch/version.rb
+- sig/rbs/patch.rbs
+homepage: https://github.com/kozy4324/rbs-patch
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kozy4324/rbs-patch
+  source_code_uri: https://github.com/kozy4324/rbs-patch
+  changelog_uri: https://github.com/kozy4324/rbs-patch/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: RBS::Patch manages RBS type definitions through patches.
+test_files: []