modulr 0.4.0 → 0.5.0

data/README.markdown

@@ -9,7 +9,7 @@ in Ruby for client-side JavaScript. It accepts a singular file as input (the _pr
 which is does static analysis to recursively resolve its dependencies.
 
 The program, its dependencies and a small, namespaced JavaScript library are
-concatenated into a single `js` file. This improves load times by
+concatenated into a single `js` file with optional minification through the [YUI Compressor](http://developer.yahoo.com/yui/compressor/). This improves load times by
 [minimizing HTTP requests](http://developer.yahoo.com/performance/rules.html#num_http).
 Further load time performance improvements are made possible by the built-in
 [lazy evaluation](http://googlecode.blogspot.com/2009/09/gmail-for-mobile-html5-series-reducing.html)
@@ -17,7 +17,12 @@ option. Modules are delivered as JavaScript strings--instead of functions--and a
 evaluated only when required.
 
 The bundled JavaScript library provides each module with the necessary `require`
-function and `exports` and `module` free variables.
+function and `exports` and `module` free variables. In its full version, the bundled
+library also provided support for the [`require.ensure`](http://wiki.commonjs.org/wiki/Modules/Async/A) (async module requires) and [`require.define`](http://wiki.commonjs.org/wiki/Modules/Transport/D) (module transport) methods.
+
+`modulr` can also be used as a build tool for JavaScript code that will be executed in a regular JS environment. In this case, the global variable defined by the `--global-export` option is assigned the `exports` of the main CommonJS module and asynchronous module requires are not supported.
+
+Finally, `modulr` allows you to create handy [dependency graphs](http://modulrjs.org/spec_dependency_graph.html).
 
 * [Github repository](http://github.com/codespeaks/modulr)
 * [Specification](http://wiki.commonjs.org/wiki/Modules/1.0)
@@ -36,9 +41,25 @@ To process a JavaScript source file, just run:
 
     $ modulrize filename.js > output.js
 
-For a comprehensive list of options:
-
-    $ modulrize --help"
+Options are as follows:
+
+    -o, --output=FILE                Write the output to FILE. Defaults to stdout.
+    -r, --root=DIR                   Set DIR as root directory. Defaults to the directory containing FILE.
+        --lazy-eval [MODULES]        Enable lazy evaluation of all JS modules or of those specified by MODULES.
+                                     MODULES accepts a comma-separated list of identifiers.
+        --minify                     Minify output using YUI Compressor.
+        --global-export=GLOBAL_VAR   Export main module's exports to the GLOBAL_VAR global variable.
+        --sync                       Avoid using require.ensure.
+        --dependency-graph[=OUTPUT]  Create a dependency graph of the module.
+    -h, --help                       Show this message.
+
+Minification options (these are forwarded to YUI Compressor without the "minify-" prefix):
+
+    --minify-disable-optimizations   Disable all micro optimizations.
+    --minify-nomunge             Minify only, do not obfuscate.
+    --minify-verbose             Display informational messages and warnings.
+    --minify-line-break COLUMN   Insert a line break after the specified column number.
+    --minify-preserve-semi       Preserve all semicolons.
 
 Specs
 -----

data/Rakefile

@@ -18,11 +18,6 @@ task :build_sync_example do
   end
 end
 
-desc "Concatenate synchronous example file"
-task :test do
-  Modulr.ize(File.join('example', 'program.js'))
-end
-
 desc "Run CommonJS Module 1.0 specs"
 task :spec do
   specs = ENV["SPECS"] || "**"

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/modulrize

@@ -35,6 +35,10 @@ opts = OptionParser.new do |opts|
     options[:global] = global
   end
   
+  opts.on('--sync', 'Load all dependencies synchronously.') do |global|
+    options[:sync] = true
+  end
+  
   opts.on('--dependency-graph[=OUTPUT]', 'Create a dependency graph of the module.') do |output|
     options[:dependency_graph] = true
     options[:output] = output
@@ -87,5 +91,5 @@ begin
     output.print(result)
   end
 ensure
-  output.close
+  output.close if output.respond_to?(:close)
 end

data/lib/modulr.rb

@@ -4,12 +4,10 @@ module Modulr
   $:.unshift(LIB_DIR)
   $:.unshift(PARSER_DIR)
   
-  class ModulrError < StandardError
-  end
-  
   require 'modulr/js_module'
   require 'modulr/parser'
   require 'modulr/collector'
+  require 'modulr/sync_collector'
   require 'modulr/global_export_collector'
   require 'modulr/minifier'
   require 'modulr/dependency_graph'
@@ -22,6 +20,8 @@ module Modulr
   def self.ize(input_filename, options = {})
     if options[:global]
       collector = GlobalExportCollector.new(options)
+    elsif options[:sync]
+      collector = SyncCollector.new(options)
     else
       collector = Collector.new(options)
     end

data/lib/modulr/collector.rb

@@ -12,7 +12,6 @@ module Modulr
       @src = File.read(path)
       @root ||= File.dirname(path)
       @main = JSModule.new(File.basename(path, '.js'), @root, path)
-      modules << main
       collect_dependencies(main)
     end
     

data/lib/modulr/error.rb

@@ -0,0 +1,4 @@
+module Modulr
+  class ModulrError < StandardError
+  end
+end

data/lib/modulr/global_export_collector.rb

@@ -1,5 +1,5 @@
 module Modulr
-  class GlobalExportCollector < Collector
+  class GlobalExportCollector < SyncCollector
     
     def initialize(options = {})
       @global = options[:global]

data/lib/modulr/js_module.rb

@@ -1,3 +1,4 @@
+require 'modulr/error'
 module Modulr
   class JSModule
     include Comparable

data/lib/modulr/parser.rb

@@ -1,4 +1,5 @@
 require 'rkelly'
+require 'modulr/error'
 
 module Modulr
   class Parser
@@ -25,7 +26,8 @@ module Modulr
       end
       
       def is_a_require_expression?(node)
-        node.is_a?(RKelly::Nodes::FunctionCallNode) &&
+        (node.is_a?(RKelly::Nodes::FunctionCallNode) ||
+        node.is_a?(RKelly::Nodes::NewExprNode)) &&
         node.value.is_a?(RKelly::Nodes::ResolveNode) &&
         node.value.value == 'require'
       end

data/lib/modulr/sync_collector.rb

@@ -0,0 +1,16 @@
+module Modulr
+  class SyncCollector < Collector
+    def parse_file(path)
+      super(path)
+      modules << main unless modules.include?(main)
+    end
+    
+    def to_js(buffer = '')
+      buffer << "(function() {\n"
+      buffer << File.read(PATH_TO_MODULR_SYNC_JS)
+      buffer << transport
+      buffer << "\nrequire('#{main.id}');\n"
+      buffer << "})();\n"
+    end
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,53 @@
+require "test/unit"
+$:.unshift(File.join('..', 'vendor', 'rkelly', 'lib'))
+require "../lib/modulr/parser"
+
+class TestLibModulrParser < Test::Unit::TestCase
+  def assert_found_module(name, src, message="")
+    @parser ||= Modulr::Parser.new
+    template = "Could not find module ? in JavaScript source code ?."
+    message = build_message(message, template, name, src)
+    assert_block(message) do
+      requires = @parser.get_require_expressions(src)
+      requires.first && requires.first[:identifier] == name
+    end
+  end
+  
+  def test_simple_require_function
+    assert_found_module('foo', 'require("foo")')
+  end
+  
+  def test_setting_variable
+    assert_found_module('foo', "var bar = require('foo');")
+  end
+  
+  def test_accessing_property
+    assert_found_module('foo', "require('foo').bar;")
+  end
+  
+  def test_accessing_nested_property
+    assert_found_module('foo', "require('foo').baz.bar;")
+  end
+  
+  def test_calling_method
+    assert_found_module('foo', "require('foo').bar();")
+  end
+  
+  def test_calling_nested_method
+    assert_found_module('foo', "require('foo').bar.baz();")
+  end
+  
+  def test_instanciating_constructor
+    assert_found_module('foo', "new require('foo').Foo();")
+    assert_found_module('foo', "new require('foo').Foo;")
+    assert_found_module('foo', "new require('foo').Foo(1, 2, 3);")
+    assert_found_module('foo', "new (require('foo')).Foo();")
+  end
+  
+  def test_instanciating_nested_constructor
+    assert_found_module('foo', "new require('foo').bar.Foo();")
+    assert_found_module('foo', "new require('foo').bar.Foo;")
+    assert_found_module('foo', "new require('foo').bar.Foo(1, 2, 3);")
+    assert_found_module('foo', "new (require('foo').bar).Foo();")
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Tobie Langel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +02:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: modulrize
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,10 +55,12 @@ files:
 - lib/modulr.rb
 - lib/modulr/collector.rb
 - lib/modulr/dependency_graph.rb
+- lib/modulr/error.rb
 - lib/modulr/global_export_collector.rb
 - lib/modulr/js_module.rb
 - lib/modulr/minifier.rb
 - lib/modulr/parser.rb
+- lib/modulr/sync_collector.rb
 - lib/modulr/version.rb
 - vendor/rkelly/CHANGELOG.rdoc
 - vendor/rkelly/Manifest.txt
@@ -290,5 +292,5 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A CommonJS module implementation in Ruby for client-side JavaScript
-test_files: []
-
+test_files: 
+- test/test_parser.rb