[jrubyscripting] JRuby scripting initial contribution

[boc-tothefuture]

[jruby] JRuby Scripting Binding initial contribution

This is the initial contribution of the JRuby Scripting Binding based on JRuby 9.3.1.0

This is essentially the same as the Jython binding, with the following differences (which are also noted in the readme)

1. The File variable, referencing java.io.File is not available as it conflicts with Ruby's File class preventing Ruby from initializing
2. scriptExtension, automationManager, ruleRegistry, items, voice, rules, things, events, itemRegistry, ir, actions, se, audio, lifecycleTracker are prepended with a $ (e.g. $automationManager) making them available as a global objects in Ruby.
3. This binding has the (optional) ability to install Ruby Gems if configured - enabling users easily take advantage of 3rd party libraries within their rules.

[wborn]

Thanks for the PR! I had a quick look and noticed these artifact ID mismatches. Maybe it also helps with fixing the build. 🙂

OK

[wborn]

I have a few more comments. 🙂

Can you also fix the remaining static analysis warnings (SAT)?

[jimtng]

I believe the package name (and the corresponding directory) should be org.openhab.automation.jrubyscripting

[wborn]

Can you stop squashing and force pushing your commits @boc-tothefuture?
It makes it unneccessary difficult to review changes.

[boc-tothefuture]

Sorry - I am used to projects that want a single commit to be merged. No problem.

[wborn]

Great! We always squash commits when merging PRs by default after reviewing. Also don't worry about the DCO check, we can also set it to pass manually if somehow not all commits were properly signed off. 🙂

[jimtng]

The directory in which the java files are located, needs to change from:
org.openhab.automation.jrubyscripting/src/main/java/org/openhab/binding/jrubyscripting/internal
to
org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal

[boc-tothefuture]

@wborn I think the latest commit from @jimtng address all outstanding comments.

[wborn]

Thanks for addressing my comments!
I still have these minor comments left now. 🙂

[boc-tothefuture]

@wborn can you take another look?

@jimtng pushed some change sets that I think address your remaining concerns.

From @jimtng PR Comments:

The remaining SAT warnings appear to be false positives.

I had to revert the configuration format in the docs because it didn't work without the prefixes. It appeared to work on my system because openhab auto-created the config file in userdata/config/org/openhab/automation/jrubyscripting.config and kept it there even after the correct entries (with the prefix) in jruby.cfg were removed.

Thanks @jimtng for pushing this over the finish line.

Thanks @wborn for the thorough review and guidance.

[wborn]

Many thanks @boc-tothefuture and @jimtng!
It's nice to also have JRuby Scripting ♦️ as an official automation add-on. 👍

[wborn]

Now that the add-on is merged, it would also be nice if the add-on has an icon in the docs and when it is featured as automation add-on on the website. 🙂

That can be done with a couple of PRs similar like:

• Add more automation and voice add-on images openhab-docs#1574
• Feature missing automation/voice add-ons website#291

[jimtng]

openhab/website#305
@wborn would you mind adding the logo please? I'm not familiar with the legal aspects of it and I'd rather not get involved with such matter. The logo can be found at https://www.jruby.org/images/jruby-logo.png

[wborn]

Maybe @ghys knows a bit more about the legal aspects because he also created #8513. AFAIK the guidelines for using the openHAB logo itself are also still undefined.

It might also help to just automatically generate logos based on add-on names. That way the add-on overview looks nicer and it is easier to identify add-ons in the UI. For instance you can make text look cooler using: https://maketext.io/ 😎

[ghys]

In https://github.com/openhab/openhab-docs/tree/main/images/addons there is a LICENSE file that explicitly excludes the contents of that directory from being covered by the EPL like the rest of the repo.

Note: These images are NOT made available under the repo license (EPL).

All product names, trademarks and registered trademarks are property of their respective owners.
All company, product and service names used are for identification purposes only. 
Use of these names, trademarks and brands does not imply endorsement.

We invoke fair use and make some disclaimers, with this I think we're in the clear - especially since we only use these logos to build the website and the new add-on store UI merely links to them. This can be considered "editorial content" (https://www.upcounsel.com/permission-to-use-logo#:~:text=Fair%20use%20includes%20using%20a,or%20associates%20with%20another%20company).