ruby-lsp-refactor 0.1.1 → 0.1.2

data/test/ruby_lsp_refactor/extract_predicate_listener_test.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class ExtractPredicateListenerTest < Minitest::Test
+      include RubyLsp::Refactor::TestHelper
+
+      def find_action(actions, title)
+        actions.find { |a| a.title == title }
+      end
+
+      def all_edits(action)
+        action.edit.changes.values.flatten
+      end
+
+      # ── core acceptance ────────────────────────────────────────────────────
+
+      def test_extracts_and_compound_into_predicate_methods
+        source = <<~RUBY
+          def eligible_for_return?
+            expired_orders.exclude?(self) && self.value > MINIMUM_RETURN_VALUE
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 1)
+        action  = find_action(actions, "Extract predicate methods")
+        refute_nil action
+
+        edits = all_edits(action)
+        assert_equal 2, edits.size
+
+        replace_edit = edits.find { |e| e.new_text.include?("predicate_1?") && e.new_text.include?("&&") }
+        insert_edit  = edits.find { |e| e.new_text.include?("def predicate_1?") }
+
+        refute_nil replace_edit
+        refute_nil insert_edit
+
+        assert_match(/predicate_1\? && predicate_2\?/, replace_edit.new_text)
+        assert_match(/def predicate_1\?/, insert_edit.new_text)
+        assert_match(/expired_orders\.exclude\?\(self\)/, insert_edit.new_text)
+        assert_match(/def predicate_2\?/, insert_edit.new_text)
+        assert_match(/self\.value > MINIMUM_RETURN_VALUE/, insert_edit.new_text)
+      end
+
+      def test_extracts_or_compound_into_predicate_methods
+        source = <<~RUBY
+          def should_notify?
+            user.admin? || user.subscribed?
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 1)
+        action  = find_action(actions, "Extract predicate methods")
+        refute_nil action
+
+        edits = all_edits(action)
+        replace_edit = edits.find { |e| e.new_text.include?("||") }
+        insert_edit  = edits.find { |e| e.new_text.include?("def predicate_1?") }
+
+        refute_nil replace_edit
+        refute_nil insert_edit
+        assert_match(/predicate_1\? \|\| predicate_2\?/, replace_edit.new_text)
+        assert_match(/user\.admin\?/, insert_edit.new_text)
+        assert_match(/user\.subscribed\?/, insert_edit.new_text)
+      end
+
+      def test_inserts_private_section_after_def
+        source = <<~RUBY
+          def eligible?
+            a? && b?
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 1)
+        action  = find_action(actions, "Extract predicate methods")
+        refute_nil action
+
+        edits = all_edits(action)
+        insert_edit = edits.find { |e| e.new_text.include?("def predicate_1?") }
+        assert_match(/private/, insert_edit.new_text)
+      end
+
+      # ── negative cases ─────────────────────────────────────────────────────
+
+      def test_does_not_offer_when_method_has_multiple_statements
+        source = <<~RUBY
+          def process
+            validate!
+            a? && b?
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 2)
+        assert_nil find_action(actions, "Extract predicate methods")
+      end
+
+      def test_does_not_offer_outside_a_method
+        source = "a? && b?\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Extract predicate methods")
+      end
+
+      # ── resilience ─────────────────────────────────────────────────────────
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

data/test/ruby_lsp_refactor/method_listener_test.rb

@@ -17,56 +17,7 @@ module RubyLsp
       end
 
       # ===========================================================================
-      # 1. Extract to method
-      # ===========================================================================
-
-      def test_extract_to_method_replaces_rhs_and_inserts_new_method
-        source = <<~RUBY
-          def process
-            result = expensive_computation
-          end
-        RUBY
-
-        actions = code_actions_for(source, line: 1)
-        action  = find_action(actions, /Extract to method/)
-        refute_nil action
-
-        edits = all_edits(action)
-        assert_equal 2, edits.size
-
-        replace_edit = edits.find { |e| e.new_text.include?("result") && !e.new_text.include?("def") }
-        insert_edit  = edits.find { |e| e.new_text.include?("def result") }
-
-        refute_nil replace_edit, "Expected an edit replacing the RHS with a method call"
-        refute_nil insert_edit,  "Expected an edit inserting the new method definition"
-
-        assert_match(/def result/, insert_edit.new_text)
-        assert_match(/expensive_computation/, insert_edit.new_text)
-      end
-
-      def test_extract_to_method_passes_outer_variables_as_params
-        source = <<~RUBY
-          def process(data)
-            threshold = 10
-            result = data.select { |x| x > threshold }
-          end
-        RUBY
-
-        # Cursor on the `result =` line (line 2).
-        actions = code_actions_for(source, line: 2)
-        action  = find_action(actions, /Extract to method/)
-        refute_nil action
-
-        edits = all_edits(action)
-        insert_edit = edits.find { |e| e.new_text.include?("def result") }
-        refute_nil insert_edit
-
-        # `threshold` was defined before the extraction point and is used in the RHS.
-        assert_match(/def result\(threshold\)/, insert_edit.new_text)
-      end
-
-      # ===========================================================================
-      # 2. Add parameter
+      # 1. Add parameter
       # ===========================================================================
 
       def test_add_parameter_appends_to_existing_params
@@ -106,7 +57,7 @@ module RubyLsp
       end
 
       # ===========================================================================
-      # 3. Convert to keyword arguments
+      # 2. Convert to keyword arguments
       # ===========================================================================
 
       def test_converts_positional_params_to_kwargs
@@ -139,7 +90,7 @@ module RubyLsp
       end
 
       # ===========================================================================
-      # 4. Extract to let (RSpec)
+      # 3. Extract to let (RSpec)
       # ===========================================================================
 
       def test_extract_to_let_inserts_let_block_and_removes_assignment

data/test/ruby_lsp_refactor/tap_listener_test.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class TapListenerTest < Minitest::Test
+      include RubyLsp::Refactor::TestHelper
+
+      def find_action(actions, title)
+        actions.find { |a| a.title == title }
+      end
+
+      def single_edit(action)
+        edits = action.edit.changes.values.flatten
+        assert_equal 1, edits.size
+        edits.first
+      end
+
+      # ── core acceptance ────────────────────────────────────────────────────
+
+      def test_converts_sequence_to_tap
+        source = <<~RUBY
+          def do_something
+            obj.do_first_thing
+            obj.do_second_thing
+            obj.do_third_thing
+            obj
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert to tap")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/obj\.tap do \|o\|/, edit.new_text)
+        assert_match(/o\.do_first_thing/, edit.new_text)
+        assert_match(/o\.do_second_thing/, edit.new_text)
+        assert_match(/o\.do_third_thing/, edit.new_text)
+        assert_match(/end/, edit.new_text)
+        refute_match(/\bobj\b(?!\.tap)/, edit.new_text.sub("obj.tap", ""))
+      end
+
+      def test_preserves_method_arguments
+        source = <<~RUBY
+          def setup
+            user.assign_role(:admin)
+            user.set_name("Alice")
+            user
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert to tap")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/user\.tap do \|o\|/, edit.new_text)
+        assert_match(/o\.assign_role\(:admin\)/, edit.new_text)
+        assert_match(/o\.set_name\("Alice"\)/, edit.new_text)
+      end
+
+      def test_preserves_indentation
+        source = <<~RUBY
+          class Builder
+            def build
+              obj.step_one
+              obj.step_two
+              obj
+            end
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 1)
+        action  = find_action(actions, "Convert to tap")
+        refute_nil action
+
+        edit = single_edit(action)
+        # The body range starts at the method body's indentation (4 spaces).
+        assert_match(/\A    obj\.tap do \|o\|/, edit.new_text)
+        assert_match(/      o\.step_one/, edit.new_text)
+      end
+
+      # ── negative cases ─────────────────────────────────────────────────────
+
+      def test_does_not_offer_when_last_statement_is_not_bare_receiver
+        source = <<~RUBY
+          def do_something
+            obj.step_one
+            obj.step_two
+            obj.result
+          end
+        RUBY
+
+        # last statement is a call on obj, not a bare variable read
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to tap")
+      end
+
+      def test_does_not_offer_when_receivers_differ
+        source = <<~RUBY
+          def do_something
+            foo.step_one
+            bar.step_two
+            foo
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to tap")
+      end
+
+      def test_does_not_offer_for_single_statement_method
+        source = <<~RUBY
+          def do_something
+            obj
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to tap")
+      end
+
+      def test_does_not_offer_outside_a_method
+        source = <<~RUBY
+          obj.step_one
+          obj.step_two
+          obj
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to tap")
+      end
+
+      # ── resilience ─────────────────────────────────────────────────────────
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

data/test/ruby_lsp_refactor/variable_listener_test.rb

@@ -62,29 +62,6 @@ module RubyLsp
         assert_nil find_action(actions, /Inline variable/)
       end
 
-      # ===========================================================================
-      # 2. Extract local variable
-      # ===========================================================================
-
-      def test_extract_local_variable_inserts_assignment_above
-        source = "user.full_name.upcase\n"
-        actions = code_actions_for(source, line: 0)
-        action  = find_action(actions, "Extract local variable")
-        refute_nil action
-
-        edits = all_edits(action)
-        assert_equal 2, edits.size
-
-        insert_edit  = edits.find { |e| e.new_text.include?("variable =") }
-        replace_edit = edits.find { |e| e.new_text == "variable" }
-
-        refute_nil insert_edit
-        refute_nil replace_edit
-
-        assert_match(/variable = user\.full_name\.upcase/, insert_edit.new_text)
-        assert_equal 0, insert_edit.range.start.line
-      end
-
       # ---------------------------------------------------------------------------
       # Resilience
       # ---------------------------------------------------------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-refactor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aboobacker MK
@@ -104,10 +104,12 @@ files:
 - lib/ruby_lsp/ruby_lsp_refactor/addon.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/accessor_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/array_listener.rb
-- lib/ruby_lsp/ruby_lsp_refactor/listeners/block_style_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/conditional_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/constant_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/early_return_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/enumerable_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/extract_include_file_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/extract_predicate_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/hash_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/logical_operator_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/method_listener.rb
@@ -118,16 +120,19 @@ files:
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/string_freeze_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/string_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/super_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/tap_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/listeners/variable_listener.rb
 - lib/ruby_lsp/ruby_lsp_refactor/support/node_helpers.rb
 - lib/ruby_lsp/test_helper.rb
 - sig/ruby/lsp/refactor.rbs
 - test/ruby_lsp_refactor/accessor_listener_test.rb
 - test/ruby_lsp_refactor/array_listener_test.rb
-- test/ruby_lsp_refactor/block_style_listener_test.rb
 - test/ruby_lsp_refactor/conditional_listener_test.rb
 - test/ruby_lsp_refactor/constant_listener_test.rb
+- test/ruby_lsp_refactor/early_return_listener_test.rb
 - test/ruby_lsp_refactor/enumerable_listener_test.rb
+- test/ruby_lsp_refactor/extract_include_file_listener_test.rb
+- test/ruby_lsp_refactor/extract_predicate_listener_test.rb
 - test/ruby_lsp_refactor/hash_listener_test.rb
 - test/ruby_lsp_refactor/logical_operator_listener_test.rb
 - test/ruby_lsp_refactor/method_listener_test.rb
@@ -138,6 +143,7 @@ files:
 - test/ruby_lsp_refactor/string_freeze_listener_test.rb
 - test/ruby_lsp_refactor/string_listener_test.rb
 - test/ruby_lsp_refactor/super_listener_test.rb
+- test/ruby_lsp_refactor/tap_listener_test.rb
 - test/ruby_lsp_refactor/variable_listener_test.rb
 homepage: https://github.com/tachyons/ruby-lsp-refactor
 licenses:

data/lib/ruby_lsp/ruby_lsp_refactor/listeners/block_style_listener.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../support/node_helpers"
-
-module RubyLsp
-  module Refactor
-    # Emits block-style toggle actions on any CallNode whose block is a
-    # BlockNode (i.e. not a bare proc/lambda literal).
-    #
-    # Emitted actions
-    # ───────────────
-    # 1. Convert to do…end
-    #      receiver.method { |x| body }
-    #      →
-    #      receiver.method do |x|
-    #        body
-    #      end
-    #
-    # 2. Convert to brace block
-    #      receiver.method do |x|
-    #        body
-    #      end
-    #      →
-    #      receiver.method { |x| body }
-    #
-    # Convention: multi-statement brace blocks are always expanded to do…end.
-    # Single-statement do…end blocks are collapsed to brace style.
-    class BlockStyleListener
-      include RubyLsp::Requests::Support::Common
-      include Support::NodeHelpers
-
-      def initialize(response_builder, node_context, dispatcher)
-        @response_builder = response_builder
-        @node_context     = node_context
-
-        dispatcher.register(self, :on_call_node_enter)
-      end
-
-      def on_call_node_enter(node)
-        return unless node_covers_cursor?(node)
-
-        block = node.block
-        return unless block.is_a?(Prism::BlockNode)
-
-        if brace_block?(block)
-          emit_to_do_end(node, block)
-        elsif single_statement_body?(block)
-          emit_to_brace(node, block)
-        end
-      rescue StandardError
-        nil
-      end
-
-      private
-
-      def brace_block?(block)
-        block.opening_loc.slice == "{"
-      end
-
-      def single_statement_body?(block)
-        block.body&.body&.length == 1
-      end
-
-      # ── brace → do…end ──────────────────────────────────────────────────────
-
-      def emit_to_do_end(call_node, block)
-        indent      = indent_for(call_node)
-        params_src  = params_string(block)
-        body_lines  = block.body.body.map { |s| "#{indent}  #{s.location.slice.strip}" }.join("\n")
-
-        new_block = " do#{params_src}\n#{body_lines}\n#{indent}end"
-        new_text  = call_without_block(call_node) + new_block
-
-        @response_builder << Interface::CodeAction.new(
-          title: "Convert to do…end block",
-          kind: Constant::CodeActionKind::REFACTOR_REWRITE,
-          edit: single_edit_workspace_edit(call_node, new_text)
-        )
-      end
-
-      # ── do…end → brace ──────────────────────────────────────────────────────
-
-      def emit_to_brace(call_node, block)
-        params_src = params_string(block)
-        body_src   = block.body.body.first.location.slice.strip
-
-        new_block = " {#{params_src} #{body_src} }"
-        new_text  = call_without_block(call_node) + new_block
-
-        @response_builder << Interface::CodeAction.new(
-          title: "Convert to brace block",
-          kind: Constant::CodeActionKind::REFACTOR_REWRITE,
-          edit: single_edit_workspace_edit(call_node, new_text)
-        )
-      end
-
-      # ── helpers ──────────────────────────────────────────────────────────────
-
-      # Returns the block parameters string including pipes, e.g. " |x, y|",
-      # or an empty string when the block takes no parameters.
-      def params_string(block)
-        return "" unless block.parameters
-
-        " #{block.parameters.location.slice}"
-      end
-
-      # Returns the source of the call node up to (but not including) the block.
-      # Works by slicing from the call's start to the block's start.
-      def call_without_block(call_node)
-        call_src   = call_node.location.slice
-        block_src  = call_node.block.location.slice
-        # Remove the block suffix (and any whitespace before it) from the call.
-        call_src[0, call_src.length - block_src.length].rstrip
-      end
-    end
-  end
-end

data/test/ruby_lsp_refactor/block_style_listener_test.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-require "minitest/autorun"
-require "ruby_lsp/test_helper"
-
-module RubyLsp
-  module Refactor
-    class BlockStyleListenerTest < Minitest::Test
-      include RubyLsp::Refactor::TestHelper
-
-      def find_action(actions, title)
-        actions.find { |a| a.title == title }
-      end
-
-      def single_edit(action)
-        edits = action.edit.changes.values.flatten
-        assert_equal 1, edits.size
-        edits.first
-      end
-
-      # ── brace → do…end ────────────────────────────────────────────────────
-
-      def test_converts_brace_block_to_do_end
-        source = "users.each { |u| u.activate! }\n"
-        actions = code_actions_for(source, line: 0)
-        action  = find_action(actions, "Convert to do…end block")
-        refute_nil action
-
-        edit = single_edit(action)
-        assert_match(/do \|u\|/, edit.new_text)
-        assert_match(/u\.activate!/, edit.new_text)
-        assert_match(/end/, edit.new_text)
-      end
-
-      def test_brace_to_do_end_preserves_indentation
-        source = "  users.each { |u| u.activate! }\n"
-        actions = code_actions_for(source, line: 0)
-        action  = find_action(actions, "Convert to do…end block")
-        refute_nil action
-
-        edit = single_edit(action)
-        # The edit replaces the node range which starts at column 2, so
-        # new_text begins at the call itself (no leading spaces).
-        assert_match(/\Ausers\.each do \|u\|/, edit.new_text)
-        # Body is indented 2 (node column) + 2 (block body) = 4 spaces.
-        assert_match(/^    u\.activate!/, edit.new_text)
-        # Closing end is at the node's own indentation level (2 spaces).
-        assert_match(/^  end$/, edit.new_text)
-      end
-
-      def test_brace_to_do_end_without_params
-        source = "3.times { puts 'hi' }\n"
-        actions = code_actions_for(source, line: 0)
-        action  = find_action(actions, "Convert to do…end block")
-        refute_nil action
-
-        edit = single_edit(action)
-        assert_match(/do\n/, edit.new_text)
-        refute_match(/\|/, edit.new_text)
-      end
-
-      # ── do…end → brace ────────────────────────────────────────────────────
-
-      def test_converts_do_end_block_to_brace
-        source = <<~RUBY
-          users.each do |u|
-            u.activate!
-          end
-        RUBY
-
-        actions = code_actions_for(source, line: 0)
-        action  = find_action(actions, "Convert to brace block")
-        refute_nil action
-
-        edit = single_edit(action)
-        assert_match(/\{ \|u\| u\.activate! \}/, edit.new_text)
-      end
-
-      def test_does_not_offer_brace_for_multi_statement_do_end
-        source = <<~RUBY
-          users.each do |u|
-            u.activate!
-            u.notify!
-          end
-        RUBY
-
-        actions = code_actions_for(source, line: 0)
-        assert_nil find_action(actions, "Convert to brace block")
-      end
-
-      # ── resilience ─────────────────────────────────────────────────────────
-
-      def test_does_not_raise_on_empty_source
-        assert_silent { code_actions_for("", line: 0) }
-      end
-    end
-  end
-end