ruby-lsp-refactor 0.1.0 → 0.1.2

data/test/ruby_lsp_refactor/extract_include_file_listener_test.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class ExtractIncludeFileListenerTest < Minitest::Test
+      include RubyLsp::Refactor::TestHelper
+
+      def find_action(actions, title_pattern)
+        actions.find { |a| a.title.match?(title_pattern) }
+      end
+
+      # ── core acceptance ────────────────────────────────────────────────────
+
+      def test_extracts_module_to_new_file
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+
+          class User
+            include Greetable
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        assert_match(/greetable\.rb/, action.title)
+
+        doc_changes = action.edit.document_changes
+        assert_equal 3, doc_changes.length,
+                     "Expected CreateFile + 2 TextDocumentEdits, got #{doc_changes.length}"
+      end
+
+      def test_create_file_operation_is_first
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+
+          class User; end
+        RUBY
+
+        actions    = code_actions_for(source, line: 0)
+        action     = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        create_op = action.edit.document_changes.first
+        assert_equal "create", create_op.kind
+        assert_match(/greetable\.rb/, create_op.uri)
+      end
+
+      def test_new_file_content_includes_frozen_comment_and_source
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+
+          class User; end
+        RUBY
+
+        actions    = code_actions_for(source, line: 0)
+        action     = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        # Second document_change is the TextDocumentEdit writing the new file.
+        write_edit = action.edit.document_changes[1]
+        content    = write_edit.edits.first.new_text
+
+        assert_match(/# frozen_string_literal: true/, content)
+        assert_match(/module Greetable/, content)
+        assert_match(/def greet = "hello"/, content)
+      end
+
+      def test_source_file_is_replaced_with_require_relative
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+
+          class User; end
+        RUBY
+
+        actions    = code_actions_for(source, line: 0)
+        action     = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        # Third document_change edits the source file.
+        source_edit = action.edit.document_changes[2]
+        new_text    = source_edit.edits.first.new_text
+
+        assert_match(/require_relative "greetable"/, new_text)
+        refute_match(/module Greetable/, new_text)
+      end
+
+      def test_new_file_uri_is_in_same_directory_as_source
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+
+          class User; end
+        RUBY
+
+        actions    = code_actions_for(source, line: 0)
+        action     = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        create_op      = action.edit.document_changes.first
+        source_dir     = File.dirname(URI("file:///test/fixture.rb").path)
+        expected_path  = File.join(source_dir, "greetable.rb")
+
+        assert_equal "file://#{expected_path}", create_op.uri
+      end
+
+      def test_converts_camel_case_module_name_to_snake_case_filename
+        source = <<~RUBY
+          module MyHelperModule
+            def help = true
+          end
+
+          class App; end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        assert_match(/my_helper_module\.rb/, action.title)
+        create_op = action.edit.document_changes.first
+        assert_match(/my_helper_module\.rb/, create_op.uri)
+      end
+
+      def test_works_for_class_nodes_too
+        source = <<~RUBY
+          class AdminUser
+            def admin? = true
+          end
+
+          class User; end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /Extract to include file/)
+        refute_nil action
+
+        assert_match(/admin_user\.rb/, action.title)
+      end
+
+      # ── negative cases ─────────────────────────────────────────────────────
+
+      def test_does_not_offer_when_module_is_only_top_level_node
+        # Nothing else in the file — extraction would leave an empty source.
+        source = <<~RUBY
+          module Greetable
+            def greet = "hello"
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, /Extract to include file/)
+      end
+
+      def test_does_not_offer_for_nested_module
+        source = <<~RUBY
+          class User
+            module Callbacks
+              def before_save = nil
+            end
+          end
+        RUBY
+
+        # Cursor on the nested module (line 1)
+        actions = code_actions_for(source, line: 1)
+        assert_nil find_action(actions, /Extract to include file/)
+      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/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/logical_operator_listener_test.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class LogicalOperatorListenerTest < Minitest::Test
+      include RubyLsp::Refactor::TestHelper
+
+      def find_action(actions, title_pattern)
+        actions.find { |a| a.title.match?(title_pattern) }
+      end
+
+      def single_edit(action)
+        edits = action.edit.changes.values.flatten
+        assert_equal 1, edits.size
+        edits.first
+      end
+
+      def test_converts_double_ampersand_to_and
+        source = "user.valid? && user.save\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /&&.*and/)
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal "user.valid? and user.save", edit.new_text.strip
+      end
+
+      def test_converts_and_to_double_ampersand
+        source = "user.valid? and user.save\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /and.*&&/)
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal "user.valid? && user.save", edit.new_text.strip
+      end
+
+      def test_converts_double_pipe_to_or
+        source = "a || b\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /\|\|.*or/)
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal "a or b", edit.new_text.strip
+      end
+
+      def test_converts_or_to_double_pipe
+        source = "a or b\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /or.*\|\|/)
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal "a || b", edit.new_text.strip
+      end
+
+      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/raise_listener_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class RaiseListenerTest < 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
+
+      def test_simplifies_raise_runtime_error
+        source = "raise RuntimeError, \"something went wrong\"\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Simplify raise (remove redundant RuntimeError)")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal 'raise "something went wrong"', edit.new_text.strip
+      end
+
+      def test_simplifies_fail_runtime_error
+        source = "fail RuntimeError, \"oops\"\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Simplify raise (remove redundant RuntimeError)")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal 'fail "oops"', edit.new_text.strip
+      end
+
+      def test_does_not_offer_for_other_exception_classes
+        source = "raise ArgumentError, \"bad arg\"\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Simplify raise (remove redundant RuntimeError)")
+      end
+
+      def test_does_not_offer_for_raise_with_string_only
+        source = "raise \"already simple\"\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Simplify raise (remove redundant RuntimeError)")
+      end
+
+      def test_does_not_offer_for_runtime_error_new
+        source = "raise RuntimeError.new(\"msg\")\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Simplify raise (remove redundant RuntimeError)")
+      end
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

data/test/ruby_lsp_refactor/rescue_listener_test.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class RescueListenerTest < 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
+
+      def test_wraps_method_body_in_rescue
+        source = <<~RUBY
+          def call
+            do_thing
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Wrap body in rescue")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/rescue StandardError => e/, edit.new_text)
+        assert_match(/do_thing/, edit.new_text)
+        assert_match(/raise/, edit.new_text)
+      end
+
+      def test_preserves_all_body_statements
+        source = <<~RUBY
+          def process
+            step_one
+            step_two
+            step_three
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Wrap body in rescue")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/step_one/, edit.new_text)
+        assert_match(/step_two/, edit.new_text)
+        assert_match(/step_three/, edit.new_text)
+      end
+
+      def test_does_not_offer_on_empty_method
+        source = <<~RUBY
+          def noop
+          end
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Wrap body in rescue")
+      end
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

data/test/ruby_lsp_refactor/rspec_let_listener_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class RspecLetListenerTest < 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
+
+      def test_converts_let_to_let_bang
+        source = "let(:user) { User.new }\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert let to let!")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/let!\(:user\)/, edit.new_text)
+      end
+
+      def test_converts_let_bang_to_let
+        source = "let!(:user) { User.new }\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert let! to let")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_match(/\blet\(:user\)/, edit.new_text)
+        refute_match(/let!/, edit.new_text)
+      end
+
+      def test_does_not_offer_for_non_let_calls
+        source = "subject { User.new }\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert let to let!")
+        assert_nil find_action(actions, "Convert let! to let")
+      end
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

data/test/ruby_lsp_refactor/string_array_listener_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class StringArrayListenerTest < 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
+
+      def test_converts_bracket_string_array_to_percent_w
+        source = "[\"foo\", \"bar\", \"baz\"]\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert to string array (%w[])")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal "%w[foo bar baz]", edit.new_text
+      end
+
+      def test_converts_percent_w_to_bracket_array
+        source = "%w[foo bar baz]\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, "Convert to bracket array")
+        refute_nil action
+
+        edit = single_edit(action)
+        assert_equal '["foo", "bar", "baz"]', edit.new_text
+      end
+
+      def test_does_not_offer_percent_w_for_strings_with_spaces
+        source = "[\"hello world\", \"foo\"]\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to string array (%w[])")
+      end
+
+      def test_does_not_offer_percent_w_for_mixed_array
+        source = "[\"foo\", 42]\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to string array (%w[])")
+      end
+
+      def test_does_not_offer_percent_w_for_empty_array
+        source = "[]\n"
+        actions = code_actions_for(source, line: 0)
+        assert_nil find_action(actions, "Convert to string array (%w[])")
+      end
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end