nodeify 0.0.6 → 0.0.7

data/README.markdown

@@ -1,6 +1,22 @@
 # nodeify
 
-Bring CLI testing and npm modules to your JavaScript.
+Bring CLI testing and npm modules to your Rails JavaScript.
+
+What it does:
+
+* Allows you to use CommonJS require() statements in your javascript.
+* Allows you to place code in separate files (modules) for organization and re-use purposes.
+* Allows you to include Node.js packages in your client-side JavaScript.
+
+Why this is cool:
+
+* Code organization!
+* Test your JavaScript from the command-line using the myriad testing libraries available from npm, such as [buster.js](http://busterjs.org), [vows.js](http://vowsjs.org), [tap](http://github.com/isaacs/node-tap), and, if you have to, [jasmine-node](http://github.com/mhevery/jasmine-node/).
+* Use the ultimate "rubygems" of the JavaScript world - npm - and stop waiting for someone to package your favorite JS library in a gem or some other lesser-known package format.
+
+What this all means:
+
+You'll have to wrap your head around the CommonJS/npm module system. It's quite a bit different than rubygems, but is a very clean module system.
 
 ## Requirements
 
@@ -30,15 +46,36 @@ As with any Rails JS with the asset pipeline, put your app-specific JavaScripts
 
 ### require()
 
-Under the standard Rails asset pipeline regime, the sprockets gem is used to manage JavaScript file loading/dependencies through the `//= require xxx` syntax. With Nodeify, your javascripts fit into the standard CommonJS modules framework. You can use `var MyLib = require('./xxx')` statements that are relative to your `app/assets/javascripts` directory and `lib/assets/javascripts` directory (both paths are added to NODE_PATHS). You can also use require() to load Node.js npm modules (see below).
+Under the standard Rails asset pipeline regime, the Sprockets gem is used to manage JavaScript file loading/dependencies through the `//= require xxx` syntax. With Nodeify, your javascripts fit into the standard CommonJS modules framework. You can use `var MyLib = require('./xxx')` statements that are relative to your `app/assets/javascripts` directory. You can also use require() to load Node.js npm modules (see below).
+
+Note that you cannot require anything outside of app/assets/javascripts. This is OK because anything that would go into lib/assets or vendor/assets should probably be its own npm module, anyway. At the very least you can dump extra libraries into app/assets/javascripts/lib and require them with `var foo = require('lib/foo');`.
 
 #### Understanding require()
 
-The CommonJS require() works a bit differently than Ruby's require or the sprockets //= require. CommonJS isolates modules (any code grouped into a file) into its own environment. Variables defined local to the module will only be available in that module. To expose certain objects...
+The CommonJS require() works a bit differently than Ruby's require or the sprockets //= require. CommonJS isolates modules (any code grouped into a file) into its own environment. Variables defined local to the module will only be available in that module. Here are a couple of quick examples:
+
+    // in app/assets/javascripts/lib/misc.js
+    exports.cool = function() {
+      console.log('exports are cool');
+    };
+
+    // in app/assets/javascripts/my-class.js
+    var MyClass = function() { };
+    MyClass.prototype.cool = function() {
+      console.log('prototypes are cool');
+    };
+    module.exports = MyClass;     // note that it's module.exports
+
+    // in app/assets/javascripts/application.js
+    var misc = require('./lib/misc'),
+        MyClass = require('./my-class'),
+        _ = require('underscore');  // this is an npm module
 
-TODO: Explanation
+    misc.cool();
+    var klass = new MyClass();
+    klass.cool();
+    _.each([1,2], function(i) { console.log(i); });
 
-In the meantime, google CommonJS modules.
 
 ### Node modules
 

data/lib/nodeify/java_script.rb

@@ -1,17 +1,15 @@
-require 'tilt'
-require 'sandbox'
 require 'sprockets'
+require 'fileutils'
 
 module Nodeify
   class JavaScript < Sprockets::DirectiveProcessor
     def evaluate(context, options, &blk)
       super
 
-      Sandbox.play do |path|
-        file_path = File.join(path, File.basename(file))
-        File.open(file_path, 'w') { |f| f.puts @result }
-        @result = `node -e "var browserify = require('browserify'), _ = process.stdout.write(browserify({ entry: '#{file_path}', require: { http: 'dkastner-http-browserify' } }).bundle());"`
-      end
+      file_path = file + '.tmp'
+      File.open(file_path, 'w') { |f| f.puts @result }
+      @result = `node -e "var browserify = require('browserify'), _ = process.stdout.write(browserify({ entry: '#{file_path}', require: { http: 'http-browserify' } }).bundle());"`
+      FileUtils.rm_f file_path
 
       @result
     end

data/lib/nodeify/version.rb

@@ -1,3 +1,3 @@
 module Nodeify
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nodeify
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000Z
+date: 2012-03-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2158415820 !ruby/object:Gem::Requirement
+  requirement: &2153565600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2158415820
+  version_requirements: *2153565600
 - !ruby/object:Gem::Dependency
   name: sandbox
-  requirement: &2158415340 !ruby/object:Gem::Requirement
+  requirement: &2153564020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158415340
+  version_requirements: *2153564020
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2158414820 !ruby/object:Gem::Requirement
+  requirement: &2153562640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158414820
+  version_requirements: *2153562640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2158414320 !ruby/object:Gem::Requirement
+  requirement: &2153557660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158414320
+  version_requirements: *2153557660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2158410780 !ruby/object:Gem::Requirement
+  requirement: &2153554300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158410780
+  version_requirements: *2153554300
 description: ''
 email:
 - dkastner+nodeify@gmail.com