mustang 0.2.1 → 0.2.2

data/README.md

@@ -4,6 +4,55 @@ Mustang development is proudly sponsored by [Cubox, Agile Rails Devshop](http://
 
 Mustang is ruby proxy library for awesome Google V8 JavaScript engine. 
 
+## Motivation
+
+JavaScript integration testing suite which contains more than 4000 steps and running time
+more that 2 hours... I think that's enough. There is lot of different ways to handle headless
+testing, but they all have lot of issues as well. They are super slow (Selenium, Watir), or
+they are not working with ruby 1.9 (Johsnon), or they requires tricky external stuff (Culerity/Celerity,
+Zombie). Our goal is to create fast javascript engine working fine on all popular ruby implementations
+(1.8.x, 1.9.x, ree, rubinius), and make it core element of headless, virtual browser for testing
+purposes (of course integrated with capybara and cucubmer).
+
+## TheRubyRacer and PyV8 influence...
+
+Yeap, [TheRubyRacer](http://github.com/cowboyd/therubyracer) from [Charles Lowell](http://github.com/cowboyd)
+and [PyV8](http://code.google.com/p/pyv8/) made big influence on our Mustang code, so let say now big thanks
+to the authors...
+
+You can of course ask why we wrote library which seems to be very similar to TheRubyRacer... yeah it seems, but there
+are a lot of differences. Here is short comparison of TheRubyRacer and Mustang:
+
+Similarities:
+
+* Both are using similar integration with ruby's garbage collector. Actually, Mustang's code which handles
+  that references is just improved version of TheRubyRacer's code (check the <tt>ext/v8/v8_ref.cpp</tt>).
+* Both are reflecting JS objects to ruby and vice-versa. 
+
+Diffs:
+
+* Mustang reflects all JavaScript objects and values properly. Properly, means
+  all values from within V8 are reflected to <tt>Mustang::V8::*</tt> objects,
+  regarding V8 inheritance tree which you can find [here](http://izs.me/v8-docs/classv8_1_1Data.html).
+* Once reflected ruby object (and vice-versa) is always the same object in ruby
+  world.
+* All reflected V8 objects acts exacltly the same as ruby natives. For example
+  you can deal with Mustang::V8::Array exactly the same as with native Ruby arrays
+  (eg. they are comparable with ruby objects, etc).
+* Functions are reflected more accurately. Ruby objects' methods are represented
+  properly.
+* Classes are converted to V8 function templates, so you can deal with them as with
+  prototypes.
+* Different approach to deal with contexts, compiling JS scripts and exceptions handling. 
+* Support for regexp reflections.
+* Way more friendly ruby api.
+* A very thorough test suite (over 250 tests passing on all ruby versions)
+* Clean codebase, less magic, fully documented.
+* Lower memory usage. 
+
+And the most important, like i said before, Mustang is used as core element of our
+bigger idea, so it have to exactly fit to our needs. 
+
 ## Installation
 
 Before you install mustang gem make sure you have `scons` installed.
@@ -38,6 +87,10 @@ For now it's only proof of concept. It implements very simple evaluation of java
     cxt.eval("puts(a)") # displays "1" on the screen
     cxt[:a] # => 1
 
+### Advanced
+
+TODO: coming soon...
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/TODO.md

@@ -2,9 +2,13 @@
 
 * better exceptions handling
 * V8::Integer should inherit V8::Number
-* specs for Mustang's classes
+* specs for Mustang context
 * specs for support modules
 * v8 debug stuff
 * support for ObjectTemplates
 * reflecting ruby classes to FunctionTemplates
 * getting entered context
+
+* V8::Data, V8::Value, V8::Primitive should be modules included in
+  other v8's datatypes. All that types should inherit native ruby
+  classes as well.

data/ext/v8/extconf.rb

@@ -28,30 +28,37 @@ def compile_vendor_v8!(dir)
   arch = cpu_x64? ? 'x64' : 'ia32' 
   flags = '-fPIC -fno-builtin-memcpy -shared'
 
-  Dir.chdir dir do 
-    begin
-      make_sure_scons_installed!
-      defaults, ENV['CCFLAGS'] = ENV['CCFLAGS'], flags
-      build_cmd = "scons mode=release snapshot=off library=static arch=#{arch}"
-      puts build_cmd
-      system build_cmd
-    ensure
-      ENV['CCFLAGS'] = defaults
-    end
+  begin
+    make_sure_scons_installed!
+    defaults, ENV['CCFLAGS'] = ENV['CCFLAGS'], flags
+    puts "-"*30
+    compile_cmd = "cd #{dir} && scons mode=release snapshot=off library=static arch=#{arch}"
+    puts compile_cmd
+    system compile_cmd
+    puts "-"*30
+  ensure
+    ENV['CCFLAGS'] = defaults
   end
 end
 
-V8_DIR = File.expand_path("../../../vendor/v8", __FILE__)
-inc, lib = dir_config('v8', File.join(V8_DIR, 'include'), V8_DIR)
+unless have_library('v8')
+  V8_DIR = File.expand_path("../../../vendor/v8", __FILE__)
+  inc, lib = dir_config('v8', File.join(V8_DIR, 'include'), V8_DIR)
 
-if V8_DIR == lib
-  compile_vendor_v8!(V8_DIR)
-  $LOCAL_LIBS << Dir[File.join(V8_DIR, "**/**/libv8.a")].first
+  if V8_DIR == lib
+    compile_vendor_v8!(V8_DIR)
+    $LOCAL_LIBS << Dir[File.join(V8_DIR, "**/**/libv8.a")].first
+  end
+
+  find_library('v8', nil, lib)
 end
 
-find_library('v8', nil, lib)
 have_library('pthread')
+have_header('string.h')
+have_header('ruby.h')
 have_header('v8.h')
+have_header('v8-debug.h')
+have_header('v8-profiler.h')
 
 CONFIG['LDSHARED'] = '$(CXX) -shared' unless darwin?
 

data/ext/v8/v8.cpp

@@ -12,6 +12,7 @@
 #include "v8_function.h"
 #include "v8_regexp.h"
 #include "v8_external.h"
+#include "v8_boolean.h"
 #include "v8_errors.h"
 
 extern "C" void Init_v8() {
@@ -33,5 +34,6 @@ extern "C" void Init_v8() {
   Init_V8_Function();
   Init_V8_Regexp();
   Init_V8_External();
+  Init_V8_Boolean();
   Init_V8_Errors();
 }

data/ext/v8/v8_boolean.cpp

@@ -0,0 +1,29 @@
+#include "v8_ref.h"
+#include "v8_cast.h"
+#include "v8_boolean.h"
+#include "v8_errors.h"
+#include "v8_value.h"
+#include "v8_macros.h"
+
+using namespace v8;
+
+VALUE rb_cV8Boolean;
+VALUE rb_cV8FalseClass;
+VALUE rb_cV8TrueClass;
+
+/* Booleans initializer */
+void Init_V8_Boolean()
+{
+  rb_cV8Boolean = rb_define_class_under(rb_mV8, "Boolean", rb_cV8Primitive);
+  VALUE args;
+  
+  /* false */
+  args = Qfalse;
+  rb_cV8FalseClass = rb_define_class_under(rb_mV8, "FalseClass", rb_cV8Boolean);
+  rb_define_const(rb_mV8, "False", rb_funcall2(rb_cV8FalseClass, rb_intern("new"), 1, &args));
+
+  /* true */
+  args = Qtrue;
+  rb_cV8TrueClass = rb_define_class_under(rb_mV8, "TrueClass", rb_cV8Boolean);
+  rb_define_const(rb_mV8, "True", rb_funcall2(rb_cV8TrueClass, rb_intern("new"), 1, &args));
+}

data/ext/v8/v8_boolean.h

@@ -0,0 +1,18 @@
+#ifndef __V8_BOOLEAN_H
+#define __V8_BOOLEAN_H
+
+#include "v8_main.h"
+
+using namespace v8;
+
+/* V8::Boolean class */
+RUBY_EXTERN VALUE rb_cV8Boolean;
+/* V8::FalseClass class */
+RUBY_EXTERN VALUE rb_cV8FalseClass;
+/* V8::TrueClass class */
+RUBY_EXTERN VALUE rb_cV8TrueClass;
+
+/* API */
+void Init_V8_Boolean();
+
+#endif /* __V8_BOOLEAN_H */

data/ext/v8/v8_cast.cpp

@@ -12,6 +12,7 @@
 #include "v8_regexp.h"
 #include "v8_context.h"
 #include "v8_external.h"
+#include "v8_boolean.h"
 #include "v8_errors.h"
 #include "v8_macros.h"
 
@@ -80,7 +81,7 @@ VALUE to_ruby(Handle<Value> value)
   } else if (value->IsNull()) {
     return rb_const_get(rb_mV8, rb_intern("Null"));
   } else if (value->IsBoolean()) {
-    return value->BooleanValue() ? Qtrue : Qfalse;
+    return rb_const_get(rb_mV8, value->BooleanValue() ? rb_intern("True") : rb_intern("False"));
   } else if (value->IsDate()) {
     return to_ruby_without_peer<Date>(value, rb_cV8Date);
   } else if (value->IsUint32() || value->IsInt32()) {
@@ -101,7 +102,7 @@ VALUE to_ruby(Handle<Value> value)
     return to_ruby_with_peer<Object>(value, rb_cV8Object);
   }
 
-  return Qnil;
+  return rb_const_get(rb_mV8, rb_intern("Empty"));
 }
 
 OVERLOAD_TO_RUBY_WITH(Boolean);

data/ext/v8/v8_value.cpp

@@ -21,8 +21,12 @@ UNWRAPPER(Value);
  */
 static VALUE rb_v8_value_new(VALUE self, VALUE data)
 {
-  HandleScope scope; 
-  PREVENT_CREATION_WITHOUT_CONTEXT();
+  HandleScope scope;
+
+  if (data != Qtrue && data != Qfalse && data != Qnil) {
+    PREVENT_CREATION_WITHOUT_CONTEXT();
+  }
+  
   return v8_ref_new(self, to_v8(data));
 }
 

data/lib/mustang.rb

@@ -11,6 +11,7 @@ require 'mustang/v8/date'
 require 'mustang/v8/regexp'
 require 'mustang/v8/function'
 require 'mustang/v8/external'
+require 'mustang/v8/boolean'
 require 'mustang/v8/error'
 
 require 'mustang/core_ext/object'

data/lib/mustang/v8/array.rb

@@ -16,6 +16,10 @@ module Mustang
       def delegate
         to_a
       end
+
+      def kind_of?(klass)
+        klass == ::Array or super(klass)
+      end
     end # Array
   end # V8
 end # Mustang

data/lib/mustang/v8/boolean.rb

@@ -0,0 +1,45 @@
+module Mustang
+  module V8
+    class Boolean
+      def true?
+        self.is_a?(TrueClass)
+      end
+
+      def false?
+        self.is_a?(FalseClass)
+      end
+
+      def to_s
+        to_bool.to_s
+      end
+
+      def &(other)
+        to_bool & other
+      end
+
+      def |(other)
+        to_bool | other
+      end
+
+      def ^(other)
+        to_bool ^ other
+      end
+
+      def ==(other)
+        to_bool == other
+      end
+
+      def <=>(other)
+        to_bool <=> other
+      end
+
+      def kind_of?(klass)
+        klass == (false? ? false.class : true.class) or super(klass)
+      end
+
+      def to_bool
+        false? ? false : true
+      end
+    end # Boolean
+  end # V8
+end # Mustang

data/lib/mustang/v8/date.rb

@@ -15,6 +15,10 @@ module Mustang
       def delegate
         to_time
       end
+
+      def kind_of?(klass)
+        klass == ::Time or klass == ::Date or klass == ::DateTime or super(klass)
+      end
     end # Date
   end # V8
 end # Mustang

data/lib/mustang/v8/function.rb

@@ -8,6 +8,10 @@ module Mustang
       def to_proc
         origin.to_proc if origin
       end
+
+      def kind_of?(klass)
+        origin.is_a?(klass) or super(klass)
+      end
     end # Function
   end # V8
 end # Mustang

data/lib/mustang/v8/integer.rb

@@ -11,6 +11,10 @@ module Mustang
       def delegate
         to_i
       end
+
+      def kind_of?(klass)
+        klass == ::Fixnum or super(klass)
+      end
     end # Integer
   end # V8
 end # Mustang

data/lib/mustang/v8/number.rb

@@ -11,6 +11,10 @@ module Mustang
       def delegate
         to_f
       end
+
+      def kind_of?(klass)
+        klass == ::Float or super(klass)
+      end
     end # Number
   end # V8
 end # Mustang

data/lib/mustang/v8/regexp.rb

@@ -18,6 +18,10 @@ module Mustang
       def to_regexp
         ::Regexp.new(source, options)
       end
+
+      def kind_of?(klass)
+        klass == ::Regexp or super(klass)
+      end
     end # Regexp
   end # V8
 end # Mustang

data/lib/mustang/v8/string.rb

@@ -22,6 +22,10 @@ module Mustang
       def delegate
         to_s
       end
+
+      def kind_of?(klass)
+        klass == ::String or super(klass)
+      end
     end # String
   end # V8
 end # Mustang

data/mustang.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name = "mustang"
   s.summary = "Awesome V8 JavaScript engine embedded into the Ruby's shiny body"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
   s.authors = ["Chris Kowalik", "Cubox"]
   s.description = "Ruby proxy library for Google V8 Javascript engine."
   s.homepage = "http://github.com/nu7hatch/mustang"

data/spec/mustang/v8/array_spec.rb

@@ -7,6 +7,10 @@ describe Mustang::V8::Array do
   it "inherits Mustang::V8::Object" do
     subject.new(1,2,3).should be_kind_of(Mustang::V8::Object)
   end  
+
+  it "is kind of Array" do
+    subject.new(1,2,3).should be_kind_of Array
+  end
   
   describe ".new" do
     context "when no context entered" do

data/spec/mustang/v8/boolean_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Mustang::V8::Boolean do 
+  subject { Mustang::V8::Boolean }
+  setup_context
+  
+  it "inherits Mustang::V8::Data" do
+    subject.new(10).should be_kind_of(Mustang::V8::Primitive)
+  end
+
+  it "is kind of FalseClass or TrueClass" do
+    Mustang::V8::False.should be_kind_of FalseClass
+    Mustang::V8::True.should be_kind_of TrueClass
+  end
+end
+
+shared_examples_for "Boolean" do
+  describe "#to_bool" do
+    it "returns ruby bool value" do
+      subject.to_bool.should == compare
+    end
+  end
+
+  describe "#true?" do
+    it "returns proper value" do
+      subject.true?.should == (compare == true)
+    end
+  end
+
+  describe "#false?" do
+    it "returns proper value" do
+      subject.false?.should == (compare == false)
+    end
+  end
+
+  describe "#&" do
+    it "acts as ruby bool's method" do
+      (subject & true).should == (compare & true)
+      (subject & false).should == (compare & false)
+    end
+  end
+
+  describe "#|" do
+    it "acts as ruby bool's method" do
+      (subject | true).should == (compare | true)
+      (subject | false).should == (compare | false)
+    end
+  end
+
+  describe "#^" do
+    it "acts as ruby bool's method" do
+      (subject ^ true).should == (compare ^ true)
+      (subject ^ false).should == (compare ^ false)
+    end
+  end
+
+  describe "#==" do
+    it "acts as ruby bool's method" do
+      subject.should == compare
+      subject.should_not == !compare
+    end
+  end
+
+  describe "#to_s" do
+    it "acts as ruby bool's method" do
+      subject.to_s.should == compare.to_s
+    end
+  end
+end
+
+describe Mustang::V8::False do
+  let(:compare) { false }
+  it_should_behave_like "Boolean"
+
+  it "acts as normal bool in conditional statements" do
+    pending
+    (subject ? 'foo' : 'bar').should == 'bar'
+    (!subject ? 'foo' : 'bar').should == 'foo'
+  end
+end
+
+describe Mustang::V8::True do
+  let(:compare) { true }
+  it_should_behave_like "Boolean"
+
+  it "acts as normal bool in conditional statements" do
+    pending
+    (!subject ? 'foo' : 'bar').should == 'bar'
+    (subject ? 'foo' : 'bar').should == 'foo'
+  end
+end

data/spec/mustang/v8/cast_spec.rb

@@ -31,8 +31,8 @@ describe "Typecasting" do
     end
 
     it "converts boolean values properly" do
-      cxt.eval("true", "<eval>").should be_true
-      cxt.eval("false", "<eval>").should be_false
+      cxt.eval("true", "<eval>").should == true
+      cxt.eval("false", "<eval>").should == false
     end
 
     it "converts strings properly" do

data/spec/mustang/v8/date_spec.rb

@@ -12,6 +12,12 @@ describe Mustang::V8::Date do
     subject.new(@now).should be_kind_of(Mustang::V8::Value)
   end
 
+  it "is kind of Date, DateTime, Time" do
+    subject.new(@now).should be_kind_of Date
+    subject.new(@now).should be_kind_of DateTime
+    subject.new(@now).should be_kind_of Time
+  end
+
   describe ".new" do
     context "when no context entered" do
       it "should raise error" do

data/spec/mustang/v8/function_spec.rb

@@ -8,6 +8,10 @@ describe Mustang::V8::Function do
     subject.new(lambda { "foo" }).should be_kind_of(Mustang::V8::Object)
   end
 
+  it "is kind of Proc" do
+    subject.new(proc {}).should be_kind_of Proc
+  end
+
   describe ".new" do
     context "when no context entered" do
       it "should raise error" do

data/spec/mustang/v8/integer_spec.rb

@@ -9,6 +9,10 @@ describe Mustang::V8::Integer do
     subject.new(10).should be_kind_of(Mustang::V8::Number)
   end
 
+  it "is kind of Fixnum" do
+    subject.new(1).should be_kind_of Fixnum
+  end
+
   describe ".new" do
     context "when no context entered" do
       it "should raise error" do

data/spec/mustang/v8/number_spec.rb

@@ -8,6 +8,10 @@ describe Mustang::V8::Number do
     subject.new(10.5).should be_kind_of(Mustang::V8::Primitive)
   end
 
+  it "is kind of Float" do
+    subject.new(10.5).should be_kind_of Float
+  end
+
   describe ".new" do
     it "creates new v8 number based on passed value" do
       subject.new(10.5).should == 10.5

data/spec/mustang/v8/regexp_spec.rb

@@ -8,6 +8,10 @@ describe Mustang::V8::Regexp do
     subject.new(/foo(bar)?/).should be_kind_of(Mustang::V8::Value)
   end
 
+  it "is kind of Regexp" do
+    subject.new(/foo/).should be_kind_of Regexp
+  end
+
   describe ".new" do
     context "when no context entered" do
       it "should raise error" do

data/spec/mustang/v8/string_spec.rb

@@ -9,6 +9,10 @@ describe Mustang::V8::String do
     subject.new("foo").should be_kind_of(Mustang::V8::Primitive)
   end
 
+  it "is kind of String" do
+    subject.new("foo").should be_kind_of String
+  end
+
   describe ".new" do
     context "when no context entered" do
       it "should raise error" do

data/spec/mustang/v8/value_spec.rb

@@ -169,8 +169,8 @@ describe Mustang::V8::Value do
 
   describe "#to_boolean" do
     it "return V8 boolean representation of value" do
-      Mustang::V8::Object.new(:foo => 1).to_boolean.should be_true
-      Mustang::V8::Integer.new(0).to_boolean.should be_false
+      Mustang::V8::Object.new(:foo => 1).to_boolean.should == true
+      Mustang::V8::Integer.new(0).to_boolean.should == false
     end
   end
 

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mustang
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.2.1
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Chris Kowalik
@@ -11,7 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 Z
+date: 2011-04-11 00:00:00 -03:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ore-tasks
@@ -21,6 +27,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
         version: "0.4"
   type: :development
   version_requirements: *id001
@@ -32,6 +42,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
         version: "2.0"
   type: :development
   version_requirements: *id002
@@ -43,6 +57,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
         version: "0.9"
   type: :development
   version_requirements: *id003
@@ -54,6 +72,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
         version: "0.7"
   type: :development
   version_requirements: *id004
@@ -78,6 +100,8 @@ files:
 - ext/v8/v8_array.h
 - ext/v8/v8_base.cpp
 - ext/v8/v8_base.h
+- ext/v8/v8_boolean.cpp
+- ext/v8/v8_boolean.h
 - ext/v8/v8_cast.cpp
 - ext/v8/v8_cast.h
 - ext/v8/v8_context.cpp
@@ -115,6 +139,7 @@ files:
 - lib/mustang/errors.rb
 - lib/mustang/support/delegated.rb
 - lib/mustang/v8/array.rb
+- lib/mustang/v8/boolean.rb
 - lib/mustang/v8/context.rb
 - lib/mustang/v8/date.rb
 - lib/mustang/v8/error.rb
@@ -132,6 +157,7 @@ files:
 - spec/mustang/core_ext/object_spec.rb
 - spec/mustang/core_ext/symbol_spec.rb
 - spec/mustang/v8/array_spec.rb
+- spec/mustang/v8/boolean_spec.rb
 - spec/mustang/v8/cast_spec.rb
 - spec/mustang/v8/context_spec.rb
 - spec/mustang/v8/data_spec.rb
@@ -1577,6 +1603,7 @@ files:
 - vendor/v8/tools/visual_studio/v8_x64.vcproj
 - vendor/v8/tools/visual_studio/x64.vsprops
 - vendor/v8/tools/windows-tick-processor.bat
+has_rdoc: true
 homepage: http://github.com/nu7hatch/mustang
 licenses: 
 - MIT
@@ -1591,17 +1618,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Awesome V8 JavaScript engine embedded into the Ruby's shiny body
@@ -1612,6 +1645,7 @@ test_files:
 - spec/mustang/core_ext/object_spec.rb
 - spec/mustang/core_ext/symbol_spec.rb
 - spec/mustang/v8/array_spec.rb
+- spec/mustang/v8/boolean_spec.rb
 - spec/mustang/v8/cast_spec.rb
 - spec/mustang/v8/context_spec.rb
 - spec/mustang/v8/data_spec.rb