arirusso/web-repl

Javascript/Web REPL in Ruby

web-repl

A Javascript REPL that runs in Ruby. Evaluation is done by a web browser instance.

One use of this is to replace the Chrome Developer Console remotely as such:

Background

I've been working on a toy project recently that requires browser content to be in fullscreen. This makes live coding using the regular Chrome JS console more or less impossible. I came up with web-repl as an alternative.

There are similar tools that run in nodejs and other languages but this is convenient for me because my project uses a Ruby backend anyway.

Under the hood, communication is done with JSON over Websocket. Note that there's no extra attention to security here other than what is generally implicit with a Websocket, so please use at your own discretion.

Usage

Browser

To enable the browser side of this, include something like this in the head of your webpage:

<script src="js/replConnection.js"></script>
<script type="text/javascript">
  window.onload = function() {
    var repl = new ReplConnection("localhost", 9007, { debug: true, reconnect: true });
    repl.start();
  }
</script>

The javascript assets for this project are located in the /js directory.

There is also a full example of a webpage (with simple rack webserver configuration) in the /examples/page directory

REPL

The REPL can be used either in a Ruby program/console or there is a "binary" Ruby script.

In Ruby the usage looks like this:

require "web-repl"

WebRepl.start(:host => "localhost", :port => 9007)

You can see an explanation of background usage here.

To use this as a script, run this from the command line. (The script should install with the gem)

web-repl localhost:9007

Installation

gem install web-repl

or with Bundler

gem "web-repl"

License

Licensed under Apache 2.0, See the file LICENSE

Copyright (c) 2014-2015 Ari Russo