[jrubyscripting] Add JRuby REPL and other utilities inside karaf console #18374

jimtng · 2025-03-10T11:16:18Z

Add Karaf console utilities for JRuby, including a REPL environment that runs inside the same script engine as normal rules.

openhab> jrubyscripting 
Usage: openhab:jrubyscripting info - displays information about JRuby Scripting add-on
Usage: openhab:jrubyscripting shell - starts an interactive JRuby shell
Usage: openhab:jrubyscripting gem - manages JRuby Scripting add-on's RubyGems
Usage: openhab:jrubyscripting update - updates the configured gems
Usage: openhab:jrubyscripting prune [-f|--force] - cleans up older versions in the .gem directory
Usage: openhab:jrubyscripting unload - unloads the console's script engine

openhab> jrubyscripting info                                                                                                   
JRuby 9.4.12.0
JRuby Scripting Library 5.35.1
GEM_HOME: /home/openhab/openhab-jruby/tmp/openhab/conf/automation/ruby/.gem/9.4.12.0
RUBYLIB: /home/openhab/openhab-jruby/tmp/openhab/conf/automation/lib/ruby/personal
Script path: /home/openhab/openhab-jruby/tmp/openhab/conf/automation/ruby

JRuby Scripting Add-on Configuration:
=====================================
rubylib: /home/openhab/openhab-jruby/tmp/openhab/conf/automation/lib/ruby/personal
local_variable: transient
local_context: singlethread
gems: openhab-scripting=~>5.0
gem_home: /home/openhab/openhab-jruby/tmp/openhab/conf/automation/ruby/.gem/{RUBY_ENGINE_VERSION}
dependency_tracking: true
require: openhab/dsl
check_update: true

openhab> jrubyscripting prune                                                                                                  
Some files and directories exist in '/openhab/conf/automation/ruby/.gem' outside of your configured gem home '/openhab/conf/automation/ruby/.gem/9.4.12.0'.
They may have been left over from previous installations or updates.

  /openhab/conf/automation/ruby/.gem/9.4.9.0/
  /openhab/conf/automation/ruby/.gem/test1/
  /openhab/conf/automation/ruby/.gem/test2/
  /openhab/conf/automation/ruby/.gem/test3/

Press Enter to delete them or Ctrl+C to cancel.

Deleting: /openhab/conf/automation/ruby/.gem/test3/4/5/6
Deleting: /openhab/conf/automation/ruby/.gem/test3/4/5
Deleting: /openhab/conf/automation/ruby/.gem/test3/4
Deleting: /openhab/conf/automation/ruby/.gem/test3
Deleting: /openhab/conf/automation/ruby/.gem/test2
Deleting: /openhab/conf/automation/ruby/.gem/test1
Deleting: /openhab/conf/automation/ruby/.gem/9.4.9.0
openhab> jrubyscripting prune                                                                                                  
No files or directories to delete from /openhab/conf/automation/ruby/.gem

The REPL shell supports:

A rudimentary tab completion on item names, constants, DSL methods, and local variables.
History recall (up/down arrow) within the same session

This next screenshot shows it running in my production instance:

An alternative implementation can be done should openhab/openhab-core#4635 be merged. For the time being, this PR stands alone and will work without the linked core PR. When the core PR is merged and this is refactored, we can remove the dependency to karaf in pom.xml.

If the core PR gets merged, I can refactor this later if necessary. I don't want the core PR be a blocker for this PR though.

Signed-off-by: Jimmy Tanagra <[email protected]>

...c/main/java/org/openhab/automation/jrubyscripting/internal/JRubyConsoleCommandExtension.java

jimtng · 2025-03-11T06:08:37Z

Updated to use repl code from the helper library openhab/openhab-jruby#405

Signed-off-by: Jimmy Tanagra <[email protected]>

ccutrer

you need to run mvn i18n-generate-default-translations, no?

bundles/org.openhab.automation.jrubyscripting/src/main/resources/OH-INF/config/config.xml

ccutrer · 2025-03-11T17:19:55Z

...c/main/java/org/openhab/automation/jrubyscripting/internal/JRubyConsoleCommandExtension.java

+        }
+
+        executeWithFullJRuby(console, engine -> {
+            engine.getContext().setAttribute("$console", console, ScriptContext.ENGINE_SCOPE);


do we really need console? or would session be enough? (really, all I'm using right now is terminal - which you get from session). then you don't event need the JRubyConsole. in the one or two places that need session, just pass it through from execute().

I've changed it to just $terminal. However, we still need JRubyConsole because the OSGiConsole class from core is in an internal package. We still want to have a console object to keep a resemblance to the standard ConsoleCommandExtension in case we need to refactor this back if openhab/openhab-core#4635 is accepted.

…ties Signed-off-by: Jimmy Tanagra <[email protected]>

Signed-off-by: Jimmy Tanagra <[email protected]>

ccutrer · 2025-03-13T15:49:51Z

...c/main/java/org/openhab/automation/jrubyscripting/internal/JRubyConsoleCommandExtension.java

+                    console.println("Available console scripts:");
+                    String defaultConsole = jRubyScriptEngineFactory.getConfiguration().getConsole();
+                    consoles.forEach((name, description) -> {
+                        if (defaultConsole.endsWith(name)) {


you should be more discerning here. if (defaultConsole.equals("openhab/console/" + name)) {

cause what if I have default console configured to be "ccutrer/irb"? that would match the "irb" from the registry, but is decidedly not the default console.

and along those lines, perhaps if the default console isn't found in the registry, add an extra line at the bottom along the lines of " (default) - " + defaultConsole

good catch! refactored.

bundles/org.openhab.automation.jrubyscripting/src/main/resources/OH-INF/config/config.xml

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng added the enhancement An enhancement or new feature for an existing add-on label Mar 10, 2025

jimtng requested a review from ccutrer as a code owner March 10, 2025 11:16

jimtng force-pushed the jruby-console-without-core-changes branch from 6b2209c to 2eb74b6 Compare March 10, 2025 11:20

jimtng mentioned this pull request Mar 10, 2025

Question: ruby console / irb in production? openhab/openhab-jruby#148

Open

jimtng force-pushed the jruby-console-without-core-changes branch from 2eb74b6 to 547ac87 Compare March 10, 2025 11:49

jimtng changed the title ~~[jrubyscripting] Add JRuby shell and other utilities inside karaf console~~ [jrubyscripting] Add JRuby REPL and other utilities inside karaf console Mar 10, 2025

jimtng added 2 commits March 11, 2025 00:52

[jrubyscripting] Add console command extension: REPL, gem, prune, update

68ca809

Signed-off-by: Jimmy Tanagra <[email protected]>

fix ClassCastException

81d7750

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from 547ac87 to 81d7750 Compare March 10, 2025 14:53

ccutrer reviewed Mar 10, 2025

View reviewed changes

...c/main/java/org/openhab/automation/jrubyscripting/internal/JRubyConsoleCommandExtension.java Outdated Show resolved Hide resolved

remove engine cache, move repl code into helper library

9f01a5d

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from 6d8eca4 to 9f01a5d Compare March 11, 2025 14:15

ccutrer reviewed Mar 11, 2025

View reviewed changes

jimtng force-pushed the jruby-console-without-core-changes branch from e8d4c09 to 04d2f9f Compare March 12, 2025 00:10

allow specifying console script, refactor session, update i18n proper…

0618843

…ties Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from 04d2f9f to 0618843 Compare March 12, 2025 00:14

jimtng added 2 commits March 12, 2025 11:43

pass arguments to console script

085b27b

Signed-off-by: Jimmy Tanagra <[email protected]>

allow passing arg without specifying console script

1788172

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from a4ecdce to c94593c Compare March 12, 2025 10:50

console --list + console name completion

2411ea4

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from c94593c to 2411ea4 Compare March 12, 2025 10:59

jimtng added 2 commits March 13, 2025 11:54

group the config info by the ConfigParameterGroup

d6e3d5d

Signed-off-by: Jimmy Tanagra <[email protected]>

add bundler command

27981c5

Signed-off-by: Jimmy Tanagra <[email protected]>

ccutrer reviewed Mar 13, 2025

View reviewed changes

bundles/org.openhab.automation.jrubyscripting/src/main/resources/OH-INF/config/config.xml Outdated Show resolved Hide resolved

console: improve list defaults, add console help

ae05598

Signed-off-by: Jimmy Tanagra <[email protected]>

jimtng force-pushed the jruby-console-without-core-changes branch from f77b6e2 to ae05598 Compare March 13, 2025 23:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[jrubyscripting] Add JRuby REPL and other utilities inside karaf console #18374

[jrubyscripting] Add JRuby REPL and other utilities inside karaf console #18374

jimtng commented Mar 10, 2025 •

edited

Loading

jimtng commented Mar 11, 2025

ccutrer left a comment

ccutrer Mar 11, 2025

jimtng Mar 12, 2025

ccutrer Mar 13, 2025

jimtng Mar 13, 2025

[jrubyscripting] Add JRuby REPL and other utilities inside karaf console #18374

Are you sure you want to change the base?

[jrubyscripting] Add JRuby REPL and other utilities inside karaf console #18374

Conversation

jimtng commented Mar 10, 2025 • edited Loading

jimtng commented Mar 11, 2025

ccutrer left a comment

Choose a reason for hiding this comment

ccutrer Mar 11, 2025

Choose a reason for hiding this comment

jimtng Mar 12, 2025

Choose a reason for hiding this comment

ccutrer Mar 13, 2025

Choose a reason for hiding this comment

jimtng Mar 13, 2025

Choose a reason for hiding this comment

jimtng commented Mar 10, 2025 •

edited

Loading