execjs-xtrn 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4abcfd3f47329826a53b863835a51592f1dc1030
-  data.tar.gz: e96571ef15e4fe0b91a86a2e461cbdef62e42f29
+  metadata.gz: 8754e3aa4bbca96de99f7b970259186ab5791bd0
+  data.tar.gz: 3cbcbdba3d22e45da939f7d52b94c449bd77a2d1
 SHA512:
-  metadata.gz: 2842042b3e8091e0caa59f5943635579c673c291d11cd831afb42e08797b26b8a55045c79c72a5e7b886a8ba3037fcf10b42b92c5a37b1faaadcbea8d08cb672
-  data.tar.gz: 6328d3e668706b3282a4050ff614050254a0c20f9923219a8d56ff53631f17fdf6776bb4f7496b0e9585f5c819848a234087344353cf99b071ba6cac8f404f4c
+  metadata.gz: 0d29c2822c4e601d959ab6330d605bfbd2af5633c75dd4af16c31ecb894e40b4231fdf9ff51f15ec80d270175fb70e916a1fff86259711e772b9cfe0b49ddc89
+  data.tar.gz: 2b08bbcb400b3da6a9376351ce54b5c04f9dd4ceb5b464df03e93d7bebbe4eaf34d5c75016791bdaeac7212b67b83c9f0303ca731d370e5d70617ee85fa0842f

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.1
-  - 2.0.0
+  - '2.2'
+  - '2.1'
+  - '2.0'
   - 1.9.3
   - 1.9.2
 before_install:

data/FarMenu.ini

@@ -1,10 +1,11 @@
-i:  Bundle install
-    bundle install -new_console:c
-n:  Npm install
-    bundle exec rake npm -new_console:c
---:
-t:  Run tests
-    bundle exec rake -new_console:c
---:
-b:  Build
-    bundle exec rake build -new_console:c
+I:  Install dependencies
+    bundle install
+    bundle exec rake npm
+--:
+T:  Run tests
+    bundle exec rake -new_console:c
+C:  Console
+    bundle console -new_console
+--:
+B:  Build
+    bundle exec rake build -new_console:c

data/README.md

@@ -39,6 +39,8 @@ ExecJS::Xtrn uses two external JavaScript runners:
     - Simple (1 execution context = 1 external process)
     - Nvm (all execution contexts share single external process using [vm API](http://nodejs.org/api/vm.html))
 
+Nvm engine has nothing common with [nvm](https://github.com/creationix/nvm).
+
 So, there exist *four* engines:
 
   * Engine - absctract engine (smart enough to execute blank lines)
@@ -71,28 +73,66 @@ In general one should create instance of an Engine and then feed it with JavaScr
 ```ruby
 ctx=ExecJS::Xtrn::Wsh.new
 ctx.exec 'fact = function(n){return n>1 ? n*fact(n-1) : 1}'
-puts "10!=#{ctx.call 'fact', 10}"
+puts "10! = #{ctx.call 'fact', 10}"
 ```
-Every execution context has three methods:
-  * exec('`code`') -  executes arbitrary JavaScript code. To get result `return` must be called.
-  * eval('`expression`') - evaluate JavaScript expression. `return` is not needed
+Every execution context has four methods:
+  * exec(`code`) -  executes arbitrary JavaScript code. To get result `return` must be called
+  * load(`code`) or load(`path`) - exec that can load its code from file
+  * eval(`expression`) - evaluate JavaScript expression. `return` is not needed
   * call(`function`, arguments...) - special form of eval for function call
 
-Engine class also has exec and eval methods, they just create brand new execution context,
-pass argument to it, destroy that context and return its result. Using these class methods
-is not recommended, since it's just what ExecJS does (except for Nvm engine).
+There are `exec` and `eval` methods in Engine class,
+they just create brand new execution context,
+pass argument to it, destroy that context and return its result.
+Using these class methods is not recommended, since it's just what ExecJS does
+(except for Nvm engine).
 
-Engine class also has compile method that combines `new` and `exec` and returns execution context.
+Engine class also has `compile` method that combines `new` and `exec`
+and returns execution context.
 This is how ExecJS is used in most cases.
 
 ```ruby
 ctx=ExecJS::Xtrn::Wsh.compile 'fact = function(n){return n>1 ? n*fact(n-1) : 1}'
-puts "10!=#{ctx.call 'fact', 10}"
+puts "10! = #{ctx.call 'fact', 10}"
 ```
+And `load` methods is likewise combination of `new`+`load`,
+it is `compile` that can load its code from file.
+
+`load` method (class' or instance's) detects whether its argument
+is code or path by first symbols of it. So, start path with `/`, `./`
+or `../` (but not from `//`). On Windows `\` and `C:` can be also used.
 
-And finally ExecJS::Xtrn patches ExecJS and installs those 3 class methods (exec, eval, compile) in it.
+Finally ExecJS::Xtrn patches ExecJS and installs those 4 class methods
+(`exec`, `eval`, `compile` and `load`) in it.
 So, `ExecJS.compile` is `ExecJS::Xtrn::Nvm.compile` if Nvm engine is available.
 
+## Preloading
+
+Sometimes it's neccesary to initialize all execution contexts before passing
+code to them.
+For instance, add some standard JavaScript methods missing in Wsh engine.
+
+It can be done by setting Preload constant on engine class.
+
+```ruby
+ExecJS::Xtrn::Wsh::Preload='./lib/js/map.js'
+```
+or maybe
+
+```ruby
+ExecJS::Xtrn::Wsh::Preload=[
+  './lib/js/map.js',
+  './lib/js/keys.js',
+  'console={log: function(){WScript.Echo([].slice.call(arguments).join(" "))}}'
+  ]
+# Yes, console.log is avaialable in Wsh now!
+# And yes, console.log can be used in ExecJS::Xtrn!
+```
+You can add preload scripts to any engine or to Engine base class.
+They will be loaded according to inheritance:
+Engine::Preload will be used by all engines,
+Node::Preload is for Node and Nvm, while Nvm::Preload is for Nvm only.
+
 ## Overriding ExecJS
 
 Sometimes ExecJS is required after ExecJS::Xtrn. In that case you can call ExecJS::Xtrn.init and
@@ -130,6 +170,15 @@ s.stats
 ```
 but c (and m, x) fields are omitted there.
 
+If ExecJS::Xtrn detects it is run under Ruby on Rails,
+it installs additional path `/rails/jsx' to display its statistics
+(you can see that route in sextant, for example).
+
+It is one more reason not to use ExecJS::Xtrn in production mode ;-)
+
+By default statistics is output in YAML format, but you can
+get `/rails/jsx.json` or `/rails/jsx.html`.
+
 ## Compatibilty
 
 Not every JavaScript code behaves identically in ExecJS and ExecJS::Xtrn. In most cases it depends on how
@@ -148,7 +197,8 @@ The following packages have been tested to run under ExecJS::Xtrn out-of-box:
 
 CoffeeScript since v1.9.0 introduces new incompatibility:
 it uses `Object.create` that is missing from WSH.
-To fix it, `Object.create` was manually defined in ExecJS::Xtrn::Wsh.
+To fix it, `Object.create` was manually defined in ExecJS::Xtrn::Wsh
+(sort of [ExecJS::Xtrn::Wsh::Preload](#preloading))
 
 ## Testing
 

data/lib/execjs/wsh/repl.js

@@ -48,7 +48,7 @@ function oCreate()
   if(Object.create) return
   Object.create=function(proto)
   {
-    f=function(){}
+    function f(){}
     f.prototype=proto
     return new f
   }

data/lib/execjs/xtrn.rb

@@ -1,4 +1,4 @@
-%w(wsh nvm).each{|x| require_relative "xtrn/#{x}"}
+require_relative "xtrn/rails"
 
 module ExecJS::Xtrn
 

data/lib/execjs/xtrn/engine.rb

@@ -19,6 +19,13 @@ class ExecJS::Xtrn::Engine
     result['ok']
   end
 
+  PathX=[/^[.]{1,2}\/|^\/(?![\/*])/]
+  PathX << /^[.]{0,2}\\|^\w:./ if Gem.win_platform?
+
+  def load code
+    exec PathX.find{|re| re.match code} ? File.read(code) : code
+  end
+
   def eval(code)
     return if (code=code.to_s.strip).length==0
     exec "return eval(#{JSON.generate([code])[1...-1]})"
@@ -40,6 +47,10 @@ class ExecJS::Xtrn::Engine
     new.tap{|ctx| ctx.exec code}
   end
 
+  def self.load code
+    new.tap{|ctx| ctx.load code}
+  end
+
   def self.stats
     (@stats||{}).dup
   end
@@ -60,4 +71,11 @@ class ExecJS::Xtrn::Engine
     child
   end
 
+  def initialize
+    self.class.ancestors.reverse.map do |m|
+      list=m.const_get 'Preload', false rescue nil
+      list ? Array===list ? list : [list] : []
+    end
+    .flatten.uniq.each{|code| load code}
+  end
 end

data/lib/execjs/xtrn/rails.rb

@@ -0,0 +1,2 @@
+require_relative 'wsh'
+require_relative 'routing' if defined? Rails::Application

data/lib/execjs/xtrn/routes.rb

@@ -0,0 +1,3 @@
+Rails::application.routes.draw do
+  get "/rails/jsx" => ExecJS::Xtrn::Rack
+end

data/lib/execjs/xtrn/routing.rb

@@ -0,0 +1,45 @@
+module ExecJS::Xtrn::Rack
+  Formats=YAML.load <<-EOY
+    -:
+      mime: text/x-yaml
+      dump: YAML
+    json:
+      mime: appication/json
+      dump: JSON
+    html:
+      mime: text/html
+      dump: self
+  EOY
+
+  Formats.each {|k, v| v['dump']=instance_eval v['dump']}
+
+  def self.stats
+    ExecJS::Xtrn.stats.as_json
+  end
+
+  def self.call req
+    f=Formats[req['action_dispatch.request.path_parameters'][:format]] ||
+      Formats['-']
+    [
+      200,
+      {"Content-Type"=> f['mime']},
+      [f['dump'].dump(stats)],
+    ]
+  end
+
+  # Dump as HTML
+  def self.dump s
+    '<ul>'+
+    s.map do |k, v|
+      "<li><b>#{k}</b>#{Hash===v ? dump(v) : ": #{v}"}</li>"
+    end
+    .join('')+'</ul>'
+  end
+end
+
+class Rails::Application
+  initializer :execjs_xtrn_stats do
+    Rails.application.routes_reloader.paths <<
+      File.expand_path('../routes.rb', __FILE__)
+  end
+end

data/lib/execjs/xtrn/version.rb

@@ -1,5 +1,5 @@
 module ExecJS
   module Xtrn
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/execjs/xtrn/wsh.rb

@@ -1,4 +1,4 @@
-require_relative 'engine'
+require_relative 'nvm'
 
 class ExecJS::Xtrn::Wsh < ExecJS::Xtrn::Engine
 

data/test/engine.rb

@@ -6,6 +6,8 @@ class TestEngine < Minitest::Test
 
   Spawn=5
   Engines=M::Engines
+  Engines.each{|e| e::Preload=[]}
+  M::Engine::Preload=[]
 
   def shag_methods
     refute @engine.exec <<-EOJ
@@ -17,6 +19,12 @@ class TestEngine < Minitest::Test
     assert_equal 89, @engine.eval('fib(10)')
     assert_equal 8,  @engine.call('fib', 5)
     assert_equal 79, @engine.call('Math.max', 44, 27, 79, 73, 42, 4, 23, 24, 36, 13)
+
+    assert_raises(M::Error){ @engine.eval '_load' }
+    @engine.load File.expand_path '../load.js', __FILE__
+    assert_equal ({}), @engine.eval('_load')
+    @engine.load '_load.a=108'
+    assert_equal ({"a"=>108}), @engine.eval('_load')
   end
 
   def shag_vars
@@ -62,6 +70,29 @@ class TestEngine < Minitest::Test
     assert_equal 6, x.call('inc', 5)
   end
 
+  def klas_load
+    z=@class.load File.expand_path '../load.js', __FILE__
+    assert_equal ({}), z.eval('_load')
+  end
+
+  def klas_preload
+    res=@class.name[-1]
+    res='em' if 'm'==res
+
+    Spawn.times do
+      begin
+        Engines.shuffle.each{|e| e::Preload << "_preload.#{e.name[-1]}=1"}
+        M::Engine::Preload << '!function(){this._preload={}}()'
+
+        assert_equal res, @class.eval('_preload').keys*''
+
+      ensure
+        Engines.each{|e| e::Preload.clear}
+        M::Engine::Preload.clear
+      end
+    end
+  end
+
   def engines
     (1..Spawn).map do
       Engines.map{|k| k::Valid ? k.compile : nil }

data/test/load.js

@@ -0,0 +1,5 @@
+// Test .load method
+!function()
+{
+  this._load={}
+}()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: execjs-xtrn
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Stas Ukolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,8 @@ files:
 - Rakefile
 - execjs-xtrn.gemspec
 - lib/execjs/node/index.js
+- lib/execjs/node/node_modules/split/index.js
+- lib/execjs/node/node_modules/through/index.js
 - lib/execjs/node/package.json
 - lib/execjs/wsh/json2.js
 - lib/execjs/wsh/repl.js
@@ -104,15 +106,17 @@ files:
 - lib/execjs/xtrn/engine.rb
 - lib/execjs/xtrn/node.rb
 - lib/execjs/xtrn/nvm.rb
+- lib/execjs/xtrn/rails.rb
+- lib/execjs/xtrn/routes.rb
+- lib/execjs/xtrn/routing.rb
 - lib/execjs/xtrn/version.rb
 - lib/execjs/xtrn/wsh.rb
 - test/child.rb
 - test/engine.rb
+- test/load.js
 - test/nvm.rb
 - test/shagi.rb
 - test/top.rb
-- lib/execjs/node/node_modules/split/index.js
-- lib/execjs/node/node_modules/through/index.js
 homepage: https://github.com/ukoloff/execjs-xtrn
 licenses:
 - MIT
@@ -133,13 +137,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: 'Proof-of-concept: make ExecJS fast even without therubyracer'
 test_files:
 - test/child.rb
 - test/engine.rb
+- test/load.js
 - test/nvm.rb
 - test/shagi.rb
 - test/top.rb