ruby-lsp-ree 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655e8856a825a3b31fef950de21f56c6a4feb279693d2892000db1147db9b48e
-  data.tar.gz: 85145dce503767be96a2f3c3f351be8a77f860713cceadb9e03757c0a97a65c1
+  metadata.gz: 72573c4b291dbdfd4ed45bc81625bfc2dbc97839cdee93214e3af5358dfb8572
+  data.tar.gz: 82849950d1fa5a0c7eb95f17b2417b97136df143bc871f2ce44e869e2a7c9721
 SHA512:
-  metadata.gz: 4956cc2138f636e9bb2068287e456833215b12d56c8f8e4bccf42b9d6ac92db19b54c1fb04fecd4cd18a41355fdb86896f62cbbdb4b0377a0543af88017b8ddc
-  data.tar.gz: 5f7a6ab9e5003f0c68351306a5df06005aad772fd3fb9dee262ef7e65f8071364f003f985d797f9bdd05ee4e04078092ef4561b63b1a8c0131452412870ebc2d
+  metadata.gz: 5aba139740ca71509e49885a4135cbc838fd1ce444b2525d15962126f558c09448caa1478a8df33669d223169e081901b87d8d12464ebd1555825735f8d95ec7
+  data.tar.gz: 3e9673f5830791ce62a5dfbcb4e74cec6e3cd774fdfe7e447d9090cb4ae2063d881395bf39086e8158b697492f4e88eb68f35c55cd2b742fcba28d516075e853

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.1.14] - 2025-04-15
+
+- do not create error definition for defined class
+- added formatter config settings
+- formatter: remove unused imports
+- fixed adding `throws` section to contract without parentheses
+
+## [0.1.13] - 2025-04-04
+
+- Go To Definition for action and serializers in routes
+- support for `schema` objects
+- better support for both ree locale conventions
+
 ## [0.1.11] - 2025-03-28
 
 - fixed formatting errors for methods with `rescue`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-lsp-ree (0.1.12)
+    ruby-lsp-ree (0.1.14)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,6 +10,8 @@ Ree addon for Ruby LSP
 If everything was installed successfully, you should see Ree in the list of Ruby LSP addons.
 (In VS Code click `{}` brackets in the bottom right corner)
 
+## Formatter
+
 To use ree_formatter, add the following line into your `settings.json` file (e.g. `.vscode/settings.json`)
 ```json
 "rubyLsp.formatter": "ree_formatter"
@@ -20,6 +22,18 @@ To use diagnostics, add the following line into your `settings.json` file (e.g.
 "rubyLsp.linters": ["ree_formatter"]
 ```
 
+To switch off/on formatter features, use Ruby LSP addon settings:
+```json
+"rubyLsp.addonSettings": {
+    "Ree Addon": {
+      "formatter": {
+        "MissingErrorLocalesFormatter": false
+      }
+    }
+  }
+```
+available formatters: `SortLinksFormatter`, `MissingErrorDefinitionsFormatter`, `MissingErrorContractsFormatter`, `MissingErrorLocalesFormatter`, `UnusedLinksFormatter`
+
 ## Functions
 
 - autocomplete for Ree objects
@@ -28,4 +42,5 @@ To use diagnostics, add the following line into your `settings.json` file (e.g.
 - sort links on document save or format (with ree_formatter enabled)
 - missing error locales detection
 - Go To Definition for Ree objects
-- hover information for Ree objects and error locales
+- hover information for Ree objects and error locales
+- Ree templates support

data/lib/ruby_lsp/ruby_lsp_ree/addon.rb

@@ -15,10 +15,17 @@ module RubyLsp
     class Addon < ::RubyLsp::Addon
       def activate(global_state, message_queue)
         @global_state = global_state
+        @settings = global_state.settings_for_addon(name) || {}
+
         @message_queue = message_queue
         @template_applicator = RubyLsp::Ree::ReeTemplateApplicator.new
+        
+        global_state.register_formatter("ree_formatter", RubyLsp::Ree::ReeFormatter.new(
+          @message_queue, 
+          @settings[:formatter], 
+          @global_state.index
+        ))
 
-        global_state.register_formatter("ree_formatter", RubyLsp::Ree::ReeFormatter.new(@message_queue))
         register_additional_file_watchers(global_state, message_queue)
       end
 

data/lib/ruby_lsp/ruby_lsp_ree/formatters/base_formatter.rb

@@ -1,12 +1,13 @@
 module RubyLsp
   module Ree
     class BaseFormatter
-      def self.call(source, uri, message_queue)
-        new(message_queue).call(source, uri)
+      def self.call(source, uri, message_queue, index)
+        new(message_queue, index).call(source, uri)
       end
 
-      def initialize(message_queue)
+      def initialize(message_queue, index)
         @message_queue = message_queue
+        @index = index
       end
 
       def call(source, uri)

data/lib/ruby_lsp/ruby_lsp_ree/formatters/missing_error_contracts_formatter.rb

@@ -5,7 +5,7 @@ module RubyLsp
     class MissingErrorContractsFormatter < BaseFormatter
       def call(source, _uri)
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(source)
-        return source if !parsed_doc || !parsed_doc.class_node
+        return source if !parsed_doc || !parsed_doc.has_root_class?
 
         parsed_doc.parse_error_definitions
         parsed_doc.parse_instance_methods
@@ -40,10 +40,19 @@ module RubyLsp
             source_lines[line] = source_lines[line][0..position] + ", #{missed_errors.join(', ')}\n"
           end
         else
-          position = doc_instance_method.contract_node_end_position
-          line = doc_instance_method.contract_node_end_line
+          if doc_instance_method.contract_in_parentheses?
+            position = doc_instance_method.contract_node_end_position
+            line = doc_instance_method.contract_node_end_line
 
-          source_lines[line] = source_lines[line][0..position] + ".throws(#{missed_errors.join(', ')})\n"
+            source_lines[line] = source_lines[line][0..position] + ".throws(#{missed_errors.join(', ')})\n"
+          else
+            contract_end_position = doc_instance_method.contract_node_contract_end_position
+            start_line = doc_instance_method.contract_node_start_line
+            end_line = doc_instance_method.contract_node_end_line
+
+            source_lines[start_line] = source_lines[start_line][0..contract_end_position] + "(" + source_lines[start_line][contract_end_position+1..-1].lstrip
+            source_lines[end_line] = source_lines[end_line].chomp + ").throws(#{missed_errors.join(', ')})\n"
+          end
         end
 
         source_lines.join

data/lib/ruby_lsp/ruby_lsp_ree/formatters/missing_error_definitions_formatter.rb

@@ -7,13 +7,18 @@ module RubyLsp
 
       def call(source, _uri)
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(source)
-        return source if !parsed_doc || !parsed_doc.class_node
+        return source if !parsed_doc || !parsed_doc.has_root_class?
 
         parsed_doc.parse_error_definitions
         parsed_doc.parse_instance_methods
         parsed_doc.parse_links
+        parsed_doc.parse_defined_classes
+        parsed_doc.parse_defined_consts
 
-        existing_errors = parsed_doc.error_definition_names + parsed_doc.imported_constants
+        existing_error_classes = parsed_doc.error_definition_names + 
+          parsed_doc.imported_constants + 
+          parsed_doc.defined_classes + 
+          parsed_doc.defined_consts
 
         missed_errors = []
         parsed_doc.doc_instance_methods.each do |doc_instance_method|
@@ -21,7 +26,7 @@ module RubyLsp
 
           raised_errors = doc_instance_method.raised_errors_nested
 
-          missed_errors += raised_errors - existing_errors
+          missed_errors += raised_errors - existing_error_classes
         end
 
         missed_errors = missed_errors.uniq.reject{ Object.const_defined?(_1) }

data/lib/ruby_lsp/ruby_lsp_ree/formatters/missing_error_locales_formatter.rb

@@ -10,28 +10,35 @@ module RubyLsp
 
       def call(source, uri)
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(source)
+        return source if !parsed_doc || !parsed_doc.has_root_class?
 
         locales_folder = package_locales_folder_path(get_uri_path(uri))
         return source if !locales_folder || !File.directory?(locales_folder)
 
+        file_name = File.basename(uri.to_s, '.rb')
+
         result = []
         key_paths = []
         parsed_doc.parse_error_definitions
         parsed_doc.error_definitions.each do |error_definition|
-          key_path = if error_definition.value.arguments.arguments.size > 1
-            error_definition.value.arguments.arguments[1].unescaped
+          key_path_entries = if error_definition.value.arguments.arguments.size > 1
+            [error_definition.value.arguments.arguments[1].unescaped]
           else
             mod = underscore(parsed_doc.module_name)
-            "#{mod}.errors.#{error_definition.value.arguments.arguments[0].unescaped}"
+            [
+              "#{mod}.errors.#{error_definition.value.arguments.arguments[0].unescaped}",
+              "#{mod}.errors.#{file_name}.#{error_definition.value.arguments.arguments[0].unescaped}"
+            ]
           end
 
-          key_paths << key_path
+          key_paths << key_path_entries
         end
 
         Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
-          key_paths.each do |key_path|
-            value = find_locale_value(locale_file, key_path)
+          key_paths.each do |key_path_entries|
+            value = key_path_entries.map{ find_locale_value(locale_file, _1) }.compact.first
             unless value
+              key_path = key_path_entries.last
               loc_key = File.basename(locale_file, '.yml')
 
               add_locale_placeholder(locale_file, key_path)    

data/lib/ruby_lsp/ruby_lsp_ree/formatters/unused_links_formatter.rb

@@ -0,0 +1,56 @@
+require_relative 'base_formatter'
+require_relative '../ree_source_editor'
+require_relative '../ree_dsl_parser'
+
+module RubyLsp
+  module Ree
+    class UnusedLinksFormatter < BaseFormatter
+      include RubyLsp::Ree::ReeLspUtils
+
+      def call(source, _uri)
+        parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(source)
+        return source if !parsed_doc
+
+        parsed_doc.parse_links
+
+        editor = RubyLsp::Ree::ReeSourceEditor.new(source)
+        dsl_parser = RubyLsp::Ree::ReeDslParser.new(parsed_doc, @index)
+
+        links_count = parsed_doc.link_nodes.size
+
+        removed_links = 0
+
+        parsed_doc.link_nodes.each do |link_node|
+          removed_imports = 0
+
+          if link_node.has_import_section?
+            link_node.imports.each do |link_import|
+              # TODO extract condition
+              next if editor.contains_link_import_usage?(link_node, link_import) || dsl_parser.contains_object_usage?(link_import)
+              
+              editor.remove_link_import(link_node, link_import)
+              removed_imports += 1
+            end
+
+            if link_node.imports.size == removed_imports
+              editor.remove_link_import_arg(link_node)
+            end
+          end
+
+          # TODO extract condition
+          next if editor.contains_link_usage?(link_node) || link_node.imports.size > removed_imports || dsl_parser.contains_object_usage?(link_node.name)
+
+          editor.remove_link(link_node)
+          removed_links += 1
+        end
+
+        if removed_links == links_count
+          parsed_doc.parse_links_container_node
+          editor.remove_link_block(parsed_doc.links_container_node, parsed_doc.links_container_block_node)
+        end
+
+        editor.source
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_ree/handlers/completion_handler.rb

@@ -160,13 +160,14 @@ module RubyLsp
             class_name = full_class_name.split('::').last
             package_name = package_name_from_uri(entry.uri)
             file_name = File.basename(entry.uri.to_s)
+            entry_comment = entry.comments && entry.comments.size > 0 ? " (#{entry.comments})" : ''
 
             matched_import = parsed_doc.find_import_for_package(class_name, package_name)
 
             if matched_import   
               label_details = Interface::CompletionItemLabelDetails.new(
                 description: "imported from: :#{package_name}",
-                detail: ""
+                detail: entry_comment
               )
               
               imported_consts << Interface::CompletionItem.new(
@@ -183,7 +184,7 @@ module RubyLsp
             else
               label_details = Interface::CompletionItemLabelDetails.new(
                 description: "from: :#{package_name}",
-                detail: " #{file_name}"
+                detail: entry_comment + " #{file_name}"
               )
 
               not_imported_consts << Interface::CompletionItem.new(

data/lib/ruby_lsp/ruby_lsp_ree/handlers/const_additional_text_edits_creator.rb

@@ -46,7 +46,11 @@ module RubyLsp
         else
           # add new link
 
-          link_text = "\s\slink #{const_link[:link_name]}, import: -> { #{@const_name} }"
+          link_text = if const_link[:link_type] == :file_path
+            "\s\slink #{const_link[:link_name]}, -> { #{@const_name} }"
+          else
+            "\s\slink #{const_link[:link_name]}, import: -> { #{@const_name} }"
+          end
 
           if @parsed_doc.links_container_node
             link_text = "\s\s" + link_text
@@ -84,10 +88,12 @@ module RubyLsp
         
         ree_obj_name = nil
         link_name = nil
+        link_type = nil
 
         if is_ree_object?(@entry.uri)
           ree_obj_name = File.basename(entry_uri, ".*")
           link_name = ":#{ree_obj_name}"
+          link_type = :ree_object
 
           if @package_name != @parsed_doc.package_name
             link_name += ", from: :#{@package_name}"
@@ -95,9 +101,10 @@ module RubyLsp
         else
           ree_obj_name = path_from_package_folder(entry_uri)
           link_name = "\"#{ree_obj_name}\""
+          link_type = :file_path
         end
 
-        return { link_name: link_name, object_name: ree_obj_name }
+        return { link_name: link_name, object_name: ree_obj_name, link_type: link_type }
       end
     end
   end

data/lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb

@@ -102,7 +102,6 @@ module RubyLsp
       def get_linked_object_definition_items(node)
         result = []
         parent_node = @node_context.parent
-        return [] unless parent_node.name == :link
 
         link_node = RubyLsp::Ree::ParsedLinkNode.new(parent_node, package_name_from_uri(@uri))
         package_name = link_node.link_package_name
@@ -124,6 +123,33 @@ module RubyLsp
         result
       end
 
+      def get_routes_definition_items(node)
+        parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@root_node, @uri, :route)
+
+        return [] unless parsed_doc.includes_routes_dsl?
+
+        parent_node = @node_context.parent
+
+        package_name = if parsed_doc.has_route_option?(:from)
+          parsed_doc.route_option_value(:from)
+        else
+          package_name_from_uri(@uri)
+        end 
+
+        ree_object = @finder.find_object_for_package(node.unescaped, package_name)
+        return [] unless ree_object
+
+        [
+          Interface::Location.new(
+            uri: ree_object.uri.to_s,
+            range: Interface::Range.new(
+              start: Interface::Position.new(line: 0, character: 0),
+              end: Interface::Position.new(line: 0, character: 0),
+            ),
+          )
+        ]
+      end
+
       def get_linked_filepath_definition_items(node)
         result = []
         local_path = find_local_file_path(node.unescaped)
@@ -168,17 +194,25 @@ module RubyLsp
 
         result = []
 
-        key_path = if @node_context.parent.arguments.arguments.size > 1
-          @node_context.parent.arguments.arguments[1].unescaped
+        key_path_entries = if @node_context.parent.arguments.arguments.size > 1
+          [@node_context.parent.arguments.arguments[1].unescaped]
         else
           parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@root_node, @uri)
+          file_name = File.basename(@uri.path, '.rb')
 
           mod = underscore(parsed_doc.module_name)
-          "#{mod}.errors.#{node.unescaped}"
+          [
+            "#{mod}.errors.#{node.unescaped}",
+            "#{mod}.errors.#{file_name}.#{node.unescaped}"
+          ]
         end
 
         Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
-          location = find_locale_key_location(locale_file, key_path)
+          values = key_path_entries.map{ [_1, find_locale_value(locale_file, _1)] }
+          key_path = values.select{ |val| !val[1].nil? }.last
+          next unless key_path
+          
+          location = find_locale_key_location(locale_file, key_path[0])
 
           result << Interface::Location.new(
             uri: locale_file,

data/lib/ruby_lsp/ruby_lsp_ree/handlers/hover_handler.rb

@@ -109,17 +109,22 @@ module RubyLsp
 
         result = []
 
-        key_path = if @node_context.parent.arguments.arguments.size > 1
-          @node_context.parent.arguments.arguments[1].unescaped
+        key_path_entries = if @node_context.parent.arguments.arguments.size > 1
+          [@node_context.parent.arguments.arguments[1].unescaped]
         else
+          file_name = File.basename(uri.path, '.rb')
+
           mod = underscore(parsed_doc.module_name)
-          "#{mod}.errors.#{node.unescaped}"
+          [
+            "#{mod}.errors.#{node.unescaped}",
+            "#{mod}.errors.#{file_name}.#{node.unescaped}"
+          ]
         end
 
         documentation = ''
 
         Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
-          value = find_locale_value(locale_file, key_path)
+          value = key_path_entries.map{ find_locale_value(locale_file, _1) }.compact.first
 
           loc_key = File.basename(locale_file, '.yml')
 

data/lib/ruby_lsp/ruby_lsp_ree/listeners/definition_listener.rb

@@ -44,8 +44,10 @@ module RubyLsp
       def on_symbol_node_enter(node)
         definition_items = if @ree_context.is_error_definition?
           @handler.get_error_code_definition_items(node)
-        else
+        elsif @ree_context.is_link_object?
           @handler.get_linked_object_definition_items(node)
+        else
+          @handler.get_routes_definition_items(node)
         end
         
         put_items_into_response(definition_items)

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_base_document.rb

@@ -16,6 +16,18 @@ class RubyLsp::Ree::ParsedBaseDocument
     false
   end
 
+  def includes_link_dsl?
+    false
+  end
+
+  def includes_routes_dsl?
+    false
+  end
+
+  def includes_ree_dsl?
+    false
+  end
+
   def includes_linked_object?(obj_name)
     @link_nodes.map(&:name).include?(obj_name)
   end
@@ -42,10 +54,6 @@ class RubyLsp::Ree::ParsedBaseDocument
     raise "abstract method"
   end
 
-  def includes_link_dsl?
-    raise "abstract method"
-  end
-
   def parse_links
     raise "abstract method"
   end

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_class_document.rb

@@ -10,7 +10,8 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
 
   attr_reader :class_node, :class_includes, 
     :values, :filters, :bean_methods, :links_container_block_node, :error_definitions, 
-    :error_definition_names, :doc_instance_methods, :links_container_node
+    :error_definition_names, :doc_instance_methods, :links_container_node, 
+    :defined_classes, :defined_consts
 
   def initialize(ast, package_name = nil)
     super
@@ -33,6 +34,14 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
     @class_includes.any?{ node_name(_1) == LINK_DSL_MODULE }
   end
 
+  def includes_routes_dsl?
+    @class_includes.any?{ node_name(_1) == ROUTES_DSL_MODULE }
+  end
+
+  def includes_ree_dsl?
+    ree_dsls.size > 0
+  end
+
   def includes_linked_constant?(const_name)
     @link_nodes.map(&:imports).flatten.include?(const_name)
   end
@@ -102,7 +111,7 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
 
     @link_nodes = nodes.map do |link_node|
       link_node = RubyLsp::Ree::ParsedLinkNode.new(link_node, package_name)
-      link_node.parse_imports
+      link_node.parse_imports # TODO move parse imports inside link_node constructor
       link_node
     end
   end
@@ -175,6 +184,24 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
     @error_definition_names = @error_definitions.map(&:name)
   end
 
+  def parse_defined_classes
+    @defined_classes = []
+    return unless has_body?
+
+    @defined_classes = class_node.body.body
+      .select{ _1.is_a?(Prism::ClassNode) }
+      .map(&:name)
+  end
+    
+  def parse_defined_consts
+    @defined_consts = []
+    return unless has_body?
+
+    @defined_consts += class_node.body.body
+      .select{ _1.is_a?(Prism::ConstantWriteNode) }
+      .map(&:name)
+  end
+
   def class_name
     class_node.constant_path.name.to_s
   end
@@ -195,4 +222,8 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
   def imported_constants
     @link_nodes.map(&:imports).flatten.map(&:to_sym)
   end
+
+  def ree_dsls
+    @class_includes.select{ node_name(_1).downcase.match?(/ree/) && node_name(_1).downcase.match?(/dsl/)}
+  end
 end

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_document_builder.rb

@@ -1,6 +1,7 @@
 require 'prism'
 require_relative 'parsed_class_document'
 require_relative 'parsed_rspec_document'
+require_relative 'parsed_route_document'
 
 class RubyLsp::Ree::ParsedDocumentBuilder
   extend RubyLsp::Ree::ReeLspUtils
@@ -37,6 +38,8 @@ class RubyLsp::Ree::ParsedDocumentBuilder
       build_dao_document(ast)
     when :bean
       build_bean_document(ast)
+    when :route
+      build_route_document(ast)
     else
       build_detected_document_type(ast, package_name)
     end
@@ -104,6 +107,10 @@ class RubyLsp::Ree::ParsedDocumentBuilder
     document
   end  
 
+  def self.build_route_document(ast)
+    RubyLsp::Ree::ParsedRouteDocument.new(ast)
+  end
+
   def self.is_ruby_file?(uri)
     File.extname(uri.to_s) == '.rb'
   end

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_link_node.rb

@@ -81,6 +81,27 @@ class RubyLsp::Ree::ParsedLinkNode
     !!import_arg
   end
 
+  def first_arg_location
+    @node.arguments.arguments.first.location
+  end
+
+  def import_block_open_location
+    if object_name_type?
+      import_arg.value.opening_loc
+    else
+      import_arg.opening_loc
+    end
+  end
+
+  def import_block_close_location
+    # TODO maybe use two classes for link types
+    if object_name_type?
+      import_arg.value.closing_loc
+    else
+      import_arg.closing_loc
+    end
+  end
+
   private
 
   def last_arg
@@ -100,9 +121,12 @@ class RubyLsp::Ree::ParsedLinkNode
     
     if object_name_type?
       return [] unless import_arg
-      [import_arg.value.body.body.first.name.to_s]
+      import_body = import_arg.value.body.body.first
+      parse_object_link_multiple_imports(import_body)
     elsif last_arg.is_a?(Prism::LambdaNode)
-      [last_arg.body.body.first.name.to_s]
+      return [] unless last_arg.body
+      import_body = last_arg.body.body.first
+      parse_object_link_multiple_imports(import_body)
     else
       return []
     end
@@ -110,4 +134,12 @@ class RubyLsp::Ree::ParsedLinkNode
     $stderr.puts("can't parse imports: #{e.message}")
     return []
   end
+
+  def parse_object_link_multiple_imports(import_body)
+    if import_body.is_a?(Prism::CallNode)
+      parse_object_link_multiple_imports(import_body.receiver) + [import_body.arguments.arguments.first.name.to_s]
+    else 
+      [import_body.name.to_s]
+    end
+  end
 end

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_method_node.rb

@@ -82,6 +82,18 @@ class RubyLsp::Ree::ParsedMethodNode
   def contract_node_end_line
     @contract_node.location.end_line - 1
   end
+
+  def contract_node_start_line
+    @contract_node.location.start_line - 1
+  end
+
+  def contract_node_contract_end_position
+    @contract_node.message_loc.end_column - 1
+  end
+
+  def contract_in_parentheses?
+    @contract_node.opening == '(' && @contract_node.closing == ')'
+  end
   
   def parse_nested_local_methods(local_methods)
     unless @method_node.body
@@ -91,9 +103,9 @@ class RubyLsp::Ree::ParsedMethodNode
 
     method_body = get_method_body(@method_node)
 
-    local_method_names = local_methods.map(&:name)
     call_nodes = parse_body_call_objects(method_body)
-    call_node_names = call_nodes.map(&:name)
+    call_expressions = parse_body_call_expressions(method_body)
+    call_node_names = call_nodes.map(&:name) + call_expressions
    
     @nested_local_methods = local_methods.select{ call_node_names.include?(_1.name) }
     @nested_local_methods.each{ _1.parse_nested_local_methods(local_methods) }
@@ -107,7 +119,7 @@ class RubyLsp::Ree::ParsedMethodNode
         call_nodes << node
       elsif node.respond_to?(:statements)
         call_nodes += parse_body_call_objects(node.statements.body)
-      elsif node.respond_to?(:block) && node.block 
+      elsif node.respond_to?(:block) && node.block && node.block.is_a?(Prism::BlockNode)
         call_nodes += parse_body_call_objects(get_method_body(node.block))
       end
     end
@@ -115,6 +127,18 @@ class RubyLsp::Ree::ParsedMethodNode
     call_nodes
   end
 
+  def parse_body_call_expressions(node_body)
+    call_expressions = []
+    
+    node_body.each do |node|
+      if node.respond_to?(:block) && node.block && node.block.is_a?(Prism::BlockArgumentNode) && node.block.expression.is_a?(Prism::SymbolNode)
+        call_expressions << node.block.expression.unescaped.to_sym
+      end
+    end
+
+    call_expressions
+  end
+
   def get_method_body(node)
     if node.body.is_a?(Prism::BeginNode)
       node.body.statements.body

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_route_document.rb

@@ -0,0 +1,30 @@
+class RubyLsp::Ree::ParsedRouteDocument < RubyLsp::Ree::ParsedClassDocument
+  include RubyLsp::Ree::ReeLspUtils
+
+  def initialize(ast, package_name = nil)
+    super
+    parse_class_includes
+    parse_route_options
+  end
+
+  def parse_route_options
+    @route_options ||= {}
+    return unless @class_node
+
+    @routes_node = @class_node.body.body.detect{ node_name(_1) == :routes }
+    return if !@routes_node || !@routes_node.block
+
+    @route_opts_node = @routes_node.block.body.body.detect{ node_name(_1) == :opts }
+    @route_opts_node.value.elements.each do |assoc_node|
+      @route_options[assoc_node.key.unescaped] = assoc_node.value.unescaped
+    end
+  end
+
+  def has_route_option?(option_name)
+    @route_options.has_key?(option_name.to_s)
+  end
+
+  def route_option_value(option_name)
+    @route_options[option_name.to_s]
+  end
+end

data/lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_rspec_document.rb

@@ -31,10 +31,6 @@ class RubyLsp::Ree::ParsedRspecDocument < RubyLsp::Ree::ParsedBaseDocument
     false
   end
 
-  def includes_link_dsl?
-    false
-  end
-
   def parse_describe_node
     @describe_node ||= @ast.statements.body.detect{ |node| node.is_a?(Prism::CallNode) && node.name == :describe }
   end

data/lib/ruby_lsp/ruby_lsp_ree/ree_constants.rb

@@ -2,7 +2,8 @@ module RubyLsp
   module Ree
     module ReeConstants
       LINK_DSL_MODULE = 'Ree::LinkDSL'
-  
+      ROUTES_DSL_MODULE = 'ReeRoutes::DSL'
+
       LINKS_CONTAINER_TYPES = [
         :fn,
         :action,

data/lib/ruby_lsp/ruby_lsp_ree/ree_context.rb

@@ -15,6 +15,12 @@ module RubyLsp
         
         ERROR_DEFINITION_NAMES.include?(@node_context.parent.name)
       end
+
+      def is_link_object?
+        return false if !@node_context || !@node_context.parent || !@node_context.parent.is_a?(Prism::CallNode)
+
+        @node_context.parent.name == :link
+      end
     end
   end
 end

data/lib/ruby_lsp/ruby_lsp_ree/ree_dsl_parser.rb

@@ -0,0 +1,39 @@
+module RubyLsp
+  module Ree
+    class ReeDslParser
+      include RubyLsp::Ree::ReeLspUtils
+
+      attr_reader :parsed_doc
+
+      def initialize(parsed_doc, index)
+        @parsed_doc = parsed_doc
+        @index = index
+      end
+
+      def contains_object_usage?(obj_name)
+        return false unless @index
+        return false unless parsed_doc.includes_ree_dsl?
+
+        parsed_doc.ree_dsls.any? do |ree_dsl|
+          ree_dsl_contains_object_usage?(ree_dsl.name, obj_name)
+        end
+      end
+
+      private
+
+      def ree_dsl_contains_object_usage?(dsl_name, obj_name)
+        dsl_objects = @index[dsl_name]
+        return unless dsl_objects
+
+        uris = dsl_objects.map(&:uri)
+
+        uris.any?{ file_contains_object_usage?(_1, obj_name) }
+      end
+
+      def file_contains_object_usage?(file_uri, obj_name) 
+        file_content = File.read(file_uri.path.to_s)
+        file_content.match?(/\W#{obj_name}\W/)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_ree/ree_formatter.rb

@@ -2,6 +2,7 @@ require_relative 'formatters/sort_links_formatter'
 require_relative 'formatters/missing_error_definitions_formatter'
 require_relative 'formatters/missing_error_contracts_formatter'
 require_relative 'formatters/missing_error_locales_formatter'
+require_relative 'formatters/unused_links_formatter'
 
 module RubyLsp
   module Ree
@@ -12,8 +13,10 @@ module RubyLsp
 
       MISSING_LOCALE_PLACEHOLDER = '_MISSING_LOCALE_'
 
-      def initialize(message_queue)
+      def initialize(message_queue, settings, index = nil)
         @message_queue = message_queue
+        @settings = settings || {}
+        @index = index
       end
 
       def run_formatting(uri, document)
@@ -23,10 +26,14 @@ module RubyLsp
           RubyLsp::Ree::SortLinksFormatter,
           RubyLsp::Ree::MissingErrorDefinitionsFormatter,
           RubyLsp::Ree::MissingErrorContractsFormatter,
-          RubyLsp::Ree::MissingErrorLocalesFormatter
-        ]
+          RubyLsp::Ree::MissingErrorLocalesFormatter,
+          RubyLsp::Ree::UnusedLinksFormatter,
+        ].select do |formatter|
+          formatter_name = formatter.name.split('::').last.to_sym
+          @settings[formatter_name] != false
+        end
 
-        formatters.reduce(source){ |s, formatter| formatter.call(s, uri, @message_queue) }
+        formatters.reduce(source){ |s, formatter| formatter.call(s, uri, @message_queue, @index) }
       rescue => e
         $stderr.puts("error in ree_formatter: #{e.message} : #{e.backtrace.first}")
       end
@@ -47,29 +54,34 @@ module RubyLsp
 
         result = []
         error_keys = []
+        file_name = File.basename(uri.to_s, '.rb')
 
         parsed_doc.parse_error_definitions
         parsed_doc.error_definitions.each do |error_definition|
-          key_path = if error_definition.value.arguments.arguments.size > 1
-            error_definition.value.arguments.arguments[1].unescaped
+          key_path_entries = if error_definition.value.arguments.arguments.size > 1
+            [error_definition.value.arguments.arguments[1].unescaped]
           else
             mod = underscore(parsed_doc.module_name)
-            "#{mod}.errors.#{error_definition.value.arguments.arguments[0].unescaped}"
+            [
+              "#{mod}.errors.#{error_definition.value.arguments.arguments[0].unescaped}",
+              "#{mod}.errors.#{file_name}.#{error_definition.value.arguments.arguments[0].unescaped}"
+            ]
           end
 
-          error_keys << [key_path, error_definition]
+          error_keys << [key_path_entries, error_definition]
         end
 
         Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
           error_keys.each do |error_key|
-            key_path = error_key[0]
-            value = find_locale_value(locale_file, key_path)
+            key_path_entries = error_key[0]
+            value = key_path_entries.map{ find_locale_value(locale_file, _1) }.compact.first
+
             if !value || value == MISSING_LOCALE_PLACEHOLDER
               loc_key = File.basename(locale_file, '.yml')
               error_definition = error_key[1]
 
               result << RubyLsp::Interface::Diagnostic.new(
-                message: "Missing locale #{loc_key}: #{key_path}",
+                message: "Missing locale #{loc_key}: #{key_path_entries[0]} or #{key_path_entries[1]} ",
                 source: "Ree formatter",
                 severity: RubyLsp::Constant::DiagnosticSeverity::ERROR,
                 range: RubyLsp::Interface::Range.new( 

data/lib/ruby_lsp/ruby_lsp_ree/ree_indexing_enhancement.rb

@@ -7,9 +7,14 @@ module RubyLsp
       include RubyLsp::Ree::ReeLspUtils
 
       REE_INDEXED_OBJECTS = [:fn, :enum, :action, :dao, :bean, :mapper, :aggregate, :async_bean]
+      SCHEMA_NODE_NAME = :schema
 
       def on_call_node_enter(node)
         return unless @listener.current_owner
+      
+        if node.name == SCHEMA_NODE_NAME
+          return index_ree_schema(node)
+        end
 
         return unless REE_INDEXED_OBJECTS.include?(node.name)
         return unless node.arguments
@@ -37,6 +42,19 @@ module RubyLsp
 
       private
 
+      def index_ree_schema(node)
+        return if node.receiver
+        return if !node.arguments || !node.block
+
+        @listener.add_class(
+          node.arguments.arguments.first.name.to_s, 
+          node.location, 
+          node.location, 
+          parent_class_name: nil, 
+          comments: "ree_schema"
+        )
+      end
+
       def parse_signatures(fn_name, ast)
         class_node = ast.statements.body.detect{ |node| node.is_a?(Prism::ClassNode) }
         return [] unless class_node

data/lib/ruby_lsp/ruby_lsp_ree/ree_source_editor.rb

@@ -0,0 +1,68 @@
+module RubyLsp
+  module Ree
+    class ReeSourceEditor
+      include RubyLsp::Ree::ReeLspUtils
+
+      attr_reader :source_lines
+
+      def initialize(source)
+        @source_lines = source.lines
+      end
+
+      def source
+        @source_lines.join
+      end
+
+      def contains_link_usage?(link_node)
+        source_lines_except_link = source_lines[0...(link_node.location.start_line-1)] + source_lines[(link_node.location.end_line)..-1]
+        source_lines_except_link.any?{ |source_line| source_line.match?(/\W#{link_node.name}\W/)}
+      end
+
+      def contains_link_import_usage?(link_node, link_import)
+        source_lines_except_link = source_lines[0...(link_node.location.start_line-1)] + source_lines[(link_node.location.end_line)..-1]
+        source_lines_except_link.any?{ |source_line| source_line.match?(/\W#{link_import}\W/)}
+      end
+
+      def remove_link(link_node)
+        set_empty_lines!(link_node.location.start_line-1, link_node.location.end_line-1)
+      end
+
+      def remove_link_import(link_node, link_import)
+        imports_str = link_node.imports.reject{ _1 == link_import}.join(' & ')
+
+        block_start_col = link_node.import_block_open_location.start_column
+        block_line = link_node.import_block_open_location.start_line-1
+        block_end_line = link_node.import_block_close_location.end_line-1
+
+        source_lines[block_line] = source_lines[block_line][0..block_start_col] + " #{imports_str} }\n"
+        set_empty_lines!(block_line+1, block_end_line)
+      end
+
+      def remove_link_import_arg(link_node)
+        link_line = link_node.location.start_line - 1
+        link_end_line = link_node.location.end_line - 1
+        link_name_end = link_node.first_arg_location.end_column - 1
+
+        source_lines[link_line] = source_lines[link_line][0..link_name_end] + "\n"
+        set_empty_lines!(link_line+1, link_end_line)
+      end
+
+      def remove_link_block(links_container_node, links_container_block_node)
+        return source_lines unless links_container_block_node
+        
+        link_container_start_line = links_container_node.location.start_line-1
+        link_container_end_line = links_container_node.location.end_line-1
+        block_start = links_container_block_node.location.start_column-1
+
+        source_lines[link_container_start_line] = source_lines[link_container_start_line][0..block_start] + "\n"
+        set_empty_lines!(link_container_start_line+1, link_container_end_line)
+      end
+
+      def set_empty_lines!(start_line, end_line)
+        (start_line .. end_line).each do |i|
+          source_lines[i] = ''
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp_ree/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Ree
-    VERSION = "0.1.12"
+    VERSION = "0.1.14"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-ree
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby LSP addon that adds extra editor functionality for Ree applications
 email:
@@ -31,6 +31,7 @@ files:
 - lib/ruby_lsp/ruby_lsp_ree/formatters/missing_error_definitions_formatter.rb
 - lib/ruby_lsp/ruby_lsp_ree/formatters/missing_error_locales_formatter.rb
 - lib/ruby_lsp/ruby_lsp_ree/formatters/sort_links_formatter.rb
+- lib/ruby_lsp/ruby_lsp_ree/formatters/unused_links_formatter.rb
 - lib/ruby_lsp/ruby_lsp_ree/handlers/completion_handler.rb
 - lib/ruby_lsp/ruby_lsp_ree/handlers/const_additional_text_edits_creator.rb
 - lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb
@@ -44,13 +45,16 @@ files:
 - lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_document_builder.rb
 - lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_link_node.rb
 - lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_method_node.rb
+- lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_route_document.rb
 - lib/ruby_lsp/ruby_lsp_ree/parsing/parsed_rspec_document.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_constants.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_context.rb
+- lib/ruby_lsp/ruby_lsp_ree/ree_dsl_parser.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_formatter.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_indexing_enhancement.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_object_finder.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_rename_handler.rb
+- lib/ruby_lsp/ruby_lsp_ree/ree_source_editor.rb
 - lib/ruby_lsp/ruby_lsp_ree/ree_template_applicator.rb
 - lib/ruby_lsp/ruby_lsp_ree/utils/ree_locale_utils.rb
 - lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb