spoom 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff274fd4bbf10a58317e281a8e570908fc9827ff74799cb2380d3b90f032240e
-  data.tar.gz: 16d95b8b1311eade324cbd6086b7f4fd2a30a760478582571cc6f88768a593d5
+  metadata.gz: 6f26cb1e2c5649be363ee1319b601c2abe2c61d8ca2bcd335bec6ab91dba4195
+  data.tar.gz: 2284b21b3cec3a02d49d9b5fcb160c4c38c27af131addc7b2d63194f3e5a4041
 SHA512:
-  metadata.gz: 90b22051252521cf38c3ed26a4e728526e57e190f0f1cd8aca1f2574f9f6219f608f28905ab4fb6dca1d54e04834182e470f9da779d664f205d269fb6ac4c0e4
-  data.tar.gz: 3aa88be0f3edb8f2cc32d89e76ff83833f295204d3739424c6ea35dbe48db4df41a325771f840451b6bea1ed5e329ee2efaefd2c503a76ee483590f751a3017a
+  metadata.gz: c3695fa07844fcf1d2829ebfbfa030e514842a41edd7903c46b697ff60f0e76ddb9c4c8ce9098ac299c34434d4b720f32da88047c6884c67be59a02b04f3da57
+  data.tar.gz: 2e338e995b073cb7dedbbce7e8cd0f976cca8fd3cd9cee4adaac1d0eabeb24ba43d1e362b449f0f701026327c0d7bd3e4984089eadc51e26f991627d4c08c663

data/lib/spoom/cli/srb/sigs.rb

@@ -0,0 +1,90 @@
+# typed: true
+# frozen_string_literal: true
+
+require "spoom/sorbet/sigs"
+
+module Spoom
+  module Cli
+    module Srb
+      class Sigs < Thor
+        extend T::Sig
+        include Helper
+
+        desc "translate", "Translate signatures from/to RBI and RBS"
+        option :from, type: :string, aliases: :f, desc: "From format", enum: ["rbi"], default: "rbi"
+        option :to, type: :string, aliases: :t, desc: "To format", enum: ["rbs"], default: "rbs"
+        def translate(*paths)
+          from = options[:from]
+          to = options[:to]
+          files = collect_files(paths)
+
+          say("Translating signatures from `#{from}` to `#{to}` " \
+            "in `#{files.size}` file#{files.size == 1 ? "" : "s"}...\n\n")
+
+          transformed_files = transform_files(files) do |_file, contents|
+            Spoom::Sorbet::Sigs.rbi_to_rbs(contents)
+          end
+
+          say("Translated signatures in `#{transformed_files}` file#{transformed_files == 1 ? "" : "s"}.")
+        end
+
+        desc "strip", "Strip all the signatures from the files"
+        def strip(*paths)
+          files = collect_files(paths)
+
+          say("Stripping signatures from `#{files.size}` file#{files.size == 1 ? "" : "s"}...\n\n")
+
+          transformed_files = transform_files(files) do |_file, contents|
+            Spoom::Sorbet::Sigs.strip(contents)
+          end
+
+          say("Stripped signatures from `#{transformed_files}` file#{transformed_files == 1 ? "" : "s"}.")
+        end
+
+        no_commands do
+          def collect_files(paths)
+            paths << "." if paths.empty?
+
+            files = paths.flat_map do |path|
+              if File.file?(path)
+                [path]
+              else
+                Dir.glob("#{path}/**/*.rb")
+              end
+            end
+
+            if files.empty?
+              say_error("No files to transform")
+              exit(1)
+            end
+
+            files
+          end
+
+          def transform_files(files, &block)
+            transformed_count = 0
+
+            files.each do |file|
+              contents = File.read(file)
+              first_line = contents.lines.first
+
+              if first_line&.start_with?("# encoding:")
+                encoding = T.must(first_line).gsub(/^#\s*encoding:\s*/, "").strip
+                contents = contents.force_encoding(encoding)
+              end
+
+              contents = block.call(file, contents)
+              File.write(file, contents)
+              transformed_count += 1
+            rescue RBI::Error => error
+              say_warning("Can't parse #{file}: #{error.message}")
+              next
+            end
+
+            transformed_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/srb.rb

@@ -4,6 +4,7 @@
 require_relative "srb/bump"
 require_relative "srb/coverage"
 require_relative "srb/lsp"
+require_relative "srb/sigs"
 require_relative "srb/tc"
 
 module Spoom
@@ -19,6 +20,9 @@ module Spoom
         desc "bump", "Change Sorbet sigils from one strictness to another when no errors"
         subcommand "bump", Spoom::Cli::Srb::Bump
 
+        desc "sigs", "Translate signatures from/to RBI and RBS"
+        subcommand "sigs", Spoom::Cli::Srb::Sigs
+
         desc "tc", "Run typechecking with advanced options"
         subcommand "tc", Spoom::Cli::Srb::Tc
       end

data/lib/spoom/sorbet/sigs.rb

@@ -0,0 +1,173 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "rbi"
+
+module Spoom
+  module Sorbet
+    class Sigs
+      class << self
+        extend T::Sig
+
+        sig { params(ruby_contents: String).returns(String) }
+        def strip(ruby_contents)
+          sigs = collect_sigs(ruby_contents)
+          lines_to_strip = sigs.flat_map { |sig, _| (sig.loc&.begin_line..sig.loc&.end_line).to_a }
+
+          lines = []
+          ruby_contents.lines.each_with_index do |line, index|
+            lines << line unless lines_to_strip.include?(index + 1)
+          end
+          lines.join
+        end
+
+        sig { params(ruby_contents: String).returns(String) }
+        def rbi_to_rbs(ruby_contents)
+          ruby_contents = ruby_contents.dup
+          sigs = collect_sigs(ruby_contents)
+
+          sigs.each do |sig, node|
+            scanner = Scanner.new(ruby_contents)
+            start_index = scanner.find_char_position(
+              T.must(sig.loc&.begin_line&.pred),
+              T.must(sig.loc).begin_column,
+            )
+            end_index = scanner.find_char_position(
+              sig.loc&.end_line&.pred,
+              T.must(sig.loc).end_column,
+            )
+            ruby_contents[start_index...end_index] = SigTranslator.translate(sig, node)
+          end
+
+          ruby_contents
+        end
+
+        private
+
+        sig { params(ruby_contents: String).returns(T::Array[[RBI::Sig, T.any(RBI::Method, RBI::Attr)]]) }
+        def collect_sigs(ruby_contents)
+          tree = RBI::Parser.parse_string(ruby_contents)
+          visitor = SigsLocator.new
+          visitor.visit(tree)
+          visitor.sigs.sort_by { |sig, _rbs_string| -T.must(sig.loc&.begin_line) }
+        end
+      end
+
+      class SigsLocator < RBI::Visitor
+        extend T::Sig
+
+        sig { returns(T::Array[[RBI::Sig, T.any(RBI::Method, RBI::Attr)]]) }
+        attr_reader :sigs
+
+        sig { void }
+        def initialize
+          super
+          @sigs = T.let([], T::Array[[RBI::Sig, T.any(RBI::Method, RBI::Attr)]])
+        end
+
+        sig { override.params(node: T.nilable(RBI::Node)).void }
+        def visit(node)
+          return unless node
+
+          case node
+          when RBI::Method, RBI::Attr
+            node.sigs.each do |sig|
+              @sigs << [sig, node]
+            end
+          when RBI::Tree
+            visit_all(node.nodes)
+          end
+        end
+      end
+
+      class SigTranslator
+        class << self
+          extend T::Sig
+
+          sig { params(sig: RBI::Sig, node: T.any(RBI::Method, RBI::Attr)).returns(String) }
+          def translate(sig, node)
+            case node
+            when RBI::Method
+              translate_method_sig(sig, node)
+            when RBI::Attr
+              translate_attr_sig(sig, node)
+            end
+          end
+
+          private
+
+          sig { params(sig: RBI::Sig, node: RBI::Method).returns(String) }
+          def translate_method_sig(sig, node)
+            out = StringIO.new
+            p = RBI::RBSPrinter.new(out: out, indent: sig.loc&.begin_column)
+
+            if node.sigs.any?(&:is_final)
+              p.printn("# @final")
+              p.printt
+            end
+
+            if node.sigs.any?(&:is_abstract)
+              p.printn("# @abstract")
+              p.printt
+            end
+
+            if node.sigs.any?(&:is_override)
+              if node.sigs.any?(&:allow_incompatible_override)
+                p.printn("# @override(allow_incompatible: true)")
+              else
+                p.printn("# @override")
+              end
+              p.printt
+            end
+
+            if node.sigs.any?(&:is_overridable)
+              p.printn("# @overridable")
+              p.printt
+            end
+
+            p.print("#: ")
+            p.send(:print_method_sig, node, sig)
+
+            out.string
+          end
+
+          sig { params(sig: RBI::Sig, node: RBI::Attr).returns(String) }
+          def translate_attr_sig(sig, node)
+            out = StringIO.new
+            p = RBI::RBSPrinter.new(out: out)
+            p.print_attr_sig(node, sig)
+            "#: #{out.string}"
+          end
+        end
+      end
+
+      # From https://github.com/Shopify/ruby-lsp/blob/9154bfc6ef/lib/ruby_lsp/document.rb#L127
+      class Scanner
+        extend T::Sig
+
+        LINE_BREAK = T.let(0x0A, Integer)
+
+        sig { params(source: String).void }
+        def initialize(source)
+          @current_line = T.let(0, Integer)
+          @pos = T.let(0, Integer)
+          @source = T.let(source.codepoints, T::Array[Integer])
+        end
+
+        # Finds the character index inside the source string for a given line and column
+        sig { params(line: Integer, character: Integer).returns(Integer) }
+        def find_char_position(line, character)
+          # Find the character index for the beginning of the requested line
+          until @current_line == line
+            @pos += 1 until LINE_BREAK == @source[@pos]
+            @pos += 1
+            @current_line += 1
+          end
+
+          # The final position is the beginning of the line plus the requested column
+          @pos + character
+        end
+      end
+    end
+  end
+end

data/lib/spoom/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "1.5.0"
+  VERSION = "1.5.2"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Alexandre Terrasa
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.28.0
+- !ruby/object:Gem::Dependency
+  name: rbi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: sorbet-static-and-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +135,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.2
-description:
 email:
 - ruby@shopify.com
 executables:
@@ -144,6 +156,7 @@ files:
 - lib/spoom/cli/srb/bump.rb
 - lib/spoom/cli/srb/coverage.rb
 - lib/spoom/cli/srb/lsp.rb
+- lib/spoom/cli/srb/sigs.rb
 - lib/spoom/cli/srb/tc.rb
 - lib/spoom/colors.rb
 - lib/spoom/context.rb
@@ -207,6 +220,7 @@ files:
 - lib/spoom/sorbet/lsp/structures.rb
 - lib/spoom/sorbet/metrics.rb
 - lib/spoom/sorbet/sigils.rb
+- lib/spoom/sorbet/sigs.rb
 - lib/spoom/timeline.rb
 - lib/spoom/version.rb
 - lib/spoom/visitor.rb
@@ -218,7 +232,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -233,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.
 test_files: []