h8 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7353dcd3c307b93e4f7fd68ccbc7af260e51d09c
-  data.tar.gz: 8603a9cfb342305c5dfcf156bf92d595bde23a34
+  metadata.gz: a72940e0db998af017aa93553d91b90eefe2662c
+  data.tar.gz: b2d87d6c19c23c983cdc00b60bf874d921133f29
 SHA512:
-  metadata.gz: 94056bd7b5378d50ceefd3322479e38b3eb122ee019a0c4ce4a9531bb447fa062e26393c4a5738d97138eaf973a6627b55002126850133fe59c6a9b652028c96
-  data.tar.gz: b1a98f23583bc8cb77ffd35bae2cb1f3d71ea6b9e6f6553149ee2162b468ff9474654d6069d5aa68bb8c0cd97713b26caa24b08604f4b52bbd8b8cca92cc5eb5
+  metadata.gz: 713eedbe21d86dcaeac35d3d3d052af41bb36fc9ff434c096fa1c15f95299194c1fce45945150ac8f8ad77fb8732fa2acbbe7e6c9a4d37aa6fca82e3cf075387
+  data.tar.gz: d0ff9c201ae06798b57d1c80bcb471f72a5bc29b8e4e3404b33df1ec689422472efc2e547836df50846f955d6aca441e2ab81488853d3e26af25f63ab85dec15

data/.gitignore

@@ -20,3 +20,11 @@ tmp
 *.o
 *.a
 mkmf.log
+.cproject
+.project
+.DS_Store
+.idea
+.ruby-version
+.*swp
+.*swo
+

data/README.md

@@ -1,7 +1,8 @@
 # Hybrid8, aka H8
 
-_Warning_ this gem has yet limited functionality and is under main development. Versions suitable
-for an open beta test will start from 0.1.*.
+_Warning_ this gem functionality is almost complete but it lacks of testing and some features
+(see below). This is a working (or better say, test passing) alpha. Beta suitable versions
+will start from 0.1.*.
 
 Therubyracer gem alternative to effectively work with ruby 2.1+ in multithreaded environment in an
 effective and GC-safe way. Should be out of the box replacement for most scenarios.
@@ -16,6 +17,29 @@ javascript context
 while there are ruby objects referencing it. It also means that once created H8::Context will not
 be reclaimed as long as there is at least one active wrapped object returned from the script.
 
+- you can pass ruby objects from ruby code called from javascript back to the ruby code intact.
+Ruby objects are automatically wrapped in js code and unwrapped in ruby code (you might need to
+call #to_ruby)
+
+- Uncaught ruby exceptions are thrown as javascript exceptions in javascript code. The same,
+uncaught javascript exceptions raise ruby error in ruby code.
+
+## Main difference from therubyracer/features not ready
+
+*This version is not (yet?) thread safe*. For the sake of effectiveness, do not access same
+H8::Context and its returned values from concurrent threads. Use Mutexes!
+
+- correct and accurate object tracking in both JS and Ruby VMs, GC aware.
+
+- passed thru objects and exceptions in js -> ruby -> js -> ruby chains are usually kept unchanged,
+e.g. wrapped in one language then unwrapped when passed to the original language
+
+- Not Yet: source information in uncaught exception in js
+
+- Script is executed in the calling ruby thread without unblocking it (for the sake of
+effectiveness). If we would release GIL and reacquire it, it would take more time. And there is no
+multithreading support yet (this one might be added soon).
+
 ## Installation
 
 ### Prerequisites
@@ -23,6 +47,33 @@ be reclaimed as long as there is at least one active wrapped object returned fro
 You should have installed libv8, use latest version with v8::Isolate and v8::Locker. This version
 may not find you installation, contact me if you have problems, I'll tune it up.
 
+#### Macos (10.9 maybe+)
+
+The working process:
+
+install v8 from sources 3.31.77 (or try newer), then execute:
+
+    gclient update
+    export CXXFLAGS='-std=c++11 -stdlib=libc++ -mmacosx-version-min=10.9'
+    export LDFLAGS=-lc++
+    make native
+    exportexport V8_3_31_ROOT=`pwd` # or somehow else set it
+
+Note that exporting symbols is a hack that may not be in need anymore. After that the gem should
+install normally.
+
+#### Debian and like
+
+Install first a valid v8 version. We provide a ready package!
+
+    sudo apt-get install libv8-3.31-dev
+
+It should install prerequisites, if not, manually install
+
+   sudo apt-get install libicu-dev
+
+You might also need to install GMP.
+
 ### Setting up
 
 Add this line to your application's Gemfile:
@@ -93,3 +144,5 @@ wheel.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+

data/ext/h8/JsCatcher.cpp

@@ -0,0 +1,24 @@
+/*
+ * JsCatcher.cpp
+ *
+ *  Created on: Dec 23, 2014
+ *      Author: sergeych
+ */
+
+#include "JsCatcher.h"
+
+namespace h8 {
+
+
+JsCatcher::JsCatcher(H8* h8) : h8(h8), v8::TryCatch(h8->getIsolate()) {}
+
+void JsCatcher::throwIfCaught() {
+	if( HasCaught() ) {
+		if( !CanContinue() && HasTerminated() ) {
+			throw JsTimeoutError(h8);
+		}
+		throw JsError(h8, Message(), Exception());
+	}
+}
+
+} /* namespace h8 */

data/ext/h8/JsCatcher.h

@@ -0,0 +1,29 @@
+/*
+ * JsCatcher.h
+ *
+ *  Created on: Dec 23, 2014
+ *      Author: sergeych
+ */
+
+#ifndef JSCATCHER_H_
+#define JSCATCHER_H_
+
+#include <include/v8.h>
+#include "h8.h"
+
+namespace h8 {
+
+class H8;
+
+class JsCatcher : public v8::TryCatch {
+public:
+	JsCatcher(H8* h8);
+
+	void throwIfCaught();
+private:
+	H8* h8;
+};
+
+} /* namespace h8 */
+
+#endif /* JSCATCHER_H_ */

data/ext/h8/allocated_resource.h

@@ -0,0 +1,37 @@
+#ifndef __allocated_resource
+#define __allocated_resource
+
+#include "chain.h"
+
+namespace h8 {
+
+/**
+ * Resource that allocates anything that is tied to Isolate and should be
+ * freed _before_ isolate is destroyed.
+ *
+ * (1) derive any of such your resources from it
+ * (2) register them in the parent H8 (h8->add_resource())
+ * (3) free() resource in free(), then call unlink()/super
+ * (4) free all resources in the destructor if any.
+ */
+class AllocatedResource : public chain::link {
+public:
+	/**
+	 * If your resource references any ruby object, be sure to mark them
+	 * all overriding this method!
+	 */
+	virtual void rb_mark_gc() {};
+
+	virtual void free() {
+		unlink();
+	};
+
+	/* Default implementation does nothing but call unlink throgh parent
+	 * destructor
+	 */
+	virtual ~AllocatedResource() {};
+};
+
+}
+
+#endif

data/ext/h8/chain.h

@@ -0,0 +1,191 @@
+#ifndef __chain_h
+#define __chain_h
+
+#include <assert.h>
+
+/**
+ * Copyright (C) by Sergey S. Chernov, iCodici S.n.C
+ *
+ * Free software under MIT license.
+ *
+ * Extremely fast minimalistic double linked list.
+ *
+ * List item derives from chain::link. List item can not be inserted in
+ * more than one list. Linking chain::link into other list removes it
+ * from any other list. Unlinked chain::link links to self.
+ *
+ * Not thread safe! Inserting and removing in any position of the list
+ * is O(1) operation, iterating is O(N) operation.
+ *
+ * Typical usages:
+ *
+ * minimal:
+ *     Use any chain::link instance as a root of you list. You can do
+ *     everything with it without creating chain instance
+ *
+ * typical:
+ * 	   create chain instance and feed it with chain::instance derivatives.
+ * 	   does the same as above but provide more commonly used unterface
+ * 	   (actually it is a wrapped chain::link item)
+ */
+class chain {
+public:
+	class link;
+
+	/**
+	 * Iterator that can iterate over either chain or even chain::link
+	 * item (in which case it iterates from a given link and traverses
+	 * all the list
+	 */
+	class iterator {
+	public:
+		iterator(link *start) :
+				current(start) {
+		}
+
+		bool operator !=(const iterator& other) const {
+			return current != other.current;
+		}
+
+		const iterator& operator++() {
+			current = current->next;
+			return *this;
+		}
+
+		link* operator*() const {
+			return current;
+		}
+
+	private:
+		link *current;
+	};
+
+	/**
+	 * chain list item. Can be used as a list itself: can be iterated, can insert items,
+	 * can provide head and tail items and any of its linked items can be easily removed
+	 */
+	class link {
+	public:
+		/// Create empty list item (which is locked to itself)
+		link() {
+			next = prev = this;
+		}
+
+		/// Leave whatever chain it is in (or do nothing)
+		void unlink() {
+			next->prev = prev;
+			prev->next = next;
+			next = prev = this;
+		}
+
+		// Insert in the chain after the specified item
+		void link_after(link *left) {
+			unlink();
+			next = left->next;
+			left->next = this;
+			prev = left;
+			next->prev = this;
+		}
+
+		/**
+		 * @return true if this is the only item in the list (this is not connected
+		 *         to any other item)
+		 */
+		bool is_disconnected() const {
+			return next == prev && next == this;
+		}
+
+		/**
+		 * Get the next item in the list.
+		 *
+		 * @return this if the list is empty
+		 */
+		template<class T>
+		T* get_next() {
+			return (T*) (next);
+		}
+
+		/**
+		 * Get the previous item in the list.
+		 *
+		 * @return this if the list is empty
+		 */
+		template<class T>
+		T* get_prev() {
+			return (T*) (prev);
+		}
+
+		~link() {
+			unlink();
+		}
+
+		chain::iterator begin() const {
+			return iterator(next);
+		}
+
+		chain::iterator end() const {
+			return iterator(const_cast<link*>(this));
+		}
+
+	private:
+		link *next, *prev;
+		friend class chain;
+	};
+
+	iterator begin() const {
+		return root.begin();
+	}
+
+	iterator end() const {
+		return root.end();
+	}
+
+	/**
+	 * Add item to the tail of the list
+	 */
+	void push(link* item) {
+		item->link_after(root.prev);
+	}
+
+	void push_first(link* item) {
+		item->link_after(&root);
+	}
+
+	template<class T>
+	T* peek_first() {
+		return (T*) root.next;
+	}
+
+	template<class T>
+	T* peek_last() {
+		return (T*) root.prev;
+	}
+
+	/**
+	 * Convenience method: removes head item (if any) and returns it.
+	 * Actually, you can get any item from the list (using peek_head(), peek_tail() or iterating
+	 * the list) and then remove it from the list (@see chain::link#unlink()) - it is effective and
+	 * simple way.
+	 *
+	 * @return detached head item or NULL
+	 */
+	template<class T>
+	T* pop() {
+		if (root.is_disconnected())
+			return 0;
+		link *first = root.next;
+		first->unlink();
+		return (T*) first;
+	}
+
+	bool is_empty() const {
+		return root.is_disconnected();
+	}
+
+private:
+	// Root item default constructor is enough
+	link root;
+
+};
+
+#endif

data/ext/h8/extconf.rb

@@ -16,44 +16,63 @@
 
 require "mkmf"
 
+cxx11flag = " --std=c++11"
+
+$CXXFLAGS = CONFIG["CXXFLAGS"] unless defined?($CXXFLAGS)
+$CXXFLAGS += cxx11flag unless $CXXFLAGS.include?(cxx11flag)
 
 abort 'missing malloc()' unless have_func 'malloc'
 abort 'missing free()' unless have_func 'free'
 
-# Give it a name
-extension_name = 'h8'
-
-dir_config('v8', '/Users/sergeych/dev/v8', '/Users/sergeych/dev/v8/lib')
-
-dir_config(extension_name)
-ok = true
-
-unless have_header('include/v8.h')
-  $stderr.puts "can't find v8.h, install libv8 3.25.30+ first"
-  ok = false
-end
-
-unless have_library('v8_base') && have_library('v8_snapshot') && have_library('v8_libplatform') \
-  && have_library('v8_libbase') && have_library('icuuc') && have_library('icudata')
-  $stderr.puts "can't find libv8"
-  ok = false
-end
-
+begin
+
+  # Give it a name
+  extension_name = 'h8'
+
+  chk_headers = ['include/v8.h']
+  chk_libs    = %w(v8_base v8_libbase v8_libplatform v8_snapshot icudata icui18n icuuc)
+
+  case RbConfig::CONFIG['target_os']
+    when /darwin/
+      v8_path = ENV['V8_3_31_ROOT'] or raise "Please give me export V8_3_31_ROOT=..."
+      # dir_config('v8', '/Users/sergeych/dev/v8', '/Users/sergeych/dev/v8/out/native')
+      dir_config('v8', v8_path, v8_path+'/out/native')
+      CONFIG['CXXFLAGS'] += ' --std=c++11'
+    else
+      # example linux package https://github.com/porzione/v8-git-debian
+      dir_config('v8', '/usr/include/libv8-3.31', '/usr/lib/libv8-3.31')
+      # force static, but system icu
+      $LOCAL_LIBS = chk_libs.reject { |l| l.match /^icu/ }.map { |l| "-l#{l}" }.join(" ")
+  end
+
+  dir_config(extension_name)
+
+  chk_headers.each do |h|
+    unless have_header(h)
+      raise "can't find v8 header '#{h}', install libv8 3.31+ first"
+    end
+  end
+
+  chk_libs.each do |lib|
+    unless have_library(lib)
+      raise "can't find v8 lib '#{lib}'"
+    end
+  end
 
 # This test is actually due to a Clang 3.3 shortcoming, included in OS X 10.9,
 # fixed in Clang 3.4:
 # http://llvm.org/releases/3.4/tools/clang/docs/ReleaseNotes.html#new-compiler-flags
-if try_compile('', '-O6')
-  $CFLAGS += ' -Wall -W -O6 -g'
-else
-  $CFLAGS += ' -Wall -W -O3 -g'
-end
-
-CONFIG['CXXFLAGS'] += " --std=c++11"
+# if try_compile('', '-O6')
+#   $CFLAGS += ' -Wall -W -O6 -g'
+# else
+#   $CFLAGS += ' -Wall -W -O3 -g'
+# end
 
-if ok
+# create_makefile('h8/h8')
   create_makefile(extension_name)
-else
+rescue
+  $stderr.puts "*********************************************************************"
+  $stderr.puts "\n#{$!}\n\n"
   $stderr.puts "*********************************************************************"
   $stderr.puts "Your compiler was unable to link to all necessary libraries"
   $stderr.puts "Please install all prerequisites first"
@@ -62,7 +81,7 @@ else
   raise "Unable to build, correct above errors and rerun"
 end
 
-# LIBV8_COMPATIBILITY = '~> 3.30'
+# LIBV8_COMPATIBILITY = '~> 3.31'
 #
 # begin
 #   require 'rubygems'
@@ -77,5 +96,4 @@ end
 #
 # Libv8.configure_makefile
 
-create_makefile('h8/h8')