mirror of
https://github.com/rubyjs/therubyracer
synced 2023-03-27 23:21:42 -04:00
205c52c5bf
move v8 src to google dir moving v8 source into main extension move google upstream source dir into v8 ext dir include v8 library in generated bundle prep for 0.4.7 roll the upstream build into the main extension build Documentation was confusing the gem packager. simplify build instructions with bundled v8. Only install scons and build v8 if it has not been built already. Missing CVS.py from the scons library due to ignore patterns. Don't need libv8 anymore, only python 2.5 which is required to build it.
157 lines
No EOL
4.1 KiB
Text
157 lines
No EOL
4.1 KiB
Text
= therubyracer
|
|
|
|
* http://github.com/cowboyd/therubyracer
|
|
|
|
== DESCRIPTION:
|
|
|
|
Embed the V8 Javascript interpreter into Ruby.
|
|
|
|
== FEATURES/PROBLEMS:
|
|
|
|
* Evaluate Javascript from with in Ruby
|
|
* Embed your Ruby objects into the Javascript world
|
|
* Manipulate JavaScript objects and call JavaScript functions from Ruby
|
|
* API compatible with the The Ruby Rhino (for JRuby: http://github.com/cowboyd/therubyrhino)
|
|
* Currently ALPHA software.
|
|
|
|
== SYNOPSIS:
|
|
|
|
require 'v8'
|
|
|
|
# evaluate some simple javascript
|
|
|
|
V8.eval("7 * 6") #=> 42
|
|
|
|
# embed values into the scope of your context
|
|
|
|
V8::Context.open do |cxt|
|
|
cxt['foo'] = "bar"
|
|
cxt.eval('foo') # => "bar"
|
|
end
|
|
|
|
# evaluate a ruby function from javascript
|
|
|
|
V8::Context.open do |context|
|
|
context["say"] = lambda {|word, times| word * times}
|
|
context.eval("say("Hello", 3)") #=> HelloHelloHello
|
|
end
|
|
|
|
# embed a ruby object into your javascript environment
|
|
|
|
class MyMath
|
|
def plus(lhs, rhs)
|
|
lhs + rhs
|
|
end
|
|
end
|
|
|
|
V8::Context.open do |context|
|
|
context["math"] = MyMath.new
|
|
context.eval("math.plus(20,22)") #=> 42
|
|
end
|
|
|
|
# make a ruby object *be* your javascript environment
|
|
math = MyMath.new
|
|
V8::Context.open(:with => math) do |context|
|
|
context.eval("plus(20,22)") #=> 42
|
|
end
|
|
|
|
#or the equivalent
|
|
|
|
math.eval_js("plus(20,22)")
|
|
|
|
# Configure your embedding setup
|
|
|
|
#COMING SOON!
|
|
# Make your standard objects (Object, String, etc...) immutable
|
|
V8::Context.open(:sealed => true) do |context|
|
|
context.eval("Object.prototype.toString = function() {}") # this is an error!
|
|
end
|
|
|
|
#COMING SOON!
|
|
#limit the number of instructions that can be executed in order to prevent
|
|
#rogue scripts
|
|
V8::Context.open do |context|
|
|
context.instruction_limit = 100000
|
|
context.eval("while (true);") # => Error!
|
|
end
|
|
|
|
==== Different ways of loading javascript source
|
|
|
|
In addition to just evaluating strings, you can also use streams such as files.
|
|
|
|
# evaluate bytes read from any File/IO object:
|
|
File.open("mysource.js") do |file|
|
|
eval_js file, "mysource.js"
|
|
end
|
|
|
|
# or load it by filename
|
|
V8::Context.open do |context|
|
|
context.load("mysource.js")
|
|
end
|
|
|
|
=== Safe by default
|
|
|
|
The Ruby Racer is designed to let you evaluate javascript as safely as possible unless you tell it to do something more
|
|
dangerous. The default context is a hermetically sealed javascript environment with only the standard javascript objects
|
|
and functions. Nothing from the ruby world is accessible at all.
|
|
|
|
For ruby objects that you explicitly embed into javascript, only the +public+ methods *defined in their classes* are
|
|
exposed by default. E.g.
|
|
|
|
class A
|
|
def a
|
|
"a"
|
|
end
|
|
end
|
|
|
|
class B < A
|
|
def b
|
|
"b"
|
|
end
|
|
end
|
|
|
|
|
|
V8::Context.open do |cxt|
|
|
cxt['a'] = A.new
|
|
cxt['b'] = B.new
|
|
cxt.eval("a.a()") # => 'a'
|
|
cxt.eval("b.b()") # => 'b'
|
|
cxt.eval("b.a()") # => 'TypeError: undefined property 'a' is not a function'
|
|
end
|
|
|
|
== REQUIREMENTS:
|
|
|
|
* python >= 2.5 (required to compile v8)
|
|
|
|
== INSTALL:
|
|
* gem install therubyracer
|
|
|
|
== DEVELOP
|
|
* git clone git://github.com/cowboyd/therubyracer.git
|
|
* cd therubyracer
|
|
* rake compile
|
|
|
|
== LICENSE:
|
|
|
|
(The MIT License)
|
|
|
|
Copyright (c) 2009 Charles Lowell
|
|
|
|
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. |