mini_racer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8218ee18399c771370bf599a4d4cd46707e9f463502e058c98fb38de7505c36
+  data.tar.gz: 8fb4a94f36528343c71b05d2b25473a86c02ff0caf4b651acad4be460ea5f016
+SHA512:
+  metadata.gz: 6765304fc32d76d8e7050eeed958130e0e2075d7d2826edc6e855eeb447799b5f009d29b87e448f20c1c1cebba583d9d16569d5f0f83d5f1a64e2530333a5cee
+  data.tar.gz: b224d6b448e1bc064b051adace85bf7ead7334b7682fe132897e87e028de6506afe5fc1921612ec9b8da3b09232f49cf9a6ecba4e594739792479e6e2fbfa54f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/mini_racer_extension.so
+*.bundle

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+matrix:
+  include:
+    - rvm: 2.5.1
+      os: osx
+      osx_image: xcode9.4
+dist: trusty
+sudo: true
+before_install:
+  - gem update --system
+  - gem install bundler -v 1.16.2
+cache: bundler

data/CHANGELOG

@@ -0,0 +1,219 @@
+- 22-07-2020
+
+- 0.3.0
+
+  - FEATURE: upgraded to libv8 version 8.4.255.0
+
+- 29-06-2020
+
+- 0.2.15
+
+  - FEATURE: basic wasm support via pump_message_loop
+
+- 15-05-2020
+
+- 0.2.14
+
+  - FIX: ensure_gc_after_idle should take in milliseconds like the rest of the APIs not seconds
+  - FEATURE: strict params on MiniRacer::Context.new
+
+- 15-05-2020
+
+- 0.2.13
+
+   - FIX: edge case around ensure_gc_after_idle possibly firing when context is not idle
+
+- 15-05-2020
+
+- 0.2.12
+
+  - FEATURE: isolate.low_memory_notification which can force a full GC
+  - FEATURE: MiniRacer::Context.new(ensure_gc_after_idle: 2) - to force full GC 2 seconds after context is idle, this allows you to conserve memory on isolates
+
+- 14-05-2020
+
+- 0.2.11
+
+  - FIX: dumping heap snapshots was not flushing the file leading to corrupt snapshots
+  - FIX: a use-after-free shutdown crash
+
+- 0.2.10
+
+- 22-04-2020
+
+  - FEATURE: memory softlimit support for nogvl_context_call
+
+- 0.2.9
+
+- 09-01-2020
+
+  - FIX: correct segfault when JS returns a Symbol and properly cast to ruby symbol
+
+- 0.2.8
+
+- 11-11-2019
+
+  - FIX: ensure thread live cycle is properly accounter for following file descriptor fix
+
+- 0.2.7
+
+- 11-11-2019
+
+  - FIX: release the file descriptor for timeout pipe earlier (this avoids holding too many files open in Ruby 2.7)
+
+- 14-05-2019
+
+- 0.2.6
+
+  - FEATURE: add support for write_heap_snapshot which helps you analyze memory
+
+- 25-04-2019
+
+- 0.2.5
+
+  - FIX: Compatiblity fixes for V8 7 and above @ignisf
+  - FIX: Memory leak in gc_callback @messense
+  - IMPROVEMENT: Added example of sourcemap support @ianks
+  - URGENT: you will need this release for latest version of libv8 to work
+
+- 02-11-2018
+
+- 0.2.4
+
+  - FIX: deadlock releasing context when shared isolates are used
+  - FEATURE: include js backtrace when snapshots do not compile
+
+- 28-09-2018
+
+- 0.2.3
+
+  - Drop all conditional logic from Mini Racer compilation for clang, always
+	  rely on MacOS being High Sierra or up
+
+- 26-09-2018
+
+- 0.2.2
+
+  - WORKAROUND: RUBY_PLATFORM is hardcoded on Ruby compile and can not be
+	trusted for feature detection, use a different technique when checking for
+	macOS Mojave
+
+- 25-09-2018
+
+- 0.2.1
+
+  - FEATURE: Mojave macOS support
+
+- 06-07-2018
+
+- 0.2.0
+  - FEATURE: context#call to allow for cheaper invocation of functions
+  - FIX: rare memory leak when terminating a long running attached function
+  - FIX: rare segfault when terminating a long running attached function
+  - FIX: Reimplement Isolate#idle_notification using idle_notification_deadline, API remains the same @ignisf
+  - Account for changes in the upstream V8 API @ignisf
+  - Support for libv8 6.7
+
+23-08-2017
+
+- 0.1.15
+
+  - bump dependency of libv8 to 6.3
+
+23-08-2017
+
+- 0.1.14
+
+  - libv8 erronuously bumped to beta, reverted change
+
+23-08-2017
+
+- 0.1.13
+
+  - Fix: amend array buffer allocator to use v8 6.0 compatible allocator @ignisf
+
+18-07-2017
+
+- 0.1.12
+
+  - Feature: upgrade libv8 to 5.9
+  - Fix: warning when runnin with ruby warnings enabled (missed @disposed initialize)
+
+18-07-2017
+
+- 0.1.11
+
+  - Feature: upgrade libv8 to 5.7
+
+13-07-2017
+
+- 0.1.10
+
+ - Fix leak: memory leak when disposing a context (20 bytes per context)
+ - Feature: added #heap_stats so you can get visibility from context to actual memory usage of isolate
+ - Feature: added #dispose so you reclaim all v8 memory right away as opposed to waiting for GC
+ - Feature: you can now specify filename in an eval eg: eval('a = 1', filename: 'my_awesome.js')
+
+09-03-2017
+
+- 0.1.9
+
+ - Perf: speed up ruby/node boundary performance when moving large objects
+
+06-02-2017
+
+- 0.1.8
+
+  - Fix: Include math.h to fix use of undeclared identifier floor with rbx. See #51
+
+02-11-2016
+
+- 0.1.7
+
+  - Fix: if for some reason an isolate was forked don't free it and raise a warning instead to avoid hanging process
+
+25-10-2016
+
+- 0.1.6
+
+  - Fix: timeout behavior was incorrect, in some cases stop could be called on already stopped contexts
+
+10-10-2016
+
+- 0.1.5
+
+  - Support for snapshots, shared isolates, runtime flags thanks to @wk8
+  - Fix timeout behavior when it occurs in an attached Ruby method
+
+19-05-2016
+
+- 0.1.4
+
+  - Set upper bound for libv8 inclusion @ignisf
+  - Support conversion of Date, Time and DateTime from Ruby to JS @seanmakesgames
+  - Support conversion of large numbers back from Ruby to JS @seanmakesgames
+
+- 0.1.3
+
+  - Support more conversions from Ruby back to JS (Hash, Symbol, Array)
+  - Support attaching nested objects
+
+
+17-05-2016
+
+- 0.1.2
+
+  - Gemspec specifies minimal version of Ruby (2.0)
+  - Implement #load on Context to load files
+
+17-05-2016
+
+- 0.1.1
+
+  - Added unblock function so SIGINT does not lead to a crash
+
+14-05-2016
+
+- 0.1.1.beta.1
+
+   - First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sam.saffron@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mini_racer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2019, the mini_racer project authors.
+
+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.

data/README.md

@@ -0,0 +1,471 @@
+# MiniRacer
+
+[![Build Status](https://travis-ci.org/rubyjs/mini_racer.svg?branch=master)](https://travis-ci.org/rubyjs/mini_racer)
+
+Minimal, modern embedded V8 for Ruby.
+
+MiniRacer provides a minimal two way bridge between the V8 JavaScript engine and Ruby.
+
+It was created as an alternative to the excellent [therubyracer](https://github.com/cowboyd/therubyracer). Unlike therubyracer, mini_racer only implements a minimal bridge. This reduces the surface area making upgrading v8 much simpler and exhaustive testing simpler.
+
+MiniRacer has an adapter for [execjs](https://github.com/rails/execjs) so it can be used directly with Rails projects to minify assets, run babel or compile CoffeeScript.
+
+### A note about Ruby version Support
+
+MiniRacer only supports non-EOL versions of Ruby. See [Ruby](https://www.ruby-lang.org/en/downloads) to see the list of non-EOL Rubies.
+
+If you require support for older versions of Ruby install an older version of the gem.
+
+## Features
+
+### Simple eval for JavaScript
+
+You can simply eval one or many JavaScript snippets in a shared context
+
+```ruby
+context = MiniRacer::Context.new
+context.eval 'var adder = (a,b)=>a+b;'
+puts context.eval 'adder(20,22)'
+# => 42
+```
+
+### Attach global Ruby functions to your JavaScript context
+
+You can attach one or many ruby proc that can be accessed via JavaScript
+
+```ruby
+context = MiniRacer::Context.new
+context.attach("math.adder", proc{|a,b| a+b})
+puts context.eval 'math.adder(20,22)'
+# => 42
+```
+
+```ruby
+context = MiniRacer::Context.new
+context.attach("array_and_hash", proc{{a: 1, b: [1, {a: 1}]}})
+puts context.eval 'array_and_hash()'
+# => {"a" => 1, "b" => [1, {"a" => 1}]}
+```
+
+### GIL free JavaScript execution
+
+The Ruby Global interpreter lock is released when scripts are executing
+
+```ruby
+context = MiniRacer::Context.new
+Thread.new do
+  sleep 1
+  context.stop
+end
+context.eval 'while(true){}'
+# => exception is raised
+```
+
+This allows you to execute multiple scripts in parallel.
+
+### Timeout support
+
+Contexts can specify a default timeout for scripts
+
+```ruby
+# times out after 1 second (1000 ms)
+context = MiniRacer::Context.new(timeout: 1000)
+context.eval 'while(true){}'
+# => exception is raised
+```
+
+### Memory softlimit support
+
+Contexts can specify a memory softlimit for scripts
+
+```ruby
+# terminates script if heap usage exceeds 200mb after V8 garbage collection has run
+context = MiniRacer::Context.new(max_memory: 200000000)
+context.eval 'var a = new Array(10000); while(true) {a = a.concat(new Array(10000)); print("loop " + a.length);}'
+# => V8OutOfMemoryError is raised
+```
+
+### Rich debugging with "filename" support
+
+```ruby
+
+context = MiniRacer::Context.new
+context.eval('var foo = function() {bar();}', filename: 'a/foo.js')
+context.eval('bar()', filename: 'a/bar.js')
+
+# MiniRacer::RuntimeError is raised containing the filenames you specified for evals in backtrace
+
+```
+
+### Fork safety
+
+Some Ruby web servers employ forking (for example unicorn or puma in clustered mode). V8 is not fork safe.
+Sadly Ruby does not have support for fork notifications per [#5446](https://bugs.ruby-lang.org/issues/5446).
+
+If you want to ensure your application does not leak memory after fork either:
+
+1. Ensure no MiniRacer::Context objects are created in the master process
+
+Or
+
+2. Dispose manually of all MiniRacer::Context objects prior to forking
+
+```ruby
+# before fork
+
+require 'objspace'
+ObjectSpace.each_object(MiniRacer::Context){|c| c.dispose}
+
+# fork here
+```
+
+### Threadsafe
+
+Context usage is threadsafe
+
+```ruby
+
+context = MiniRacer::Context.new
+context.eval('counter=0; plus=()=>counter++;')
+
+(1..10).map do
+  Thread.new {
+    context.eval("plus()")
+  }
+end.each(&:join)
+
+puts context.eval("counter")
+# => 10
+
+```
+
+### Snapshots
+
+Contexts can be created with pre-loaded snapshots:
+
+```ruby
+
+snapshot = MiniRacer::Snapshot.new('function hello() { return "world!"; }')
+
+context = MiniRacer::Context.new(snapshot: snapshot)
+
+context.eval("hello()")
+# => "world!"
+
+```
+
+Snapshots can come in handy for example if you want your contexts to be pre-loaded for effiency. It uses [V8 snapshots](http://v8project.blogspot.com/2015/09/custom-startup-snapshots.html) under the hood; see [this link](http://v8project.blogspot.com/2015/09/custom-startup-snapshots.html) for caveats using these, in particular:
+
+```
+There is an important limitation to snapshots: they can only capture V8’s
+heap. Any interaction from V8 with the outside is off-limits when creating the
+snapshot. Such interactions include:
+
+ * defining and calling API callbacks (i.e. functions created via v8::FunctionTemplate)
+ * creating typed arrays, since the backing store may be allocated outside of V8
+
+And of course, values derived from sources such as `Math.random` or `Date.now`
+are fixed once the snapshot has been captured. They are no longer really random
+nor reflect the current time.
+```
+
+Also note that snapshots can be warmed up, using the `warmup!` method, which allows you to call functions which are otherwise lazily compiled to get them to compile right away; any side effect of your warm up code being then dismissed. [More details on warming up here](https://github.com/electron/electron/issues/169#issuecomment-76783481), and a small example:
+
+```ruby
+
+snapshot = MiniRacer::Snapshot.new('var counter = 0; function hello() { counter++; return "world! "; }')
+
+snapshot.warmup!('hello()')
+
+context = MiniRacer::Context.new(snapshot: snapshot)
+
+context.eval('hello()')
+# => "world! 1"
+context.eval('counter')
+# => 1
+
+```
+
+### Shared isolates
+
+By default, MiniRacer's contexts each have their own isolate (V8 runtime). For efficiency, it is possible to re-use an isolate across contexts:
+
+```ruby
+
+isolate = MiniRacer::Isolate.new
+
+context1 = MiniRacer::Context.new(isolate: isolate)
+context2 = MiniRacer::Context.new(isolate: isolate)
+
+context1.isolate == context2.isolate
+# => true
+```
+
+The main benefit of this is avoiding creating/destroying isolates when not needed (for example if you use a lot of contexts).
+
+The caveat with this is that a given isolate can only execute one context at a time, so don't share isolates across contexts that you want to run concurrently.
+
+Also, note that if you want to use shared isolates together with snapshots, you need to first create an isolate with that snapshot, and then create contexts from that isolate:
+
+```ruby
+snapshot = MiniRacer::Snapshot.new('function hello() { return "world!"; }')
+
+isolate = MiniRacer::Isolate.new(snapshot)
+
+context = MiniRacer::Context.new(isolate: isolate)
+
+context.eval("hello()")
+# => "world!"
+```
+
+Re-using the same isolate over and over again means V8's garbage collector will have to run to clean it up every now and then; it's possible to trigger a _blocking_ V8 GC run inside your isolate by running the `idle_notification` method on it, which takes a single argument: the amount of time (in milliseconds) that V8 should use at most for garbage collecting:
+
+```ruby
+isolate = MiniRacer::Isolate.new
+
+context = MiniRacer::Context.new(isolate: isolate)
+
+# do stuff with that context...
+
+# give up to 100ms for V8 garbage collection
+isolate.idle_notification(100)
+
+# force V8 to perform a full GC
+isolate.low_memory_notification
+
+```
+
+This can come in handy to force V8 GC runs for example in between requests if you use MiniRacer on a web application.
+
+Note that this method maps directly to [`v8::Isolate::IdleNotification`](http://bespin.cz/~ondras/html/classv8_1_1Isolate.html#aea16cbb2e351de9a3ae7be2b7cb48297), and that in particular its return value is the same (true if there is no further garbage to collect, false otherwise) and the same caveats apply, in particular that `there is no guarantee that the [call will return] within the time limit.`
+
+Additionally you may automate this process on a context by defining it with `MiniRacer::Content.new(ensure_gc_after_idle: 1000)`. Using this will ensure V8 will run a full GC using `context.isolate.low_memory_notification` 1 second after the last eval on the context. Low memory notification is both slower and more aggressive than an idle_notification and will ensure long living isolates use minimal amounts of memory.
+
+### V8 Runtime flags
+
+It is possible to set V8 Runtime flags:
+
+```ruby
+MiniRacer::Platform.set_flags! :noconcurrent_recompilation, max_inlining_levels: 10
+```
+
+This can come in handy if you want to use MiniRacer with Unicorn, which doesn't seem to alwatys appreciate V8's liberal use of threading:
+```ruby
+MiniRacer::Platform.set_flags! :noconcurrent_recompilation, :noconcurrent_sweeping
+```
+
+Or else to unlock experimental features in V8, for example tail recursion optimization:
+```ruby
+MiniRacer::Platform.set_flags! :harmony
+
+js = <<-JS
+'use strict';
+var f = function f(n){
+  if (n <= 0) {
+    return  'foo';
+  }
+  return f(n - 1);
+}
+
+f(1e6);
+JS
+
+context = MiniRacer::Context.new
+
+context.eval js
+# => "foo"
+```
+The same code without the harmony runtime flag results in a `MiniRacer::RuntimeError: RangeError: Maximum call stack size exceeded` exception.
+Please refer to http://node.green/ as a reference on other harmony features.
+
+A list of all V8 runtime flags can be found using `node --v8-options`, or else by perusing [the V8 source code for flags (make sure to use the right version of V8)](https://github.com/v8/v8/blob/master/src/flags/flag-definitions.h).
+
+Note that runtime flags must be set before any other operation (e.g. creating a context, a snapshot or an isolate), otherwise an exception will be thrown.
+
+Flags:
+
+- :expose_gc : Will expose `gc()` which you can run in JavaScript to issue a gc
+- :max_old_space_size : defaults to 1400 (megs) on 64 bit, you can restric memory usage by limiting this.
+- **NOTE TO READER** our documentation could be awesome we could be properly documenting all the flags, they are hugely useful, if you feel like documenting a few more, PLEASE DO, PRs are welcome.
+
+## Controlling memory
+
+When hosting v8 you may want to keep track of memory usage, use #heap_stats to get memory usage:
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+p context.heap_stats
+# {:total_physical_size=>1280640,
+#  :total_heap_size_executable=>4194304,
+#  :total_heap_size=>3100672,
+#  :used_heap_size=>1205376,
+#  :heap_size_limit=>1501560832}
+```
+
+If you wish to dispose of a context before waiting on the GC use
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+context.dispose
+context.eval("a = 2")
+# MiniRacer::ContextDisposedError
+
+# nothing works on the context from now on, its a shell waiting to be disposed
+```
+
+A MiniRacer context can also be dumped in a heapsnapshot file using `#write_heap_snapshot(file_or_io)`
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+context.write_heap_snapshot("test.heapsnapshot")
+```
+
+This file can then be loaded in the memory tab of the chrome dev console.
+
+### Function call
+
+This calls the function passed as first argument:
+
+```ruby
+context = MiniRacer::Context.new
+context.eval('function hello(name) { return "Hello, " + name + "!" }')
+context.call('hello', 'George')
+# "Hello, George!"
+```
+
+Performance is slightly better than running `eval('hello("George")')` since:
+
+ - compilation of eval'd string is avoided
+ - function arguments don't need to be converted to JSON
+
+## Performance
+
+The `bench` folder contains benchmark.
+
+### Benchmark minification of Discourse application.js (both minified and unminified)
+
+MiniRacer outperforms node when minifying assets via execjs.
+
+- MiniRacer version 0.1.9
+- node version 6.10
+- therubyracer version 0.12.2
+
+```
+
+$ bundle exec ruby bench.rb mini_racer
+Benching with mini_racer
+mini_racer minify discourse_app.js 9292.72063ms
+mini_racer minify discourse_app_minified.js 11799.850171ms
+mini_racer minify discourse_app.js twice (2 threads) 10269.570797ms
+
+sam@ubuntu exec_js_uglify % bundle exec ruby bench.rb node
+Benching with node
+node minify discourse_app.js 13302.715484ms
+node minify discourse_app_minified.js 18100.761243ms
+node minify discourse_app.js twice (2 threads) 14383.600207000001ms
+
+sam@ubuntu exec_js_uglify % bundle exec ruby bench.rb therubyracer
+Benching with therubyracer
+therubyracer minify discourse_app.js 171683.01867700001ms
+therubyracer minify discourse_app_minified.js 143138.88492ms
+therubyracer minify discourse_app.js twice (2 threads) NEVER FINISH
+
+Killed: 9
+```
+
+The huge performance disparity (MiniRacer is 10x faster) is due to MiniRacer running latest version of V8. In July 2016 there is a queued upgrade to therubyracer which should bring some of the perf inline.
+
+Note how the global interpreter lock release leads to 2 threads doing the same work taking the same wall time as 1 thread.
+
+As a rule MiniRacer strives to always support and depend on the latest stable version of libv8.
+
+## Source Maps
+
+MiniRacer can fully support source maps but must be configured correctly to do so. [Check out this example](./examples/source-map-support/) for a working implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_racer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_racer
+
+
+**Note** using v8.h and compiling MiniRacer requires a C++11 standard compiler, more specifically clang 3.5 (or later) or gcc 4.8 (or later).
+
+
+## Travis-ci
+
+To install `mini-racer` you will need a version of gcc that supports C++11 (gcc 4.8) this is included by default in ubuntu trusty based images.
+
+Travis today ships by default with a precise based image. Precise Pangolin (12.04 LTS) was first released in August 2012. Even though you can install GCC 4.8 on precise the simpler approach is to opt for the trusty based image.
+
+Add this to your .travis.yml file:
+
+```
+- sudo: required
+- dist: trusty
+```
+
+## Similar Projects
+
+### therubyracer
+
+- https://github.com/cowboyd/therubyracer
+- Most comprehensive bridge available
+- Provides the ability to "eval" JavaScript
+- Provides the ability to invoke Ruby code from JavaScript
+- Hold references to JavaScript objects and methods in your Ruby code
+- Hold references to Ruby objects and methods in JavaScript code
+- Uses libv8, so installation is fast
+- Supports timeouts for JavaScript execution
+- Does not release global interpreter lock, so performance is constrained to a single thread
+- Currently (May 2016) only supports v8 version 3.16.14 (Released approx November 2013), plans to upgrade by July 2016
+- Supports execjs
+
+
+### v8eval
+
+- https://github.com/sony/v8eval
+- Provides the ability to "eval" JavaScript using the latest V8 engine
+- Does not depend on the [libv8](https://github.com/cowboyd/libv8) gem, installation can take 10-20 mins as V8 needs to be downloaded and compiled.
+- Does not release global interpreter lock when executing JavaScript
+- Does not allow you to invoke Ruby code from JavaScript
+- Multi runtime support due to SWIG based bindings
+- Supports a JavaScript debugger
+- Does not support timeouts for JavaScript execution
+- No support for execjs (can not be used with Rails uglifier and coffeescript gems)
+
+
+### therubyrhino
+
+- https://github.com/cowboyd/therubyrhino
+- API compatible with therubyracer
+- Uses Mozilla's Rhino engine https://github.com/mozilla/rhino
+- Requires JRuby
+- Support for timeouts for JavaScript execution
+- Concurrent cause .... JRuby
+- Supports execjs
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyjs/mini_racer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+