holistic-ruby 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe4144d1f581c6151784152792604f799c0140d62c28f445f377f6039c40457
-  data.tar.gz: 6593b92046a8087f75c171280ae66401ff0bb1eb0f6dba9fa496df127bb39ee8
+  metadata.gz: b5eda7bf8e9da75eb3716452dfc2ebafdbaf35af0a53aef452c64bd95cd00bd8
+  data.tar.gz: 5522698edac5824011fd5aeee3ba4c71eb5cfee51b956c3d5942e329c7644072
 SHA512:
-  metadata.gz: eb1f43eaa7f78c334da3f8d8f2fc782bfa662b94f8a5a6b5a8a24ab271cae26d62703bd722860dbecf637d9aae5d4595d1424257406d9d349f0d90a95ab702d4
-  data.tar.gz: f42ed13efc65779f8ef175c7127d03cf68bebd5df990a1744d714100efe639cad104b55592507d4737ecfa4d48e75d6b69da194a033f056740a16fde8bf3d65d
+  metadata.gz: 06caa82194be9d2d2d9832aefd9132ab3d3cc1838be8b2cff9cd64f3fbafa36a9f0f79c40384eb4439adfd224a559605a9e328ae7dfb722235870b535f0d155f
+  data.tar.gz: a542c510078f1f528b4621000ba87843d0544e23dea77123bcf627e79d17f8dcdcb987be4122bd0f39c7f96533fc57d1a26e489e0cc25b6f5e0e5dfc68c436d3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    holistic-ruby (0.1.0)
+    holistic-ruby (0.1.7)
       activesupport (~> 7.0)
       syntax_tree (~> 6.0)
       zeitwerk (~> 2.6)

data/README.md

@@ -5,7 +5,7 @@
 ## Installation for Sublime Text
 
 1. Make sure you have the [LSP package installed](https://github.com/sublimelsp/LSP).
-2. Install the gem `$ gem install holistic-ruby`
+2. Install the gem with `$ gem install holistic-ruby`
 3. Go to `Preferences > Package Settings > LSP > Settings` and add:
 
 ```json
@@ -25,10 +25,10 @@
 
 * Go to definition.
 * Find references.
-* Autocompletion for namespaces, methods and local variables.
-* Syntax highlighting boundaries based on packwerk.
-* Outline dependencies.
-* Glossary.
+* Autocompletion for namespaces and methods.
+* (WIP) Outline dependencies.
+* (WIP) Syntax highlighting boundaries based on packwerk.
+* (WIP) Glossary.
 
 ## Why is it a toy language server?
 

data/exe/holistic-ruby

@@ -3,4 +3,3 @@
 require "holistic"
 
 ::Holistic::LanguageServer::Stdio::Start.call
-

data/lib/holistic/application.rb

@@ -2,12 +2,12 @@
 
 module Holistic
   class Application
-    attr_reader :name, :root_directory, :root_scope
+    attr_reader :name, :root_directory, :database
 
     def initialize(name:, root_directory:)
       @name = name
       @root_directory = root_directory
-      @root_scope = Ruby::Scope::Record.new(kind: Ruby::Scope::Kind::ROOT, name: "::", parent: nil)
+      @database = Database.new.tap(&Database::Migrations::Run)
     end
 
     def extensions
@@ -15,11 +15,19 @@ module Holistic
     end
 
     def scopes
-      @scopes ||= Ruby::Scope::Repository.new
+      @scopes ||= Ruby::Scope::Repository.new(database:)
     end
 
     def references
-      @references ||= Ruby::Reference::Repository.new
+      @references ||= Ruby::Reference::Repository.new(database:)
+    end
+
+    def files
+      @files ||= Document::File::Repository.new(database:)
+    end
+
+    def type_inference_processing_queue
+      @type_inference_processing_queue ||= Ruby::TypeInference::ProcessingQueue.new
     end
 
     def unsaved_documents

data/lib/holistic/database/migrations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Holistic::Database::Migrations
+  Run = ->(database) do
+    # scope lexical parent-children relation
+    database.define_relation(name: :lexical_children, inverse_of: :lexical_parent)
+
+    # scope inheritance and mixins
+    database.define_relation(name: :ancestors, inverse_of: :descendants)
+
+    # type inference conclusion
+    database.define_relation(name: :referenced_scope, inverse_of: :referenced_by)
+
+    # reference definition
+    database.define_relation(name: :located_in_scope, inverse_of: :contains_many_references)
+
+    # scope location in files
+    database.define_relation(name: :defines_scopes, inverse_of: :scope_defined_in_file)
+
+    # reference location in files
+    database.define_relation(name: :defines_references, inverse_of: :reference_defined_in_file)
+  end
+end

data/lib/holistic/database/node.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Holistic::Database::Node
+  attr_accessor :attributes, :relations, :__database__
+
+  def initialize(id, attributes)
+    @id = id
+    @attributes = attributes
+    @relations = ::Hash.new(&method(:build_relation_hash))
+  end
+
+  def attr(attribute_name)
+    @attributes[attribute_name]
+  end
+
+  def relation(relation_name)
+    @relations[relation_name]
+  end
+
+  def has_many(connection_name)
+    @relations[connection_name].to_a
+  end
+
+  def has_one(connection_name)
+    @relations[connection_name].first
+  end
+
+  private
+
+  def build_relation_hash(hash, name)
+    inverse_of = __database__.relations.dig(name, :inverse_of)
+
+    raise ::ArgumentError, "unknown relation: #{name}" if inverse_of.nil?
+
+    hash[name] = ::Holistic::Database::Relation.new(node: self, name:, inverse_of:)
+  end
+end

data/lib/holistic/database/relation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Holistic::Database::Relation < ::Set
+  def initialize(node:, name:, inverse_of:)
+    @node = node
+    @name = name
+    @inverse_of = inverse_of
+
+    super()
+  end
+
+  def add!(related_node)
+    @node.relations[@name].add(related_node)
+    related_node.relations[@inverse_of].add(@node)
+  end
+
+  def delete!(related_node)
+    @node.relations[@name].delete(related_node)
+    related_node.relations[@inverse_of].delete(@node)
+  end
+end

data/lib/holistic/database.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Holistic::Database
+  attr_reader :records, :relations
+
+  def initialize
+    @records = ::Hash.new
+    @relations = ::Hash.new
+  end
+
+  def define_relation(name:, inverse_of:)
+    raise ::ArgumentError if @relations.key?(name) || @relations.key?(inverse_of)
+
+    @relations[name] = { inverse_of: }
+    @relations[inverse_of] = { inverse_of: name }
+  end
+
+  def store(id, node_or_attrs)
+    if @records.key?(id)
+      return @records[id]&.tap do |node|
+        node.attributes =
+          case node_or_attrs
+          in ::Hash then node_or_attrs
+          in Node   then node_or_attrs.attributes
+          end
+      end
+    end
+
+    node =
+      case node_or_attrs
+      in ::Hash then Node.new(id, node_or_attrs)
+      in Node   then node_or_attrs
+      end
+
+    node.__database__ = self
+
+    @records[id] = node
+  end
+
+  def find(id)
+    @records[id]
+  end
+
+  def delete(id)
+    records.delete(id)
+  end
+
+  concerning :TestHelpers do
+    def all
+      records.values
+    end
+
+    def size
+      records.size
+    end
+  end
+end

data/lib/holistic/document/file/record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Holistic::Document::File
+  class Record < ::Holistic::Database::Node
+    def path = attr(:path)
+
+    def defines_scopes     = has_many(:defines_scopes)
+    def defines_references = has_many(:defines_references)
+  end
+end

data/lib/holistic/document/file/repository.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ::Holistic::Document::File
+  class Repository
+    attr_reader :database
+
+    def initialize(database:)
+      @database = database
+    end
+
+    # rename to `find_file`
+    def find(file_path)
+      @database.find(file_path)
+    end
+
+    concerning :TestHelpers do
+      def build_fake_location(file_path)
+        file = Store.call(database:, file_path:)
+
+        ::Holistic::Document::Location.new(file, 0, 0, 0, 0)
+      end
+    end
+  end
+end

data/lib/holistic/document/file/store.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Holistic::Document::File
+  module Store
+    extend self
+
+    def call(database:, file_path:)
+      record = Record.new(file_path, { path: file_path })
+
+      database.store(file_path, record)
+    end
+  end
+end

data/lib/holistic/document/location.rb

@@ -2,20 +2,18 @@
 
 module Holistic::Document
   Location = ::Data.define(
-    :file_path,
+    :file,
     :start_line,
     :start_column,
     :end_line,
     :end_column
   ) do
-    def self.beginning_of_file(file_path)
-      new(file_path, 0, 0, 0, 0)
+    def identifier
+      "#{file.path}[#{start_line},#{start_column},#{end_line},#{end_column}]"
     end
 
-    def identifier = "#{file_path}[#{start_line},#{start_column},#{end_line},#{end_column}]"
-
     def contains?(cursor)
-      same_file = cursor.file_path == file_path
+      same_file = cursor.file_path == file.path
       contains_line = cursor.line >= start_line && cursor.line <= end_line
       
       contains_column =

data/lib/holistic/document/unsaved/record.rb

@@ -54,6 +54,14 @@ module Holistic::Document
       line = 0
       column = 0
 
+      # first edition to the document is special because we can't iterate over the content to find the insert position.
+      # there is nothing to iterate over.
+      if @content.empty? && change.insertion?
+        @content = change.text
+
+        return
+      end
+
       @content.each_char.with_index do |char, index|
         if change.insertion? && change.starts_on?(line, column)
           content.insert(index, change.text)
@@ -74,10 +82,11 @@ module Holistic::Document
           column += 1
         end
       end
-    end
 
-    def to_file
-      File::Fake.new(path:, content:)
+      # off-by-one error to insert at the of the document
+      if change.insertion? && change.starts_on?(line, column)
+        content.insert(@content.length, change.text)
+      end
     end
   end
 end

data/lib/holistic/extensions/ruby/stdlib.rb

@@ -10,7 +10,7 @@ module Holistic::Extensions::Ruby
       if method_call_clue.method_name == "new" && referenced_scope.class?
         initialize_method = "#{referenced_scope.fully_qualified_name}#initialize"
 
-        return application.scopes.find_by_fully_qualified_name(initialize_method)
+        return application.scopes.find(initialize_method)
       end
 
       nil
@@ -19,12 +19,12 @@ module Holistic::Extensions::Ruby
     RegisterClassConstructor = ->(application, params) do
       class_scope, location = params[:class_scope], params[:location]
 
-      has_overridden_new_method = class_scope.children.find { _1.class_method? && _1.name == "new" }
+      has_overridden_new_method = class_scope.lexical_children.find { _1.instance_method? && _1.name == "initialize" }
 
       unless has_overridden_new_method
-        ::Holistic::Ruby::Scope::Register.call(
-          repository: application.scopes,
-          parent: class_scope,
+        ::Holistic::Ruby::Scope::Store.call(
+          database: application.database,
+          lexical_parent: class_scope,
           kind: ::Holistic::Ruby::Scope::Kind::CLASS_METHOD,
           name: "new",
           location:
@@ -38,9 +38,9 @@ module Holistic::Extensions::Ruby
       lambda_scope, location = params[:lambda_scope], params[:location]
 
       LAMBDA_METHODS.each do |method_name|
-        ::Holistic::Ruby::Scope::Register.call(
-          repository: application.scopes,
-          parent: lambda_scope,
+        ::Holistic::Ruby::Scope::Store.call(
+          database: application.database,
+          lexical_parent: lambda_scope,
           kind: ::Holistic::Ruby::Scope::Kind::CLASS_METHOD,
           name: method_name,
           location:

data/lib/holistic/language_server/requests/lifecycle/initialize.rb

@@ -14,23 +14,18 @@ module Holistic::LanguageServer
 
       parse_application_in_background(application)
 
-      respond_with_holistic_capabilities(request)
+      respond_with_language_server_capabilities(request)
     end
 
     private
 
     def create_application(request)
-      ::Holistic.logger.info("===========")
-      ::Holistic.logger.info(request.message.inspect)
-      
       root_directory = request.param("rootPath")
       name = ::File.basename(root_directory)
 
-      Current.application = ::Holistic::Application.new(name:, root_directory:)
-
-      ::Holistic::Extensions::Ruby::Stdlib.register(Current.application)
-
-      Current.application
+      Current.application = ::Holistic::Application.new(name:, root_directory:).tap do |application|
+        ::Holistic::Extensions::Ruby::Stdlib.register(application)
+      end
     end
 
     def advance_lifecycle_state
@@ -45,7 +40,7 @@ module Holistic::LanguageServer
       end
     end
 
-    def respond_with_holistic_capabilities(request)
+    def respond_with_language_server_capabilities(request)
       request.respond_with({
         capabilities: {
           # Defines how the host (editor) should sync document changes to the language server.

data/lib/holistic/language_server/requests/text_document/completion.rb

@@ -9,20 +9,31 @@ module Holistic::LanguageServer
 
       document = request.application.unsaved_documents.find(cursor.file_path)
 
-      return request.respond_with(nil) if document.nil?
+      if document.nil?
+        ::Holistic.logger.info("aborting completion because document was not found for #{cursor.file_path}")
+
+        return request.respond_with(nil) 
+      end
 
       if document.has_unsaved_changes?
         ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(
           application: request.application,
-          file: document.to_file
+          file_path: document.path,
+          content: document.content
         )
       end
 
       code = document.expand_code(cursor)
-      
-      return request.respond_with(nil) if code.blank?
 
-      scope = request.application.scopes.find_inner_most_scope_by_cursor(cursor) || request.application.root_scope
+      if code.blank?
+        ::Holistic.logger.info("aborting completion because code under cursor was blank: #{cursor.inspect}")
+
+        return request.respond_with(nil)
+      end
+
+      scope = request.application.scopes.find_inner_most_scope_by_cursor(cursor) || request.application.scopes.root
+
+      ::Holistic.logger.info("scope under cursor is: #{scope.fully_qualified_name}")
 
       suggestions = ::Holistic::Ruby::Autocompletion::Suggest.call(code:, scope:)
 

data/lib/holistic/language_server/requests/text_document/did_close.rb

@@ -13,19 +13,15 @@ module Holistic::LanguageServer
         if unsaved_document.has_unsaved_changes?
           unsaved_document.restore_original_content!
 
-          process_in_background(application: request.application, file: unsaved_document.to_file)
+          ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(
+            application: request.application,
+            file_path: unsaved_document.path,
+            content: unsaved_document.content
+          )
         end
       end
 
       request.respond_with(nil)
     end
-
-    private
-
-    def process_in_background(application:, file:)
-      ::Holistic::BackgroundProcess.run do
-        ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(application:, file:)
-      end
-    end
   end
 end

data/lib/holistic/language_server/requests/text_document/did_open.rb

@@ -9,6 +9,7 @@ module Holistic::LanguageServer
       content = request.message.param("textDocument", "text")
 
       request.application.unsaved_documents.add(path:, content:)
+      ::Holistic::Document::File::Store.call(database: request.application.database, file_path: path)
 
       request.respond_with(nil)
     end

data/lib/holistic/language_server/requests/text_document/did_save.rb

@@ -17,17 +17,13 @@ module Holistic::LanguageServer
 
       unsaved_document.mark_as_saved!
 
-      process_in_background(application: request.application, file: unsaved_document.to_file)
+      ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(
+        application: request.application,
+        file_path: unsaved_document.path,
+        content: unsaved_document.content
+      )
 
       request.respond_with(nil)
     end
-
-    private
-
-    def process_in_background(application:, file:)
-      ::Holistic::BackgroundProcess.run do
-        ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(application:, file:)
-      end
-    end
   end
 end

data/lib/holistic/language_server/requests/text_document/find_references.rb

@@ -12,7 +12,8 @@ module Holistic::LanguageServer
         if unsaved_document.has_unsaved_changes?
           ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(
             application: request.application,
-            file: unsaved_document.to_file
+            file_path: unsaved_document.path,
+            content: unsaved_document.content
           )
         end
       end
@@ -37,11 +38,13 @@ module Holistic::LanguageServer
 
     def respond_with_locations(request, references)
       locations = references.map do |reference|
+        location = reference.location
+
         {
-          "uri" => Format::FileUri.from_path(reference.location.file_path),
+          "uri" => Format::FileUri.from_path(location.file.path),
           "range" => {
-            "start" => { "line" => reference.location.start_line, "character" => reference.location.start_column },
-            "end" => { "line" => reference.location.end_line, "character" => reference.location.end_column }
+            "start" => { "line" => location.start_line, "character" => location.start_column },
+            "end" => { "line" => location.end_line, "character" => location.end_column }
           }
         }
       end

data/lib/holistic/language_server/requests/text_document/go_to_definition.rb

@@ -12,7 +12,8 @@ module Holistic::LanguageServer
         if unsaved_document.has_unsaved_changes?
           ::Holistic::Ruby::Parser::LiveEditing::ProcessFileChanged.call(
             application: request.application,
-            file: unsaved_document.to_file
+            file_path: unsaved_document.path,
+            content: unsaved_document.content
           )
         end
       end
@@ -46,7 +47,7 @@ module Holistic::LanguageServer
           "start" => { "line" => origin_location.start_line, "character" => origin_location.start_column },
           "end" => { "line" => origin_location.end_line, "character" => origin_location.end_column }
         },
-        "targetUri" => Format::FileUri.from_path(target_declaration_location.file_path),
+        "targetUri" => Format::FileUri.from_path(target_declaration_location.file.path),
         "targetRange" => {
           "start" => { "line" => target_declaration_location.start_line, "character" => target_declaration_location.start_column },
           "end" => { "line" => target_declaration_location.end_line, "character" => target_declaration_location.end_column }

data/lib/holistic/language_server/stdio/parser.rb

@@ -11,7 +11,7 @@ module Holistic::LanguageServer
 
     def ingest(payload)
       payload.each_char do |char|
-        if @in_header || !completed?
+        if @in_header || !has_complete_message?
           @buffer.concat(char)
         else
           @overflow_from_previous_ingestion.concat(char)
@@ -23,7 +23,7 @@ module Holistic::LanguageServer
       end
     end
 
-    def completed?
+    def has_complete_message?
       !@in_header && @content_length == @buffer.length
     end
 

data/lib/holistic/language_server/stdio/start.rb

@@ -15,7 +15,7 @@ module Holistic::LanguageServer
       server.start_input_loop do |payload|
         parser.ingest(payload)
 
-        while parser.completed?
+        while parser.has_complete_message?
           response = ::Holistic::LanguageServer::Router.dispatch(parser.message)
 
           case response