openvox-editor-services 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cda59eba9edbedf441cecc12f6e9008896fe7cbebee4fa7f54973c24042f5190
-  data.tar.gz: 95b0094bfba3986aaa34b9672de8f606e49b54e7e78e98cbe8905e6236e61f1f
+  metadata.gz: 8ced2731b011c871cca3b491fbc8d1a80a3145c5c734e4e6280d971d3d9bb16c
+  data.tar.gz: 66bb67ee45ea6b0366f19f4b6fe02fea140a9cb52e76cd29cb3a4e6d8228842e
 SHA512:
-  metadata.gz: 9f8a477f7f92a7cbd9ccd0f48678a94da073c1115dd2e2873a539349e57e6fa079ea91829350cd0db18aacddb7e5d7ffd6d64ca800ebf4aa61e4af8dfeaa8d56
-  data.tar.gz: 38d3f0bacdfa3cfcf46a66e702c17c95c1d7e83dd45501db9a0d540ea1c755a80d615d6d3d962fa7c18958dbbe8d663af71374abf8fbdac523ee1a4a205d7794
+  metadata.gz: 645deea766c6d0b2b03cf6fe8810d289e9afd19199698b5767e28c8b0ee3f390155132407b122b7c4528d83b130ed92bf1dc88b1aea923626f69668555a5100f
+  data.tar.gz: d3e7069ad80724af6bfa7d743bdc3de1c27a82cb8ef8f0431cc8dd8b888a5f316957518a5c6d78856b6b8458551e197ac263652c4a2882cdd259e3050d8a3fc7

data/CHANGELOG.md

@@ -1,8 +1,35 @@
 # Changelog
 
-## [3.1.0](https://github.com/voxpupuli/openvox-editor-services/tree/3.1.0) (2026-07-03)
+## [3.1.2](https://github.com/voxpupuli/openvox-editor-services/tree/3.1.2) (2026-10-30)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/v3.0.0...3.1.0)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/v3.1.1...3.1.2)
+
+**Fixed bugs:**
+
+- fix: recognize packaged OpenVox Agent Ruby on Windows [\#71](https://github.com/voxpupuli/openvox-editor-services/pull/71) ([rwaffen](https://github.com/rwaffen))
+- fix: Rubocop Lint/\* Offences  [\#50](https://github.com/voxpupuli/openvox-editor-services/pull/50) ([rwaffen](https://github.com/rwaffen))
+- fix: Incomplete string escaping or encoding [\#49](https://github.com/voxpupuli/openvox-editor-services/pull/49) ([rwaffen](https://github.com/rwaffen))
+- fix: handle security/code-scanning/1 by using File instead of IO [\#47](https://github.com/voxpupuli/openvox-editor-services/pull/47) ([rwaffen](https://github.com/rwaffen))
+
+**Merged pull requests:**
+
+- docs: update readme to reflect the state of the gem [\#74](https://github.com/voxpupuli/openvox-editor-services/pull/74) ([rwaffen](https://github.com/rwaffen))
+- ci: merge method is set by merge\_group automatically [\#46](https://github.com/voxpupuli/openvox-editor-services/pull/46) ([rwaffen](https://github.com/rwaffen))
+- test: try merge queue [\#45](https://github.com/voxpupuli/openvox-editor-services/pull/45) ([rwaffen](https://github.com/rwaffen))
+- add some meta updates: switch to renovate, remove pr template, extend release docs [\#17](https://github.com/voxpupuli/openvox-editor-services/pull/17) ([rwaffen](https://github.com/rwaffen))
+
+## [v3.1.1](https://github.com/voxpupuli/openvox-editor-services/tree/v3.1.1) (2026-07-18)
+
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/v3.1.0...v3.1.1)
+
+**Fixed bugs:**
+
+- fix: use relative flag to fix autoload layout bug [\#14](https://github.com/voxpupuli/openvox-editor-services/pull/14) ([rwaffen](https://github.com/rwaffen))
+- fix: patch autoload behavior [\#13](https://github.com/voxpupuli/openvox-editor-services/pull/13) ([rwaffen](https://github.com/rwaffen))
+
+## [v3.1.0](https://github.com/voxpupuli/openvox-editor-services/tree/v3.1.0) (2026-07-03)
+
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/v3.0.0...v3.1.0)
 
 **Implemented enhancements:**
 
@@ -162,15 +189,15 @@
 
 ## [0.7.2](https://github.com/voxpupuli/openvox-editor-services/tree/0.7.2) (2017-10-27)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.7.1...0.7.2)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.7.0...0.7.2)
 
-## [0.7.1](https://github.com/voxpupuli/openvox-editor-services/tree/0.7.1) (2017-09-20)
+## [0.7.0](https://github.com/voxpupuli/openvox-editor-services/tree/0.7.0) (2017-09-20)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.7.0...0.7.1)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.7.1...0.7.0)
 
-## [0.7.0](https://github.com/voxpupuli/openvox-editor-services/tree/0.7.0) (2017-09-20)
+## [0.7.1](https://github.com/voxpupuli/openvox-editor-services/tree/0.7.1) (2017-09-20)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.6.0...0.7.0)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.6.0...0.7.1)
 
 ## [0.6.0](https://github.com/voxpupuli/openvox-editor-services/tree/0.6.0) (2017-07-21)
 
@@ -186,15 +213,15 @@
 
 ## [0.4.5](https://github.com/voxpupuli/openvox-editor-services/tree/0.4.5) (2017-06-16)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.4.2...0.4.5)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.4.0...0.4.5)
 
-## [0.4.2](https://github.com/voxpupuli/openvox-editor-services/tree/0.4.2) (2017-06-16)
+## [0.4.0](https://github.com/voxpupuli/openvox-editor-services/tree/0.4.0) (2017-06-16)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.4.0...0.4.2)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/0.4.2...0.4.0)
 
-## [0.4.0](https://github.com/voxpupuli/openvox-editor-services/tree/0.4.0) (2017-06-16)
+## [0.4.2](https://github.com/voxpupuli/openvox-editor-services/tree/0.4.2) (2017-06-16)
 
-[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/804559931cdefe5364e463ee904f68c1a8d7ed39...0.4.0)
+[Full Changelog](https://github.com/voxpupuli/openvox-editor-services/compare/804559931cdefe5364e463ee904f68c1a8d7ed39...0.4.2)
 
 
 

data/Gemfile

@@ -9,23 +9,25 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org"
 # -=-=-=-=-=- WARNING -=-=-=-=-=-
 
 group :development do
-  gem 'json', "< 2.8.0",                  :require => false
-  gem 'openfact', '>= 5.1', '< 6',        :require => false
+  # JSON 3 support requires keyword options in the sidecar/OpenVox JSON loaders
+  # and replacing JSON::PRETTY_STATE_PROTOTYPE in OpenVox's JSON dumper.
+  gem 'json', "< 3.0",                   :require => false
+  gem 'openfact', '>= 5.1', '< 7',        :require => false
   gem 'openvox-strings', '~> 7.1',        :require => false
   gem 'puppetfile-resolver', '~> 0.6.2',  :require => false
   gem 'rake', '>= 10.4',                  :require => false
   gem 'rspec', '>= 3.2',                  :require => false
-  gem 'rubocop-capybara', '~> 2.22.0',    :require => false
-  gem 'rubocop-factory_bot', '~> 2.27.0', :require => false
-  gem 'rubocop-rspec_rails', '~> 2.31.0', :require => false
+  gem 'rubocop-capybara', '~> 3.1.0',     :require => false
+  gem 'rubocop-factory_bot', '~> 2.28.0', :require => false
+  gem 'rubocop-rspec_rails', '~> 2.33.0', :require => false
   gem 'simplecov-console',                :require => false
   gem 'simplecov',                        :require => false
   gem 'syslog', '~> 0.4',                 :require => false unless Gem.win_platform?
   gem 'voxpupuli-puppet-lint-plugins', '= 7.0.0', :require => false
   gem 'yard', '~> 0.9.28',                :require => false
-  gem "rubocop-performance", '~> 1.24.0', :require => false
-  gem "rubocop-rspec", '~> 3.5.0',        :require => false
-  gem "rubocop", '~> 1.73.0',             :require => false
+  gem "rubocop-performance", '~> 1.27.0', :require => false
+  gem "rubocop-rspec", '~> 3.10.0',       :require => false
+  gem "rubocop", '~> 1.92.0',             :require => false
 
   if ENV['OPENVOX_GEM_VERSION']
     gem 'openvox', ENV['OPENVOX_GEM_VERSION'], :require => false
@@ -38,11 +40,12 @@ group :development do
     gem 'CFPropertyList'
   end
 
-  gem "win32-dir", "<= 0.4.9",      :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
-  gem "win32-eventlog", "<= 0.6.5", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
-  gem "win32-process", "<= 0.7.5",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
-  gem "win32-security", "<= 0.2.5", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
-  gem "win32-service", "<= 0.8.8",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-dir", "<= 0.7.2",      :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-eventlog", "<= 0.6.7", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-process", "<= 0.10.0",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-security", "<= 0.5.0", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-service", "<= 2.4.0",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32ole", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
 
   # Gems for building release tarballs etc.
   gem "archive-zip", :require => false

data/README.md

@@ -6,6 +6,7 @@ The internal `Puppet` Ruby namespace and `puppet/*` protocol methods are retaine
 - [OpenVox Editor Services](#openvox-editor-services)
   - [Requirements](#requirements)
   - [Setting up editor services for development](#setting-up-editor-services-for-development)
+  - [Build a local VSIX](#build-a-local-vsix)
   - [Language Server](#language-server)
     - [How to run the Language Server for Development](#how-to-run-the-language-server-for-development)
     - [How to run the Language Server in Production](#how-to-run-the-language-server-in-production)
@@ -26,123 +27,84 @@ The internal `Puppet` Ruby namespace and `puppet/*` protocol methods are retaine
   - [Other information](#other-information)
     - [Reporting bugs](#reporting-bugs)
   - [Development](#development)
-  - [Why are there vendored gems and why only native ruby](#why-are-there-vendored-gems-and-why-only-native-ruby)
+  - [Packaging and runtime dependencies](#packaging-and-runtime-dependencies)
 
 ## Requirements
 
 - OpenVox 8 or above
-- Ruby 3.1 or above
+- Ruby 3.4 or above
 
 ## Setting up editor services for development
 
-- Ensure a modern ruby is installed (3.4+)
-- The editor services support OpenVox 8.0.0 and above.
-- Clone this repository
+Use Ruby 3.4 or above, then clone the repository and install the development dependencies:
 
-```bash
-> git clone https://github.com/voxpupuli/openvox-editor-services.git
-
-> cd openvox-editor-services
+```shell
+git clone https://github.com/voxpupuli/openvox-editor-services.git
+cd openvox-editor-services
+bundle install
+bundle exec rake gem_revendor
 ```
 
-- Bundle the development gems
+`gem_revendor` downloads runtime dependency sources and requires network access.
+Run it before starting the servers from the checkout or running the test suites.
 
-```bash
-> bundle install
+The Gemfile accepts `OPENVOX_GEM_VERSION` to select the OpenVox dependency.
+For example, to use the OpenVox 8 series as configured in CI:
 
-  ... < lots of text >
+```shell
+export OPENVOX_GEM_VERSION='~> 8.0'
+bundle install
 ```
 
-- Installed vendored gems
+Keep this variable set for subsequent `bundle exec` commands.
+Without it, the Gemfile does not constrain the OpenVox version; Bundler resolves it using the available gems and lockfile.
+When changing the requirement, run `bundle update openvox` if the existing lockfile does not satisfy it.
 
-```bash
-> bundle exec rake gem_revendor
+## Build a local VSIX
 
-  ... < lots of text >
+To test the current editor-services checkout with the sibling `openvox-vscode` repository, run:
+
+```shell
+./scripts/build-local-vsix.sh
 ```
 
+The script removes old local gem and VSIX build artifacts, builds the local gem, installs it and its dependencies into
+the extension, compiles the extension, and creates
+`../openvox-vscode/artifacts/openvox-vscode-local-<gem-version>.vsix`.
+It requires Ruby 3.4 or newer and existing npm dependencies in `openvox-vscode`.
+Set `RUBY`, `OPENVOX_VSCODE_DIR`, or `VSIX_OUTPUT` to override the detected Ruby, repository path, or output path.
+
 ## Language Server
 
 ### How to run the Language Server for Development
 
-By default the language server will stop if no connection is made within 10 seconds and will also stop after a client disconnects.  Adding `--debug=stdout` will log messages to the console
+By default the language server stops if no connection is made within 10 seconds or after a client disconnects.
+Adding `--debug=stdout` logs diagnostic messages to the console.
+The example below shows only the readiness message; the port is selected dynamically.
 
 ```bash
-> bundle exec ruby ./puppet-languageserver --debug=stdout
-I, [2018-12-05T15:19:51.853802 #28756]  INFO -- : Language Server is v0.16.0
-I, [2018-12-05T15:19:51.854809 #28756]  INFO -- : Using Puppet v5.5.8
-D, [2018-12-05T15:19:51.856726 #28756] DEBUG -- : Detected additional puppet settings []
-I, [2018-12-05T15:19:51.867798 #28756]  INFO -- : Initializing Puppet Helper...
-D, [2018-12-05T15:19:51.867798 #28756] DEBUG -- : Initializing Document Store...
-I, [2018-12-05T15:19:51.868726 #28756]  INFO -- : Initializing settings...
-I, [2018-12-05T15:19:51.870728 #28756]  INFO -- : Starting RPC Server...
-D, [2018-12-05T15:19:51.870728 #28756] DEBUG -- : Using Simple TCP
-I, [2018-12-05T15:19:51.871729 #28756]  INFO -- : Using Facter v2.5.1
-I, [2018-12-05T15:19:51.871729 #28756]  INFO -- : Preloading Puppet Types (Async)...
-I, [2018-12-05T15:19:51.872728 #28756]  INFO -- : Preloading Facter (Async)...
-I, [2018-12-05T15:19:51.873727 #28756]  INFO -- : Preloading Functions (Async)...
-I, [2018-12-05T15:19:51.876727 #28756]  INFO -- : Preloading Classes (Async)...
-D, [2018-12-05T15:19:51.876727 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_types", "--feature-flags="]
-D, [2018-12-05T15:19:51.899795 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_functions", "--feature-flags="]
-D, [2018-12-05T15:19:51.919794 #28756] DEBUG -- : TCPSRV: Services running. Press ^C to stop
-D, [2018-12-05T15:19:51.920795 #28756] DEBUG -- : TCPSRV: Will stop the server in 10 seconds if no connection is made.
-D, [2018-12-05T15:19:51.921809 #28756] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+> bundle exec ruby ./openvox-languageserver --debug=stdout
 LANGUAGE SERVER RUNNING localhost:55087
-D, [2018-12-05T15:19:51.923800 #28756] DEBUG -- : TCPSRV: Started listening on localhost:55087.
-A, [2018-12-05T15:19:54.520501 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_functions --feature-flags= returned exitcode 0,
-D, [2018-12-05T15:19:54.532525 #28756] DEBUG -- : SidecarQueue Thread: default_functions returned 270 items
-D, [2018-12-05T15:19:54.533522 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_classes", "--feature-flags="]
-A, [2018-12-05T15:19:54.576503 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_types --feature-flags= returned exitcode 0,
-D, [2018-12-05T15:19:54.638503 #28756] DEBUG -- : SidecarQueue Thread: default_types returned 81 items
-A, [2018-12-05T15:19:56.732112 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_classes --feature-flags= returned exitcode 0,
-D, [2018-12-05T15:19:56.732112 #28756] DEBUG -- : SidecarQueue Thread: default_classes returned 0 items
-...
-D, [2018-12-05T15:20:03.319045 #28756] DEBUG -- : TCPSRV: No connection has been received in 10 seconds.  Shutting down server.
-D, [2018-12-05T15:20:03.320049 #28756] DEBUG -- : TCPSRV: Stopping services
-D, [2018-12-05T15:20:03.377052 #28756] DEBUG -- : TCPSRV: Stopped listening on localhost:55087
-D, [2018-12-05T15:20:03.377052 #28756] DEBUG -- : TCPSRV: Started shutdown process. Press ^C to force quit.
-D, [2018-12-05T15:20:03.378052 #28756] DEBUG -- : TCPSRV: Stopping services
-D, [2018-12-05T15:20:03.379050 #28756] DEBUG -- : TCPSRV: Waiting for workers to cycle down
-I, [2018-12-05T15:20:03.632011 #28756]  INFO -- : Language Server exited.
 ```
 
 To make the server run continuously add `--timeout=0` and `--no-stop` to the command line. For example;
 
 ```bash
-> bundle exec ruby ./puppet-languageserver --debug=stdout --timeout=0 --no-stop
-I, [2018-12-05T15:20:56.302414 #29752]  INFO -- : Language Server is v0.16.0
-I, [2018-12-05T15:20:56.303391 #29752]  INFO -- : Using Puppet v5.5.8
-D, [2018-12-05T15:20:56.306343 #29752] DEBUG -- : Detected additional puppet settings []
-I, [2018-12-05T15:20:56.318333 #29752]  INFO -- : Initializing Puppet Helper...
-D, [2018-12-05T15:20:56.318333 #29752] DEBUG -- : Initializing Document Store...
-I, [2018-12-05T15:20:56.319346 #29752]  INFO -- : Initializing settings...
-I, [2018-12-05T15:20:56.321337 #29752]  INFO -- : Starting RPC Server...
-D, [2018-12-05T15:20:56.321337 #29752] DEBUG -- : Using Simple TCP
-I, [2018-12-05T15:20:56.322332 #29752]  INFO -- : Using Facter v2.5.1
-I, [2018-12-05T15:20:56.323335 #29752]  INFO -- : Preloading Puppet Types (Async)...
-I, [2018-12-05T15:20:56.325337 #29752]  INFO -- : Preloading Facter (Async)...
-I, [2018-12-05T15:20:56.326335 #29752]  INFO -- : Preloading Functions (Async)...
-I, [2018-12-05T15:20:56.327333 #29752]  INFO -- : Preloading Classes (Async)...
-...
-D, [2018-12-05T15:20:56.365334 #29752] DEBUG -- : TCPSRV: Services running. Press ^C to stop
-LANGUAGE SERVER RUNNING localhost:55180
-D, [2018-12-05T15:20:56.374333 #29752] DEBUG -- : TCPSRV: Started listening on localhost:55180.
-...
+> bundle exec ruby ./openvox-languageserver --debug=stdout --timeout=0 --no-stop
+LANGUAGE SERVER RUNNING localhost:55087
 ```
 
 ### How to run the Language Server in Production
 
-- Ensure that Puppet Agent is installed
-  - [Linux](https://puppet.com/docs/puppet/latest/install_agents.html#install_nix_agents)
-  - [Windows](https://puppet.com/docs/puppet/latest/install_agents.html#install_windows_agents)
-  - [macOS](https://puppet.com/docs/puppet/latest/install_agents.html#install_mac_agents)
+- Ensure that OpenVox Agent is installed
 
-- Run the `puppet-languageserver` with ruby
+- Run the `openvox-languageserver` with ruby
 
-> On Windows you need to run ruby with the `Puppet Command Prompt` which can be found in the Start Menu.  This enables the Puppet Agent ruby environment.
+On Windows, run Ruby from the `OpenVox Command Prompt` in the Start Menu.
+This enables the OpenVox Agent Ruby environment.
 
 ```bash
-> ruby puppet-languageserver
+> ruby openvox-languageserver
 LANGUAGE SERVER RUNNING 127.0.0.1:55086
 ```
 
@@ -153,31 +115,35 @@ The IP Address and Port can be changed using the `--ip` and `--port` arguments r
 For example to listen on all interfaces on port 9000;
 
 ```bash
-> ruby ./puppet-languageserver --ip=0.0.0.0 --port=9000
+> ruby ./openvox-languageserver --ip=0.0.0.0 --port=9000
 ```
 
 To change the protocol to STDIO, that is using STDOUT and STDIN, use the `--stdio` argument.
 
 ### Command line arguments
 
-```bash
-Usage: puppet-languageserver.rb [options]
-    -p, --port=PORT                  TCP Port to listen on.  Default is random port
-    -i, --ip=ADDRESS                 IP Address to listen on (0.0.0.0 for all interfaces).  Default is localhost
-    -c, --no-stop                    Do not stop the language server once a client disconnects.  Default is to stop
-    -t, --timeout=TIMEOUT            Stop the language server if a client does not connection within TIMEOUT seconds.  A value of zero will not timeout.  Default is 10 seconds
-    -d, --no-preload                 ** DEPRECATED ** Do not preload Puppet information when the language server starts.  Default is to preload
-        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output
-    -s, --slow-start                 Delay starting the Language Server until Puppet initialisation has completed.  Default is to start fast
-        --stdio                      Runs the server in stdio mode, without a TCP listener
-        --enable-file-cache          ** DEPRECATED ** Enables the file system cache for Puppet Objects (types, class etc.)
-        --[no-]cache                 Enable or disable all caching inside the sidecar. By default caching is enabled.
-        --feature-flags=FLAGS        A list of comma delimited feature flags
-        --openvox-version=TEXT       The OpenVox Gem version to use
-        --puppet-settings=TEXT       Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture
-        --local-workspace=PATH       The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path.
-    -h, --help                       Prints this help
-    -v, --version                    Prints the Langauge Server version
+Common options:
+
+| Option | Behavior |
+| --- | --- |
+| `--ip=ADDRESS` | TCP listen address; defaults to `localhost`. |
+| `--port=PORT` | TCP listen port; defaults to a randomly selected port. |
+| `--stdio` | Use STDIN and STDOUT instead of TCP. |
+| `--timeout=SECONDS` | Wait for a connection for up to 10 seconds by default; `0` disables this timeout. |
+| `--no-stop` | Keep running after a client disconnects. |
+| `--debug=PATH` | Write diagnostic logs to a file, or use `STDOUT` for console output. |
+| `--[no-]cache` | Enable or disable sidecar caching; enabled by default. |
+| `--openvox-version=VERSION` | Select an OpenVox gem version; `--puppet-version` is a compatibility alias. |
+| `--puppet-settings=SETTINGS` | Pass comma-separated settings, such as `--vardir,/path/to/vardir`. |
+
+`--no-preload` and `--slow-start` are deprecated.
+`--enable-file-cache` and `--local-workspace` are deprecated and have no effect.
+The client supplies the Language Server workspace; the Sidecar's `--local-workspace` option remains supported.
+
+For the complete option list, run:
+
+```shell
+bundle exec ruby ./openvox-languageserver --help
 ```
 
 ## Language Server Sidecar
@@ -200,52 +166,52 @@ Typically this only used by a developer to inspect what the Sidecar is doing.
 The `noop` action just outputs an empty JSON array but can be used to confirm that the Sidecar does not error while loading Puppet.
 
 ```bash
-> bundle exec ruby ./puppet-languageserver-sidecar --action=noop
+> bundle exec ruby ./openvox-languageserver-sidecar --action=noop
 []
 ```
 
 #### Output all default Puppet Types
 
 ```bash
-> bundle exec ruby ./puppet-languageserver-sidecar --action=default_types
+> bundle exec ruby ./openvox-languageserver-sidecar --action=default_types
 [{"key":"anchor","calling_source":"puppet/cache/lib/puppet/type/anchor.rb","sou ...
 ```
 
 #### Output all default Puppet Functions with a different puppet configuration, and debug information
 
 ```bash
-> bundle exec ruby ./puppet-languageserver-sidecar --action=default_types --puppet-settings=--vardir,./test/vardir,--confdir,./test/confdir --debug=STDOUT
-I, [2018-12-05T15:42:56.679837 #51864]  INFO -- : Language Server Sidecar is v0.16.0
-I, [2018-12-05T15:42:56.679837 #51864]  INFO -- : Using Puppet v5.5.8
-D, [2018-12-05T15:42:56.680820 #51864] DEBUG -- : Detected additional puppet settings ["--vardir", "./test/vardir", "--confdir", "./test/confdir"]
-D, [2018-12-05T15:42:56.690876 #51864] DEBUG -- : [PuppetHelper::load_functions] Starting
-D, [2018-12-05T15:42:56.752804 #51864] DEBUG -- : [PuppetLanguageServerSidecar::load] Loading lib/puppet/parser/functions/assert_type.rb from cache
-...
-[{"key":"debug","calling_source":"lib/puppet/parser/functions.rb", ...
+bundle exec ruby ./openvox-languageserver-sidecar --action=default_functions --puppet-settings=--vardir,./test/vardir,--confdir,./test/confdir --debug=STDOUT
 ```
 
+This prints diagnostic messages followed by the JSON function data.
+Use `--output=functions.json` to save the JSON separately from the diagnostic output.
+
 #### Output all Puppet Classes in a workspace directory
 
 ```bash
-> bundle exec ruby ./puppet-languageserver-sidecar --action=workspace_classes --local-workspace=C:\source\puppetlabs-sqlserver
+> bundle exec ruby ./openvox-languageserver-sidecar --action=workspace_classes --local-workspace=C:\source\puppetlabs-sqlserver
 [{"key":"sqlserver::config","calling_source":"C:/Source/puppetlabs-sqlserver/manifests/config.pp","source":"C:/Source/puppetlabs-sqlserver/manifests/config.pp","line":25,"ch...
 ```
 
 ### Command line arguments for the Language Server Sidecar
 
-```bash
-Usage: puppet-languageserver-sidecar.rb [options]
-    -a, --action=NAME                The action for the sidecar to take. Expected ["noop", "default_classes", "default_functions",
-                                      "default_types", "node_graph", "resource_list", "workspace_classes", "workspace_functions", "workspace_types"]
-    -c, --action-parameters=JSON     JSON Encoded string containing the parameters for the sidecar action
-    -w, --local-workspace=PATH       The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path
-    -o, --output=PATH                The file to save the output from the sidecar. Default is output to STDOUT
-    -p, --puppet-settings=TEXT       Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture
-    -f, --feature-flags=FLAGS        A list of comma delimited feature flags to pass the the sidecar
-    -n, --[no-]cache                 Enable or disable all caching inside the sidecar. By default caching is enabled.
-        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'. Default is no debug output
-    -h, --help                       Prints this help
-    -v, --version                    Prints the Langauge Server version
+Common options:
+
+| Option | Behavior |
+| --- | --- |
+| `--action=NAME` | Required action, such as `noop`, `default_functions`, or `workspace_classes`. |
+| `--action-parameters=JSON` | Supply action parameters as a JSON string. |
+| `--local-workspace=PATH` | Set the workspace or file path for module-specific actions. |
+| `--output=PATH` | Save JSON output to a file; defaults to STDOUT. |
+| `--puppet-settings=SETTINGS` | Pass comma-separated settings, such as `--vardir,/path/to/vardir`. |
+| `--[no-]cache` | Enable or disable caching; enabled by default. |
+| `--openvox-version=VERSION` | Select an OpenVox gem version; `--puppet-version` is a compatibility alias. |
+| `--debug=PATH` | Write diagnostic logs to a file, or use `STDOUT` for console output. |
+
+For all supported actions and options, run:
+
+```shell
+bundle exec ruby ./openvox-languageserver-sidecar --help
 ```
 
 ## Debug Server
@@ -253,49 +219,32 @@ Usage: puppet-languageserver-sidecar.rb [options]
 ### How to run the Debug Server for Development
 
 By default the debug server will stop if no connection is made within 10 seconds and will also stop after a client disconnects.
-Adding `--debug=stdout` will log messages to the console
+Adding `--debug=stdout` logs diagnostic messages to the console.
+The examples below show only the readiness message; the port is selected dynamically.
 
 ```bash
-> bundle exec ruby ./puppet-debugserver --debug=stdout
-I, [2018-04-17T14:19:24.131869 #6940]  INFO -- : Debug Server is v0.10.0
-I, [2018-04-17T14:19:24.132871 #6940]  INFO -- : Starting RPC Server...
-D, [2018-04-17T14:19:24.135373 #6940] DEBUG -- : TCPSRV: Services running. Press ^C to stop
-D, [2018-04-17T14:19:24.135870 #6940] DEBUG -- : TCPSRV: Will stop the server in 10 seconds if no connection is made.
-D, [2018-04-17T14:19:24.135870 #6940] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+> bundle exec ruby ./openvox-debugserver --debug=stdout
 DEBUG SERVER RUNNING 127.0.0.1:8082
-D, [2018-04-17T14:19:24.136871 #6940] DEBUG -- : TCPSRV: Started listening on 127.0.0.1:8082.
-D, [2018-04-17T14:19:34.140900 #6940] DEBUG -- : TCPSRV: No connection has been received in 10 seconds.  Shutting down server.
-D, [2018-04-17T14:19:34.140900 #6940] DEBUG -- : TCPSRV: Stopping services
-D, [2018-04-17T14:19:34.141400 #6940] DEBUG -- : TCPSRV: Stopped listening on 127.0.0.1:8082
-D, [2018-04-17T14:19:34.141900 #6940] DEBUG -- : TCPSRV: Started shutdown process. Press ^C to force quit.
-D, [2018-04-17T14:19:34.141900 #6940] DEBUG -- : TCPSRV: Stopping services
-D, [2018-04-17T14:19:34.142401 #6940] DEBUG -- : TCPSRV: Waiting for workers to cycle down
-I, [2018-04-17T14:19:34.150402 #6940]  INFO -- : Debug Server exited.
 ```
 
-To make the server run continuously add `--timeout=0` to the command line. For example;
+To wait for a client without a connection timeout, add `--timeout=0`.
+The debug server still stops after the client disconnects.
 
 ```bash
-> bundle exec ruby ./puppet-debugserver --debug=stdout --timeout=0
-I, [2018-04-17T14:21:10.542332 #12424]  INFO -- : Debug Server is v0.10.0
-I, [2018-04-17T14:21:10.543334 #12424]  INFO -- : Starting RPC Server...
-D, [2018-04-17T14:21:10.545836 #12424] DEBUG -- : TCPSRV: Services running. Press ^C to stop
-D, [2018-04-17T14:21:10.546336 #12424] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+> bundle exec ruby ./openvox-debugserver --debug=stdout --timeout=0
 DEBUG SERVER RUNNING 127.0.0.1:8082
-D, [2018-04-17T14:21:10.546834 #12424] DEBUG -- : TCPSRV: Started listening on 127.0.0.1:8082.
-...
 ```
 
 ### How to run the Debug Server for Production
 
 - Ensure that OpenVox Agent is installed
-- Run the `puppet-debugserver` with ruby
+- Run the `openvox-debugserver` with ruby
 
 On Windows you need to run ruby with the `OpenVox Command Prompt` which can be found in the Start Menu.
 This enables the OpenVox Agent ruby environment.
 
 ```bash
-> ruby puppet-debugserver
+> ruby openvox-debugserver
 DEBUG SERVER RUNNING 127.0.0.1:8082
 ```
 
@@ -303,14 +252,20 @@ Note the debug server will stop after 10 seconds if no client connection is made
 
 ### Command line arguments for the Debug Server
 
-```bash
-Usage: puppet-debugserver.rb [options]
-    -p, --port=PORT                  TCP Port to listen on.  Default is random port}
-    -i, --ip=ADDRESS                 IP Address to listen on (0.0.0.0 for all interfaces).  Default is localhost
-    -t, --timeout=TIMEOUT            Stop the Debug Server if a client does not connection within TIMEOUT seconds.  A value of zero will not timeout.  Default is 10 seconds
-        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output
-    -h, --help                       Prints this help
-    -v, --version                    Prints the Debug Server version
+Common options:
+
+| Option | Behavior |
+| --- | --- |
+| `--ip=ADDRESS` | TCP listen address; defaults to `localhost`. |
+| `--port=PORT` | TCP listen port; defaults to a randomly selected port. |
+| `--timeout=SECONDS` | Wait for a connection for up to 10 seconds by default; `0` disables this timeout. |
+| `--openvox-version=VERSION` | Select an OpenVox gem version; `--puppet-version` is a compatibility alias. |
+| `--debug=PATH` | Write diagnostic logs to a file, or use `STDOUT` for console output. |
+
+For the complete option list, run:
+
+```shell
+bundle exec ruby ./openvox-debugserver --help
 ```
 
 ## License
@@ -321,19 +276,46 @@ This codebase is licensed under Apache 2.0. However, the open source dependencie
 
 ### Reporting bugs
 
-If you find a bug in puppet-editor-services or its results, please create an issue in the [repo issues tracker](https://github.com/voxpupulo/openvox-editor-services/issues).
+If you find a bug in OpenVox Editor Services or its results, please create an issue in the
+[repository issue tracker](https://github.com/voxpupuli/openvox-editor-services/issues).
 Bonus points will be awarded if you also include a patch that fixes the issue.
 
 ## Development
 
-If you run into an issue with this tool or would like to request a feature you can raise a PR with your suggested changes.
-Alternatively, you can raise a Github issue with a feature request or to report any bugs.
-Every other Tuesday the DevX team holds office hours in the Puppet Community Slack, where you can ask questions about this and any other supported tools.
-This session runs at 15:00 (GMT) for about an hour.
+After completing the [development setup](#setting-up-editor-services-for-development), run the relevant checks:
 
-## Why are there vendored gems and why only native ruby
+```shell
+bundle exec rake test_languageserver
+bundle exec rake test_languageserver_sidecar
+bundle exec rake test_debugserver
+bundle exec rake acceptance_languageserver
+bundle exec rake rubocop
+```
+
+The first three commands run the component specs; the acceptance suite runs separately.
+For coverage across the three component suites, run `bundle exec rake test:coverage`.
+CI currently runs these checks with Ruby 4.0 and `OPENVOX_GEM_VERSION='~> 8.0'`,
+with component and acceptance tests on Linux and Windows.
+Use the explicit tasks above; the default Rake task currently refers to an undefined `test` task.
 
-When used by editors this language server will be running using the Ruby runtime provided by Puppet Agent.
-That means no native extensions and no bundler.
-Also, only the gems provided by Puppet Agent would be available by default.
-To work around this limitation all runtime dependencies should be re-vendored and then the load path modified appropriately.
+If you run into an issue with this tool or would like to request a feature you can raise a PR with your suggested changes.
+Alternatively, you can raise a GitHub issue with a feature request or to report any bugs.
+
+## Packaging and runtime dependencies
+
+Editor services can run with the Ruby runtime provided by OpenVox Agent.
+Dependencies must be available to that runtime when the editor starts the server.
+The repository supports two packaging paths:
+
+- **Standalone archives:** `bundle exec rake build` runs `gem_revendor` and includes the downloaded Ruby sources from
+  `vendor/` alongside `lib/` and the root-level server scripts in ZIP and tar.gz archives.
+  The server loads these vendored dependencies through its Ruby load path, without requiring Bundler at runtime.
+  Run `bundle exec rake gem_revendor` when preparing a checkout for development and tests as described above.
+- **Ruby gem and local VSIX:** the gemspec declares runtime dependencies, which `gem install` resolves and installs.
+  The gem contains `lib/` and `bin/`; it does not include the repository's `vendor/` directory.
+  `scripts/build-local-vsix.sh` builds this gem and installs it with its dependencies into the extension's
+  `vendor/languageserver/gems` directory, then packages the extension.
+  This path does not run `gem_revendor` and does not require Bundler at runtime.
+
+Keep dependencies compatible with the OpenVox Agent Ruby runtime and prefer pure Ruby dependencies to avoid
+platform-specific native extension builds.

data/RELEASE.md

@@ -31,6 +31,6 @@ Then open a PR, discuss and merge.
 ```shell
 git switch main
 git pull --rebase
-git tag v$RELEASE_VERSION --message "v$RELEASE_VERSION"
+git tag v$RELEASE_VERSION --sign --message "v$RELEASE_VERSION"
 git push --tags
 ```

data/lib/dsp/dsp_base.rb

@@ -29,7 +29,8 @@ module DSP
     def from_h!(value); end
 
     def to_json(*options)
-      to_h.to_json(options)
+      # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+      to_h.to_json(*options)
     end
 
     private

data/lib/lsp/lsp_base.rb

@@ -30,7 +30,8 @@ module LSP
     def from_h!(value); end
 
     def to_json(*options)
-      to_h.to_json(options)
+      # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+      to_h.to_json(*options)
     end
 
     private

data/lib/openvox_agent_rubygems.rb

@@ -54,7 +54,8 @@ module OpenVoxAgentRubygems
 
   def self.packaged_agent_ruby?
     [RbConfig::CONFIG['prefix'], Gem.default_dir].compact.any? do |path|
-      normalized_path(path).include?('/puppetlabs/puppet')
+      normalized = normalized_path(path)
+      normalized.include?('/puppetlabs/puppet') || normalized.include?('/puppet labs/puppet')
     end
   end
   private_class_method :packaged_agent_ruby?

data/lib/openvox_runtime.rb

@@ -8,7 +8,11 @@ module OpenVoxRuntime
   def self.activate!(version = nil)
     OpenVoxAgentRubygems.activate!
     specification = select_specification(version)
-    raise Gem::LoadError, "Unable to find the #{GEM_NAME} gem#{version.nil? ? '' : " version #{version}"}" if specification.nil?
+    if specification.nil?
+      message = "Unable to find the #{GEM_NAME} gem"
+      message << " version #{version}" unless version.nil?
+      raise Gem::LoadError, message
+    end
 
     if Gem::Specification.find_all_by_name(GEM_NAME).include?(specification)
       version.nil? || version.empty? ? gem(GEM_NAME) : gem(GEM_NAME, version)

data/lib/puppet-debugserver/debug_session/break_points.rb

@@ -29,7 +29,7 @@ module PuppetDebugServer
 
           begin
             # TODO: This could be slow on big files....
-            IO.foreach(file_path, mode: 'rb', encoding: 'UTF-8').each_with_index do |item, index|
+            File.foreach(file_path, mode: 'rb', encoding: 'UTF-8').each_with_index do |item, index|
               # index here zero-based whereas we want one-based indexing
               file_contents[index + 1] = item if line_list.include?(index + 1)
             end

data/lib/puppet-debugserver/debug_session/hook_handlers.rb

@@ -133,7 +133,7 @@ module PuppetDebugServer
           target_end_line   = @debug_session.line_for_offset(target, target_loc.offset + target_loc.length)
 
           # TODO: What about Hit and Conditional BreakPoints?
-          bp = line_breakpoints.find_index { |bp_line| bp_line >= target_start_line && bp_line <= target_end_line }
+          bp = line_breakpoints.find_index { |bp_line| bp_line.between?(target_start_line, target_end_line) }
           unless bp.nil?
             # Re-raise the hook as a breakpoint
             @debug_session.execute_hook(:hook_breakpoint, [ast_classname, ''] + args)

data/lib/puppet-languageserver/global_queues/validation_queue.rb

@@ -57,6 +57,7 @@ module PuppetLanguageServer
         results = case document_store.document_type(job_object.file_uri)
                   when :manifest
                     options[:tasks_mode] = document_store.plan_file?(job_object.file_uri)
+                    options[:document_uri] = job_object.file_uri
                     PuppetLanguageServer::Manifest::ValidationProvider.validate(session_state, content, options)
                   when :epp
                     PuppetLanguageServer::Epp::ValidationProvider.validate(content)

data/lib/puppet-languageserver/manifest/completion_provider.rb

@@ -247,7 +247,7 @@ module PuppetLanguageServer
           return result if item_type.nil?
 
           result.documentation = item_type.doc unless item_type.doc.nil?
-          unless item_type.nil? || item_type.signatures.count.zero?
+          unless item_type.nil? || item_type.signatures.none?
             result.detail = item_type.signatures.map(&:key).join("\n\n")
             # The signature provider should handle suggestions after this, so just place the cursor ready for an opening bracket
             result.insertText = data['name'].to_s

data/lib/puppet-languageserver/manifest/format_on_type_provider.rb

@@ -87,9 +87,10 @@ module PuppetLanguageServer
         result
       end
 
-      private
-
       VALID_TOKEN_TYPES = %i[NAME STRING SSTRING].freeze
+      private_constant :VALID_TOKEN_TYPES
+
+      private
 
       def find_token_by_location(tokens, line, character)
         return nil if tokens.empty?

data/lib/puppet-languageserver/manifest/hover_provider.rb

@@ -194,7 +194,7 @@ module PuppetLanguageServer
       def self.get_puppet_class_content(item_class)
         content = "**#{item_class.key}** Resource"
         content += "\n\n#{item_class.doc}" unless item_class.doc.nil?
-        unless item_class.parameters.count.zero?
+        unless item_class.parameters.none?
           content += "\n\n---\n"
           item_class.parameters.sort.each do |name, _param|
             content += "* #{name}\n"

data/lib/puppet-languageserver/manifest/signature_provider.rb

@@ -78,7 +78,7 @@ module PuppetLanguageServer
         signature_number = func_info.signatures.find_index { |sig| sig.parameters.count >= func_arg_count }
 
         # If we still don't know the signature number then assume it's the first one
-        signature_number = 0 if signature_number.nil? && func_info.signatures.count > 0
+        signature_number = 0 if signature_number.nil? && func_info.signatures.any?
 
         response.activeSignature = signature_number unless signature_number.nil?
         response.activeParameter = param_number
@@ -110,10 +110,10 @@ module PuppetLanguageServer
         # Is the cursor on or beyond the closing bracket? then we are not in any parameters
         return nil if char_offset >= function_offset + function_length
         # Does the function even have arguments? then the cursor HAS to be in the first parameter
-        return 0 if function_ast_object.arguments.count.zero?
+        return 0 if function_ast_object.arguments.none?
 
         # Is the cursor within any of the function argument locations? if so, return the parameter number we're in
-        param_number = function_ast_object.arguments.find_index { |arg| char_offset >= arg.offset && char_offset <= arg.offset + arg.length }
+        param_number = function_ast_object.arguments.find_index { |arg| char_offset.between?(arg.offset, arg.offset + arg.length) }
         return param_number unless param_number.nil?
 
         # So now we know the char_offset exists outside any of the locators.  Check the extremities

data/lib/puppet-languageserver/manifest/validation_provider.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'puppet-languageserver/puppet_lint'
+require 'puppet-languageserver/uri_helper'
 module PuppetLanguageServer
   module Manifest
     module ValidationProvider
@@ -13,11 +14,11 @@ module PuppetLanguageServer
       #  [ <Int> Number of problems fixed,
       #    <String> New Content
       #  ]
-      def self.fix_validate_errors(session_state, content)
-        init_puppet_lint(session_state.documents.store_root_path, ['--fix'])
+      def self.fix_validate_errors(session_state, content, document_uri = nil)
+        init_puppet_lint(session_state.documents.store_root_path, ['--fix', '--relative'])
 
         linter = PuppetLint::Checks.new
-        problems = linter.run(LINT_FILENAME, content)
+        problems = linter.run(lint_filename(document_uri), content)
         problems_fixed = problems.nil? ? 0 : problems.count { |item| item[:kind] == :fixed }
 
         [problems_fixed, linter.manifest]
@@ -33,11 +34,11 @@ module PuppetLanguageServer
         # TODO: Need to implement max_problems
         problems = 0
 
-        init_puppet_lint(session_state.documents.store_root_path, [])
+        init_puppet_lint(session_state.documents.store_root_path, ['--relative'])
 
         begin
           linter = PuppetLint::Checks.new
-          problems = linter.run(LINT_FILENAME, content)
+          problems = linter.run(lint_filename(options[:document_uri]), content)
           unless problems.nil?
             problems.each do |problem|
               # Syntax errors are better handled by the puppet parser, not puppet lint
@@ -125,6 +126,13 @@ module PuppetLanguageServer
         linter_options.parse!(lint_options)
       end
       private_class_method :init_puppet_lint
+
+      def self.lint_filename(document_uri)
+        PuppetLanguageServer::UriHelper.uri_path(document_uri) || LINT_FILENAME
+      rescue URI::InvalidURIError
+        LINT_FILENAME
+      end
+      private_class_method :lint_filename
     end
   end
 end

data/lib/puppet-languageserver/message_handler.rb

@@ -133,7 +133,7 @@ module PuppetLanguageServer
 
       case documents.document_type(file_uri)
       when :manifest
-        changes, new_content = PuppetLanguageServer::Manifest::ValidationProvider.fix_validate_errors(session_state, content)
+        changes, new_content = PuppetLanguageServer::Manifest::ValidationProvider.fix_validate_errors(session_state, content, file_uri)
       else
         raise "Unable to fixDiagnosticErrors on #{file_uri}"
       end

data/lib/puppet-languageserver/puppetfile/validation_provider.rb

@@ -143,7 +143,7 @@ module PuppetLanguageServer
       private_class_method :resolver_cache
 
       def self.document_error_to_diagnostic(document_uri, error)
-        if error.puppetfile_modules.count.zero?
+        if error.puppetfile_modules.none?
           return LSP::Diagnostic.new(
             'severity' => LSP::DiagnosticSeverity::ERROR,
             'range' => LSP.create_range(0, 0, 0, max_line_length),

data/lib/puppet-languageserver/session_state/document_store.rb

@@ -149,17 +149,17 @@ module PuppetLanguageServer
       end
 
       # Workspace management
-      WORKSPACE_CACHE_TTL_SECONDS ||= 60
+      WORKSPACE_CACHE_TTL_SECONDS = 60
       def initialize_store(options = {})
         @workspace_path = options[:workspace]
         @workspace_info_cache = {
-          expires: Time.new - 120
+          expires: Time.now - 120
         }
       end
 
       def expire_store_information
         @doc_mutex.synchronize do
-          @workspace_info_cache[:expires] = Time.new - 120
+          @workspace_info_cache[:expires] = Time.now - 120
         end
       end
 
@@ -208,7 +208,7 @@ module PuppetLanguageServer
       end
 
       def store_details
-        return @workspace_info_cache unless @workspace_info_cache[:never_expires] || @workspace_info_cache[:expires] < Time.new
+        return @workspace_info_cache unless @workspace_info_cache[:never_expires] || @workspace_info_cache[:expires] < Time.now
 
         # TTL has expired, time to calculate the document store details
 
@@ -232,7 +232,7 @@ module PuppetLanguageServer
             new_cache[:has_environmentconf] = file_exist?(File.join(root_path, 'environment.conf'))
           end
         end
-        new_cache[:expires] = Time.new + WORKSPACE_CACHE_TTL_SECONDS
+        new_cache[:expires] = Time.now + WORKSPACE_CACHE_TTL_SECONDS
 
         @doc_mutex.synchronize do
           @workspace_info_cache = new_cache

data/lib/puppet-languageserver/session_state/language_client.rb

@@ -100,7 +100,7 @@ module PuppetLanguageServer
 
         PuppetLanguageServer.log_message(:info, "Attempting to dynamically register the #{method} method with id #{id}")
 
-        if @registrations[method] && @registrations[method].select { |i| i[:state] == :pending }.count > 0
+        if @registrations[method]&.any? { |registration| registration[:state] == :pending }
           # The protocol doesn't specify whether this is allowed and is probably per client specific. For the moment we will allow
           # the registration to be sent but log a message that something may be wrong.
           PuppetLanguageServer.log_message(:warn, "A dynamic registration/deregistration for the #{method} method is already in progress")
@@ -135,7 +135,7 @@ module PuppetLanguageServer
           reg[:state] = :pending
         end
 
-        if params.unregisterations.count.zero?
+        if params.unregisterations.none?
           PuppetLanguageServer.log_message(:debug, "Nothing to deregister for the #{method} method")
           return true
         end

data/lib/puppet-languageserver/sidecar_protocol.rb

@@ -17,7 +17,8 @@ module PuppetLanguageServer
         include Base
 
         def to_json(*options)
-          ::JSON.generate(to_h, options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          ::JSON.generate(to_h, *options)
         end
 
         def from_json!(json_string)
@@ -32,8 +33,11 @@ module PuppetLanguageServer
       class BaseClass
         include Base
 
+        IGNORED_INSTANCE_METHODS = %i[to_h to_json].freeze
+
         def to_json(*options)
-          to_h.to_json(options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          to_h.to_json(*options)
         end
 
         def from_json!(json_string)
@@ -46,7 +50,7 @@ module PuppetLanguageServer
           self.class
               .instance_methods(false)
               .reject { |name| name.to_s.end_with?('=', '!') }
-              .reject { |name| %i[to_h to_json].include?(name) }
+              .reject { |name| IGNORED_INSTANCE_METHODS.include?(name) }
               .each do |method_name|
             return false unless send(method_name) == other.send(method_name)
           end
@@ -59,7 +63,7 @@ module PuppetLanguageServer
           self.class
               .instance_methods(false)
               .reject { |name| name.to_s.end_with?('=', '!') }
-              .reject { |name| %i[to_h to_json].include?(name) }
+              .reject { |name| IGNORED_INSTANCE_METHODS.include?(name) }
               .each do |method_name|
             return false unless send(method_name).eql?(other.send(method_name))
           end
@@ -70,7 +74,7 @@ module PuppetLanguageServer
           props = self.class
                       .instance_methods(false)
                       .reject { |name| name.to_s.end_with?('=', '!') }
-                      .reject { |name| %i[to_h to_json].include?(name) }
+                      .reject { |name| IGNORED_INSTANCE_METHODS.include?(name) }
                       .map do |method_name|
             send(method_name).hash
           end
@@ -120,7 +124,8 @@ module PuppetLanguageServer
         include Base
 
         def to_json(*options)
-          "[#{map { |item| item.to_json(options) }.join(',')}]"
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          "[#{map { |item| item.to_json(*options) }.join(',')}]"
         end
 
         def from_json!(json_string)
@@ -141,11 +146,12 @@ module PuppetLanguageServer
         attr_accessor :vertices, :edges, :error_content
 
         def to_json(*options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
           {
             'vertices' => vertices,
             'edges' => edges,
             'error_content' => error_content
-          }.to_json(options)
+          }.to_json(*options)
         end
 
         def from_json!(json_string)
@@ -398,7 +404,8 @@ module PuppetLanguageServer
         end
 
         def to_json(*options)
-          to_h.to_json(options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          to_h.to_json(*options)
         end
 
         def from_json!(json_string)
@@ -448,7 +455,8 @@ module PuppetLanguageServer
         end
 
         def to_json(*options)
-          @aggregate.to_json(options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          @aggregate.to_json(*options)
         end
 
         def from_json!(json_string)
@@ -469,8 +477,6 @@ module PuppetLanguageServer
           @aggregate.each(&block)
         end
 
-        private
-
         # When adding a new metadata item:
         # - Add to the information to this hash
         # - Add a method to access the aggregate
@@ -492,6 +498,9 @@ module PuppetLanguageServer
             list_class: PuppetTypeList
           }
         }.freeze
+        private_constant :METADATA_LIST
+
+        private
 
         def list_for_object_class(klass)
           METADATA_LIST.each do |name, info|

data/lib/puppet-languageserver-sidecar/cache/filesystem.rb

@@ -13,8 +13,8 @@ module PuppetLanguageServerSidecar
 
         @cache_dir = File.join(Dir.tmpdir, 'puppet-vscode-cache')
         begin
-          Dir.mkdir(@cache_dir) unless Dir.exist?(@cache_dir)
-        rescue Errno::ENOENT => e
+          FileUtils.mkdir_p(@cache_dir)
+        rescue SystemCallError => e
           PuppetLanguageServerSidecar.log_message(:error, "[PuppetLanguageServerSidecar::Cache::FileSystem] An error occured while creating file cache.  Disabling cache: #{e}")
           @cache_dir = nil
         end

data/lib/puppet-languageserver-sidecar/puppet_helper.rb

@@ -12,6 +12,7 @@ module PuppetLanguageServerSidecar
     # Object - While useful, typically only needed when extended the type system as opposed to general use
     # TypeSet - While useful, typically only needed when extended the type system as opposed to general use
     IGNORE_DATATYPE_NAMES = %w[TypeReference TypeAlias Object TypeSet ObjectTypeExten Iterable AbstractTimeData TypeWithContained].freeze
+    IGNORE_TYPE_NAMES = %w[whit component].freeze
 
     # Resource Face
     def self.get_puppet_resource(typename, title = nil)
@@ -107,7 +108,7 @@ module PuppetLanguageServerSidecar
         next unless object_types.include?(:type)
 
         file_doc.types.each do |item|
-          result.append!(item) unless %w[whit component].include?(name)
+          result.append!(item) unless IGNORE_TYPE_NAMES.include?(name)
           finder.temp_file.unlink if item.key == 'file' && File.exist?(finder.temp_file.path) # Remove the temp_file.rb if it exists
         end
       end
@@ -163,9 +164,7 @@ module PuppetLanguageServerSidecar
         # Path to the environment
         @env_path = puppet_env.configuration.path_to_env
         # Path to the puppet installation
-        @puppet_path = if puppet_env.loaders.nil? # No loaders have been created yet
-                         nil
-                       elsif puppet_env.loaders.puppet_system_loader.nil?
+        @puppet_path = if puppet_env.loaders.nil? || puppet_env.loaders.puppet_system_loader.nil? # No loaders have been created yet
                          nil
                        elsif puppet_env.loaders.puppet_system_loader.lib_root?
                          File.join(puppet_env.loaders.puppet_system_loader.path, '..')
@@ -260,7 +259,7 @@ module PuppetLanguageServerSidecar
       def all_object_info
         {
           class: [
-            { relative_dir: 'manifests',                   glob: '/**/*.pp' } # Pretty much everything in most modules
+            { relative_dir: 'manifests', glob: '/**/*.pp' } # Pretty much everything in most modules
           ],
           datatype: [
             { relative_dir: 'lib/puppet/datatypes',        glob: '/**/*.rb' }, # Custom Data Types
@@ -272,7 +271,7 @@ module PuppetLanguageServerSidecar
             { relative_dir: 'lib/puppet/parser/functions', glob: '/**/*.rb' }  # Contains functions written in Ruby for the legacy Puppet::Parser::Functions API
           ],
           type: [
-            { relative_dir: 'lib/puppet/type',             glob: '/{,file/}*.rb' } # Contains Puppet resource types. Resource types like `file` can live in subdirs, hence the glob
+            { relative_dir: 'lib/puppet/type', glob: '/{,file/}*.rb' } # Contains Puppet resource types. Resource types like `file` can live in subdirs, hence the glob
           ]
         }
       end

data/lib/puppet-languageserver-sidecar/puppet_parser_helper.rb

@@ -7,7 +7,7 @@ module PuppetLanguageServerSidecar
 
       begin
         node_graph = compile_to_pretty_relationship_graph(content)
-        if node_graph.vertices.count.zero?
+        if node_graph.vertices.none?
           result.set_error('There were no resources created in the node graph. Is there an include statement missing?')
           return result
         end
@@ -60,15 +60,15 @@ module PuppetLanguageServerSidecar
       # Remove vertexes which just clutter the graph
 
       # Remove all of the Puppet::Type::Whit nodes.  This is an internal only class
-      list = graph.vertices.select { |node| node.is_a?(Puppet::Type::Whit) }
+      list = graph.vertices.grep(Puppet::Type::Whit)
       list.each { |node| graph.remove_vertex!(node) }
 
       # Remove all of the Puppet::Type::Schedule nodes
-      list = graph.vertices.select { |node| node.is_a?(Puppet::Type::Schedule) }
+      list = graph.vertices.grep(Puppet::Type::Schedule)
       list.each { |node| graph.remove_vertex!(node) }
 
       # Remove all of the Puppet::Type::Filebucket nodes
-      list = graph.vertices.select { |node| node.is_a?(Puppet::Type::Filebucket) }
+      list = graph.vertices.grep(Puppet::Type::Filebucket)
       list.each { |node| graph.remove_vertex!(node) }
 
       graph

data/lib/puppet-languageserver-sidecar/puppet_strings_helper.rb

@@ -370,7 +370,8 @@ module PuppetLanguageServerSidecar
     end
 
     def to_json(*options)
-      JSON.generate(to_h, options)
+      # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+      JSON.generate(to_h, *options)
     end
 
     # Deserialisation

data/lib/puppet-languageserver-sidecar/workspace.rb

@@ -17,11 +17,11 @@ module PuppetLanguageServerSidecar
       @root_path
     end
 
-    def self.has_module_metadata? # rubocop:disable Naming/PredicateName
+    def self.has_module_metadata? # rubocop:disable Naming/PredicatePrefix
       @has_module_metadata
     end
 
-    def self.has_environmentconf? # rubocop:disable Naming/PredicateName
+    def self.has_environmentconf? # rubocop:disable Naming/PredicatePrefix
       @has_environmentconf
     end
 

data/lib/puppet_editor_services/protocol/debug_adapter_messages.rb

@@ -20,7 +20,8 @@ module PuppetEditorServices
         end
 
         def to_json(*options)
-          to_h.to_json(options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          to_h.to_json(*options)
         end
 
         def to_h

data/lib/puppet_editor_services/protocol/json_rpc_messages.rb

@@ -25,7 +25,8 @@ module PuppetEditorServices
         end
 
         def to_json(*options)
-          to_h.to_json(options)
+          # JSON 2.21 requires an options hash, so expand the captured arguments instead of passing their array.
+          to_h.to_json(*options)
         end
 
         def to_h

data/lib/puppet_editor_services/server/stdio.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'io/wait'
 require 'puppet_editor_services/logging'
 require 'puppet_editor_services/server/base'
 require 'puppet_editor_services/connection/stdio'
@@ -59,8 +60,7 @@ module PuppetEditorServices
       end
 
       def pipe_is_readable?(stream, timeout = 0.5)
-        read_ready = IO.select([stream], [], [], timeout)
-        read_ready && stream == read_ready[0][0]
+        !stream.wait_readable(timeout).nil?
       end
 
       def read_from_pipe(pipe, timeout = 0.1, &)

data/lib/puppet_editor_services/server/tcp.rb

@@ -3,8 +3,6 @@
 require 'socket'
 require 'openssl'
 
-# frozen_string_literal: true
-
 require 'puppet_editor_services/logging'
 require 'puppet_editor_services/server/base'
 require 'puppet_editor_services/connection/tcp'
@@ -340,9 +338,8 @@ module PuppetEditorServices
       # @api private
       def clear_connections
         # Using a SymbolProc here does not work
-        # rubocop:disable Style/SymbolProc
+        # rubocop:disable-next Style/SymbolProc
         self.class.c_locker.synchronize { self.class.io_connection_dic.delete_if { |c| c.closed? } }
-        # rubocop:enable Style/SymbolProc
       end
     end
   end

data/lib/puppet_editor_services/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PuppetEditorServices
-  PUPPETEDITORSERVICESVERSION = '3.1.0' unless defined? PUPPETEDITORSERVICESVERSION
+  PUPPETEDITORSERVICESVERSION = '3.1.2' unless defined? PUPPETEDITORSERVICESVERSION
 
   # @api public
   #

data/lib/puppet_languageserver.rb

@@ -165,6 +165,7 @@ module PuppetLanguageServer
         end
 
         opts.on('--enable-file-cache', '** DEPRECATED ** Enables the file system cache for Puppet Objects (types, class etc.)') do |_misc|
+          # This option is now deprecated and has no effect.  The file system cache is always enabled.
         end
 
         # These options are normally passed through to the Sidecar
@@ -185,6 +186,7 @@ module PuppetLanguageServer
         end
 
         opts.on('--local-workspace=PATH', '** DEPRECATED ** The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path.') do |_path|
+          # This option is now deprecated and has no effect.  The workspace path is now determined by the client.
         end
 
         opts.on('-h', '--help', 'Prints this help') do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openvox-editor-services
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - OpenVox Project contributors
@@ -46,7 +46,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,7 +56,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: openvox-strings
   requirement: !ruby/object:Gem::Requirement
@@ -253,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: OpenVox Puppet DSL Server for editors
 test_files: []