ruby-lsp-rake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d62c520f6161c9188a81725ba3d7a0344b79ac6616e8f5067cb3c6bf53005f8
+  data.tar.gz: 4e2d992c8cfe1707c989ecce92c766bed76b5a225897e92a0d1d24c3145446dc
+SHA512:
+  metadata.gz: 04d0ee7602ec8ce503c8ebb9a5fb439efdc8825038a339eed233121e4df7bf232a5ae168bd5e3e4af5a566c7fde27de83fd2accf7ecf841a58b4b4d8a2ad366c
+  data.tar.gz: c39ce4f0873a88375151e0e99559e65914fd4c168dd347691aabffb7778c3bf23743347a6802cc1e02056635866c22f4424a6609c0c961b176fe6b618ca41d74

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Koji NAKAMURA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# ruby-lsp-rake
+
+A Ruby LSP addon that adds extra editor functionality for Rake.
+
+## Installation
+
+If you haven't already done so, you'll need to first [set up Ruby LSP](https://shopify.github.io/ruby-lsp/#usage).
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ruby-lsp-rake --group development
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ruby-lsp-rake
+```
+
+## Indexing Configuration
+
+To index tasks defined in `Rakefile` files, configure `rubyLsp.indexing.includedPatterns` as shown below.
+
+```
+{
+    "rubyLsp.indexing": {
+        "includedPatterns": ["**/Rakefile"]
+    }
+}
+```
+
+see also: https://shopify.github.io/ruby-lsp/#configuring-code-indexing
+
+## Features
+
+### Dependency task links on hover
+
+Add a link to the location where the dependency task is defined to the hover content.
+
+![depenency_task_links_on_hover](img/dependency_task_links_on_hover.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kozy4324/ruby-lsp-rake.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Following are task definitions for tests
+
+task default: %w[test]
+
+task :test do
+  ruby "test/unittest.rb"
+end

data/lib/ruby/lsp/rake/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Lsp
+    module Rake
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/ruby/lsp/rake.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "rake/version"
+
+module Ruby
+  module Lsp
+    module Rake
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rake/addon.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require_relative "indexing_enhancement"
+require_relative "hover"
+
+module RubyLsp
+  module Rake
+    class Addon < ::RubyLsp::Addon # rubocop:disable Style/Documentation
+      def activate(global_state, _message_queue)
+        @index = global_state.index
+      end
+
+      def deactivate; end
+
+      def name
+        "Ruby LSP Rake go to task def"
+      end
+
+      def version
+        "0.1.0"
+      end
+
+      def create_hover_listener(response_builder, node_context, dispatcher)
+        Hover.new(response_builder, node_context, dispatcher, @index)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rake/hover.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rake
+    class Hover # rubocop:disable Style/Documentation
+      include Requests::Support::Common
+
+      def initialize(response_builder, node_context, dispatcher, index)
+        @response_builder = response_builder
+        @node_context = node_context
+        dispatcher.register(self, :on_string_node_enter)
+        @index = index
+      end
+
+      def on_string_node_enter(node) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        call_node_name = @node_context.call_node&.name
+        return unless call_node_name == :task
+
+        name = case node
+               when Prism::StringNode
+                 node.content
+               when Prism::SymbolNode
+                 node.value
+               end
+
+        task_name = "task_#{name}"
+        return unless @index.indexed? task_name
+
+        entries = @index[task_name]
+        contents = entries.map do |entry|
+          label = "task :#{name}"
+          loc = entry.location
+          uri = URI::Generic.from_path(
+            path: entry.file_path,
+            fragment: "L#{loc.start_line},#{loc.start_column + 1}-#{loc.end_line},#{loc.end_column + 1}"
+          )
+          "[#{label}](#{uri})"
+        end
+        @response_builder.push("Definitions: #{contents.join(", ")}", category: :documentation)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rake/indexing_enhancement.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rake
+    class IndexingEnhancement < RubyIndexer::Enhancement # rubocop:disable Style/Documentation
+      def on_call_node_enter(node) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+        return unless @listener.current_owner.nil?
+        return unless node.name == :task
+
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        arg = arguments.first
+        name = case arg
+               when Prism::StringNode
+                 arg.content
+               when Prism::SymbolNode
+                 arg.value
+               when Prism::KeywordHashNode
+                 case arg.child_nodes.first
+                 when Prism::AssocNode
+                   case arg.child_nodes.first.key
+                   when Prism::StringNode
+                     arg.child_nodes.first.key.content
+                   when Prism::SymbolNode
+                     arg.child_nodes.first.key.value
+                   end
+                 end
+               end
+
+        return if name.nil?
+
+        location = node.location
+        @listener.add_method(
+          "task_#{name}",
+          location,
+          nil
+        )
+      end
+
+      def on_call_node_leave(node); end
+    end
+  end
+end

data/sig/ruby/lsp/rake.rbs

@@ -0,0 +1,8 @@
+module Ruby
+  module Lsp
+    module Rake
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-rake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji NAKAMURA
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-30 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.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.1
+description: A Ruby LSP addon that adds extra editor functionality for Rake
+email:
+- kozy4324@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- img/dependency_task_links_on_hover.png
+- lib/Rakefile
+- lib/ruby/lsp/rake.rb
+- lib/ruby/lsp/rake/version.rb
+- lib/ruby_lsp/ruby_lsp_rake/addon.rb
+- lib/ruby_lsp/ruby_lsp_rake/hover.rb
+- lib/ruby_lsp/ruby_lsp_rake/indexing_enhancement.rb
+- sig/ruby/lsp/rake.rbs
+homepage: https://github.com/kozy4324/ruby-lsp-rake
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kozy4324/ruby-lsp-rake
+  source_code_uri: https://github.com/kozy4324/ruby-lsp-rake
+  changelog_uri: https://github.com/kozy4324/ruby-lsp-rake/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A Ruby LSP addon for Rake
+test_files: []