ruby-lsp-ree 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34821c4dab78822a47dd7fc927dbfaa8172992c8b51e62efe5650e4ed82a258
-  data.tar.gz: a2e0d86639041a0f0810da2309e3d0d1a5d95d60069d1815a01d27d1d720889a
+  metadata.gz: 830eb15946648bcdb6d03779678f3a4ed0d1f25081bf948d9951496b050a51b0
+  data.tar.gz: 6fb752c0d447d1e5a3e4d680b24ff8295555af253875d95498430951d872e919
 SHA512:
-  metadata.gz: 4c234cf9d220472e15fce43d01a5e304fb16a63de4c9b913110567f9e7f099950221308ce7b93f0637bc2d24492a4d3cafcc1da32e877fa7d0feb2a0aea2d4fa
-  data.tar.gz: 8323e4a46dcce71fd00c480374c58022415ba34603c640af812e7356bf8d0ce314fd0a8a919dc6bc54f0b23c82f2dc34c0df3f097930dc8f37bfadf56cc8a327
+  metadata.gz: 9766f1c674d1a3d695db8f181931c72d76993c46133d733e92f996c3d016d66bcc2b158f29a4e231b6dc39d5754b0586b9714496e13cb0d365169a96841d6626
+  data.tar.gz: b2883d1193a0039850fc343e2baf6aea0e374b08fbd1dc8c04e44c76f9c16a3fb4a755269b33e260e7a38dc7d0ff2f8d9fcb90b24d83bf0d1b242a82560bfdd6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [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.11)
+    ruby-lsp-ree (0.1.13)
 
 GEM
   remote: https://rubygems.org/

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

@@ -14,24 +14,30 @@ module RubyLsp
         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/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,14 @@ class RubyLsp::Ree::ParsedBaseDocument
     false
   end
 
+  def includes_link_dsl?
+    false
+  end
+
+  def includes_routes_dsl?
+    false
+  end
+
   def includes_linked_object?(obj_name)
     @link_nodes.map(&:name).include?(obj_name)
   end
@@ -42,10 +50,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

@@ -33,6 +33,10 @@ 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_linked_constant?(const_name)
     @link_nodes.map(&:imports).flatten.include?(const_name)
   end
@@ -69,11 +73,22 @@ class RubyLsp::Ree::ParsedClassDocument < RubyLsp::Ree::ParsedBaseDocument
     return unless has_body?
 
     @class_includes ||= class_node.body.body.select{ node_name(_1) == :include }.map do |class_include|
-      parent_name = class_include.arguments.arguments.first.parent.name.to_s
-      module_name = class_include.arguments.arguments.first.name
+      first_arg = class_include.arguments.arguments.first
+
+      include_name = case first_arg
+      when Prism::ConstantPathNode
+        parent_name = class_include.arguments.arguments.first.parent.name.to_s
+        module_name = class_include.arguments.arguments.first.name
+
+        [parent_name, module_name].compact.join('::')
+      when Prism::ConstantReadNode
+        first_arg.name.to_s
+      else
+        ''
+      end
     
       OpenStruct.new(
-        name: [parent_name, module_name].compact.join('::')
+        name: include_name, location: class_include.location
       )          
     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_method_node.rb

@@ -108,7 +108,7 @@ class RubyLsp::Ree::ParsedMethodNode
       elsif node.respond_to?(:statements)
         call_nodes += parse_body_call_objects(node.statements.body)
       elsif node.respond_to?(:block) && node.block 
-        call_nodes += parse_body_call_objects(node.block.body.body)
+        call_nodes += parse_body_call_objects(get_method_body(node.block))
       end
     end
 

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_formatter.rb

@@ -47,29 +47,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/utils/ree_lsp_utils.rb

@@ -68,8 +68,13 @@ module RubyLsp
             links_container_node.arguments.location.end_column + 1
           end
         elsif parsed_doc.includes_link_dsl?
-          fn_line = parsed_doc.link_nodes.last.location.start_line
-          position = parsed_doc.link_nodes.last.location.end_column + 1
+          if parsed_doc.link_nodes.size > 0
+            fn_line = parsed_doc.link_nodes.last.location.start_line
+            position = parsed_doc.link_nodes.last.location.end_column + 1
+          else
+            fn_line = parsed_doc.class_includes.last.location.start_line
+            position = parsed_doc.class_includes.last.location.end_column + 1
+          end
         elsif parsed_doc.allows_root_links?
           root_node_location = parsed_doc.root_node_line_location
          

data/lib/ruby_lsp_ree/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Ree
-    VERSION = "0.1.11"
+    VERSION = "0.1.13"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-ree
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby LSP addon that adds extra editor functionality for Ree applications
 email:
@@ -44,6 +44,7 @@ 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