commonjs-rhino 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4f7640189ccde5551d0a7f169a3110c31277a7d
+  data.tar.gz: 064cf4210d30d3a30327eec3cb0fae93d46e983b
+SHA512:
+  metadata.gz: 6e03cf89bc2ad65228b490a5030ac90924383d9417001f8a960ca90331862089b0c4424411c115d262578a1398b950cffb75aa33376aec63b5dd9cb104bc5867
+  data.tar.gz: efcced0cee70429a5057d0cf21f33395e7b15a5c9318278758a55ffea7b25f653986658510f49f8059144ff4aaafaf098260d03c3051a69bea8e2ac738db1e10

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gemspec
+
+ruby '1.9.3', engine: 'jruby', engine_version: '1.7.12'
+
+group :development, :test do
+  gem 'pry-nav'
+  gem 'rake'
+  gem 'jbundler'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rr'
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday

data/README.md

@@ -0,0 +1,64 @@
+commonjs-rhino
+==============
+
+CommonJs support for Rhino, in Ruby (JRuby specifically). commonjs-rhino allows you to create JavaScript contexts that contain a `require` method you can use to load CommonJs modules.
+
+## Installation
+
+`gem install commonjs-rhino`
+
+Then, require it somewhere in your code:
+
+```ruby
+require 'commonjs-rhino'
+```
+
+Please be aware this gem requires Mozilla's Rhino JavaScript environment, which means Rhino will need to be somewhere in your Java classpath. commonjs-rhino was developed using [jbundler](https://github.com/mkristian/jbundler), which I recommend for Java dependency management. It's pretty easy to set up, here's a quick guide: Run `gem install jbundler`, then add `require 'jbundler'` in your project before any `java_import` statements are executed. In other words, your project should contain these lines in this order:
+
+```ruby
+require 'jbundler'
+require 'commonjs-rhino'
+# require other jbundler-compatible gems
+```
+
+## Usage
+
+Let's say you have this nice little CommonJs JavaScript module you'd like to use in Rhino. The module exists on disk at `/path/to/camertron/teapot.js`:
+
+```javascript
+(function() {
+  module.exports.strVariable = 'foobarbaz';
+  module.exports.func = function() {
+    return "I'm a little teapot";
+  };
+}).call();
+```
+
+Create a commonjs-rhino context, point it at your modules, and require away:
+
+```ruby
+context = CommonjsRhino.create_context(['/path/to/camertron'])
+context.eval('var hello = require("camertron/teapot")')
+context.eval('hello.strVariable')  # => 'foobarbaz'
+```
+
+It's that easy!
+
+You can also evaluate files with the handy `eval_file` method:
+
+```ruby
+context.eval_file('/path/to/file.js')
+```
+
+## Requirements
+
+1. [JRuby](http://jruby.org/)
+2. [Rhino](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino) in your classpath (see above).
+
+## Running Tests
+
+`bundle exec rspec` should do the trick :)
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'jbundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/commonjs-rhino'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/commonjs-rhino.gemspec

@@ -0,0 +1,19 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'commonjs-rhino/version'
+
+Gem::Specification.new do |s|
+  s.name     = "commonjs-rhino"
+  s.version  = ::CommonjsRhino::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "CommonJS support for Rhino, in Ruby."
+  s.requirements << "jar 'org.mozilla:rhino', '1.7R4'"
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "commonjs-rhino.gemspec"]
+end

data/lib/commonjs-rhino.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require 'java'
+
+java_import 'java.io.FileReader'
+java_import 'org.mozilla.javascript.commonjs.module.ModuleScriptProvider'
+java_import 'org.mozilla.javascript.commonjs.module.provider.ModuleSourceProvider'
+java_import 'org.mozilla.javascript.commonjs.module.provider.SoftCachingModuleScriptProvider'
+java_import 'org.mozilla.javascript.commonjs.module.provider.UrlModuleSourceProvider'
+java_import 'org.mozilla.javascript.commonjs.module.Require'
+java_import 'org.mozilla.javascript.commonjs.module.RequireBuilder'
+
+# http://stackoverflow.com/questions/11074836/resolving-modules-using-require-js-and-java-rhino
+module CommonjsRhino
+  class Context
+    attr_reader :rhino_context, :shared_scope, :require_base_paths
+
+    def initialize(shared_scope, require_base_paths)
+      @shared_scope = shared_scope
+      @require_base_paths = require_base_paths
+      nil
+    end
+
+    def eval_file(file)
+      with_context do |context|
+        context.evaluateReader(
+          shared_scope, FileReader.new(file), nil, 1, nil
+        )
+      end
+    end
+
+    def eval(str)
+      with_context do |context|
+        context.evaluateString(shared_scope, str, nil, 1, nil)
+      end
+    end
+
+    private
+
+    def with_context
+      context = Java::OrgMozillaJavascript::Context.enter
+      yield context
+    ensure
+      context.java_send(:exit)
+      nil
+    end
+  end
+
+  def self.create_context(require_base_paths = [Dir.getwd])
+    require_base_paths = Array(require_base_paths)
+
+    source_provider = UrlModuleSourceProvider.new(
+      require_base_paths.map do |base_path|
+        Java::JavaNet::URI.new("file://#{base_path}")
+      end, nil
+    )
+
+    script_provider = SoftCachingModuleScriptProvider.new(source_provider)
+
+    builder = RequireBuilder.new
+      .setModuleScriptProvider(script_provider)
+      .setSandboxed(false)
+
+    context = Java::OrgMozillaJavascript::Context.enter
+    top_level_scope = context.initStandardObjects()
+    req = builder.createRequire(context, top_level_scope)
+    req.install(top_level_scope)
+    context.java_send(:exit)
+
+    CommonjsRhino::Context.new(top_level_scope, require_base_paths)
+  end
+end

data/lib/commonjs-rhino/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module CommonjsRhino
+  VERSION = '1.0.0'
+end

data/spec/commonjs-rhino_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe CommonjsRhino do
+  let(:rhino) { CommonjsRhino }
+  let(:privileged_uris) { [File.expand_path('../', __FILE__)] }
+
+  describe '#create_context' do
+    it 'returns a context object' do
+      rhino.create_context(privileged_uris).tap do |context|
+        expect(context).to respond_to(:eval)
+        expect(context).to respond_to(:eval_file)
+      end
+    end
+  end
+end

data/spec/context_spec.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe CommonjsRhino::Context do
+  let(:rhino) { CommonjsRhino }
+
+  # Privileged URIs are like a load path, except that the last
+  # part of the path must also be used when requiring the module.
+  let(:privileged_uris) { [File.expand_path('../fixtures', __FILE__)] }
+
+  # Notice the module here has to include a prefix of 'fixtures/'
+  # even though the path we added above ends with the same.
+  let(:test_module) { 'fixtures/test_module' }
+
+  # Any scripts you load from disk should be referenced via paths,
+  # not via module syntax (i.e. include file extensions, etc)
+  let(:test_script) { File.expand_path('../fixtures/test_script.js', __FILE__) }
+
+  before(:each) do
+    @context = rhino.create_context(privileged_uris)
+  end
+
+  describe '#eval' do
+    it 'evaluates javascript code' do
+      expect(@context.eval('1 + 2 + 3')).to eq(6)
+    end
+
+    it 'supports loading modules' do
+      @context.eval("var foo = require('#{test_module}');")
+      expect(@context.eval('foo.strVariable;')).to eq('foobarbaz')
+      expect(@context.eval('foo.func();')).to eq("I'm a little teapot")
+    end
+
+    it 'does not allow modules to be loaded from non-privileged uris' do
+      expect(
+        lambda { @context.eval("var foo = require('non/existent');") }
+      ).to raise_error(Java::OrgMozillaJavascript::JavaScriptException)
+    end
+  end
+
+  describe '#eval_file' do
+    it 'loads and interprets a file' do
+      @context.eval_file(test_script)
+      expect(@context.eval('hello')).to eq('world')
+    end
+  end
+end

data/spec/fixtures/test_module.js

@@ -0,0 +1,6 @@
+(function() {
+  module.exports.strVariable = 'foobarbaz';
+  module.exports.func = function() {
+    return "I'm a little teapot";
+  };
+}).call();

data/spec/fixtures/test_script.js

@@ -0,0 +1 @@
+var hello = 'world';

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+require 'jbundler'
+require 'rspec'
+require 'commonjs-rhino'
+require 'pry-nav'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: commonjs-rhino
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-08-04 00:00:00.000000000 Z
+dependencies: []
+description: CommonJS support for Rhino, in Ruby.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- commonjs-rhino.gemspec
+- lib/commonjs-rhino.rb
+- lib/commonjs-rhino/version.rb
+- spec/commonjs-rhino_spec.rb
+- spec/context_spec.rb
+- spec/fixtures/test_module.js
+- spec/fixtures/test_script.js
+- spec/spec_helper.rb
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar 'org.mozilla:rhino', '1.7R4'
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: CommonJS support for Rhino, in Ruby.
+test_files: []