inline_javascript 0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require=./spec/helpers/spec_helper.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@ruby_inline_javascript

data/Gemfile

@@ -0,0 +1,14 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem 'json'
+
+group :test do
+  gem 'rspec', '>= 2.5'
+end
+
+group :development do
+  gem 'hoe', '>= 2.7.0'
+  gem 'newgem', '>= 1.5.3'
+  gem 'rdoc', '>= 3.2'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.7)
+    activesupport (2.3.11)
+    diff-lcs (1.1.2)
+    hoe (2.9.1)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    json (1.5.1)
+    newgem (1.5.3)
+      RedCloth (>= 4.1.1)
+      activesupport (~> 2.3.4)
+      hoe (>= 2.4.0)
+      rubigen (>= 1.5.3)
+      syntax (>= 1.0.0)
+    rake (0.8.7)
+    rdoc (3.5.3)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rubigen (1.5.6)
+      activesupport (>= 2.3.5)
+      i18n
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe (>= 2.7.0)
+  json
+  newgem (>= 1.5.3)
+  rdoc (>= 3.2)
+  rspec (>= 2.5)

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-02-23
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,21 @@
+.rspec
+.rvmrc
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+ext/inline_java_script_v8_wrapper/extconf.rb
+ext/inline_java_script_v8_wrapper/inline_java_script_v8_wrapper.cc
+lib/inline_java_script.rb
+lib/inline_java_script/v8_wrapper.rb
+script/console
+script/destroy
+script/generate
+spec/helpers/spec_helper.rb
+spec/inline_javascript_spec.rb
+spec/inline_javascript_v8_wrapper_extn_spec.rb
+tasks/extconf.rake
+tasks/extconf/inline_java_script_v8_wrapper.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on inline_javascript, see http://inline_javascript.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,89 @@
+= inline_javascript
+
+* http://github.com/moowahaha/ruby_inline_javascript
+
+== DESCRIPTION:
+
+Call JavaScript methods from Ruby using either InlineJavaScript or, more directly,
+InlineJavaScript::V8Wrapper.
+
+
+== FEATURES/PROBLEMS:
+
+* InlineJavaScript supports calling methods with multiple parameters of Fixnum (integer),
+  String, Hash, Array or any other class that supports the ".to_json" method (as provided
+  by the "json" gem).
+
+* InlineJavaScript supports JavaScript return values of type String, Integer, Hash, Array or any
+  other type supported by JavaScript's "JSON.stringify()" method.
+
+* InlineJavaScript::V8Wrapper only currently supports functions returning basic scalars,
+  that it then turns into strings.
+
+
+== SYNOPSIS:
+
+To call a JavaScript function as if it was Ruby:
+
+    require 'inline_java_script'
+
+    js = InlineJavaScript.new('function my_add (a, b) { return a+b}')
+    js.my_add(1, 2) #=> 3
+
+Using more complex types:
+
+    js = InlineJavaScript.new('function my_concat (a) { return {concat_string: a[0] + " " + a[1]} }')
+    js.my_concat(['hello', 'world']) #=> {"concat_string" => "hello world"}
+
+To call the V8 engine directly (no smarts):
+
+    require 'inline_java_script/v8_wrapper'
+
+    wrapper = InlineJavaScript::V8Wrapper.new
+    wrapper.execute('1 + 2') #=> "3"
+
+An instance of the V8Wrapper maintains state:
+
+    wrapper = InlineJavaScript::V8Wrapper.new
+    wrapper.execute('var e = "monster"')
+    wrapper.execute('e') #=> "monster"
+
+    # ... But I cannot access another instance...
+    InlineJavaScript::V8Wrapper.new.execute('e') #=> SyntaxError
+
+
+== REQUIREMENTS:
+
+* Google's libv8. I installed this using Homebrew (https://github.com/mxcl/homebrew)
+  by running "brew install v8" on OSX. libv8 is also available for other operating
+  systems through various means (e.g. yum install libv8-dev).
+
+
+== INSTALL:
+
+* gem install inline_javascript
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Stephen Hardisty.
+
+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/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/inline_java_script'
+
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'inline_javascript' do
+  self.developer 'Stephen Hardisty', 'moowahaha@hotmail.com'
+  self.post_install_message = 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.extra_deps         = [['json','>= 0']]
+
+  self.clean_globs = [
+    'ext/inline_java_script_v8_wrapper/Makefile',
+    'ext/inline_java_script_v8_wrapper/*.{o,so,bundle,a,log,dll}',
+    'ext/inline_java_script_v8_wrapper/conftest.dSYM'
+  ]
+
+  self.spec_extras = { :extensions => ["ext/inline_java_script_v8_wrapper/extconf.rb"] }
+end
+
+task :default do
+  sh 'rake clean && rake extconf:compile && rake spec'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/ext/inline_java_script_v8_wrapper/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+have_library("stdc++")
+have_library('v8')
+
+create_makefile("inline_java_script_v8_wrapper")

data/ext/inline_java_script_v8_wrapper/inline_java_script_v8_wrapper.cc

@@ -0,0 +1,103 @@
+#include "ruby.h"
+#include <v8.h>
+
+using namespace v8;
+
+class V8Context {
+
+    public:
+
+    V8Context() {
+        this->context = Context::New();
+    }
+
+    ~V8Context() {
+        this->dispose();
+    }
+
+    void dispose() {
+        this->context.Dispose();
+    }
+
+    VALUE execute(VALUE javascript_string) {
+        Context::Scope context_scope(this->context);
+
+        HandleScope handle_scope;
+
+        Handle<String> source = String::New(StringValueCStr(javascript_string));
+
+        TryCatch try_catch;
+
+        Handle<Script> javascript_functions = Script::Compile(source);
+
+        if (javascript_functions.IsEmpty()) {
+            throw_javascript_exception(&try_catch);
+        }
+
+        Handle<Value> result = javascript_functions->Run();
+
+        return this->rb_result(result, &try_catch);
+    }
+
+    private:
+
+    Persistent<Context> context;
+
+    VALUE rb_result(Handle<Value> result, TryCatch *try_catch) {
+        if (result.IsEmpty()) {
+            throw_javascript_exception(try_catch);
+        }
+
+        if (result->IsUndefined()) {
+            return Qnil;
+        }
+
+        String::Utf8Value str(result);
+
+        return rb_str_new2(*str);
+    }
+
+    void throw_javascript_exception(TryCatch *try_catch) {
+        Handle<Value> exception = try_catch->Exception();
+        String::AsciiValue exception_str(exception);
+
+        Handle<Message> message = try_catch->Message();
+        if (message.IsEmpty()) {
+            rb_raise(rb_eSyntaxError, "JavaScript error: %s", *exception_str);
+        }
+
+        int line = message->GetLineNumber();
+        String::Utf8Value sourceline(message->GetSourceLine());
+
+        rb_raise(rb_eSyntaxError, "JavaScript error: %s on line %d:\n%s", *exception_str, line, *sourceline);
+    }
+
+};
+
+VALUE rb_cInlineJavaScriptV8Wrapper = Qnil;
+
+VALUE rb_execute_java_script(VALUE self, VALUE javascript_string) {
+    V8Context *this_context;
+    Data_Get_Struct(self, V8Context, this_context);
+    return this_context->execute(javascript_string);
+
+}
+
+void dispose_of_context(V8Context *this_context) {
+    this_context->dispose();
+    free(this_context);
+}
+
+VALUE allocate_context(VALUE klass) {
+    V8Context *this_context = new V8Context();
+    return Data_Wrap_Struct(klass, 0, dispose_of_context, this_context);
+}
+
+extern "C" void Init_inline_java_script_v8_wrapper() {
+    VALUE rb_cInlineJavaScript = rb_define_class("InlineJavaScript", rb_cObject);
+    rb_cInlineJavaScriptV8Wrapper = rb_define_class_under(rb_cInlineJavaScript, "V8Wrapper", rb_cObject);
+	
+    rb_define_method(rb_cInlineJavaScriptV8Wrapper, "execute", (VALUE(*)(...))&rb_execute_java_script, 1);
+    rb_define_alloc_func(rb_cInlineJavaScriptV8Wrapper, allocate_context);
+}
+

data/lib/inline_java_script.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+#== SYNOPSIS:
+#
+#To call a JavaScript function as if it was Ruby:
+#
+#    require 'inline_java_script'
+#
+#    js = InlineJavaScript.new('function my_add (a, b) { return a+b}')
+#    js.my_add(1, 2) #=> 3
+#
+#Using more complex types:
+#
+#    js = InlineJavaScript.new('function my_concat (a) { return {concat_string: a[0] + " " + a[1]} }')
+#    js.my_concat(['hello', 'world']) #=> {"concat_string" => "hello world"}
+
+
+class InlineJavaScript
+  VERSION = '0.1'
+
+  # Takes a string containing some JavaScript and executes it. The state is maintained.
+  # JavaScript functions defined in the string can be called directly from an instance
+  # of InlineJavaScript as if they were methods.
+
+  def initialize javascript_functions
+    require File.join(File.dirname(__FILE__), %w{.. ext inline_java_script_v8_wrapper inline_java_script_v8_wrapper})
+
+    @wrapper = InlineJavaScript::V8Wrapper.new
+    @wrapper.execute(javascript_functions)
+  end
+
+  # Attempts to call whatever JavaScript function you defined in the constructor.
+  # It will accept any number of parameters of String, Fixnum, Array or Hash and can
+  # support returning the same from JavaScript.
+
+  def method_missing(method, *arguments, &unused_block)
+    json_arguments = arguments.map do |arg|
+      "JSON.parse(" + arg.to_json.to_json + ")"
+    end
+
+    JSON[@wrapper.execute("JSON.stringify({result: #{method}(#{json_arguments.join(',')})})")]['result']
+  end
+end

data/lib/inline_java_script/v8_wrapper.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), %w{.. .. ext inline_java_script_v8_wrapper inline_java_script_v8_wrapper})
+
+#== SYNOPSIS:
+#To call the V8 engine:
+#
+#    require 'inline_java_script/v8_wrapper'
+#
+#    wrapper = InlineJavaScript::V8Wrapper.new
+#    wrapper.execute('1 + 2') #=> "3"
+#
+#An instance of the V8Wrapper maintains state:
+#
+#    wrapper = InlineJavaScript::V8Wrapper.new
+#    wrapper.execute('var e = "monster"')
+#    wrapper.execute('e') #=> "monster"
+#
+#    # ... But I cannot access another instance...
+#    InlineJavaScript::V8Wrapper.new.execute('e') #=> SyntaxError
+
+class InlineJavaScript::V8Wrapper
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/pickaxe.rb'}"
+puts "Loading pickaxe gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/helpers/spec_helper.rb

@@ -0,0 +1 @@
+require 'inline_java_script'

data/spec/inline_javascript_spec.rb

@@ -0,0 +1,18 @@
+describe InlineJavaScript do
+
+  it "should call pass arguments and return results" do
+    js = InlineJavaScript.new('function concat (a, b) { return(a + " " + b) }')
+    js.concat('bath', 'rules').should == 'bath rules'
+  end
+
+  it "should be able to deal with numeric values" do
+    js = InlineJavaScript.new('function add (a, b) { return(a + b) }')
+    js.add(1, 100).should == 101
+  end
+
+  it "should handle more complex types" do
+    js = InlineJavaScript.new('function something (some_array) { return {second: some_array[1]} }')
+    js.something(%w{hopefully this works great}).should == {'second' => 'this'}
+  end
+
+end

data/spec/inline_javascript_v8_wrapper_extn_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + "/../ext/inline_java_script_v8_wrapper/inline_java_script_v8_wrapper"
+
+describe InlineJavaScript::V8Wrapper do
+
+  it "should execute some javascript" do
+    wrapper = InlineJavaScript::V8Wrapper.new
+    wrapper.execute('function blah() { return "hello"}')
+    wrapper.execute('blah()').should == "hello"
+  end
+
+  it "should not have globally scoped JS" do
+    InlineJavaScript::V8Wrapper.new.execute('function i_should_have_a_short_life() {}')
+
+    wrapper = InlineJavaScript::V8Wrapper.new
+    wrapper.execute('function i_am_wasted_javascript () {}')
+    -> { wrapper.execute('i_should_have_a_short_life()') }.should raise_error(SyntaxError)
+  end
+
+  it "should return nil when nothing is returned" do
+    InlineJavaScript::V8Wrapper.new.execute('var x = 2').should be_nil
+  end
+
+  it "should throw exceptions with syntax errors" do
+    -> { InlineJavaScript::V8Wrapper.new.execute('sdfsdf') }.should raise_error(SyntaxError)
+  end
+
+end

data/tasks/extconf.rake

@@ -0,0 +1,13 @@
+namespace :extconf do
+  desc "Compiles the Ruby extension"
+  task :compile
+end
+
+task :compile => "extconf:compile"
+
+task :test => :compile
+
+BIN = "*.{bundle,jar,so,obj,pdb,lib,def,exp,o}"
+$hoe.clean_globs |= ["ext/**/#{BIN}", "lib/**/#{BIN}", 'ext/**/Makefile']
+$hoe.spec.require_paths = Dir['{lib,ext/*}']
+$hoe.spec.extensions = FileList["ext/**/extconf.rb"].to_a

data/tasks/extconf/inline_java_script_v8_wrapper.rake

@@ -0,0 +1,43 @@
+namespace :extconf do
+  extension = File.basename(__FILE__, '.rake')
+
+  ext = "ext/#{extension}"
+  ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+  ext_files = FileList[
+    "#{ext}/*.c",
+    "#{ext}/*.h",
+    "#{ext}/*.rl",
+    "#{ext}/extconf.rb",
+    "#{ext}/Makefile",
+    # "lib"
+  ]
+
+
+  task :compile => extension do
+    if Dir.glob("**/#{extension}.{o,so,dll}").length == 0
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      STDERR.puts "Gem actually failed to build.  Your system is"
+      STDERR.puts "NOT configured properly to build #{GEM_NAME}."
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      exit(1)
+    end
+  end
+
+  desc "Builds just the #{extension} extension"
+  task extension.to_sym => ["#{ext}/Makefile", ext_so ]
+
+  file "#{ext}/Makefile" => ["#{ext}/extconf.rb"] do
+    Dir.chdir(ext) do ruby "extconf.rb" end
+  end
+
+  file ext_so => ext_files do
+    Dir.chdir(ext) do
+      sh(RUBY_PLATFORM =~ /win32/ ? 'nmake' : 'make') do |ok, res|
+        if !ok
+          require "fileutils"
+          FileUtils.rm Dir.glob('*.{so,o,dll,bundle}')
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: inline_javascript
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Hardisty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-02-27 00:00:00.000000000 +11:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2757730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2757730
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &2757460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :development
+  prerelease: false
+  version_requirements: *2757460
+description: ! 'Call JavaScript methods from Ruby using either InlineJavaScript or,
+  more directly,
+
+  InlineJavaScript::V8Wrapper.'
+email:
+- moowahaha@hotmail.com
+executables: []
+extensions:
+- ext/inline_java_script_v8_wrapper/extconf.rb
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files:
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- ext/inline_java_script_v8_wrapper/extconf.rb
+- ext/inline_java_script_v8_wrapper/inline_java_script_v8_wrapper.cc
+- lib/inline_java_script.rb
+- lib/inline_java_script/v8_wrapper.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/helpers/spec_helper.rb
+- spec/inline_javascript_spec.rb
+- spec/inline_javascript_v8_wrapper_extn_spec.rb
+- tasks/extconf.rake
+- tasks/extconf/inline_java_script_v8_wrapper.rake
+has_rdoc: true
+homepage: http://github.com/moowahaha/ruby_inline_javascript
+licenses: []
+post_install_message: PostInstall.txt
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+- ext/inline_java_script_v8_wrapper
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: inline_javascript
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Call JavaScript methods from Ruby using either InlineJavaScript or, more
+  directly, InlineJavaScript::V8Wrapper.
+test_files: []