rider-server 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 302928be71e4f0608534e86f87c555a0f3507004c93c058947b74d480cfde558
-  data.tar.gz: 80707ddff979bb2a92f7f696dcbc44ac68830d56dffa11cfc021aa5eec06d743
+  metadata.gz: 42460de42badb3c5e588c8f606d395f91b8c91f419f119983e18d9ee7833b6c6
+  data.tar.gz: 3a1b5c4b92bb2bfe630a01736aa75dfa7eb23cd058686faaa748589d62f95e96
 SHA512:
-  metadata.gz: f9fcc56b8cbceaa6df781155af166873e66c0bfe1261041b6667759dfc5eb56c3c9dfd6943b45e1e7f302cb0737e21da048ba399f837dec4a77416cb7af037bf
-  data.tar.gz: 74527b4e988b97b6ed527530bbdef94cc6b48776c74fef12930dbf70a59c648209f3afa615ebb835861acba0b0eba70884107268b65e7aa12da0adb7b63040f8
+  metadata.gz: f42e2bb3d67f2922b0fe7a06c027b17a5737361521aa73f41a9b2376d53217f2f81f54066b82ba168ec3f5046dc8b2b238d0c7e2d6d0d8f8db5a6ac1bd279654
+  data.tar.gz: 5518b9ca7125186c9c248606b219819b271aa35514518ee90384614c8ccb9e7f0d8e1d1bc22014129d11dda586d849fd31854a7b8309083a0c3f8ac35e4e0acc

data/.build.yml

@@ -1,6 +1,6 @@
 image: debian/stable
 sources:
-  - https://git.sr.ht/~rsl/rider
+  - https://git.sr.ht/~rsl/rider-server
 packages:
   - bundler
   - curl
@@ -10,11 +10,11 @@ packages:
   - zlib1g-dev
 tasks:
   - lint: |
-      cd rider
+      cd rider-server
       bundle install --path="../.gems"
       bundle exec rake standard
   - test: |
-      cd rider
+      cd rider-server
       bundle install --path="../.gems"
       bundle exec rake test
 triggers:

data/CHANGELOG.md

@@ -1,4 +1,26 @@
-## [Unreleased]
+## [0.1.2] - 2024-08-14
+
+- update to latest bencode and remove ruby version limitation
+- request argument validation
+- add a global configuration object and a mechanism to load
+  configuration at startup.
+- support setting the caputured exception buffer size.
+- allow setting of the log level 
+- enable setting of the current namespace to an element of an array
+- add a separate inspect mechanism for the singleton class
+- fill in missing parameter details in ruby.  This is a port of the
+  elisp code, and simplifies the Emacs implementation.
+- ENV object printing, previously the env object would print the
+  entire env value which is of an unknown size.
+- printing of constant names along with values in inspect view.
+  Module constants have a name as a value, but this isn't true for
+  other constants.
+
+## [0.1.1] - 2024-07-31
+
+- Basic completion
+- Basic symbol lookup
+- Fix ancestor lookup
 
 ## [0.1.0] - 2024-07-27
 

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.rdoc

@@ -0,0 +1,39 @@
+= RIDER -- RIDER Interactive Development Environment for Ruby
+
+RIDER Server is the server component of the RIDER development
+environment.
+
+== Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+  $ bundle add rider-server
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+  $ gem install rider-server
+
+== Usage
+
+TODO: Write usage instructions here
+
+== Development
+
+After checking out the repo, run <tt>bin/setup</tt> to install
+dependencies. Then, run <tt>rake test</tt> to run the tests. You can also run
+<tt>bin/console</tt> for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run <tt>bundle exec rake
+install</tt>.
+
+To release a new version run <tt>rake bump:patch</tt> and then run <tt>bundle
+exec rake release</tt>, which will create a git tag for the version, push
+git commits and the created tag, and push the <tt>.gem</tt> file to
+http://rubygems.org.
+
+== Contributing
+
+Bug reports http://todo.sr.ht/~rsl/rider
+
+Support or discussion http://lists.sr.ht/~rsl/rider-devel

data/Rakefile

@@ -3,9 +3,14 @@
 require "bundler/gem_tasks"
 require "minitest/test_task"
 require "bump/tasks"
+require "rdoc/task"
 
 Bump.tag_by_default = true
 Minitest::TestTask.create
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
 
 require "standard/rake"
 

data/exe/rider-server

@@ -5,7 +5,7 @@
 
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
 
-require "rider_server/server"
-
-server = RiderServer::Server.new
+require "rider_server"
+config = RiderServer::Config.new
+server = RiderServer::Server.new(config)
 server.run

data/lib/rider_server/config.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+#
+# config.rb -- A config class for global config
+#
+# Author: Russell Sim
+# Copyright (c) 2024 Russell Sim
+# SPDX-License-Identifier: MIT
+
+require "rider_server/validate"
+
+module RiderServer
+  class Config
+    DEFAULTS = {
+      host: "localhost",
+      port: 7888,
+
+      # Whether to capture RIDER exceptions and send them to the
+      # client.
+      capture_exceptions: false,
+
+      # The number of exceptions to keep in the history.
+      exception_history_size: 10,
+
+      # The log level
+      log_level: :INFO
+    }
+
+    def self.configure(&block)
+      instance = new
+      instance.instance_eval(&block)
+      instance
+    end
+
+    # Define a configuration option, +option_name+ is a symbol
+    # representing the name of the configuration option, and
+    # +validator+ is a Validate object that will be used to validate
+    # the value of the option.
+    def self.def_option(option_name, validator)
+      define_method :"#{option_name}" do |value = nil|
+        if value
+          @options[option_name] = validator.validate(value)
+        else
+          unless @options.key?(option_name)
+            raise ArgumentError, "Option #{option_name} not set"
+          end
+
+          @options[option_name]
+        end
+      end
+    end
+
+    def_option :host, Validate.string.not_empty
+    def_option :port, Validate.integer.greater_than(0)
+    def_option :capture_exceptions, Validate.bool
+    def_option :exception_history_size, Validate.integer.greater_than(0)
+
+    def_option :log_level, Validate.symbol.upcase.one_of(:DEBUG, :INFO, :WARN, :ERROR, :FATAL)
+
+    attr_reader :options
+
+    def initialize(config_file: "rider.rb")
+      @options = DEFAULTS.dup
+
+      if File.file?(config_file)
+        config.load_from(config_file)
+      end
+    end
+
+    # Load configuration from file +path+.  The contents of the file
+    # will be evaluated within the context of this class instance.
+    def load_from(path)
+      instance_eval(File.read(path), path, 1)
+    end
+  end
+end

data/lib/rider_server/core_ext/array.rb

@@ -8,7 +8,9 @@
 # SPDX-License-Identifier: MIT
 
 class Array
-  def rider_inspect
+  # Return a +string+ representation of the object in a consistent
+  # manner that will not be excessivly long.
+  def rider_display
     max_length = 50
     sample = +""
 

data/lib/rider_server/core_ext/class.rb

@@ -0,0 +1,5 @@
+class Class
+  def rider_descendants
+    ObjectSpace.each_object(::Class).select { |klass| klass < self }
+  end
+end

data/lib/rider_server/core_ext/env.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+#
+# env.rb -- ENV extensions
+#
+# Author: Russell Sim
+# Copyright (c) 2024 Russell Sim
+# SPDX-License-Identifier: MIT
+
+# Return a +string+ representation of the object in a consistent
+# manner that will not be excessivly long.
+def ENV.rider_display
+  "#<ENV #{keys[..3].join(", ")}, ...>"
+end

data/lib/rider_server/core_ext/hash.rb

@@ -8,7 +8,9 @@
 # SPDX-License-Identifier: MIT
 
 class Hash
-  def rider_inspect
+  # Return a +string+ representation of the object in a consistent
+  # manner that will not be excessivly long.
+  def rider_display
     "#<#{self.class}: #{length} items}>"
   end
 end

data/lib/rider_server/core_ext/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def rider_methods
+    Kernel.instance_method(:methods).bind_call(self)
+  end
+end

data/lib/rider_server/core_ext/module.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#
+# module.rb -- Module extensions
+#
+# Author: Russell Sim
+# Copyright (c) 2024 Russell Sim
+# SPDX-License-Identifier: MIT
+
+class Module
+  def rider_inspect
+    Module.instance_method(:inspect).bind_call(self)
+  end
+
+  def rider_instance_methods
+    Module.instance_method(:instance_methods).bind_call(self)
+  end
+end

data/lib/rider_server/core_ext/object.rb

@@ -8,11 +8,17 @@
 # SPDX-License-Identifier: MIT
 
 class Object
-  def rider_inspect
+  # Return a +string+ representation of the object in a consistent
+  # manner that will not be excessivly long.
+  def rider_display
     if defined?(inspect) && method(:inspect).owner != Object && method(:inspect).owner != Kernel
       inspect
     else
       "#<#{self.class} #{object_id}>"
     end
   end
+
+  def rider_inspect
+    Object.instance_method(:inspect).bind_call(self)
+  end
 end

data/lib/rider_server/core_ext/string.rb

@@ -8,7 +8,9 @@
 # SPDX-License-Identifier: MIT
 
 class String
-  def rider_inspect
+  # Return a +string+ representation of the object in a consistent
+  # manner that will not be excessivly long.
+  def rider_display
     if length <= 50
       "#<String #{inspect}>"
     else

data/lib/rider_server/core_ext/symbol.rb

@@ -8,7 +8,9 @@
 # SPDX-License-Identifier: MIT
 
 class Symbol
-  def rider_inspect
+  # Return a +string+ representation of the object in a consistent
+  # manner that will not be excessivly long.
+  def rider_display
     ":#{self}"
   end
 end

data/lib/rider_server/exception_extension.rb

@@ -28,6 +28,8 @@ module RiderServer
 end
 
 unless ::Exception.included_modules.include?(RiderServer::ExceptionExtension)
+  # Extend the +exception+ class so that RIDER can capture the
+  # backtraces for inspection.
   class ::Exception
     prepend RiderServer::ExceptionExtension
   end

data/lib/rider_server/inspect.rb

@@ -11,67 +11,139 @@ 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
 
-    def self.class(obj)
+    def self.safely_location(src)
+      loc = safely_eval(src, __FILE__, __LINE__)
+      if loc.length == 2 && loc[0].is_a?(String) && loc[1].is_a?(Integer)
+        loc
+      else
+        []
+      end
+    end
+
+    def self.inspect_class(obj)
       klass = obj.class
       {
         "name" => klass.to_s,
-        "value" => Utils.rider_inspect(safely_eval("Object.const_get('#{klass}')", __FILE__, __LINE__)),
+        "value" => Utils.rider_display(safely_eval("Object.const_get('#{klass}')", __FILE__, __LINE__)),
         "inspect-location" => "toplevel_const_get:#{klass.inspect}",
         "source-location" => safely_eval("Object.const_source_location('#{klass}')", __FILE__, __LINE__) || []
       }
     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|
-          {
-            "name" => item.to_s,
-            "value" => Utils.rider_inspect(item),
-            "inspect-location" => "ancestor_find:#{item}",
-            "source-location" => safely_eval("Object.const_source_location('#{item}')", __FILE__, __LINE__) || []
-          }
+    def self.inspect_singleton_class(obj)
+      klass = obj.singleton_class
+      {
+        "name" => klass.to_s,
+        "value" => Utils.rider_display(klass),
+        "inspect-location" => "singleton_class",
+        "source-location" => []
+      }
+    rescue => e  # integers have no singleton
+      {
+        "name" => e.to_s,
+        "value" => Utils.rider_display(e)
+      }
+    end
+
+    def self.inspect_ancestors(obj)
+      if obj.respond_to?(:ancestors)
+        obj.ancestors.map do |item|
+          if item.instance_of? ::Module
+            {
+              "name" => item.to_s,
+              "value" => Utils.rider_display(item),
+              "inspect-location" => "ancestor_find:#{item}",
+              "source-location" => safely_location("Object.const_source_location('#{item}')")
+            }
+          else
+            {
+              "name" => item.to_s,
+              "value" => Utils.rider_display(item),
+              "inspect-location" => "ancestor_find:#{item}",
+              "source-location" => []
+            }
+          end
         end
       else
         []
       end
     end
 
-    def self.constants(obj)
+    def self.inspect_constants(obj)
       if obj.respond_to?(:constants)
-        constants = safely_eval("#{obj.inspect}.constants", __FILE__, __LINE__)
+        constants = safely_eval("#{obj.rider_inspect}.constants", __FILE__, __LINE__)
         return [] if constants.nil?  # Eigen classes have no constants
         constants.map do |item|
-          {
-            "name" => item.to_s,
-            "value" => Utils.rider_inspect(safely_eval("#{obj.inspect}.const_get('#{item}')", __FILE__, __LINE__)),
-            "inspect-location" => "const_get:#{obj.inspect}::#{item}",
-            "source-location" => safely_eval("#{obj.inspect}.const_source_location('#{item}')", __FILE__, __LINE__) || []
-          }
-        end.sort_by { |hash| hash["name"] }
+          [
+            {
+              "name" => item.to_s
+            },
+            {
+              "name" => item.to_s,
+              "value" => Utils.rider_display(safely_eval("#{obj.rider_inspect}.const_get('#{item}')", __FILE__, __LINE__)),
+              "inspect-location" => "const_get:#{obj.rider_inspect}::#{item}",
+              "source-location" => safely_location("#{obj.rider_inspect}.const_source_location('#{item}')")
+            }
+          ]
+        end.sort_by { |hash| hash[0]["name"] }
       else
         []
       end
     end
 
+    def self.inspect_parameters(parameters)
+      alpha = Enumerator.new do |y|
+        ("a".."z").each { |char| y << char }
+      end
+
+      parameters.map do |params|
+        arg, name = params
+        if arg == :rest
+          "*#{name || "args"}"
+        elsif arg == :keyrest
+          if name.nil? || name == "**"
+            "**kwargs"
+          else
+            name
+          end
+        elsif arg == :req
+          name || alpha.next
+        elsif arg == :keyreq
+          "#{name || alpha.next}: ..."
+        elsif arg == :key
+          "#{name || alpha.next}:"
+        elsif arg == :opt
+          "#{name || alpha.next}=..."
+        elsif arg == :block
+          "&block"
+        else
+          raise "Unknown prameter format #{arg}"
+        end.to_s
+      end
+    end
+
     def self.describe_method(method)
+      loc = method.source_location
+      method_location = if !loc.nil? && loc.length == 2 && loc[0].is_a?(String) && loc[1].is_a?(Integer)
+        loc
+      else
+        []
+      end
+
       {
         "name" => method.name.to_s,
-        "value" => Utils.rider_inspect(method),
+        "value" => Utils.rider_display(method),
         "visibility" => if method.private?
                           ":private"
                         elsif method.protected?
@@ -81,15 +153,15 @@ module RiderServer
                         else
                           ":unknown"
                         end,
-        "owner" => method.owner.inspect,
-        "source-location" => method.source_location || [],
-        "parameters" => method.parameters.map { |subarray| subarray.map(&:to_s) }
+        "owner" => method.owner.rider_inspect,
+        "source-location" => method_location,
+        "parameters" => inspect_parameters(method.parameters)
       }
     end
 
-    def self.methods(obj)
-      if obj.respond_to?(:methods)
-        obj.methods.map do |name|
+    def self.inspect_methods(obj)
+      if obj.respond_to?(:rider_methods)
+        obj.rider_methods.map do |name|
           describe_method(obj.method(name))
         end
       else
@@ -97,9 +169,9 @@ module RiderServer
       end
     end
 
-    def self.instance_methods(obj)
-      if obj.respond_to?(:instance_methods)
-        obj.instance_methods.map do |item|
+    def self.inspect_instance_methods(obj)
+      if obj.respond_to?(:rider_instance_methods)
+        obj.rider_instance_methods.map do |item|
           describe_method(obj.instance_method(item))
         end
       else
@@ -107,7 +179,7 @@ module RiderServer
       end
     end
 
-    def self.instance_variables(obj)
+    def self.inspect_instance_variables(obj)
       if obj.respond_to?(:instance_variables)
         obj.instance_variables.map do |item|
           [
@@ -116,7 +188,7 @@ module RiderServer
             },
             {
               "name" => obj.instance_variable_get(item).to_s,
-              "value" => Utils.rider_inspect(obj.instance_variable_get(item)),
+              "value" => Utils.rider_display(obj.instance_variable_get(item)),
               "inspect-location" => "instance_variable_get:#{item}"
             }
           ]
@@ -126,7 +198,7 @@ module RiderServer
       end
     end
 
-    def self.class_variables(obj)
+    def self.inspect_class_variables(obj)
       if obj.respond_to?(:class_variables)
         obj.class_variables.map do |item|
           [
@@ -135,7 +207,7 @@ module RiderServer
             },
             {
               "name" => obj.class_variable_get(item).to_s,
-              "value" => Utils.rider_inspect(obj.class_variable_get(item)),
+              "value" => Utils.rider_display(obj.class_variable_get(item)),
               "inspect-location" => "class_variable_get:#{item}"
             }
           ]

data/lib/rider_server/logger.rb

@@ -2,12 +2,19 @@ require "logger"
 
 module RiderServer
   module Logger
-    def log
-      @logger ||= begin
-        log_level = (ENV["LOG_LEVEL"] || "INFO").upcase.to_sym
+    class << self
+      def configure_logger(logdev: ::STDERR, level: ENV["LOG_LEVEL"] || "INFO") # rubocop:disable Style/GlobalStdStream
+        log_level = level.upcase.to_sym
+        @@logger = ::Logger.new(logdev, level: log_level)
+      end
 
-        ::Logger.new(STDERR, level: log_level) # rubocop:disable Style/GlobalStdStream
+      def log
+        @@logger ||= configure_logger
       end
     end
+
+    def log
+      Logger.log
+    end
   end
 end