ringo / ringojs

RingoJS is a JavaScript platform built on the JVM and optimized for server-side applications.

RingoJS

Ringo is a JavaScript platform built on the JVM and optimized for server-side applications. It's based on the Mozilla Rhino JavaScript engine.

It adds a number of features to Rhino that make it suitable for real-world, large-scale application development:

• A fast, auto-reloading, and CommonJS-compliant module loader.
• A rich set of modules covering I/O, logging, development tools and much more.
• Support for blocking and non-blocking I/O.
• Scalable HTTP server based on the Jetty project.
• Support for CommonJS packages to install or write additional software components.

For more information, visit the RingoJS web site: https://ringojs.org

Download and Installation

Download the latest precompiled release from the download page. Extract the archive and add the ringojs/bin directory to your local PATH for convinience.

If you use the Homebrew package manager on MacOS, you can use the ringojs formula: brew install ringojs

Take a look at the Getting Started Guide on Ringo's website for more details how to get started after you installed Ringo on your system.

Verify releases

To verify the integrity of a downloaded binary distribution, use the associated checksum file:

$ grep ringojs-x.y.z.tar.gz SHASUMS256-x.y.z.txt | sha256sum -c -

Verifying the integrity of provided checksums

Releases of RingoJS will be signed with one of the following GPG keys:

• 3.0.0 and newer: Philipp Naderer-Puiu <[email protected]>
  1405 9F17 6485 6429 089F B423 6167 CFBB BDF2 A508
• 2.0.0 and older: Philipp Naderer-Puiu <[email protected]>
  DE2A A9A1 B018 6C2F 622F D9EF 3F47 C28B 23EB 3072
• 1.2.0 and older: Philipp Naderer <[email protected]>
  8FF2 26B7 F268 547B 176F ABAC F312 313B 5CBC 0883

All official releases will be signed by at least one published key. Get the latest release key for 3.0.0 and newer with:

$ gpg --keyserver hkps://keys.openpgp.org --recv-keys 14059F1764856429089FB4236167CFBBBDF2A508

Download the checksums SHASUMS256.txt and separate signature SHASUMS256.txt.sig for the release, e.g.

$ curl -LO https://github.com/ringo/ringojs/releases/download/v4.0.0/SHASUMS256-4.0.0.txt
$ curl -LO https://github.com/ringo/ringojs/releases/download/v4.0.0/SHASUMS256-4.0.0.txt.sig

Now verify the checksums with:

$ gpg --verify SHASUMS256-4.0.0.txt.sig
gpg: assuming signed data in 'SHASUMS256-4.0.0.txt'
gpg: Signature made Wed Feb 23 12:07:10 2022 CET
gpg:                using RSA key 14059F1764856429089FB4236167CFBBBDF2A508
gpg: Good signature from "Philipp Naderer-Puiu <[email protected]>" [ultimate]

Building from Source

Ringo runs on top of the Java Platform. You can use an open implementation like Eclipse Temurin or Oracle's distribution. It uses Gradle as build tool.

If you have these installed, building Ringo is straightforward:

Check out Ringo using Git:

git clone git://github.com/ringo/ringojs.git

Change to the ringojs directory and run

./gradlew

Supporters

JetBrains

JetBrains sponsored an Open Source license for IntelliJ IDEA to create and maintain Ringo. Thanks for your continuous support!

ORF.at

A huge salute to ORF.at for supporting this projects over the years!

ringojs's Issues

Document storage features

http://ringojs.org/wiki/Storage

Implement globbing in fs module

(updated title to reflect list*Tree() already implemented)

googlestore not working with standard appengine template

problem is that google appengine sdk jar is missing.

Document logging features

http://ringojs.org/wiki/Logging/

Rename java packages and classes

Make ringo usable as library in other js embeddings

RingoJS (or its libraries and frameworks) should be usable in other JS environments, both based on Rhino or other implementations. For that we have to reduce libraries/frameworks reliance on the engine bits, or provide alternatives when the engine is not available.

Add JMX support for core ringojs classes

Fix handling of debian packaging temporaries

Currently, ant package also adds ant dpkg leftovers into the tgz/zip packages. It should not. Either make ant dpkg clean up those temporaries after it finished, or explicitly exclude those temporaries in ant package.

Problems with symlinked packages in AppEngine deployment

For details have a look at this thread:
http://groups.google.com/group/ringojs/browse_frm/thread/4c1736723ef2e7c1

Modules from outside module path think they're in top-level module space

When a module is loaded via absolute path name (e.g. "/usr/local/test/repository/all") the module thinks it is a top-level module, i.e. it's moudle id is "all". When this module loads another module via relative id (e.g. "./file"), that module may wrongly be loaded from the module path (e.g "file").

Support for comment-embedded options

http://code.google.com/p/gpsee/issues/detail?id=12

Investigate Maven usage scenarios

Concerning ringo.jar central mvn repo syncing/hosting, see:
http://maven.apache.org/guides/mini/guide-central-repository-upload.html
http://nexus.sonatype.org/oss-repository-hosting.html

Impl. some versioning for ringojs.org wiki

earl suggested on irc, e.g., hacking up some simple git-based backend.

Git-based Site

the pages making up the ringojs.org site should preferably also be maintained via the main git repository. this will make it easier to keep the web documentation up-to-date with actual ringojs source.

Implement dependency handling in ringo-admin install

Rename "skin" to "template"

IRC transcript from http://ringojs.com/bot/2010-04-13:

[8:22] micmath (since you're a native english speaker) - is "skins" good term for templates?
[8:22] or does it sound strange?
[8:22] it's kind of helma 1 heritage, and I'm not sure we should continue using it
[8:23] ummm, it does sound a tiny bit, slightly strange. It's not the first word that would come to my mind when I was looking for it.
[8:23] ok, i guess template/templating is the term to use
[8:24] "skins" sounds more like something that would be used to alter the appearance of an existing app. Like my FireFox has a new skin and now it's green.
[8:24] yes, agreed
[8:24] whereas "template" sounds more like what this is.

log4j.properties from web app config directory not used

The problem is that webapp directory is added to module path after logging is configured, so the default log4j.properties from modules/config is used.

Move existing documentation from helma.org to ringojs.org

• storage page
  http://bin.strain.at/paste/MhWLQm.html

fix in demo app:http://bin.strain.at/paste/MhWLQm.html

Implement updating of packages using ringo-admin install

Improve web app docs

http://ringojs.org/wiki/web%20framework/
http://ringojs.org/wiki/request%20dispatching/

Fix & improve how webapp and daemon handle system.args and config options

currently httpConfig defined in config.js has no effect if the webapp is started with bin/ringo app/main.js. the server will always use the defaults provided in webapp.js

Increase code coverage by tests

Provide ringo-admin install shortcuts for package repositories other than github

New httpclient module

using jetty's httpclient. based on jquery's ajax interface, sync&async, streaming.

api: http://gist.github.com/309682 (progress..)

see also discussion here http://github.com/hns/ringojs/issues#issue/29

Fileupload bug(s)

There is at least still one bug in ringo/webapp/fileupload triggered by alignment of the boundary at the beginning of the buffer (results in a copy with negative index).

Generally, the method has a few problems and could use some refactoring.

Rename JS modules, apps, and tools

open questions: should we use ringo or ringojs for

• module namespace
• executable/start script

Use "ringo" or "ringojs" in the shell prompt, or should we switch to something short and anonymous such as ">>"?

Remove log4j dependency in response logging middleware

We currently use a log4j appender to implement logging to web pages. Since we switched to slf4j as our primary logging interface this isn't such a good solution anymore (e.g. it won't work on google app engine)

Logo

Hannes' notes from Issue #7:

Regarding logo, I stumbled across this:
http://www.coroflot.com/public/individual_file.asp?from_url=true&individual_id=195034&portfolio_id=1041576&
maybe we should contact the guy who did this and ask him for a quote for this or something similar.

importClass/importPackage import to the common global scope

Currently, importClass and importPackage use the shared global scope instead of the module scope they're used in, leading to global scope pollution.

The reason lies in the implementation of these functions and our specific setup (the global scope extending ImporterTopLevel).

Update CommonJS modules to latest specs/proposals

There have been a few changes, especially in Filesystem/A

http://wiki.commonjs.org/wiki/Filesystem/A

also, support for native file operations via JNA/JFFI should be considered - see issue #12

We might look at the new Binary/F spec, too.

http://wiki.commonjs.org/wiki/Binary/F

Update text in demo app

Text in demo app still refers to the old helma site.

Improve Rhino engine creation API

• get rid of (or change default for) the includeSystemModules property.
• make sure there's a way to define packages settings etc.

Deploy API docs and demo app on ringojs.org

Implement webapp extensions

it should be possible to add extensions to webapps. These should be defined in the webapp's config module. Extensions should be installed once when the webapp is started, and there should be a stop hook as well i guess.

One place where we need this is for stuff like cometd where you need to set up callbacks at the beginning of the session.

Move ringoglobal module to ringo/global

ringoglobal provides Ringo-specific global functions. Due to it's Ringo-specifity, it should be under the ringo/ module namespace.

Attack the file, fs-base, ringo/file, ringo/fileutils module zoo

Implement CommonJS unit testing spec

http://wiki.commonjs.org/wiki/Unit_Testing/1.0

properties in core modules are defined as non-writable

affected modules are core/array, core/date, core/number, core/regexp

Update JSGI support to 0.3

Time and day of week for regular IRC meetings

What day and time should we hold our regular (weekly? forthnightly? monthly?) IRC meetings?

My proposal is Monday 18:00 CET.

http://www.timeanddate.com/worldclock/fixedtime.html?day=22&month=2&year=2010&hour=18&min=0&sec=0&p1=259

Style the main website

IRC logs for #ringojs on ringojs.org

preferrably using a small ircbot written with ringo. chris zumbrunn suggested looking at pjircbot.

Base64 code in core/string uses sun.misc java package

This package should not be used.

"The sun.* packages are not part of the supported, public interface.
A Java program that directly calls into sun.* packages is not guaranteed to work on all Java-compatible platforms. In fact, such a program is not guaranteed to work even in future versions on the same platform."

cf. http://java.sun.com/products/jdk/faq/faq-sun-packages.html

Use JNA/JFFI from JRuby to implement POSIX features

The libraries used by JRuby to implement POSIX and other native features are now hosted at github: http://github.com/wmeissner/

Mail API

Port over from Helma and/or impl.

do not extend core prototypes

move useful functionality from core/* into utils; fix any ringo code using core/*

App Engine template requires appengine-api-1.0-sdk-x.y.z.jar for googlestore to work

The file is in the lib/user directory of the google app engine sdk with x.y.z being the version of the app engine sdk.

Investigate using Apache Ivy

Could be useful for resolving JAR dependencies (especially for Ringo modules which heavily rely on them, e.g., Hibernate).

Also take current CommonJS/Narwhal package management approach into consideration in connection to that.

Impl. file upload for ringojs.org wiki

Update documentation and READMEs