yoda-language-server 0.8.0 → 0.10.1

data/lib/yoda/server/lifecycle_handler.rb

@@ -1,9 +1,12 @@
 require 'concurrent'
+require 'yoda/server/providers'
 
 module Yoda
   class Server
     # Handle
     class LifecycleHandler
+      include Providers::ReportableProgress
+
       # @return [Session, nil]
       attr_reader :session
 
@@ -41,83 +44,92 @@ module Yoda
 
       # @param params [LanguageServer::Protocol::Interface::InitializeParams]
       def handle_initialize(params)
-        Instrument.instance.hear(initialization_progress: method(:notify_initialization_progress)) do
-          @session = begin
-            if params[:workspace_folders]
-              workspace_folders = params[:workspace_folders].map { |hash| LanguageServer::Protocol::Interface::WorkspaceFolder.new(name: hash[:name], uri: hash[:uri]) }
-              Session.from_workspace_folders(workspace_folders)
-            elsif params[:root_uri]
-              Session.from_root_uri(params[:root_uri])
-            else
-              Session.new(workspaces: [])
+        in_progress(params, title: "Initializing Yoda") do |progress_reporter|
+          reporter = InitializationProgressReporter.new(progress_reporter)
+
+          subscriptions = {
+            initialization_progress: reporter.public_method(:notify_initialization_progress),
+            build_library_registry: reporter.public_method(:notify_build_library_registry),
+          }
+
+          Instrument.instance.hear(**subscriptions) do
+            @session = begin
+              if params[:workspace_folders]
+                workspace_folders = params[:workspace_folders].map { |hash| LanguageServer::Protocol::Interface::WorkspaceFolder.new(name: hash[:name], uri: hash[:uri]) }
+                Session.from_workspace_folders(workspace_folders)
+              elsif params[:root_uri]
+                Session.from_root_uri(params[:root_uri])
+              else
+                Session.new(workspaces: [])
+              end
             end
-          end
 
-          send_warnings(@session.setup || [])
+            send_warnings(@session.setup || [])
+          end
+        end
 
-          LanguageServer::Protocol::Interface::InitializeResult.new(
-            server_info: {
-              name: "yoda",
-              version: Yoda::VERSION,
-            },
-            capabilities: LanguageServer::Protocol::Interface::ServerCapabilities.new(
-              text_document_sync: LanguageServer::Protocol::Interface::TextDocumentSyncOptions.new(
-                open_close: true,
-                change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::FULL,
-                save: LanguageServer::Protocol::Interface::SaveOptions.new(
-                  include_text: true,
-                ),
-              ),
-              completion_provider: LanguageServer::Protocol::Interface::CompletionOptions.new(
-                resolve_provider: false,
-                trigger_characters: ['.', '@', '[', ':', '!', '<'],
+        LanguageServer::Protocol::Interface::InitializeResult.new(
+          server_info: {
+            name: "yoda",
+            version: Yoda::VERSION,
+          },
+          capabilities: LanguageServer::Protocol::Interface::ServerCapabilities.new(
+            text_document_sync: LanguageServer::Protocol::Interface::TextDocumentSyncOptions.new(
+              open_close: true,
+              change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::FULL,
+              save: LanguageServer::Protocol::Interface::SaveOptions.new(
+                include_text: true,
               ),
-              hover_provider: true,
-              definition_provider: true,
-              signature_help_provider: LanguageServer::Protocol::Interface::SignatureHelpOptions.new(
-                trigger_characters: ['(', ','],
-              ),
-              workspace_symbol_provider: LanguageServer::Protocol::Interface::WorkspaceSymbolOptions.new(
-                work_done_progress: true,
+            ),
+            completion_provider: LanguageServer::Protocol::Interface::CompletionOptions.new(
+              resolve_provider: false,
+              trigger_characters: ['.', '@', '[', ':', '!', '<'],
+            ),
+            hover_provider: true,
+            definition_provider: true,
+            signature_help_provider: LanguageServer::Protocol::Interface::SignatureHelpOptions.new(
+              trigger_characters: ['(', ','],
+            ),
+            workspace_symbol_provider: LanguageServer::Protocol::Interface::WorkspaceSymbolOptions.new(
+              work_done_progress: true,
+            ),
+            workspace: {
+              workspaceFolders: LanguageServer::Protocol::Interface::WorkspaceFoldersServerCapabilities.new(
+                supported: true,
+                change_notifications: true,
               ),
-              workspace: {
-                workspaceFolders: LanguageServer::Protocol::Interface::WorkspaceFoldersServerCapabilities.new(
-                  supported: true,
-                  change_notifications: true,
-                ),
-                fileOperations: {
-                  didCreate: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
-                    filters: [
-                      LanguageServer::Protocol::Interface::FileOperationFilter.new(
-                        pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
-                          glob: "**/*",
-                        ),
+              fileOperations: {
+                didCreate: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
+                  filters: [
+                    LanguageServer::Protocol::Interface::FileOperationFilter.new(
+                      pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
+                        glob: "**/*",
                       ),
-                    ],
-                  ),
-                  didRename: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
-                    filters: [
-                      LanguageServer::Protocol::Interface::FileOperationFilter.new(
-                        pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
-                          glob: "**/*",
-                        ),
+                    ),
+                  ],
+                ),
+                didRename: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
+                  filters: [
+                    LanguageServer::Protocol::Interface::FileOperationFilter.new(
+                      pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
+                        glob: "**/*",
                       ),
-                    ],
-                  ),
-                  didDelete: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
-                    filters: [
-                      LanguageServer::Protocol::Interface::FileOperationFilter.new(
-                        pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
-                          glob: "**/*",
-                        ),
+                    ),
+                  ],
+                ),
+                didDelete: LanguageServer::Protocol::Interface::FileOperationRegistrationOptions.new(
+                  filters: [
+                    LanguageServer::Protocol::Interface::FileOperationFilter.new(
+                      pattern: LanguageServer::Protocol::Interface::FileOperationPattern.new(
+                        glob: "**/*",
                       ),
-                    ],
-                  ),
-                },
+                    ),
+                  ],
+                ),
               },
-            ),
-          )
-        end
+            },
+          ),
+        )
       rescue => e
         Logger.warn e.full_message
         LanguageServer::Protocol::Interface::ResponseError.new(
@@ -206,18 +218,29 @@ module Yoda
         EOS
       end
 
-      def notify_initialization_progress(phase: nil, message: nil, index:, length:)
-        if length && length > 0
-          percentage = (index || 0) * 100 / length
-          if index <= 0
-            notifier.start_progress(id: phase, title: phase, message: message, percentage: percentage)
-          elsif index >= length
-            notifier.done_progress(id: phase)
+      class InitializationProgressReporter
+        # @return [Providers::ReportableProgress::ProgressReporter]
+        attr_reader :progress_reporter
+
+        # @param progress_reporter [Providers::ReportableProgress::ProgressReporter]
+        def initialize(progress_reporter)
+          @progress_reporter = progress_reporter
+        end
+
+        def notify_initialization_progress(phase: nil, message: nil, index:, length:)
+          if length && length > 0
+            percentage = (index || 0) * 100 / length
+
+            progress_reporter.report(message: message, percentage: percentage)
           else
-            notifier.report_progress(id: phase, message: message, percentage: percentage)
+            progress_reporter.report(message: message)
           end
-        else
-          notifier.event(type: :initialization, phase: phase, message: message)
+
+          progress_reporter.notifier.event(type: :initialization, phase: phase, message: message)
+        end
+
+        def notify_build_library_registry(message: nil, name: nil, version: nil)
+          progress_reporter.report(message: message)
         end
       end
     end

data/lib/yoda/server/notifier.rb

@@ -10,19 +10,18 @@ module Yoda
       def busy(type:, id: nil)
         failed = false
         event(type: type, phase: :begin, id: id)
-        start_progress(id: id, title: type)
         yield
       rescue => e
         Logger.warn(e.full_message)
         failed = true
+        event(type: type, phage: :failed, id: id)
         raise e 
       ensure
         event(type: type, phase: :end, id: id)
-        failed ? cancel_progress(id: id) : done_progress(id: id)
       end
 
       # @param params [Hash]
-      def event(params)
+      def event(**params)
         write(method: 'telemetry/event', params: params)
       end
 
@@ -121,58 +120,6 @@ module Yoda
         )
       end
 
-      # @param id [String, Symbol]
-      # @param title [String]
-      # @param calcellable [Boolean]
-      # @param message [String, nil]
-      # @param percentage [Integer]
-      def start_progress(id:, title:, cancellable: false, message: nil, percentage: 0)
-        write(
-          method: 'window/progress/start',
-          params: {
-            id: id,
-            title: title,
-            calcellable: cancellable,
-            message: message,
-            percentage: percentage,
-          }
-        )
-      end
-
-      # @param id [String, Symbol]
-      # @param message [String, nil]
-      # @param percentage [Integer, nil]
-      def report_progress(id:, message: nil, percentage: nil)
-        write(
-          method: 'window/progress/report',
-          params: {
-            id: id,
-            message: message,
-            percentage: percentage,
-          }
-        )
-      end
-
-      # @param id [String, Symbol]
-      def done_progress(id:)
-        write(
-          method: 'window/progress/done',
-          params: {
-            id: id,
-          }
-        )
-      end
-
-      # @param id [String, Symbol]
-      def cancel_progress(id:)
-        write(
-          method: 'window/progress/cancel',
-          params: {
-            id: id,
-          }
-        )
-      end
-
       private
 
       def write(params)

data/lib/yoda/services/loadable_path_resolver.rb

@@ -0,0 +1,40 @@
+module Yoda
+  module Services
+    class LoadablePathResolver
+      def initialize
+      end
+
+      # @param base_paths [Array<String>]
+      # @param pattern [String]
+      # @return [String, nil]
+      def find_loadable_path(base_paths, pattern)
+        # TODO: Support absolute path
+        return nil if absolute_path?(pattern)
+        return nil if pattern.start_with?("~/")
+        return nil if pattern.start_with?("./")
+        return nil if pattern.start_with?("../")
+
+        base_paths.each do |base_path|
+          path = File.join(base_path, pattern)
+
+          if File.extname(path).empty?
+            paths_with_suffix = ::Gem.suffixes.map { |suffix| path + suffix }
+            matched_path = paths_with_suffix.find { |path| File.file?(path) }
+            return matched_path if matched_path
+          else
+            return path if File.file?(path)
+          end
+        end
+
+        return nil
+      end
+
+      # This is a workaround for Ruby 2.6 (This version does not have `File.absolute_path?`)
+      # @param path [String]
+      # @return [Boolean]
+      def absolute_path?(path)
+        path[0] == "/"
+      end
+    end
+  end
+end

data/lib/yoda/services.rb

@@ -4,6 +4,7 @@ module Yoda
     require 'yoda/services/current_node_explain'
     require 'yoda/services/comment_completion'
     require 'yoda/services/code_completion'
+    require 'yoda/services/loadable_path_resolver'
     require 'yoda/services/signature_discovery'
   end
 end

data/lib/yoda/store/actions/read_project_files.rb

@@ -2,21 +2,23 @@ module Yoda
   module Store
     module Actions
       class ReadProjectFiles
+        # @return [Project]
+        attr_reader :project
+
         # @return [Registry]
         attr_reader :registry
 
-        # @return [String]
-        attr_reader :root_path
-
         # @param project [Project]
         # @return [ReadProjectFiles]
         def self.for_project(project)
-          new(project.registry, project.root_path)
+          new(project, project.registry)
         end
 
-        def initialize(registry, root_path)
+        # @param project [Project]
+        # @param registry [Project]
+        def initialize(project, registry)
+          @project = project
           @registry = registry
-          @root_path = root_path
         end
 
         def run
@@ -35,7 +37,7 @@ module Yoda
 
         # @return [Array<String>]
         def project_files
-          Dir.chdir(root_path) { Dir.glob(["{lib,app}/**/*.rb", "ext/**/*.c", ".yoda/*.rb"]).map { |name| File.expand_path(name, root_path) } }
+          project.project_source_paths
         end
       end
     end

data/lib/yoda/store/adapters/gdbm_adapter/namespace_accessor.rb

@@ -20,7 +20,7 @@ module Yoda
 
           # @param address [String, Symbol]
           # @return [Object, nil]
-          def get(address)
+          def get(address, **)
             JSON.load(database[build_key(address)], symbolize_names: true)
           end
 

data/lib/yoda/store/adapters/memory_adapter.rb

@@ -28,7 +28,7 @@ module Yoda
 
         # @param address [String]
         # @return [any]
-        def get(address)
+        def get(address, **)
           JSON.load(db[address.to_s], symbolize_names: true)
         end
 

data/lib/yoda/store/objects/libraries_status.rb

@@ -10,7 +10,7 @@ module Yoda
         # @param dependency [Project::Dependency]
         # @return [Array<Object::Library::Core, Object::Library::Std, Object::Library::Gem>]
         def self.libraies_from_dependency(dependency)
-          [dependency.core, dependency.std, *dependency.gems.select(&:installed?)]
+          [dependency.core, dependency.std, *dependency.autoload_gems.select(&:installed?)]
         end
 
         # @param libraries [Array<Library::Core, Library::Std, Library::Gem>]

data/lib/yoda/store/objects/library/core.rb

@@ -1,3 +1,5 @@
+require 'yoda/store/objects/library/path_resolvable'
+
 module Yoda
   module Store
     module Objects
@@ -42,6 +44,7 @@ module Yoda
           class Connected
             extend ConnectedDelegation
             include WithRegistry
+            include PathResolvable
 
             delegate_to_object :version
             delegate_to_object :id, :name, :doc_path, :to_h, :with_project_connection
@@ -64,6 +67,11 @@ module Yoda
             def registry_path
               VersionStore.for_current_version.registry_path_for_core
             end
+
+            # @return [Array<String>]
+            def require_paths
+              []
+            end
           end
         end
       end

data/lib/yoda/store/objects/library/gem.rb

@@ -1,18 +1,24 @@
+require 'yoda/store/objects/library/path_resolvable'
+
 module Yoda
   module Store
     module Objects
       module Library
         class Gem
           include Serializable
+          include PathResolvable
 
           # @return [String]
           attr_reader :name, :version, :source_path, :full_gem_path, :doc_dir
 
+          # @return [Array<String>]
+          attr_reader :require_paths
+
           # @return [Symbol, nil]
           attr_reader :source_type
 
           class << self
-            # @param spec [Bundler::LazySpecification]
+            # @param spec [Bundler::LazySpecification, Gem::Specification]
             def from_gem_spec(spec)
               if spec.respond_to?(:full_gem_path)
                 # Installed
@@ -20,6 +26,7 @@ module Yoda
                   name: spec.name,
                   version: spec.version.version,
                   source_path: spec.source.respond_to?(:path) ? spec.source.path : nil,
+                  require_paths: spec.full_require_paths,
                   full_gem_path: spec.full_gem_path,
                   doc_dir: spec.doc_dir,
                   source_type: source_type_of(spec.source),
@@ -30,6 +37,7 @@ module Yoda
                   name: spec.name,
                   version: spec.version.version,
                   source_path: nil,
+                  require_paths: [],
                   full_gem_path: nil,
                   doc_dir: nil,
                   source_type: nil,
@@ -57,11 +65,12 @@ module Yoda
             end
           end
 
-          def initialize(name:, version:, source_path:, full_gem_path:, doc_dir:, source_type:)
+          def initialize(name:, version:, source_path:, full_gem_path:, require_paths:, doc_dir:, source_type:)
             @name = name
             @version = version
             @source_path = source_path
             @full_gem_path = full_gem_path
+            @require_paths = require_paths
             @doc_dir = doc_dir
             @source_type = source_type&.to_sym
           end
@@ -80,6 +89,7 @@ module Yoda
               version: version,
               source_path: source_path,
               full_gem_path: full_gem_path,
+              require_paths: require_paths,
               doc_dir: doc_dir,
               source_type: source_type,
             }
@@ -103,9 +113,10 @@ module Yoda
             extend ConnectedDelegation
             include WithRegistry
 
-            delegate_to_object :name, :version, :source_path, :full_gem_path, :doc_dir, :source_type
+            delegate_to_object :name, :version, :source_path, :full_gem_path, :doc_dir, :source_type, :require_paths
             delegate_to_object :id, :local?, :to_h, :installed?, :managed_by_rubygems?, :with_project_connection
             delegate_to_object :hash, :eql?, :==, :to_json, :derive
+            delegate_to_object :contain_requirable_file?, :find_requirable_file
 
             # @return [Gem]
             attr_reader :object

data/lib/yoda/store/objects/library/path_resolvable.rb

@@ -0,0 +1,29 @@
+require 'yoda/store/objects/library/path_resolvable'
+
+module Yoda
+  module Store
+    module Objects
+      module Library
+        module PathResolvable
+          # @abstract
+          # @return [Array<String>]
+          def require_paths
+            fail NotImplementedError
+          end
+
+          # @param relative_path [String]
+          # @return [Boolean]
+          def contain_requirable_file?(relative_path)
+            !!find_requirable_file(relative_path)
+          end
+
+          # @param relative_path [String]
+          # @return [String, nil]
+          def find_requirable_file(relative_path)
+            Services::LoadablePathResolver.new.find_loadable_path(require_paths, relative_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoda/store/objects/library/std.rb

@@ -1,3 +1,5 @@
+require 'yoda/store/objects/library/path_resolvable'
+
 module Yoda
   module Store
     module Objects
@@ -42,6 +44,7 @@ module Yoda
           class Connected
             extend ConnectedDelegation
             include WithRegistry
+            include PathResolvable
 
             delegate_to_object :version
             delegate_to_object :id, :name, :doc_path, :to_h, :with_project_connection
@@ -64,6 +67,12 @@ module Yoda
             def registry_path
               VersionStore.for_current_version.registry_path_for_stdlib
             end
+
+            # @return [Array<String>]
+            def require_paths
+              # TODO: Calculate from registry
+              [File.join(VersionStore.for_current_version.ruby_source_path, "lib/")]
+            end
           end
         end
       end

data/lib/yoda/store/objects/library.rb

@@ -6,6 +6,7 @@ module Yoda
         require 'yoda/store/objects/library/core'
         require 'yoda/store/objects/library/std'
         require 'yoda/store/objects/library/gem'
+        require 'yoda/store/objects/library/path_resolvable'
 
         class << self
           # @return [Core]

data/lib/yoda/store/objects/patch.rb

@@ -17,7 +17,7 @@ module Yoda
 
         # @param address [String, Symbol]
         # @return [Addressable, nil]
-        def find(address)
+        def find(address, **)
           @registry[address.to_sym]
         end
         alias get find

data/lib/yoda/store/objects/patch_set.rb

@@ -13,7 +13,7 @@ module Yoda
 
           # @param address [Symbol]
           # @return [Set<Symbol>]
-          def get(address)
+          def get(address, **)
             index[address] ||= Set.new
           end
 
@@ -73,7 +73,7 @@ module Yoda
 
         # @param address [String, Symbol]
         # @return [Addressable, nil]
-        def find(address)
+        def find(address, **)
           if (patches = get_patches(address)).empty?
             nil
           else

data/lib/yoda/store/project/dependency.rb

@@ -12,8 +12,13 @@ module Yoda
         end
 
         # @return [Array<Objects::Library::Gem>]
-        def gems
-          builder.gems
+        def loadable_gems
+          builder.loadable_gems
+        end
+
+        # @return [Array<Objects::Library::Gem>]
+        def autoload_gems
+          builder.autoload_gems
         end
 
         # @param name [String]
@@ -33,6 +38,7 @@ module Yoda
           @std ||= Objects::Library.std
         end
 
+        # @return [Builder]
         def builder
           @builder ||= Builder.new(project)
         end
@@ -47,14 +53,21 @@ module Yoda
           end
 
           # @return [Array<Objects::Library::Gem>]
-          def gems
-            @gems ||= begin
+          def loadable_gems
+            @loadable_gems ||= begin
               dependencies
                 .map { |attrs| Objects::Library::Gem.new(**attrs) }
                 .reject { |spec| project.config.ignored_gems.include?(spec.name) }
             end
           end
 
+          # @return [Array<Objects::Library::Gem>]
+          def autoload_gems
+            @autoload_gems ||= begin
+              loadable_gems.select { |gem| autoload_dependency_ids.include?(gem.id) }
+            end
+          end
+
           private
 
           # @return [Array<Hash>]
@@ -62,6 +75,11 @@ module Yoda
             analyzed_deps[:dependencies] || []
           end
 
+          # @return [Array<String>]
+          def autoload_dependency_ids
+            analyzed_deps[:autoload_dependency_ids] || []
+          end
+
           # @return [Hash]
           def analyzed_deps
             @analyzed_deps ||= begin