[jrubyscripting] update README, and default configuration installing gem (#14489)

README is generated by YARD from USAGE.md in the gem.

Signed-off-by: Cody Cutrer <cody@cutrer.us>
This commit is contained in:
Cody Cutrer 2023-03-27 07:22:48 -06:00 committed by GitHub
parent 18e7d81e4d
commit 558908e69a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 1569 additions and 64 deletions

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

View File

@ -79,9 +79,9 @@ public class JRubyScriptEngineConfiguration {
new OptionalConfigurationElement(OptionalConfigurationElement.Type.RUBY_ENVIRONMENT,
DEFAULT_RUBYLIB, "RUBYLIB")),
Map.entry(GEMS_CONFIG_KEY, new OptionalConfigurationElement("")),
Map.entry(GEMS_CONFIG_KEY, new OptionalConfigurationElement("openhab-scripting=~>5.0.0")),
Map.entry(REQUIRE_CONFIG_KEY, new OptionalConfigurationElement("")),
Map.entry(REQUIRE_CONFIG_KEY, new OptionalConfigurationElement("openhab/dsl")),
Map.entry(CHECK_UPDATE_CONFIG_KEY, new OptionalConfigurationElement("true")),

View File

@ -26,14 +26,16 @@
<parameter name="gems" type="text" required="false" groupName="gems">
<label>Ruby Gems</label>
<description><![CDATA[A comma separated list of Ruby Gems to install. Versions may be constrained by separating with an
<tt>=</tt> and then the standard RubyGems version constraint, such as "<tt>openhab-scripting=~>4.0</tt>".
<tt>=</tt> and then the standard RubyGems version constraint, such as "<tt>openhab-scripting=~>5.0.0</tt>".
]]></description>
<default>openhab-scripting=~>5.0.0</default>
</parameter>
<parameter name="require" type="text" required="false" groupName="gems">
<label>Require Scripts</label>
<description>A comma separated list of script names to be required by the JRuby Scripting Engine before running user
scripts.</description>
<default>openhab/dsl</default>
</parameter>
<parameter name="check_update" type="boolean" required="true" groupName="gems">

View File

@ -5,7 +5,7 @@ automation.config.jruby.dependency_tracking.description = Dependency tracking al
automation.config.jruby.gem_home.label = GEM_HOME
automation.config.jruby.gem_home.description = Location Ruby Gems will be installed to and loaded from. Directory will be created if necessary. You can use <tt>{RUBY_ENGINE_VERSION}</tt>, <tt>{RUBY_ENGINE}</tt> and/or <tt>{RUBY_VERSION}</tt> replacements in this value to automatically point to a new directory when the addon is updated with a new version of JRuby. Defaults to "<tt>OPENHAB_CONF/automation/ruby/.gem/{RUBY_ENGINE_VERSION}</tt>" when not specified.
automation.config.jruby.gems.label = Ruby Gems
automation.config.jruby.gems.description = A comma separated list of Ruby Gems to install. Versions may be constrained by separating with an <tt>=</tt> and then the standard RubyGems version constraint, such as "<tt>openhab-scripting=~>4.0</tt>".
automation.config.jruby.gems.description = A comma separated list of Ruby Gems to install. Versions may be constrained by separating with an <tt>=</tt> and then the standard RubyGems version constraint, such as "<tt>openhab-scripting=~>5.0.0</tt>".
automation.config.jruby.group.environment.label = Ruby Environment
automation.config.jruby.group.environment.description = This group defines Ruby's environment.
automation.config.jruby.group.gems.label = Ruby Gems