ruby-lsp-refactor 0.1.0

data/test/ruby_lsp_refactor/variable_listener_test.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "ruby_lsp/test_helper"
+
+module RubyLsp
+  module Refactor
+    class VariableListenerTest < Minitest::Test
+      include RubyLsp::Refactor::TestHelper
+
+      def find_action(actions, title_pattern)
+        actions.find { |a| a.title.match?(title_pattern) }
+      end
+
+      def all_edits(action)
+        action.edit.changes.values.flatten
+      end
+
+      # ===========================================================================
+      # 1. Inline variable
+      # ===========================================================================
+
+      def test_inline_variable_replaces_reads_and_deletes_assignment
+        source = <<~RUBY
+          result = user.calculate
+          puts result
+          log result
+        RUBY
+
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /Inline variable/)
+        refute_nil action
+
+        edits = all_edits(action)
+        # 1 delete + 2 replacements
+        assert_equal 3, edits.size
+
+        delete_edit = edits.find { |e| e.new_text == "" }
+        refute_nil delete_edit
+        assert_equal 0, delete_edit.range.start.line
+
+        replace_edits = edits.reject { |e| e.new_text == "" }
+        replace_edits.each { |e| assert_equal "user.calculate", e.new_text }
+      end
+
+      def test_inline_variable_title_includes_variable_name
+        source = "total = price * qty\nputs total\n"
+        actions = code_actions_for(source, line: 0)
+        action  = find_action(actions, /Inline variable/)
+        refute_nil action
+        assert_match(/total/, action.title)
+      end
+
+      def test_does_not_offer_inline_when_cursor_not_on_assignment
+        source = <<~RUBY
+          result = user.calculate
+          puts result
+        RUBY
+
+        # Cursor on the `puts` line, not the assignment.
+        actions = code_actions_for(source, line: 1)
+        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
+      # ---------------------------------------------------------------------------
+
+      def test_does_not_raise_on_empty_source
+        assert_silent { code_actions_for("", line: 0) }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-refactor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aboobacker MK
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: A ruby-lsp add-on that provides safe, AST-driven refactoring operations
+  (post-conditional conversion, inline variable, etc.) natively within any LSP-supported
+  IDE.
+email:
+- aboobackervyd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby/lsp/refactor.rb
+- lib/ruby/lsp/refactor/version.rb
+- lib/ruby_lsp/ruby_lsp_refactor/addon.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/array_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/conditional_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/hash_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/method_listener.rb
+- lib/ruby_lsp/ruby_lsp_refactor/listeners/string_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/array_listener_test.rb
+- test/ruby_lsp_refactor/conditional_listener_test.rb
+- test/ruby_lsp_refactor/hash_listener_test.rb
+- test/ruby_lsp_refactor/method_listener_test.rb
+- test/ruby_lsp_refactor/string_listener_test.rb
+- test/ruby_lsp_refactor/variable_listener_test.rb
+homepage: https://github.com/tachyons/ruby-lsp-refactor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tachyons/ruby-lsp-refactor
+  source_code_uri: https://github.com/tachyons/ruby-lsp-refactor
+  changelog_uri: https://github.com/tachyons/ruby-lsp-refactor/blob/main/CHANGELOG.md
+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.10
+specification_version: 4
+summary: AST-driven refactoring code actions for the ruby-lsp ecosystem.
+test_files: []