Ruby JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmark-ips Add benchmarks for loop vs while & block vs yield Mar 1, 2018
benchmark Improve benchmark reporting Dec 18, 2017
bin Add a bin/rake binstub Mar 18, 2018
docs Update all refs to opalrb.org with the new domain Jan 16, 2018
examples Update the rack example app Nov 1, 2016
exe Keep internal utilities inside bin/ Jan 10, 2018
lib Add C lexer from opal/c_lexer. (#1806) Apr 21, 2018
opal Merge pull request #1803 from Mogztter/issue-1793-cache-global-regexp Apr 22, 2018
spec Returns the exit code (#1808) Apr 22, 2018
stdlib resolves #1801 add logger impl to stdlib (#1802) Apr 16, 2018
tasks Install smoke test deps before updating Apr 10, 2018
test Commented out failing MRI specs for Matrix. Mar 19, 2018
vendored-minitest Skip Encoding for vendored minitest Mar 29, 2016
.codeclimate.yml Moved rubocop from Gemfile to the gem's development dependency in the… Mar 16, 2018
.gitattributes Reduce Changelog conflicts Jan 29, 2016
.gitignore Ignore old submodules paths Jun 7, 2016
.gitmodules Update ruby spec submodule name Aug 7, 2016
.inch.yml Add inch CI configuration Oct 15, 2014
.jshintrc Drop PhantomJS support. Jun 16, 2017
.rspec Update RSpec configuration to 3.5 standards Dec 4, 2016
.rubocop.yml Excluded E2MMAP and matrix classes from .rubocop config. Mar 19, 2018
.rubocop_todo.yml Cleanup .rubocop.yml using new rubocop option 'inherit_mode'. Mar 14, 2018
.travis.yml Fix CI (Kernel#exit always exits with 0 code, chrome runner exits wit… Apr 20, 2018
.yardopts Refactor Opal::Config and improve docs Dec 7, 2016
CHANGELOG.md don't substitute . in regexp source Mar 29, 2018
CONDUCT.md Use a shorter name for the conduct guidelines Aug 10, 2016
CONTRIBUTING.md Split CONTRIBUTING.md into HACKING.md Dec 27, 2015
Gemfile Add C lexer from opal/c_lexer. (#1806) Apr 21, 2018
Guardfile Rename spec/rubyspec to spec/ruby Feb 24, 2016
HACKING.md Update gemspec and gem structure with latest fixes Nov 29, 2017
LICENSE Fix some whitespace Jan 16, 2013
README.md Update all refs to opalrb.org with the new domain Jan 16, 2018
Rakefile Let the default rake task run all test frameworks Apr 30, 2017
appveyor.yml Only build main branches plus check-ci Mar 5, 2018
config.ru Remove support for config via `Opal::Processor` Mar 3, 2016
opal.gemspec Add C lexer from opal/c_lexer. (#1806) Apr 21, 2018

README.md

Opal

Build Status (Linux) Build Status (Windows) Gem Version Code Climate Coverage Status

Opal is a Ruby to JavaScript source-to-source compiler. It also has an implementation of the Ruby corelib.

Opal is hosted on GitHub. Chat is available on Gitter at opal/opal (also available as IRC at irc.gitter.im) and the Freenode IRC channel at #opal. Ask questions on stackoverflow (tag #opalrb). Get the Opalist newsletter for updates and community news.

Inline docs Gitter Stack Overflow

Usage

See the website for more detailed instructions and guides for Rails, jQuery, Sinatra, rack, CDN, etc. http://opalrb.com.

Compiling Ruby code with the CLI (Command Line Interface)

Contents of app.rb:

puts 'Hello world!'

Then from the terminal

$ opal --compile app.rb > app.js # The Opal runtime is included by default
                                 # but can be skipped with the --no-opal flag

The resulting JavaScript file can be used normally from an HTML page:

<script src="app.js"></script>

Be sure to set the page encoding to UTF-8 inside your <head> tag as follows:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <script src="app.js"></script>
    …
  </head>
  <body>
    …
  </body>
</html>

Just open this page in a browser and check the JavaScript console.

Compiling Ruby code from Ruby

Opal.compile is a simple interface to just compile a string of Ruby into a string of JavaScript code.

Opal.compile("puts 'wow'")  # => "(function() { ... self.$puts("wow"); ... })()"

Running this by itself is not enough; you need the opal runtime/corelib.

Using Opal::Builder

Opal::Builder can be used to build the runtime/corelib into a string.

Opal::Builder.build('opal') #=> "(function() { ... })()"

or to build an entire app including dependencies declared with require:

builder = Opal::Builder.new
builder.build_str('require "opal"; puts "wow"', '(inline)')
File.write 'app.js', builder.to_s

Compiling Ruby code from HTML (or using it as you would with inline JavaScript)

opal-parser allows you to eval Ruby code directly from your HTML (and from Opal) files without needing any other building process.

So you can create a file like the one below, and start writing ruby for your web applications.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <script src="http://cdn.opalrb.com/opal/current/opal.js"></script>
    <script src="http://cdn.opalrb.com/opal/current/opal-parser.js"></script>
    <script type="text/javascript">Opal.load('opal-parser')</script>

    <script type="text/ruby">
      puts "hi"
    </script>

  </head>
  <body>
  </body>
</html>

Just open this page and check the JavaScript console.

NOTE: Although this is possible, this is not really recommended for production and should only be used as a quick way to get your hands on opal.

Running tests

The Ruby Spec Suite related repos must be cloned as git submodules:

$ git submodule update --init

Then, install dependencies:

$ bundle install
$ npm install -g jshint

The test suite can be run using:

$ bundle exec rake

This will command will run all RSpec and MSpec examples in sequence.

Automated runs

A Guardfile with decent mappings between specs and lib/corelib/stdlib files is in place. Run bundle exec guard -i to start guard.

MSpec

MSpec tests can be run with:

$ rake mspec

Alternatively, you can just load up a rack instance using rackup, and visit http://localhost:9292/ in any web browser.

RSpec

RSpec tests can be run with:

$ rake rspec

Code Overview

What code is supposed to run where?

  • lib/ code runs inside your Ruby env. It compiles Ruby to JavaScript.
  • opal/ is the runtime+corelib for our implementation (runs in browser).
  • stdlib/ is our implementation of Ruby's stdlib. It is optional (runs in browser).

lib/

The lib directory holds the Opal parser/compiler used to compile Ruby into JavaScript. It is also built ready for the browser into opal-parser.js to allow compilation in any JavaScript environment.

opal/

This directory holds the Opal runtime and corelib implemented in Ruby and JavaScript.

stdlib/

Holds the stdlib currently supported by Opal. This includes Observable, StringScanner, Date, etc.

Browser support

  • Internet Explorer 9+
  • Firefox (Current - 1) or Current
  • Chrome (Current - 1) or Current
  • Safari (Current - 1) or Current
  • Opera (Current - 1) or Current

Any problems encountered using the browsers listed above should be reported as bugs.

(Current - 1) or Current denotes that we support the current stable version of the browser and the version that preceded it. For example, if the current version of a browser is 24.x, we support the 24.x and 23.x versions.

12.1x or (Current - 1) or Current denotes that we support Opera 12.1x as well as the last 2 versions of Opera. For example, if the current Opera version is 20.x, then we support Opera 12.1x, 19.x and 20.x but not Opera 15.x through 18.x.

Cross-browser testing is sponsored by SauceLabs.

License

(The MIT License)

Copyright (C) 2013-2015 by Adam Beynon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.