ruby-lsp-ree 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d126a7d0c8462f33b63113cf86ae134f8cb029da147273bdb2f8cb76cb448e
-  data.tar.gz: dbb25c53fc012b487a3ed9555ad470c10445603e808aa3f44442070b4fc57851
+  metadata.gz: 9c8f904d1cf98e1106296f608f265999c5c606fc83473d3e65a05395dd83ace5
+  data.tar.gz: daba84c44a1bf697f80ec7589ab0a9a436af14aa5d9d8cc6cb12377623de5e8f
 SHA512:
-  metadata.gz: 50d85fbda0c61e33709823c7e8b5f263d94eba2d6822b1e84f011ad0b058adf6d5766a5fe27b6613c537b2e36f878a8ef50ddf7fad7dd41cfd954011fe90c156
-  data.tar.gz: 66c76a82263258d76fcc7cc604e6aa499deb209ae80c6ae8a5bad1dd486f7ee70c9e0af896277c0cc01631ad99c91f5b5b827e18337b0d95e4d18622d1c2c389
+  metadata.gz: 318c26fe57dcc12ac7a2209c10abd65b5662034e00eb87fea1a2ea58107ccd955db3b1e22a40c80f0a92e1ff10fef0f27c5a1ed3964b7877daa15dd5c64c61d4
+  data.tar.gz: 13c136bd68c1aa9f505a79b94d6f30b713e4e7f24b22a2157c5ccdadc1300d57e27fd7fb4bc5d75f55e7a441125dccf10d6923048948ec416616d7dd723936b1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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.5)
 
 GEM
   remote: https://rubygems.org/

data/lib/ruby_lsp/ruby_lsp_ree/addon.rb

@@ -5,6 +5,7 @@ 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 "parsing/parsed_document_builder"
 
 module RubyLsp
@@ -13,8 +14,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 +41,42 @@ 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
+        
+        return unless @template_applicator.template_dir_exists?
+
+        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,
+                    ),
+                  ],
+                ),
+              ),
+            ],
+          ),
+        )
+      end
+
+      def workspace_did_change_watched_files(changes)
+        $stderr.puts("workspace_did_change_watched_files #{changes.inspect}")
+
+        changes.each do |change_item|
+          @template_applicator.apply(change_item)
+        end
+      end
     end
   end
 end

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

@@ -21,13 +21,13 @@ module RubyLsp
         return [] unless ree_object
 
         documentation =  <<~DOC
-        Ree object, type: :#{@finder.object_type(ree_object)}
+        \`\`\`ruby
+        #{node.name.to_s}#{get_detail_string(ree_object)}
+        \`\`\`
+        ---
+        ree type: :#{@finder.object_type(ree_object)} package: #{package_name_from_uri(ree_object.uri)}
 
-        usage: #{node.name.to_s}#{get_detail_string(ree_object)}
-        
-        package: #{package_name_from_uri(ree_object.uri)}
-
-        file: #{path_from_package_folder(ree_object.uri)}
+        [#{path_from_package_folder(ree_object.uri)}](#{ree_object.uri})
         DOC
 
         [documentation]

data/lib/ruby_lsp/ruby_lsp_ree/ree_object_finder.rb

@@ -71,21 +71,10 @@ 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
     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.5"
   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.5
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby LSP addon that adds extra editor functionality for Ree applications
 email:
@@ -39,6 +39,7 @@ 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_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