rider-server 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acb6833a29ab9facb82c72d8f2e012ab0dd7a44dbd1ad93dfe69f8d1bff2a765
-  data.tar.gz: 62834c0a615baa860e1e7650f14353180b874cf877833cc94b6f9804edd32efa
+  metadata.gz: 42460de42badb3c5e588c8f606d395f91b8c91f419f119983e18d9ee7833b6c6
+  data.tar.gz: 3a1b5c4b92bb2bfe630a01736aa75dfa7eb23cd058686faaa748589d62f95e96
 SHA512:
-  metadata.gz: bec9b6906b7e47954bdf9a85fcb3a47ca89d86f63f68023b90d0c8ac83028f6aa7681ad0a4042934cd4a663a0f86f344d8ee11374816efe5616d5eaeaa2a8b75
-  data.tar.gz: a0d1b287bfeeaf68bbd82c9d72d7bb9405a9873286993e6171cd5f754c545c56cdcde1f186e8c9edb755a1e883a627ce6b33eeea2b21a047220ced97e3e973e5
+  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,20 @@
-## [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
 

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

@@ -22,52 +22,128 @@ module RiderServer
       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)
+    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|
-          {
-            "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__) || []
-          }
+          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?
@@ -77,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
@@ -93,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
@@ -103,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|
           [
@@ -112,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}"
             }
           ]
@@ -122,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|
           [
@@ -131,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

data/lib/rider_server/operation.rb

@@ -13,38 +13,57 @@ module RiderServer
   class Operation
     include RiderServer::Logger
 
-    attr_reader :documentation, :arguments, :controller
-    def self.operation_name
-      name.split("::").last.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    # Operations registry
+    @operations = {}
+    class << self
+      attr_reader :operations
     end
 
-    def self.documentation(desc)
-      @documentation = desc
+    def self.handles?(request)
+      @operations.key? request.op
     end
 
-    def self.argument(name, type, description, required: false)
-      @arguments ||= []
+    def self.handle(context, request)
+      operation = @operations[request.op]
+      operation.validate_request!(request)
+      operation.handle(context, request)
+    end
 
-      raise ArgumentError, "Invalid argument type #{type}" \
-        unless [:string, :integer, :array].include?(type)
+    def self.define(&block)
+      instance = new
+      instance.instance_eval(&block)
+      raise ArgumentError, "Operation #{self} must have a name" if instance.name.empty?
+      raise ArgumentError, "Operation #{self} must have a documentation string" if instance.documentation.empty?
+      raise ArgumentError, "Operation #{self} must have at least one argument" if instance.arguments.empty?
+      @operations[instance.name] = instance
+      instance
+    end
 
-      @arguments << {name: name, type: type, required: required, description: description}
+    attr_reader :arguments
+
+    def documentation(value = nil)
+      @documentation = value if value
+      @documentation
     end
 
-    def initialize(controller)
-      @controller = controller
-      @documentation = self.class.instance_variable_get(:@documentation) || ""
-      @arguments = self.class.instance_variable_get(:@arguments) || []
-      raise ArgumentError, "Operation must have a documentation string" if @documentation.empty?
-      raise ArgumentError, "Operation must have at least one argument" if @arguments.empty?
+    def name(value = nil)
+      @name = value if value
+      @name
     end
 
-    def create_response(operation)
-      Utils.create_response(operation)
+    def initialize
+      @name = ""
+      @arguments = []
+      @documentation = ""
     end
 
-    def send_response(response)
-      controller.send_response(response)
+    def argument(name, type, description, required: false)
+      @arguments ||= []
+
+      raise ArgumentError, "Invalid argument type #{type}" \
+        unless [:string, :integer, :array].include?(type)
+
+      @arguments << {name: name, type: type, required: required, description: description}
     end
 
     def validate_request!(request)

data/lib/rider_server/{ops → operations}/clone.rb

@@ -3,14 +3,15 @@ require "rider_server/response"
 
 module RiderServer
   module Ops
-    class Clone < Operation
+    Operation.define do
+      name "clone"
       documentation "Clone a session"
 
       argument :id, :string, "The request id", required: true
       argument :session, :string, "The session to clone"
 
       # Handle the clone operation, session will be nil
-      def handle(session, operation)
+      def handle(controller, operation)
         response = Response.new(operation)
 
         # Clone a specific session if specified