rider-server 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 302928be71e4f0608534e86f87c555a0f3507004c93c058947b74d480cfde558
-  data.tar.gz: 80707ddff979bb2a92f7f696dcbc44ac68830d56dffa11cfc021aa5eec06d743
+  metadata.gz: acb6833a29ab9facb82c72d8f2e012ab0dd7a44dbd1ad93dfe69f8d1bff2a765
+  data.tar.gz: 62834c0a615baa860e1e7650f14353180b874cf877833cc94b6f9804edd32efa
 SHA512:
-  metadata.gz: f9fcc56b8cbceaa6df781155af166873e66c0bfe1261041b6667759dfc5eb56c3c9dfd6943b45e1e7f302cb0737e21da048ba399f837dec4a77416cb7af037bf
-  data.tar.gz: 74527b4e988b97b6ed527530bbdef94cc6b48776c74fef12930dbf70a59c648209f3afa615ebb835861acba0b0eba70884107268b65e7aa12da0adb7b63040f8
+  metadata.gz: bec9b6906b7e47954bdf9a85fcb3a47ca89d86f63f68023b90d0c8ac83028f6aa7681ad0a4042934cd4a663a0f86f344d8ee11374816efe5616d5eaeaa2a8b75
+  data.tar.gz: a0d1b287bfeeaf68bbd82c9d72d7bb9405a9873286993e6171cd5f754c545c56cdcde1f186e8c9edb755a1e883a627ce6b33eeea2b21a047220ced97e3e973e5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.1.1] - 2024-07-31
+
+- Basic completion
+- Basic symbol lookup
+- Fix ancestor lookup
+
 ## [0.1.0] - 2024-07-27
 
 - Initial release

data/COPYING

@@ -0,0 +1,20 @@
+Copyright 2024 Russell Sim <rsl@simopolis.xyz>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+“Software”), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -32,10 +32,12 @@ dependencies. Then, run `rake test` to run the tests. You can also run
 experiment.
 
 To install this gem onto your local machine, run `bundle exec rake
-install`. To release a new version, update the version number in
-`version.rb`, and then run `bundle exec rake release`, which will
-create a git tag for the version, push git commits and the created
-tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+install`.
+
+To release a new version run `rake bump:patch` and then run `bundle
+exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/rider_server/inspect.rb

@@ -11,14 +11,13 @@ require "rider_server/utils"
 
 module RiderServer
   module Inspect
-
     def self.safely_eval(string, file, line)
       code = <<~HEREDOC
-      begin
-        #{string}
-      rescue StandardError => e
-        e
-      end
+        begin
+          #{string}
+        rescue StandardError => e
+          e
+        end
       HEREDOC
       eval(code, TOPLEVEL_BINDING, file, line) # rubocop:disable Security/Eval
     end
@@ -34,11 +33,8 @@ module RiderServer
     end
 
     def self.ancestors(obj)
-      # Look for instance ancestors on the class.
-      obj = obj.class if !obj.respond_to?(:ancestors) && obj.class.respond_to?(:ancestors)
-
-      if obj.class.respond_to?(:ancestors)
-        obj.class.ancestors.map do |item|
+      if obj.respond_to?(:ancestors)
+        obj.ancestors.map do |item|
           {
             "name" => item.to_s,
             "value" => Utils.rider_inspect(item),

data/lib/rider_server/operations.rb

@@ -104,14 +104,14 @@ module RiderServer
       response.set("out", e.full_message)
       response.status("eval-error", "done")
       if session
-        exception_id = session.add_exception(operation["id"], e)
-        response.set("rider/exception-id", exception_id)
+        exception = session.push_exception(operation["id"], e)
+        response.set("rider/exception-id", exception["id"])
       end
-
-      # Broadcast the exception to sessions that are listening
-      @sessions_catching_exceptions.each do |s|
-        next if session == s
-        @sessions[s]&.add_exception(operation["id"], e)
+      @sessions_catching_exceptions.each do |session_id|
+        session = @sessions[session_id]
+        next if session.nil?
+        exception = session.push_exception(operation["id"], e)
+        response.set("rider/exception-id", exception["id"])
       end
       send_response(response)
     end

data/lib/rider_server/ops/completions.rb

@@ -9,6 +9,7 @@ module RiderServer
 
       argument :id, :string, "The request id", required: true
       argument :prefix, :string, "The prefix to complete", required: true
+      argument :complete_fn, :string, "What completion function to use, top-level, module, method or singleton-method"
       argument :ns, :string, "The namespace to search for completions"
 
       def initialize(*args)
@@ -20,38 +21,40 @@ module RiderServer
         response = Response.new(operation)
 
         prefix = operation["prefix"]
-        log.info "prefix: #{prefix}"
         ns = operation["ns"]
-        # options = operation["options"]
+        complete_fn = operation.fetch("complete-fn", "top-level")
 
-        log.info "prefix: #{prefix}"
-        ns_object = @workspace.lookup_module(ns)
-        log.info "ns_object: #{ns_object}"
-
-        response.set("completions", lookup_module(prefix, ns_object))
-        log.info "completions: #{response["completions"]}"
+        if prefix.nil? || parse_string(prefix).nil?
+          response.set("completions", [])
+        else
+          ns_object = if ns.empty?
+            ::Object
+          else
+            @workspace.lookup_module(ns)
+          end
 
+          # If the prefix isn't parseable, return an empty list
+          response.set("completions", lookup_module(prefix, klass: ns_object, completion_fn: complete_fn))
+        end
         response.status("done")
         response
-      rescue ScriptError, StandardError => e
-        log.error "Error in completions: #{e}"
-        log.error e.backtrace.join("\n")
-        raise e
       end
 
-      private
-
-      def lookup_module(module_name, klass = ::Object)
+      def lookup_module(module_name, klass: ::Object, completion_fn: "top-level")
         node = parse_string(module_name)
         case node.type
         when :const
           ns = lookup_module_ast(node.children.first, klass)
           prefix = node.children.last
-          all_constants(ns, prefix) + all_methods(ns, prefix)
+          all_constants(ns, prefix)
         when :send
           ns = lookup_module_ast(node.children.first, klass)
           prefix = node.children.last
-          all_methods(ns, prefix)
+          if completion_fn == "method"
+            all_constants(ns, prefix) + encode_methods(class_instance_methods(ns, prefix) + class_singleton_methods(::Kernel, prefix))
+          else
+            all_constants(ns, prefix) + encode_methods(class_methods(ns, prefix) + class_singleton_methods(::Kernel, prefix))
+          end
         else
           []
         end
@@ -64,6 +67,8 @@ module RiderServer
       end
 
       def lookup_module_ast(node, klass = ::Object)
+        return klass if node.nil?
+
         case node.type
         when :cbase
           ::Object
@@ -78,17 +83,57 @@ module RiderServer
         end
       end
 
+      def parent_constant(ns_object)
+        ns_object_name = ns_object.to_s
+        parent_name, _ = ns_object_name.rpartition("::")
+        parent_name.empty? ? nil : ::Object.const_get(parent_name)
+      end
+
       def all_constants(ns_object, prefix)
-        ns_object.constants.grep(/^#{prefix}/).map do |constant|
+        consts = []
+        ns_object.constants.grep(/^#{prefix}/).each do |constant|
+          consts << constant.to_s
+        end
+
+        # Search up the tree to find all the other constants
+        constant = ns_object
+        loop do
+          constant = parent_constant(constant)
+          break if constant.nil?
+
+          constant.constants.grep(/^#{prefix}/).each do |constant|
+            consts << constant.to_s
+          end
+        end
+
+        consts.map do |constant|
           {
-            "candidate" => constant.to_s,
+            "candidate" => constant,
             "type" => "constant"
           }
         end
       end
 
-      def all_methods(ns_object, prefix)
-        ns_object.methods.grep(/^#{prefix}/).map do |method|
+      ##
+      # Get all instance methods that match a +prefix+ for a given object +obj+
+      #
+      # This method should be called when in the context of an
+      # instance method, as all other instance methods will be
+      # acessable.
+      def class_instance_methods(obj, prefix)
+        Set.new(obj.instance_methods.grep(/^#{prefix}/))
+      end
+
+      def class_methods(obj, prefix)
+        Set.new(obj.methods.grep(/^#{prefix}/))
+      end
+
+      def class_singleton_methods(obj, prefix)
+        Set.new(obj.singleton_methods.grep(/^#{prefix}/))
+      end
+
+      def encode_methods(methods)
+        methods.map do |method|
           {
             "candidate" => method.to_s,
             "type" => "method"

data/lib/rider_server/ops/eval.rb

@@ -46,8 +46,8 @@ module RiderServer
             response.set("ex", e.inspect)
             response.set("ns", session.workspace.evaluate("inspect"))
             response.status("eval-error", "done")
-            exception_id = session.add_exception(operation["id"], e)
-            response.set("rider/exception-id", exception_id)
+            exception = session.push_exception(operation["id"], e)
+            response.set("rider/exception-id", exception["id"])
             send_response(response)
           end
 

data/lib/rider_server/ops/lookup.rb

@@ -5,10 +5,11 @@ require "rider_server/inspect"
 module RiderServer
   module Ops
     class Lookup < Operation
-      documentation "Get completions for a given string"
+      documentation "Get info about a symbol."
 
       argument :id, :string, "The request id", required: true
       argument :sym, :string, "The symbol to lookup", required: true
+      argument :lookup_fn, :string, "What lookup function to use, top-level, module, method or singleton-method"
       argument :ns, :string, "The namespace to search for completions"
 
       def initialize(*args)
@@ -20,63 +21,83 @@ module RiderServer
         response = Response.new(operation)
         ns = operation["ns"]
         sym = operation["sym"]
+        lookup_fn = operation.fetch("lookup-fn", "top-level")
 
-        ns_object = @workspace.lookup_module(ns)
-
-        method_type = nil
-        if sym.include?("#")
-          sym, method = sym.split("#")
-          method_type = :instance
-          method = method.to_sym
-        elsif sym.start_with?("self.class")
-          method = sym.split(".").last
-          method_type = :class
-          method = method.to_sym
-        elsif sym.include?(".")
-          sym, method = sym.split(".")
-          method_type = :class
-          method = method.to_sym
-        end
+        if sym.nil? || parse_string(sym).nil?
+          response.set("info", {})
+        else
+          ns_object = if ns.empty?
+            ::Object
+          else
+            @workspace.lookup_module(ns)
+          end
 
-        if sym.include?("::")
-          ns_object = lookup_ns(sym.split("::"), ns_object)
+          # If the prefix isn't parseable, return an empty list
+          response.set("info", lookup_module(sym, klass: ns_object, lookup_fn: lookup_fn))
         end
-        constant = ns_object
+        response.status("done")
+        response
+      end
 
-        info = if sym.start_with?("@")
-          constant = ns_object.instance_variable_get(sym)
-        elsif method_type == :instance
-          RiderServer::Inspect.describe_method(constant.instance_method(method))
-        elsif method_type == :class
-          RiderServer::Inspect.describe_method(constant.method(method))
-        elsif constant.respond_to?(:instance_methods) && constant.instance_methods.include?(sym.to_sym)
-          RiderServer::Inspect.describe_method(constant.instance_method(sym))
-        elsif constant.respond_to?(:methods) && constant.methods.include?(sym.to_sym)
-          RiderServer::Inspect.describe_method(constant.method(sym))
+      def lookup_module(module_name, klass: ::Object, lookup_fn: "top-level")
+        node = parse_string(module_name)
+        case node.type
+        when :const
+          ns = lookup_module_ast(node.children.first, klass)
+          name = node.children.last
+          encode_const(ns, name)
+        when :send
+          ns = lookup_module_ast(node.children.first, klass)
+          prefix = node.children.last
+          if lookup_fn == "method"
+            encode_method(ns.instance_method(prefix))
+          else
+            encode_method(ns.method(prefix))
+          end
         else
-          {}
+          []
         end
+      end
 
-        response.set("info", info)
-        response.status("done")
-        response
+      def parse_string(string)
+        buffer = Parser::Source::Buffer.new("(string)")
+        buffer.source = string
+        Parser::CurrentRuby.new.parse(buffer)
       end
 
-      private
+      def lookup_module_ast(node, klass = ::Object)
+        return klass if node.nil?
 
-      def lookup_ns(module_name, klass = Object)
-        if module_name.start_with?("::")
-          klass = Module
-          module_name = module_name.delete_prefix("::")
+        case node.type
+        when :cbase
+          ::Object
+        when :const
+          if node.children.first.nil?
+            klass.const_get(node.children.last)
+          else
+            lookup_module_ast(node.children.first, klass).const_get(node.children.last)
+          end
+        else
+          raise ModuleLookupError, "Unknown node type #{node.type}"
         end
+      end
 
-        path = module_name.split("::")
-
-        path.inject(klass) do |acc, elem|
-          acc.const_get(elem)
+      def encode_const(ns, const_name)
+        if ns.const_defined? const_name
+          {
+            "name" => "#{ns}::#{const_name}",
+            "source_location" => ns.const_source_location(const_name)
+          }
+        else
+          {}
         end
-      rescue NameError
-        nil
+      end
+
+      def encode_method(thing)
+        {
+          "name" => thing.name.to_s,
+          "source_location" => thing.source_location
+        }
       end
     end
   end

data/lib/rider_server/ops/ls_exceptions.rb

@@ -4,7 +4,7 @@ require "rider_server/response"
 module RiderServer
   module Ops
     class LsExceptions < Operation
-      documentation "List all exceptions that have occurred in the session."
+      documentation "List all exceptions that exist in the sessions cache."
 
       argument :id, :string, "The request id", required: true
 

data/lib/rider_server/ops/set_namespace_variable.rb

@@ -13,7 +13,7 @@ module RiderServer
       def handle(session, operation)
         response = Response.new(operation)
         name = operation["name"]
-        raise "Name must be a valid Ruby identifier" unless name =~ /\A[a-zA-Z_]\w*\z/
+        raise "Name must be a valid Ruby identifier" unless /\A[a-zA-Z_]\w*\z/.match?(name)
         location = operation["location"]
 
         value = traverse_location(location, nil, session)

data/lib/rider_server/server.rb

@@ -57,7 +57,7 @@ module RiderServer
 
             begin
               output = response.bencode
-            rescue StandardError => e
+            rescue => e
               log.error "Error encoding response: #{e}"
               response = Response.new(response.to_h)
               response.set("ex", e.inspect)

data/lib/rider_server/services/capture_exceptions.rb

@@ -28,11 +28,27 @@ module RiderServer
         }
       end
 
-      def self.handle_exception(exception, metadata = {})
+      def self.create_exception_wrapper(exception, metadata)
+        id = SecureRandom.uuid
+        {
+          "id" => id,
+          "created_at" => DateTime.now,
+          "exception" => exception,
+          "metadata" => metadata
+        }
+      end
+
+      def self.handle_exception(exception, metadata: {})
+        wrapped_ex = create_exception_wrapper(exception, metadata)
+        # Firstly this needs to generate wrapper for the exception
+        # This needs to use push exception
+
         @sessions.each do |session, stream_id|
-          ex = session.add_exception(stream_id, exception, metadata)
+          ex = session.push_anonymous_exception(wrapped_ex)
           session.response_queue.push(create_response(stream_id, ex))
         end
+
+        wrapped_ex
       end
 
       def initialize(session)

data/lib/rider_server/session.rb

@@ -93,15 +93,20 @@ module RiderServer
     # Historical Exceptions
     #
 
-    def add_exception(operation_id, exception, metadata = {})
+    def wrap_exception(operation_id, exception, metadata = {})
       id = SecureRandom.uuid
-      @exceptions << {
+      {
         "id" => id,
         "operation_id" => operation_id,
         "created_at" => DateTime.now,
         "exception" => exception,
         "metadata" => metadata
       }
+    end
+
+    def add_exception(operation_id, exception, metadata = {})
+      id = SecureRandom.uuid
+      @exceptions << wrap_exception(operation_id, exception, metadata)
       id
     end
 
@@ -113,7 +118,14 @@ module RiderServer
 
     # A threadsafe way to add exceptions
     def push_exception(operation_id, exception, metadata = {})
-      @exception_queue.push([operation_id, exception, metadata])
+      ex = wrap_exception(operation_id, exception, metadata)
+      @exception_queue.push(ex)
+      ex
+    end
+
+    def push_anonymous_exception(exception)
+      @exception_queue.push(exception)
+      exception
     end
 
     def start_exception_processing
@@ -121,7 +133,7 @@ module RiderServer
 
       @exception_processing_thread = Thread.new do
         loop do
-          add_exception(*@exception_queue.pop)
+          @exceptions << @exception_queue.pop
         end
       end
     end

data/lib/rider_server/version.rb

@@ -8,5 +8,5 @@
 # SPDX-License-Identifier: MIT
 
 module RiderServer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rider-server
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Russell Sim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bencode
@@ -50,6 +50,7 @@ files:
 - ".ruby-version"
 - ".standard.yml"
 - CHANGELOG.md
+- COPYING
 - README.md
 - Rakefile
 - exe/rider-server