duktape 1.3.0.4 → 1.3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a83f9f94bcb9062672ab5f4b394379b3c6b3bb3a
-  data.tar.gz: 61109c31d8865a66852a004a4a393c1edb72ca7b
+  metadata.gz: 28cb600087093cad9368ab6b897a04c555f17572
+  data.tar.gz: f768cc0a2b9d71f6a4df6dbed8a216ef5a8b7acb
 SHA512:
-  metadata.gz: 6564704f5eaa7bdfd87894ba1bb70d854d2818a68740d984fe96e4f249fe2991ce4369a91bbeadb4538cbe09f2cb00572a94221339d73ec328c825776978d9c3
-  data.tar.gz: 9f42fbed534b7c41ff92dfac44a08227301e701297eea9cbc7c6d7f7ca07ae89465aebe630e0c82d05ecf1d77ef11b5b4f7411de1ba99a3d95e292748540f540
+  metadata.gz: 505392082298a898dfe7658e5d518deeba13843edd47c31c55a57a14aa71e555b42adab9c8433e48406f974b9d6de345a53b3743d33980270159fef0215018df
+  data.tar.gz: 20ca551193c9403aa527804963487249b889f505483a11efeab923aa28aee902e96140f95cf7b8f7f263ebf7984cbc2aff7ed67cbf15b265f4fe555864c4c6ea

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # ChangeLog
 
+## v1.3.0.6 (2016-03-27)
+
+* Implement `#define_function` (#16, judofyr, did)
+
+## v1.3.0.5 (2016-01-22)
+
+* Convert symbols to strings (judofyr, Jean-Baptiste Aviat)
+
 ## v1.3.0.4 (2015-11-23)
 
 * Support Illumos and Solaris (#33, F4S4K4N)

data/README.md

@@ -52,6 +52,17 @@ ctx.call_prop('process', 'some data', a: 1, b: 2)
 - `call_prop`   - Call a defined function with the given parameters and return
                   the value as a Ruby Object.
 
+### Defining functions
+
+You can define simple functions in Ruby that can be called from
+JavaScript:
+
+```ruby
+ctx.define_function("leftpad") do |str, n, ch=' '|
+  str.rjust(n, ch)
+end
+```
+
 ### Exceptions
 
 Executing JS may raise two classes of errors: `Duktape::Error` and

data/ext/duktape/duktape_ext.c

@@ -40,6 +40,7 @@ struct state {
   duk_context *ctx;
   VALUE complex_object;
   int was_complex;
+  VALUE blocks;
 };
 
 static void ctx_dealloc(void *ptr)
@@ -52,6 +53,7 @@ static void ctx_dealloc(void *ptr)
 static void ctx_mark(struct state *state)
 {
   rb_gc_mark(state->complex_object);
+  rb_gc_mark(state->blocks);
 }
 
 static VALUE ctx_alloc(VALUE klass)
@@ -67,6 +69,7 @@ static VALUE ctx_alloc(VALUE klass)
   struct state *state = malloc(sizeof(struct state));
   state->ctx = ctx;
   state->complex_object = oComplexObject;
+  state->blocks = rb_ary_new();
   return Data_Wrap_Struct(klass, ctx_mark, ctx_dealloc, state);
 }
 
@@ -255,6 +258,14 @@ static void ctx_push_ruby_object(struct state *state, VALUE obj)
       duk_push_number(ctx, NUM2DBL(obj));
       return;
 
+    case T_SYMBOL:
+#ifdef HAVE_RB_SYM2STR
+      obj = rb_sym2str(obj);
+#else
+      obj = rb_id2str(SYM2ID(obj));
+#endif
+      // Intentional fall-through:
+
     case T_STRING:
       str = encode_cesu8(state, obj);
       duk_push_lstring(ctx, RSTRING_PTR(str), RSTRING_LEN(str));
@@ -298,8 +309,15 @@ static int ctx_push_hash_element(VALUE key, VALUE val, VALUE extra)
   struct state *state = (struct state*) extra;
   duk_context *ctx = state->ctx;
 
-  Check_Type(key, T_STRING);
-  duk_push_lstring(ctx, RSTRING_PTR(key), RSTRING_LEN(key));
+  switch (TYPE(key)) {
+    case T_SYMBOL:
+    case T_STRING:
+      ctx_push_ruby_object(state, key);
+      break;
+    default:
+      clean_raise(ctx, rb_eTypeError, "invalid key type %s", rb_obj_classname(key));
+  }
+
   ctx_push_ruby_object(state, val);
   duk_put_prop(ctx, -3);
   return ST_CONTINUE;
@@ -519,6 +537,80 @@ static VALUE ctx_call_prop(int argc, VALUE* argv, VALUE self)
   return res;
 }
 
+static duk_ret_t ctx_call_pushed_function(duk_context *ctx) {
+  VALUE block; // the block to yield
+  struct state *state;
+  int nargs = duk_get_top(ctx); // number of arguments of the block (arity)
+  VALUE args = rb_ary_new(); // the block to yield needs an array of arguments
+  VALUE result; // the result returned by yielding the block
+
+  duk_push_current_function(ctx);
+
+  // get the block which is a property of the pushed function
+  duk_get_prop_string(ctx, -1, "block");
+  block = (VALUE) duk_get_pointer(ctx, -1);
+  duk_pop(ctx);
+
+  // get the state so that we don't need to a create a new one
+  duk_get_prop_string(ctx, -1, "state");
+  state = (struct state *) duk_get_pointer(ctx, -1);
+  duk_pop(ctx);
+
+  // before pushing each argument to the array, each one needs to be converted into a ruby value
+  for (int i = 0; i < nargs; i++)
+    rb_ary_push(args, ctx_stack_to_value(state, i));
+
+  result = rb_proc_call(block, args); // yield
+  ctx_push_ruby_object(state, result);
+
+  return 1;
+}
+
+/*
+ * call-seq:
+ *   ctx_define_function(name, &block) -> nil
+ *
+ * Define a function defined in the global scope and identified by a name.
+ *
+ *     ctx.ctx_define_function("hello_world") { |ctx| 'Hello world' } #=> nil
+ *
+ */
+static VALUE ctx_define_function(VALUE self, VALUE prop)
+{
+  VALUE block;
+  struct state *state;
+  duk_context *ctx;
+
+  // a block is required
+  if (!rb_block_given_p())
+    rb_raise(rb_eArgError, "Expected block");
+
+  // get the context
+  Data_Get_Struct(self, struct state, state);
+  ctx = state->ctx;
+
+  // the c function is available in the global scope
+  duk_push_global_object(ctx);
+
+  duk_push_c_function(ctx, ctx_call_pushed_function, DUK_VARARGS);
+
+  block = rb_block_proc();
+  rb_ary_push(state->blocks, block); // block will be properly garbage collected
+
+  // both block and state are required by the pushed function
+  duk_push_string(ctx, "block");
+  duk_push_pointer(ctx, (void *) block);
+  duk_def_prop(ctx, -3,  DUK_DEFPROP_HAVE_VALUE | DUK_DEFPROP_HAVE_WRITABLE | 0);
+
+  duk_push_string(ctx, "state");
+  duk_push_pointer(ctx, (void *) state);
+  duk_def_prop(ctx, -3,  DUK_DEFPROP_HAVE_VALUE | DUK_DEFPROP_HAVE_WRITABLE | 0);
+
+  duk_put_prop_string(ctx, -2, StringValueCStr(prop));
+
+  return Qnil;
+}
+
 /*
  * :nodoc:
  *
@@ -624,6 +716,7 @@ void Init_duktape_ext()
   rb_define_method(cContext, "exec_string", ctx_exec_string, -1);
   rb_define_method(cContext, "get_prop", ctx_get_prop, 1);
   rb_define_method(cContext, "call_prop", ctx_call_prop, -1);
+  rb_define_method(cContext, "define_function", ctx_define_function, 1);
   rb_define_method(cContext, "_valid?", ctx_is_valid, 0);
 
   oComplexObject = rb_obj_alloc(cComplexObject);

data/ext/duktape/extconf.rb

@@ -2,5 +2,6 @@ require 'mkmf'
 require 'zlib'
 
 $CFLAGS += ' -std=c99'
+have_func 'rb_sym2str'
 create_makefile 'duktape_ext'
 

data/lib/duktape/version.rb

@@ -1,3 +1,3 @@
 module Duktape
-  VERSION = "1.3.0.4"
+  VERSION = "1.3.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duktape
 version: !ruby/object:Gem::Version
-  version: 1.3.0.4
+  version: 1.3.0.6
 platform: ruby
 authors:
 - Magnus Holm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-03-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: judofyr@gmail.com