ruby-lsp-ree 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d126a7d0c8462f33b63113cf86ae134f8cb029da147273bdb2f8cb76cb448e
-  data.tar.gz: dbb25c53fc012b487a3ed9555ad470c10445603e808aa3f44442070b4fc57851
+  metadata.gz: 3814d8a258c4c291c8c2a858e5bf23094086e25162435b956bae4401bd456109
+  data.tar.gz: a8ae59abe162776aba2356dc2a3c9b607703ac9d5012fac2c843ab84c7e12e96
 SHA512:
-  metadata.gz: 50d85fbda0c61e33709823c7e8b5f263d94eba2d6822b1e84f011ad0b058adf6d5766a5fe27b6613c537b2e36f878a8ef50ddf7fad7dd41cfd954011fe90c156
-  data.tar.gz: 66c76a82263258d76fcc7cc604e6aa499deb209ae80c6ae8a5bad1dd486f7ee70c9e0af896277c0cc01631ad99c91f5b5b827e18337b0d95e4d18622d1c2c389
+  metadata.gz: 4ab9db29ce9ed0fc7ee54721826ee1933308511c3f07ddce31c53504dde5d422a131dcb6421bb428c9694ddbbc6cdab83b5f96315d9195e97e2bac11a5bad2e2
+  data.tar.gz: f6dcffe5363c8acb0481b9c8adbd1d6a5b6322833dc0fe1d8001188d7daf796aa68008ae648d3b99a4ad7f9f9e281b0fbdab4efec80a88b362cd18865dbd829c

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.1.6] - 2025-03-04
+
+- file rename triggers class name change
+- add documentation string to hover
+- add hover on link section beans
+
+## [0.1.5] - 2025-02-28
+
+- improved hover format
+- basic support for ree templates
+
 ## [0.1.4] - 2025-02-25
 
 - autocompletion in spec files

data/Gemfile.lock

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

data/lib/ruby_lsp/ruby_lsp_ree/addon.rb

@@ -5,6 +5,8 @@ require_relative "listeners/hover_listener"
 require_relative "ree_indexing_enhancement"
 require_relative "utils/ree_lsp_utils"
 require_relative "ree_formatter"
+require_relative "ree_template_applicator"
+require_relative "ree_rename_handler"
 require_relative "parsing/parsed_document_builder"
 
 module RubyLsp
@@ -13,8 +15,10 @@ module RubyLsp
       def activate(global_state, message_queue)
         @global_state = global_state
         @message_queue = message_queue
+        @template_applicator = RubyLsp::Ree::ReeTemplateApplicator.new
 
         global_state.register_formatter("ree_formatter", RubyLsp::Ree::ReeFormatter.new)
+        register_additional_file_watchers(global_state, message_queue)
       end
 
       def deactivate
@@ -38,6 +42,46 @@ module RubyLsp
         index = @global_state.index
         RubyLsp::Ree::HoverListener.new(response_builder, node_context, index, dispatcher)
       end
+
+      def register_additional_file_watchers(global_state, message_queue)
+        # Clients are not required to implement this capability
+        return unless global_state.supports_watching_files
+        
+        message_queue << Request.new(
+          id: "ruby-lsp-ree-file-create-watcher",
+          method: "client/registerCapability",
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: "workspace/didCreateWatchedFilesRee",
+                method: "workspace/didChangeWatchedFiles",
+                register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
+                  watchers: [
+                    Interface::FileSystemWatcher.new(
+                      glob_pattern: "**/*.rb",
+                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE,
+                    ),
+                  ],
+                ),
+              ),
+            ],
+          ),
+        )
+      end
+
+      def workspace_did_change_watched_files(changes)
+        if changes.size == 1 && changes[0][:type] == Constant::FileChangeType::CREATED
+          $stderr.puts("file created #{changes[0][:uri]}")
+
+          return unless @template_applicator.template_dir_exists?
+
+          @template_applicator.apply(changes[0])
+        elsif changes.size == 2 && changes.any?{ _1[:type] == Constant::FileChangeType::CREATED } && changes.any?{ _1[:type] == Constant::FileChangeType::DELETED }
+          $stderr.puts("file renamed #{changes[0][:uri]} #{changes[1][:uri]}")
+  
+          RubyLsp::Ree::ReeRenameHandler.call(changes)
+        end
+      end
     end
   end
 end

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

@@ -110,7 +110,7 @@ module RubyLsp
       def get_enum_values_completion_items(enum_obj, location)
         enum_node = RubyLsp::Ree::ParsedDocumentBuilder.build_from_uri(enum_obj.uri, :enum)
 
-        class_name = enum_node.get_class_name
+        class_name = enum_node.full_class_name
 
         label_details = Interface::CompletionItemLabelDetails.new(
           description: "from: #{class_name}",

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

@@ -20,19 +20,36 @@ module RubyLsp
 
         return [] unless ree_object
 
-        documentation =  <<~DOC
-        Ree object, type: :#{@finder.object_type(ree_object)}
+        documentation = get_object_documentation(ree_object)
 
-        usage: #{node.name.to_s}#{get_detail_string(ree_object)}
-        
-        package: #{package_name_from_uri(ree_object.uri)}
+        [documentation]
+      end
 
-        file: #{path_from_package_folder(ree_object.uri)}
-        DOC
+      def get_linked_object_hover_items(node)
+        parent_node = @node_context.parent
+        return [] unless parent_node.name == :link
+
+        ree_object = @finder.find_object(node.unescaped)
+
+        return [] unless ree_object
+
+        documentation = get_object_documentation(ree_object)
 
         [documentation]
       end
 
+      def get_object_documentation(ree_object)
+        <<~DOC
+        \`\`\`ruby
+        #{ree_object.name}#{get_detail_string(ree_object)}
+        \`\`\`
+        ---
+        #{@finder.object_documentation(ree_object)}
+
+        [#{path_from_package_folder(ree_object.uri)}](#{ree_object.uri})
+        DOC
+      end
+
       def get_detail_string(ree_object)
         return '' if ree_object.signatures.size == 0
 

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

@@ -9,8 +9,12 @@ module RubyLsp
         @response_builder = response_builder
         @handler = RubyLsp::Ree::HoverHandler.new(index, node_context)
 
-        dispatcher.register(self, :on_call_node_enter)
-        dispatcher.register(self, :on_constant_read_node_enter)
+        dispatcher.register(
+          self, 
+          :on_call_node_enter,
+          :on_symbol_node_enter,
+          :on_constant_read_node_enter
+        )
       end
 
       def on_constant_read_node_enter(node)
@@ -32,6 +36,13 @@ module RubyLsp
         $stderr.puts("error in hover listener(on_call_node_enter): #{e.message} : #{e.backtrace.first}")
       end
 
+      def on_symbol_node_enter(node)
+        hover_items = @handler.get_linked_object_hover_items(node)
+        put_items_into_response(hover_items)
+      rescue => e
+        $stderr.puts("error in hover listener(on_symbol_node_enter): #{e.message} : #{e.backtrace.first}")
+      end
+
       def put_items_into_response(items)
         items.each do |item|
           @response_builder.push(item, category: :documentation)

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

@@ -175,11 +175,19 @@ class RubyLsp::Ree::ParsedDocument
     [RubyIndexer::Entry::Signature.new(signature_params)]
   end
 
-  def get_class_name
+  def class_name
+    class_node.constant_path.name.to_s
+  end
+
+  def full_class_name
     name_parts = [class_node.constant_path&.parent&.name, class_node.constant_path.name]
     name_parts.compact.map(&:to_s).join('::')
   end
 
+  def links_container_node_name
+    links_container_node.arguments.arguments.first.unescaped
+  end
+
   def node_name(node)
     return nil unless node.respond_to?(:name)
 

data/lib/ruby_lsp/ruby_lsp_ree/ree_indexing_enhancement.rb

@@ -18,9 +18,14 @@ module RubyLsp
         obj_name = node.arguments.child_nodes.first.unescaped
         return unless current_filename == obj_name
 
+        source = @listener.instance_variable_get(:@source_lines).join
+        ast = Prism.parse(source).value # TODO use doc builder
+
         location = node.location
-        signatures = parse_signatures(obj_name)
-        comments = "ree_object\ntype: :#{node.name}"
+        signatures = parse_signatures(obj_name, ast)
+        documentation = parse_documentation(obj_name, ast)
+
+        comments = "ree_object\ntype: :#{node.name}\n#{documentation}"
 
         @listener.add_method(
           obj_name,
@@ -32,10 +37,7 @@ module RubyLsp
 
       private
 
-      def parse_signatures(fn_name)
-        source = @listener.instance_variable_get(:@source_lines).join
-        ast = Prism.parse(source).value
-
+      def parse_signatures(fn_name, ast)
         class_node = ast.statements.body.detect{ |node| node.is_a?(Prism::ClassNode) }
         return [] unless class_node
 
@@ -47,6 +49,28 @@ module RubyLsp
         [RubyIndexer::Entry::Signature.new(signature_params)]
       end
 
+      def parse_documentation(fn_name, ast)
+        class_node = ast.statements.body.detect{ |node| node.is_a?(Prism::ClassNode) }
+        return '' unless class_node
+
+        doc_node = class_node.body.body.detect{ |node| node.respond_to?(:name) && node.name == :doc }
+        return '' unless doc_node
+
+        str_node = doc_node.arguments.arguments.first
+
+        case str_node
+        when Prism::StringNode
+          str_node.unescaped
+        when Prism::InterpolatedStringNode
+          str_node.parts.map(&:unescaped).join
+        else
+          ''
+        end
+      rescue => e
+        $stderr.puts("error parsing documentation for #{fn_name}: #{e.message} : #{e.backtrace.first}")
+        return ''
+      end
+
       def current_filename
         uri = @listener.instance_variable_get(:@uri)
         File.basename(uri.path, '.rb')  

data/lib/ruby_lsp/ruby_lsp_ree/ree_object_finder.rb

@@ -71,21 +71,14 @@ module RubyLsp
       end
 
       def object_type(ree_object)
-        # TODO rewrite to use string split
-        case ree_object.comments.lines[1]&.chomp
-        when DAO_TYPE_STRING
-          :dao
-        when BEAN_TYPE_STRING
-          :bean
-        when ENUM_TYPE_STRING
-          :enum
-        when MAPPER_TYPE_STRING
-          :mapper
-        when AGGREGATE_TYPE_STRING
-          :aggregate
-        else
-          nil
-        end
+        type_str = ree_object.comments.lines[1]&.chomp
+        return unless type_str
+          
+        type_str.split(' ').last[1..-1].to_sym
+      end
+
+      def object_documentation(ree_object)
+        ree_object.comments.lines[2..-1].join("\n").chomp
       end
     end
   end

data/lib/ruby_lsp/ruby_lsp_ree/ree_rename_handler.rb

@@ -0,0 +1,39 @@
+module RubyLsp
+  module Ree
+    class ReeRenameHandler
+      include RubyLsp::Ree::ReeLspUtils
+
+      def self.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_file_name = File.basename(old_uri, '.rb')
+        new_file_name = File.basename(new_uri, '.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
+        new_class_name = new_file_name.split('_').collect(&:capitalize).join
+
+        return unless parsed_doc.class_name == old_class_name
+
+        file_content_lines = File.read(new_uri.path).lines
+        
+        class_line = parsed_doc.class_node.location.start_line - 1
+
+        file_content_lines[class_line].gsub!(/\b#{old_class_name}\b/, new_class_name)
+
+        if parsed_doc.links_container_node
+          links_container_node_line = parsed_doc.links_container_node.location.start_line - 1
+
+          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)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_ree/ree_template_applicator.rb

@@ -0,0 +1,100 @@
+module RubyLsp
+  module Ree
+    class ReeTemplateApplicator
+      include RubyLsp::Ree::ReeLspUtils
+
+      TEMPLATES_FOLDER = '.vscode-ree/templates'
+      DEFAULT_TEMPLATE_FILENAME = 'default.rb'
+      RSPEC_TEMPLATE_PATH = 'spec_template.rb'
+
+      def initialize
+        return unless template_dir_exists?
+
+        @template_types = Dir
+          .entries(TEMPLATES_FOLDER)
+          .select{ |entry| 
+            File.directory? File.join(TEMPLATES_FOLDER,entry) and !(entry =='.' || entry == '..')
+          }
+      end
+
+      def template_dir_exists?
+        File.exist?(TEMPLATES_FOLDER)
+      end
+
+      def apply(change_item)
+        uri = change_item[:uri]
+        path = URI.parse(uri).path
+
+        file_content = File.read(path)
+        return if file_content.size > 0
+
+        if path.end_with?('_spec.rb')
+          template_str = fetch_rspec_template
+          template_info = fetch_rspec_template_info(uri)
+        else
+          template_type = get_template_type_from_uri(uri)
+          return unless template_type
+  
+          template_str = fetch_template(template_type)
+          template_info = fetch_template_info(uri)
+        end
+        
+        template_content = replace_placeholders(template_str, template_info)
+
+        File.write(path, template_content)
+      end
+
+      def get_template_type_from_uri(uri)
+        uri_parts = File.dirname(uri).split('/')
+
+        uri_parts.reverse.detect{ @template_types.include?(_1) }
+      end
+
+      def fetch_template(template_type)
+        File.read(File.join(TEMPLATES_FOLDER, template_type, DEFAULT_TEMPLATE_FILENAME))
+      end
+
+      def fetch_rspec_template
+        File.read(File.join(TEMPLATES_FOLDER, RSPEC_TEMPLATE_PATH))
+      end
+
+      def fetch_template_info(uri)
+        object_name = File.basename(uri, '.rb')
+        object_class = object_name.split('_').collect(&:capitalize).join
+        package_name = package_name_from_uri(uri)
+        package_class = package_name.split('_').collect(&:capitalize).join
+        
+        {
+          'PACKAGE_MODULE' => package_class,
+          'PACKAGE_NAME' => package_name,
+          'OBJECT_CLASS' => object_class,
+          'OBJECT_NAME' => object_name,
+        }
+      end
+
+      def fetch_rspec_template_info(uri)
+        object_name = File.basename(uri, '.rb')
+        object_class = object_name.split('_').collect(&:capitalize).join
+        package_name = package_name_from_spec_uri(uri)
+        package_class = package_name.split('_').collect(&:capitalize).join
+        file_path = spec_relative_file_path_from_uri(URI(uri))&.delete_suffix('_spec')
+        
+        {
+          'RELATIVE_FILE_PATH' => file_path,
+          'MODULE_NAME' => package_class,
+          'CLASS_NAME' => object_class,
+          'OBJECT_NAME' => object_name, 
+          'PACKAGE_NAME' => package_name,
+        }
+      end
+      
+      def replace_placeholders(template_str, template_info)
+        template_info.each do |k,v|
+          template_str.gsub!(k, v)
+        end
+
+        template_str
+      end
+    end
+  end
+end

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

@@ -17,8 +17,17 @@ module RubyLsp
         uri_parts[package_folder_index + 1]
       end
 
+      def package_name_from_spec_uri(uri)
+        uri_parts = uri.to_s.split('/')
+        
+        spec_folder_index = uri_parts.find_index('spec')
+        return unless spec_folder_index
+
+        uri_parts[spec_folder_index + 1]
+      end
+
       def path_from_package_folder(uri)
-        uri_parts = uri.to_s.chomp(File.extname(uri)).split('/')
+        uri_parts = uri.to_s.chomp(File.extname(uri.to_s)).split('/')
 
         package_folder_index = uri_parts.index('package')
         return unless package_folder_index
@@ -26,6 +35,14 @@ module RubyLsp
         uri_parts.drop(package_folder_index+1).join('/')
       end
 
+      def spec_relative_file_path_from_uri(uri)
+        uri_parts = uri.path.split('/')
+        spec_folder_index = uri_parts.index('spec')
+        return unless spec_folder_index
+
+        uri_parts[spec_folder_index+1..-1].join('/').chomp('.rb')
+      end
+
       def get_ree_type(ree_object)
         type_comment = ree_object.comments.to_s.lines[1]
         return unless type_comment

data/lib/ruby_lsp_ree/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Ree
-    VERSION = "0.1.4"
+    VERSION = "0.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-ree
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby LSP addon that adds extra editor functionality for Ree applications
 email:
@@ -39,6 +39,8 @@ files:
 - 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_template_applicator.rb
 - lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb
 - lib/ruby_lsp_ree.rb
 - lib/ruby_lsp_ree/version.rb