spoom 1.8.1 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cbd6c18447795a6c80c58456353edf11b7a591fb745a16b69b85076dbdb283b
-  data.tar.gz: ffb8f40253e1496b180aa6cee5d4d120567f95698b7e61f2e2992a3cfd978da8
+  metadata.gz: a2abc815d0eba3a4297d4ee83c8aeb6cfa8e70bcd734785e6db51e109692cb5b
+  data.tar.gz: 7c27a7d39af33be7c307cc1055ee8ad1930a3781a32fd6e44de50e936fc84ac2
 SHA512:
-  metadata.gz: fab5f10f8233cec7793b019d427a483f8f0f71dcce16f8661cfb595388fbda72dac8d99fa3f068c4dd6aa24c16c4330bc4111108436c79d294d963b99ae88bee
-  data.tar.gz: f896ed13b17abd4e483a0a3334d0add82e199cc3c68194932b1c6ae04cfd6f6ce0a48dae475e49cfe86a3e9fe1f61a7b17aeb07f3acb040da9585e15d6e155db
+  metadata.gz: 063b6a30843d0a49533a0ae4c797370bd685e71f82887e0ed28d471a95944ff88e45602078a9b847c284cc4a447f7578c98c364b9340f4e06318701517aeb93d
+  data.tar.gz: fdcdc43a27d19ec879deb78fc9ad5fe817283444a35d8a3bc2ce027d3f3e9a704dd3780ef45138e062b7c6d83fb40f9c5291510a77dc90bf0f440c109091b927

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

@@ -3,6 +3,8 @@
 
 require "find"
 require "open3"
+require "tempfile"
+require "yaml"
 
 module Spoom
   module Cli
@@ -72,6 +74,11 @@ module Spoom
             exit(1)
           end
 
+          unless context.sorbet_config.typed_overrides.empty?
+            say_error("Cannot run `spoom bump` on a project that already uses Sorbet's `--typed-override` option")
+            exit(1)
+          end
+
           say("Checking files...")
 
           files_to_bump = context.srb_files_with_strictness(from, include_rbis: false)
@@ -90,18 +97,18 @@ module Spoom
             exit(0)
           end
 
-          Sorbet::Sigils.change_sigil_in_files(files_to_bump, to)
-
           if force
+            Sorbet::Sigils.change_sigil_in_files(files_to_bump, to) unless dry
             print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-            undo_changes(files_to_bump, from) if dry
             exit(files_to_bump.empty?)
           end
 
           error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
+          typed_override_file = create_typed_override_file(context, files_to_bump, to)
           result = begin
             T.unsafe(context).srb_tc(
               *options[:sorbet_options].split(" "),
+              "--typed-override=#{T.must(typed_override_file.path)}",
               "--error-url-base=#{error_url_base}",
               capture_err: true,
               sorbet_bin: options[:sorbet],
@@ -114,7 +121,6 @@ module Spoom
               It means one of the file bumped to `typed: #{to}` made Sorbet crash.
               Run `spoom bump -f` locally followed by `bundle exec srb tc` to investigate the problem.
             ERR
-            undo_changes(files_to_bump, from)
             exit(error.result.exit_code)
           rescue Spoom::Sorbet::Error::Killed => error
             say_error(<<~ERR, status: nil)
@@ -123,13 +129,14 @@ module Spoom
               It means Sorbet was killed while executing. Changes to files have not been applied.
               Re-run `spoom bump` to try again.
             ERR
-            undo_changes(files_to_bump, from)
             exit(error.result.exit_code)
+          ensure
+            typed_override_file.close!
           end
 
           if result.status
+            Sorbet::Sigils.change_sigil_in_files(files_to_bump, to) unless dry
             print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-            undo_changes(files_to_bump, from) if dry
             exit(files_to_bump.empty?)
           end
 
@@ -137,7 +144,6 @@ module Spoom
             # Sorbet will return exit code 100 if there are type checking errors.
             # If Sorbet returned something else, it means it didn't terminate normally.
             say_error(result.err, status: nil, nl: false)
-            undo_changes(files_to_bump, from)
             exit(1)
           end
 
@@ -156,13 +162,11 @@ module Spoom
             path
           end.compact.uniq
 
-          undo_changes(files_with_errors, from)
-
           say("Found #{errors.length} type checking error#{"s" if errors.length > 1}") if options[:count_errors]
 
           files_changed = files_to_bump - files_with_errors
+          Sorbet::Sigils.change_sigil_in_files(files_changed, to) unless dry
           print_changes(files_changed, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-          undo_changes(files_to_bump, from) if dry
           exit(files_changed.empty?)
         end
 
@@ -189,8 +193,16 @@ module Spoom
             end
           end
 
-          def undo_changes(files, from_strictness)
-            Sorbet::Sigils.change_sigil_in_files(files, from_strictness)
+          #: (Spoom::Context context, Array[String] files, String strictness) -> Tempfile
+          def create_typed_override_file(context, files, strictness)
+            relative_paths = files.map do |file|
+              relative_path = file.delete_prefix("#{context.absolute_path}/")
+              "./#{relative_path}"
+            end
+            typed_override_file = Tempfile.new(["spoom-typed-override", ".yml"])
+            typed_override_file.write(YAML.dump({ strictness => relative_paths }))
+            typed_override_file.flush
+            typed_override_file
           end
         end
       end

data/lib/spoom/deadcode/remover.rb

@@ -48,8 +48,10 @@ module Spoom
 
           node = @node_context.node
           case node
-          when Prism::ClassNode, Prism::ModuleNode, Prism::DefNode
+          when Prism::ClassNode, Prism::ModuleNode
             delete_node_and_comments_and_sigs(@node_context)
+          when Prism::DefNode
+            delete_node_and_comments_and_sigs(modifier_call_context(node) || @node_context)
           when Prism::ConstantWriteNode, Prism::ConstantOperatorWriteNode,
                 Prism::ConstantAndWriteNode, Prism::ConstantOrWriteNode,
                 Prism::ConstantPathWriteNode, Prism::ConstantPathOperatorWriteNode,
@@ -65,6 +67,47 @@ module Spoom
 
         private
 
+        # When a method is defined as the argument of a modifier call (e.g. `private def foo; end` or
+        # `private_class_method def self.foo; end`), the `def` node's parent is the call rather than the
+        # enclosing class or module body, so its sigs and comments are siblings of the call. Return a
+        # context targeting the outermost such call so they are removed together with the method.
+        #
+        # Modifiers are matched structurally rather than from a fixed list, so user-defined ones are
+        # handled too. A call only counts as a modifier when the `def` is its sole argument and it takes
+        # no block and is a standalone statement, so we never remove a call that does more than wrap
+        # the method (e.g. `register(:thing, def foo; end)` or `FOO = register(def foo; end)`).
+        #: (Prism::DefNode def_node) -> NodeContext?
+        def modifier_call_context(def_node)
+          wrapped = def_node #: Prism::Node
+          nesting = @node_context.nesting.dup
+          outer_call = nil #: Prism::CallNode?
+          outer_nesting = nil #: Array[Prism::Node]?
+
+          while (ancestor = nesting.pop)
+            case ancestor
+            when Prism::ArgumentsNode
+              # An arguments node sits between a call and its arguments, keep climbing
+              next
+            when Prism::CallNode
+              # Stop unless the call wraps the node as its sole argument and takes no block, otherwise
+              # it does more than wrap the method and we must not remove it
+              args = ancestor.arguments&.arguments
+              break if ancestor.block
+              break unless args && args.size == 1 && args.first.equal?(wrapped)
+
+              wrapped = ancestor
+              outer_call = ancestor
+              outer_nesting = nesting.dup
+            else
+              break
+            end
+          end
+          return unless outer_call && outer_nesting
+          return unless outer_nesting.last.is_a?(Prism::StatementsNode)
+
+          NodeContext.new(@old_source, @node_context.comments, outer_call, outer_nesting)
+        end
+
         #: (NodeContext context) -> void
         def delete_constant_assignment(context)
           case context.node

data/lib/spoom/rbs.rb

@@ -68,7 +68,12 @@ module Spoom
       end
     end
 
-    class Annotation < Comment; end
+    class Annotation < Comment
+      #: () -> bool
+      def abstract?
+        @string == "@abstract"
+      end
+    end
 
     class Signature < Comment
       # Locations of the `#|` continuation comment lines that make up a multiline signature,

data/lib/spoom/sorbet/config.rb

@@ -27,7 +27,7 @@ module Spoom
       DEFAULT_ALLOWED_EXTENSIONS = [".rb", ".rbi"].freeze #: Array[String]
 
       #: Array[String]
-      attr_accessor :paths, :ignore, :allowed_extensions
+      attr_accessor :paths, :ignore, :allowed_extensions, :typed_overrides
 
       #: bool
       attr_accessor :no_stdlib
@@ -37,6 +37,7 @@ module Spoom
         @paths = [] #: Array[String]
         @ignore = [] #: Array[String]
         @allowed_extensions = [] #: Array[String]
+        @typed_overrides = [] #: Array[String]
         @no_stdlib = false #: bool
       end
 
@@ -46,6 +47,7 @@ module Spoom
         @paths = @paths.dup
         @ignore = @ignore.dup
         @allowed_extensions = @allowed_extensions.dup
+        @typed_overrides = @typed_overrides.dup
       end
 
       # Returns self as a string of options that can be passed to Sorbet
@@ -66,6 +68,7 @@ module Spoom
         opts.concat(paths.map { |p| "'#{p}'" })
         opts.concat(ignore.map { |p| "--ignore '#{p}'" })
         opts.concat(allowed_extensions.map { |ext| "--allowed-extension '#{ext}'" })
+        opts.concat(typed_overrides.map { |path| "--typed-override '#{path}'" })
         opts << "--no-stdlib" if @no_stdlib
         opts.join(" ")
       end
@@ -95,6 +98,12 @@ module Spoom
             when /^--ignore=/
               config.ignore << parse_option(line)
               next
+            when /^--typed-override$/
+              state = :typed_override
+              next
+            when /^--typed-override=/
+              config.typed_overrides << parse_option(line)
+              next
             when /^--file$/
               next
             when /^--file=/
@@ -124,6 +133,8 @@ module Spoom
                 config.ignore << line
               when :extension
                 config.allowed_extensions << line
+              when :typed_override
+                config.typed_overrides << line
               when :skip
                 # nothing
               else

data/lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs/base_translator.rb

@@ -25,6 +25,7 @@ module Spoom
             end #: Integer?
 
             @overloads_strategy = options.overloads_strategy #: Symbol
+            @translate_abstract_methods = options.translate_abstract_methods #: bool
             @type_translator = RBI::RBS::TypeTranslator.new #: RBI::RBS::TypeTranslator
           end
 
@@ -141,6 +142,7 @@ module Spoom
           def rewrite_def(def_node, comments)
             return if comments.empty?
             return if comments.signatures.empty?
+            return if !@translate_abstract_methods && comments.method_annotations.any?(&:abstract?)
 
             signatures = apply_overloads_strategy(
               comments.signatures,

data/lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs/options.rb

@@ -47,13 +47,18 @@ module Spoom
           #: BaseRBIFormat
           attr_reader :output_format
 
+          #: bool
+          attr_reader :translate_abstract_methods
+
           #: (
           #|   ?overloads_strategy: Symbol,
           #|   ?output_format: BaseRBIFormat,
+          #|   ?translate_abstract_methods: bool,
           #| ) -> void
           def initialize(
             overloads_strategy: :translate_all,
-            output_format: HumanReadableRBIFormat.default
+            output_format: HumanReadableRBIFormat.default,
+            translate_abstract_methods: true
           )
             unless ALLOWED_OVERLOAD_STRATEGIES.include?(overloads_strategy)
               raise ArgumentError, "Unknown overloads_strategy: #{overloads_strategy.inspect}. " \
@@ -62,6 +67,7 @@ module Spoom
 
             @overloads_strategy = overloads_strategy
             @output_format = output_format
+            @translate_abstract_methods = translate_abstract_methods
 
             freeze
           end

data/lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb

@@ -103,10 +103,12 @@ module Spoom
           # Otherwise, replace up to the end of the node
           end_offset = comment_end_offset || node.location.end_offset
 
+          heredoc_body = heredoc_body_within_range(value, end_offset)
+
           replacement = if node.name == :bind
             "#{rbs_annotation}#{trailing_comment}"
           else
-            "#{dedent_value(node, value)} #{rbs_annotation}#{trailing_comment}"
+            "#{dedent_value(node, value)} #{rbs_annotation}#{trailing_comment}#{heredoc_body}"
           end
 
           @rewriter << Source::Replace.new(start_offset, end_offset - 1, replacement)
@@ -212,6 +214,53 @@ module Spoom
           [" #{range.pack("C*")}", end_offset]
         end
 
+        #: (Prism::Node, Integer) -> String?
+        def heredoc_body_within_range(node, replace_end_offset)
+          heredoc_end = heredoc_end_offsets(node)
+            .select { |offset| offset <= replace_end_offset }
+            .max
+          return unless heredoc_end
+
+          opener_line_end = adjust_to_line_end(node.location.end_offset)
+          body_bytes = @ruby_bytes[(opener_line_end + 1)...heredoc_end] #: as !nil
+          body = body_bytes.pack("C*")
+          body.chomp! if @ruby_bytes[replace_end_offset] == LINE_BREAK
+          "\n#{body}"
+        end
+
+        #: (Prism::Node) -> Array[Integer]
+        def heredoc_end_offsets(node)
+          offsets = [] #: Array[Integer]
+
+          case node
+          when Prism::StringNode, Prism::InterpolatedStringNode, Prism::XStringNode, Prism::InterpolatedXStringNode
+            opening = node.opening_loc
+            closing = node.closing_loc
+            if opening && closing && opening.start_line != closing.start_line && opening.slice.start_with?("<<")
+              offsets << closing.end_offset
+            end
+          end
+
+          node.child_nodes.each do |child|
+            next unless child
+
+            offsets.concat(heredoc_end_offsets(child))
+          end
+
+          offsets
+        end
+
+        #: (Prism::Node) -> bool
+        def string_literal?(node)
+          case node
+          when Prism::StringNode, Prism::InterpolatedStringNode,
+               Prism::XStringNode, Prism::InterpolatedXStringNode
+            true
+          else
+            false
+          end
+        end
+
         #: (Prism::Node, Prism::Node) -> String
         def dedent_value(assign, value)
           if value.location.start_line == assign.location.start_line
@@ -243,7 +292,7 @@ module Spoom
           # ```
           indent = value.location.start_line - assign.location.start_line
           lines = value.slice.lines
-          if lines.size > 1
+          if lines.size > 1 && !string_literal?(value)
             lines[1..]&.each_with_index do |line, i|
               lines[i + 1] = line.delete_prefix("  " * indent)
             end

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -126,9 +126,11 @@ class Spoom::Cli::Srb::Bump < ::Thor
   sig { params(directory: ::String).void }
   def bump(directory = T.unsafe(nil)); end
 
+  sig { params(context: ::Spoom::Context, files: T::Array[::String], strictness: ::String).returns(::Tempfile) }
+  def create_typed_override_file(context, files, strictness); end
+
   def help(command = T.unsafe(nil), subcommand = T.unsafe(nil)); end
   def print_changes(files, command:, from: T.unsafe(nil), to: T.unsafe(nil), dry: T.unsafe(nil), path: T.unsafe(nil)); end
-  def undo_changes(files, from_strictness); end
 end
 
 class Spoom::Cli::Srb::Coverage < ::Thor
@@ -1519,6 +1521,9 @@ class Spoom::Deadcode::Remover::NodeRemover
   end
   def insert_accessor(node, send_context, was_removed:); end
 
+  sig { params(def_node: ::Prism::DefNode).returns(T.nilable(::Spoom::Deadcode::Remover::NodeContext)) }
+  def modifier_call_context(def_node); end
+
   sig { params(start_char: ::Integer, end_char: ::Integer, replacement: ::String).void }
   def replace_chars(start_char, end_char, replacement); end
 
@@ -2575,7 +2580,11 @@ end
 module Spoom::PrismTypes; end
 Spoom::PrismTypes::AnyScopeNode = T.type_alias { T.any(::Prism::ClassNode, ::Prism::ModuleNode, ::Prism::SingletonClassNode) }
 module Spoom::RBS; end
-class Spoom::RBS::Annotation < ::Spoom::RBS::Comment; end
+
+class Spoom::RBS::Annotation < ::Spoom::RBS::Comment
+  sig { returns(T::Boolean) }
+  def abstract?; end
+end
 
 class Spoom::RBS::Comment
   sig { params(string: ::String, location: ::Prism::Location).void }
@@ -2654,6 +2663,8 @@ class Spoom::Sorbet::Config
   def paths; end
 
   def paths=(_arg0); end
+  def typed_overrides; end
+  def typed_overrides=(_arg0); end
 
   private
 
@@ -3206,10 +3217,11 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::Options
   sig do
     params(
       overloads_strategy: ::Symbol,
-      output_format: ::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseRBIFormat
+      output_format: ::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseRBIFormat,
+      translate_abstract_methods: T::Boolean
     ).void
   end
-  def initialize(overloads_strategy: T.unsafe(nil), output_format: T.unsafe(nil)); end
+  def initialize(overloads_strategy: T.unsafe(nil), output_format: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
 
   sig { returns(::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseRBIFormat) }
   def output_format; end
@@ -3217,6 +3229,9 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::Options
   sig { returns(::Symbol) }
   def overloads_strategy; end
 
+  sig { returns(T::Boolean) }
+  def translate_abstract_methods; end
+
   class << self
     sig { returns(::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::Options) }
     def default; end
@@ -3262,9 +3277,18 @@ class Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments < ::Spoom::Sorbet:
   sig { params(node: ::Prism::Node).returns(T::Boolean) }
   def has_rbs_annotation?(node); end
 
+  sig { params(node: ::Prism::Node, replace_end_offset: ::Integer).returns(T.nilable(::String)) }
+  def heredoc_body_within_range(node, replace_end_offset); end
+
+  sig { params(node: ::Prism::Node).returns(T::Array[::Integer]) }
+  def heredoc_end_offsets(node); end
+
   sig { params(node: ::Prism::Node).returns(T::Boolean) }
   def maybe_translate_assertion(node); end
 
+  sig { params(node: ::Prism::Node).returns(T::Boolean) }
+  def string_literal?(node); end
+
   sig { params(node: T.nilable(::Prism::Node)).returns(T::Boolean) }
   def t?(node); end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.3
 platform: ruby
 authors:
 - Alexandre Terrasa