ruby-lsp-ree 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccc9c39cc6ca44feeb3c8c5369e259a790dc01c02a0aecf9a14eee2d19e65015
-  data.tar.gz: 61233b0b379f7ab994f102fc748e2ef54eed53e605017bb0d28793ea160a45d7
+  metadata.gz: 363caa1c6e2f1d4bdedac1791e0edf969fab9fa7037039a6146de7f0d98d0056
+  data.tar.gz: 750e5d2bba1606b9f50d465b7a86aafb830ee43c18637053421b68e59fabf1f9
 SHA512:
-  metadata.gz: 07cf2e0c6c6670f5405a967e7fffe9af19af8a29dc55d33afef3b9dd0f231df826a0cd11d4e5b91ad23b7348635107c0186a7bb8b878bce00d9a480710267608
-  data.tar.gz: 5a5bcdf420fe934e46ec0b0318c6325cd5c6a0753ca18ea73a8188f54dc19a1c7abd6b3e41a777fb4f0a8b6f6bf83c8fd015226ceb21ee54c8228264874f0aaf
+  metadata.gz: 422890cf9cb718b345df5290c2493a0647ad699636e166c9989b4b91a88909c068a0f3b866b32481303d47e0a1eb29f3cfb1a45d3ba14431a9c8aece0aa85b37
+  data.tar.gz: b6a374374b8070b679bc2d2720f8a97c49116f21f91d63ba202a98838ec110d90e61c18936963e2aeaa0ff613a3c3fbe89c7ac48c151495045690e46eacd35c7

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.10] - 2025-03-26
+
+- async_bean support
+- rename for 'copy' files
+- add diagnostics for missing locale
+- link in error locale hover leads to the correct line
+- missing locale notification
+
 ## [0.1.8] - 2025-03-21
 
 - hover: show missing locales

data/Gemfile.lock

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

data/README.md

@@ -10,15 +10,22 @@ 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)
 
-To use ree_formatter, add the following line into you `settings.json` file (e.g. `.vscode/settings.json`)
+To use ree_formatter, add the following line into your `settings.json` file (e.g. `.vscode/settings.json`)
 ```json
 "rubyLsp.formatter": "ree_formatter"
 ```
 
+To use diagnostics, add the following line into your `settings.json` file (e.g. `.vscode/settings.json`)
+```json
+"rubyLsp.linters": ["ree_formatter"]
+```
+
 ## Functions
 
-- autocomplete for Ree functions
+- autocomplete for Ree objects
 - autocomplete for constants
 - adds links to the links section on autocomplete
 - sort links on document save or format (with ree_formatter enabled)
-- Go To Definition for Ree functions
+- missing error locales detection
+- Go To Definition for Ree objects
+- hover information for Ree objects and error locales

data/lib/ruby_lsp/ruby_lsp_ree/addon.rb

@@ -17,7 +17,7 @@ module RubyLsp
         @message_queue = message_queue
         @template_applicator = RubyLsp::Ree::ReeTemplateApplicator.new
 
-        global_state.register_formatter("ree_formatter", RubyLsp::Ree::ReeFormatter.new)
+        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,8 +1,12 @@
 module RubyLsp
   module Ree
     class BaseFormatter
-      def self.call(source, uri)
-        new.call(source, uri)
+      def self.call(source, uri, message_queue)
+        new(message_queue).call(source, uri)
+      end
+
+      def initialize(message_queue)
+        @message_queue = message_queue
       end
 
       def call(source, uri)

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

@@ -11,7 +11,7 @@ module RubyLsp
       def call(source, uri)
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(source)
 
-        locales_folder = package_locales_folder_path(URI.parse(uri.to_s).path)
+        locales_folder = package_locales_folder_path(get_uri_path(uri))
         return source if !locales_folder || !File.directory?(locales_folder)
 
         result = []
@@ -34,7 +34,8 @@ module RubyLsp
             unless value
               loc_key = File.basename(locale_file, '.yml')
 
-              add_locale_placeholder(locale_file, key_path)          
+              add_locale_placeholder(locale_file, key_path)    
+              send_message(locale_file, key_path)      
             end
           end
         end
@@ -77,7 +78,20 @@ module RubyLsp
 
         lines = File.read(file_path).lines
         lines[last_found_key.line] += adding_string
-        File.write(file_path, lines.join)
+        
+        new_source = lines.join.force_encoding("utf-8")
+        File.open(file_path, 'wb:UTF-8'){|f|
+          f.write(new_source)
+        }
+        
+        new_source
+      end
+
+      def send_message(locale_file, key_path)   
+        loc_key = File.basename(locale_file, '.yml')
+
+        message = "Missing locale #{loc_key}: #{key_path}"
+        @message_queue << RubyLsp::Notification.window_show_message(message, type: Constant::MessageType::ERROR)
       end
     end
   end

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

@@ -7,7 +7,7 @@ module RubyLsp
       include Requests::Support::Common
       include RubyLsp::Ree::ReeLspUtils
 
-      RECEIVER_OBJECT_TYPES = [:enum, :dao, :bean]
+      RECEIVER_OBJECT_TYPES = [:enum, :dao, :bean, :async_bean]
       CANDIDATES_LIMIT = 100
 
       def initialize(index, uri, node_context)
@@ -30,7 +30,7 @@ module RubyLsp
         case @finder.object_type(ree_receiver)
         when :enum
           get_enum_values_completion_items(ree_receiver, location)
-        when :bean
+        when :bean, :async_bean
           get_bean_methods_completion_items(ree_receiver, location)
         when :dao
           get_dao_filters_completion_items(ree_receiver, location)

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

@@ -86,7 +86,7 @@ module RubyLsp
           if value
             if value == MISSING_LOCALE_PLACEHOLDER
               value_location = find_locale_key_location(locale_file, key_path)
-              file_uri = "#{locale_file}" # TODO add line to uri :#{value_location.line+1}:#{value_location.column}"
+              file_uri = "file://#{locale_file}##{value_location.line+1}"
               documentation += "#{loc_key}: [#{value}](#{file_uri})\n\n"
             else
               documentation += "#{loc_key}: #{value}\n\n"

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

@@ -28,8 +28,9 @@ class RubyLsp::Ree::ParsedDocument
     :bean_node, :bean_methods, :mapper_node, :links_container_block_node, :aggregate_node,
     :error_definitions, :error_definition_names, :doc_instance_methods
 
-  def initialize(ast)
+  def initialize(ast, package_name = nil)
     @ast = ast
+    set_package_name(package_name) if package_name
   end
 
   def links_container_node
@@ -105,7 +106,7 @@ class RubyLsp::Ree::ParsedDocument
   def parse_bean_node
     return unless class_node
 
-    @bean_node ||= class_node.body.body.detect{ |node| node_name(node) == :bean }
+    @bean_node ||= class_node.body.body.detect{ |node| node_name(node) == :bean || node_name(node) == :async_bean}
     @links_container_block_node ||= @bean_node&.block
   end
 

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

@@ -7,20 +7,16 @@ class RubyLsp::Ree::ParsedDocumentBuilder
 
   def self.build_from_uri(uri, type = nil)
     ast = Prism.parse_file(uri.path).value
-    document = build_document(ast, type)
+    document = build_document(ast, type, package_name_from_uri(uri))
     return unless document
 
-    document.set_package_name(package_name_from_uri(uri))
-
     document
   end
 
   def self.build_from_ast(ast, uri, type = nil)
-    document = build_document(ast, type)
+    document = build_document(ast, type, package_name_from_uri(uri))
     return unless document
 
-    document.set_package_name(package_name_from_uri(uri))
-
     document
   end
 
@@ -29,7 +25,7 @@ class RubyLsp::Ree::ParsedDocumentBuilder
     build_document(ast, type)
   end
 
-  def self.build_document(ast, type)
+  def self.build_document(ast, type, package_name = nil)
     case type
     when :enum
       build_enum_document(ast)
@@ -38,13 +34,13 @@ class RubyLsp::Ree::ParsedDocumentBuilder
     when :bean
       build_bean_document(ast)
     else
-      build_detected_document_type(ast)
+      build_detected_document_type(ast, package_name)
     end
   end
 
-  def self.build_detected_document_type(ast)
+  def self.build_detected_document_type(ast, package_name = nil)
     if has_root_class?(ast)
-      build_regular_document(ast)
+      build_regular_document(ast, package_name)
     elsif has_root_rspec_call?(ast)
       build_rspec_document(ast)
     else 
@@ -69,8 +65,8 @@ class RubyLsp::Ree::ParsedDocumentBuilder
     document
   end
 
-  def self.build_regular_document(ast)
-    document = RubyLsp::Ree::ParsedDocument.new(ast)
+  def self.build_regular_document(ast, package_name)
+    document = RubyLsp::Ree::ParsedDocument.new(ast, package_name)
     
     document.parse_class_node
     document.parse_fn_node

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

@@ -1,7 +1,7 @@
 require 'prism'
 
 class RubyLsp::Ree::ParsedMethodNode
-  attr_reader :method_node, :contract_node
+  attr_reader :method_node, :contract_node, :nested_local_methods
 
   def initialize(method_node, contract_node)
     @method_node = method_node
@@ -89,8 +89,10 @@ class RubyLsp::Ree::ParsedMethodNode
       return
     end
 
+    method_body = get_method_body(@method_node)
+
     local_method_names = local_methods.map(&:name)
-    call_nodes = parse_body_call_objects(@method_node.body.body)
+    call_nodes = parse_body_call_objects(method_body)
     call_node_names = call_nodes.map(&:name)
    
     @nested_local_methods = local_methods.select{ call_node_names.include?(_1.name) }
@@ -112,4 +114,12 @@ class RubyLsp::Ree::ParsedMethodNode
 
     call_nodes
   end
+
+  def get_method_body(node)
+    if node.body.is_a?(Prism::BeginNode)
+      node.body.statements.body
+    else
+      node.body.body
+    end
+  end
 end

data/lib/ruby_lsp/ruby_lsp_ree/ree_formatter.rb

@@ -10,6 +10,12 @@ module RubyLsp
       include RubyLsp::Ree::ReeLspUtils
       include RubyLsp::Ree::ReeLocaleUtils
 
+      MISSING_LOCALE_PLACEHOLDER = '_MISSING_LOCALE_'
+
+      def initialize(message_queue)
+        @message_queue = message_queue
+      end
+
       def run_formatting(uri, document)
         source = document.source
 
@@ -20,13 +26,12 @@ module RubyLsp
           RubyLsp::Ree::MissingErrorLocalesFormatter
         ]
 
-        formatters.reduce(source){ |s, formatter| formatter.call(s, uri) }
+        formatters.reduce(source){ |s, formatter| formatter.call(s, uri, @message_queue) }
       rescue => e
         $stderr.puts("error in ree_formatter: #{e.message} : #{e.backtrace.first}")
       end
 
       def run_diagnostic(uri, document)
-        $stderr.puts("ree_formatter_diagnostic")
         detect_missing_error_locales(uri, document)
       rescue => e
         $stderr.puts("error in ree_formatter_diagnostic: #{e.message} : #{e.backtrace.first}")
@@ -38,10 +43,11 @@ module RubyLsp
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_source(document.source)
 
         locales_folder = package_locales_folder_path(uri.path)
-        return [] unless File.directory?(locales_folder)
+        return [] if !locales_folder || !File.directory?(locales_folder)
 
         result = []
-        key_paths = []
+        error_keys = []
+
         parsed_doc.parse_error_definitions
         parsed_doc.error_definitions.each do |error_definition|
           key_path = if error_definition.value.arguments.arguments.size > 1
@@ -51,27 +57,24 @@ module RubyLsp
             "#{mod}.errors.#{error_definition.value.arguments.arguments[0].unescaped}"
           end
 
-          key_paths << key_path
+          error_keys << [key_path, error_definition]
         end
 
-        $stderr.puts("ree_formatter_diagnostic #{key_paths}")
-
         Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
-          key_paths.each do |key_path|
+          error_keys.each do |error_key|
+            key_path = error_key[0]
             value = find_locale_value(locale_file, key_path)
-            unless value
+            if !value || value == MISSING_LOCALE_PLACEHOLDER
               loc_key = File.basename(locale_file, '.yml')
+              error_definition = error_key[1]
 
-              $stderr.puts("ree_formatter_diagnostic add diagnostic")
-
-              # TODO correct error range
               result << RubyLsp::Interface::Diagnostic.new(
                 message: "Missing locale #{loc_key}: #{key_path}",
                 source: "Ree formatter",
                 severity: RubyLsp::Constant::DiagnosticSeverity::ERROR,
                 range: RubyLsp::Interface::Range.new( 
-                  start: RubyLsp::Interface::Position.new(line: 0, character: 0),
-                  end: RubyLsp::Interface::Position.new(line: 0, character: 0),
+                  start: RubyLsp::Interface::Position.new(line: error_definition.location.start_line-1, character: error_definition.name_loc.start_column),
+                  end: RubyLsp::Interface::Position.new(line: error_definition.location.start_line-1, character: error_definition.name_loc.end_column),
                 ),
               )
             end

data/lib/ruby_lsp/ruby_lsp_ree/ree_indexing_enhancement.rb

@@ -6,7 +6,7 @@ module RubyLsp
     class ReeIndexingEnhancement < RubyIndexer::Enhancement
       include RubyLsp::Ree::ReeLspUtils
 
-      REE_INDEXED_OBJECTS = [:fn, :enum, :action, :dao, :bean, :mapper, :aggregate]
+      REE_INDEXED_OBJECTS = [:fn, :enum, :action, :dao, :bean, :mapper, :aggregate, :async_bean]
 
       def on_call_node_enter(node)
         return unless @listener.current_owner

data/lib/ruby_lsp/ruby_lsp_ree/ree_rename_handler.rb

@@ -4,15 +4,23 @@ module RubyLsp
       include RubyLsp::Ree::ReeLspUtils
 
       def self.call(changes)
+        new.call(changes)
+      end
+
+      def call(changes)
         old_uri = URI.parse(changes.detect{ _1[:type] == Constant::FileChangeType::DELETED }[:uri])
         new_uri = URI.parse(changes.detect{ _1[:type] == Constant::FileChangeType::CREATED }[:uri])
+      
+        old_path = get_uri_path(old_uri)
+        new_path = get_uri_path(new_uri)
 
-        old_file_name = File.basename(old_uri, '.rb')
-        new_file_name = File.basename(new_uri, '.rb')
+        old_file_name = File.basename(old_path, '.rb').chomp(" copy")
+        new_file_name = File.basename(new_path, '.rb')
 
         return if old_file_name == new_file_name
 
         parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_uri(new_uri)
+
         return if !parsed_doc || !parsed_doc.class_node
 
         old_class_name = old_file_name.split('_').collect(&:capitalize).join
@@ -20,7 +28,7 @@ module RubyLsp
 
         return unless parsed_doc.class_name == old_class_name
 
-        file_content_lines = File.read(new_uri.path).lines
+        file_content_lines = File.read(new_path).lines
         
         class_line = parsed_doc.class_node.location.start_line - 1
 
@@ -32,7 +40,7 @@ module RubyLsp
           file_content_lines[links_container_node_line].gsub!(/\b#{old_file_name}\b/, new_file_name)
         end
 
-        File.write(new_uri.path, file_content_lines.join)
+        File.write(new_path, file_content_lines.join)
       end
     end
   end

data/lib/ruby_lsp/ruby_lsp_ree/ree_template_applicator.rb

@@ -23,7 +23,9 @@ module RubyLsp
 
       def apply(change_item)
         uri = change_item[:uri]
-        path = URI.parse(uri).path
+        path = get_uri_path(uri)
+
+        return unless File.exist?(path)
 
         file_content = File.read(path)
         return if file_content.size > 0

data/lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb

@@ -3,6 +3,10 @@ module RubyLsp
     module ReeLspUtils
       Entry = RubyIndexer::Entry
 
+      def get_uri_path(uri)
+        URI.decode_www_form_component(URI.parse(uri.to_s).path)
+      end
+
       def find_local_file_path(file_path)
         file_name = file_path + ".rb"
         Dir[File.join('**', file_name)].first

data/lib/ruby_lsp/ruby_lsp_ree/utils/yaml_file_parser.rb

@@ -11,7 +11,7 @@ module RubyLsp
     class YamlFileParser
       def self.parse(file_path)
         parser = Psych::Parser.new(Psych::TreeBuilder.new)
-        parser.parse(File.read(file_path))
+        parser.parse(File.read(file_path, encoding: 'utf-8'))
 
         parse_result = NodeVisitor.create.accept(parser.handler.root)
         normalize_hash_keys(parse_result.first)
@@ -19,7 +19,7 @@ module RubyLsp
 
       def self.parse_with_key_coordinates(file_path)
         parser = Psych::Parser.new(Psych::TreeBuilder.new)
-        parser.parse(File.read(file_path))
+        parser.parse(File.read(file_path, encoding: 'utf-8'))
 
         NodeVisitor.create.accept(parser.handler.root).first
       end

data/lib/ruby_lsp_ree/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Ree
-    VERSION = "0.1.8"
+    VERSION = "0.1.10"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-ree
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby LSP addon that adds extra editor functionality for Ree applications
 email: