modulr 0.1.0 → 0.2.0

data/README.markdown

@@ -21,8 +21,13 @@ Usage
 `modulr` accepts a singular file as input (the _program_) on 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 minimizing HTTP requests](http://developer.yahoo.com/performance/rules.html#num_http).
+The program, its dependencies and a small, namespaced JavaScript library are 
+concatenated into a single `js` file. 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)
+option. Modules are delivered as JavaScript strings--instead of functions--and are
+evaluated only when required.
 
 The bundled JavaScript library provides each module with the necessary `require`
 function and `exports` and `module` free variables.

data/Rakefile

@@ -23,7 +23,7 @@ task :spec do
     begin
       puts File.basename(dir).center(80, "_")
       File.open(output, 'w') do |f|
-        f << Modulr.ize(spec)
+        f << Modulr.ize(spec, {:lazy_eval => ['a']})
       end
       system("js -f #{output}")
     rescue => e
@@ -31,8 +31,8 @@ task :spec do
       puts "ERROR while #{phase} (#{e.class}):"
       puts e.message
     ensure
-      FileUtils.rm(output)
-      FileUtils.rm(system)
+      #FileUtils.rm(output)
+      #FileUtils.rm(system)
       puts
       puts
     end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/assets/modulr.js

@@ -16,7 +16,8 @@ var modulr = (function(global) {
   
   function require(identifier) {
     var fn, modObj,
-        id = _references[PREFIX + identifier],
+        key = PREFIX + identifier,
+        id = _references[key] || key,
         expts = _exports[id];
     
     log('Required module "' + identifier + '".');
@@ -29,20 +30,22 @@ var modulr = (function(global) {
       
       fn = _modules[id];
       if (!fn) { throw 'Can\'t find module "' + identifier + '".'; }
+      if (typeof fn === 'string') {
+        fn = eval('function(require, exports, module) {' + fn + '}');
+      }
       fn(require, expts, modObj);
     }
     return expts;
   }
   
-  function cache(identifier, id, fn) {
-    log('Cached module "' + identifier + '".');
-    id = PREFIX + id;
+  function cache(id, fn) {
+    var key = PREFIX + id;
     
-    if (_modules[id]) {
-      throw 'Can\'t overwrite module "' + identifier + '".';
+    log('Cached module "' + id + '".');
+    if (_modules[key]) {
+      throw 'Can\'t overwrite module "' + id + '".';
     }
-    _modules[id] = fn;
-    _references[PREFIX + identifier] = id;
+    _modules[key] = fn;
   }
   
   function alias(identifier, id) {

data/bin/modulrize

@@ -7,17 +7,24 @@ options = {
 }
 
 opts = OptionParser.new do |opts|
-  opts.banner = 'Usage: modulrize [options] FILE'
+  opts.banner = 'Usage: modulrize program.js [options] > output.js'
   
-  opts.on('-o', '--output=FILE', 'Write the output to FILE. Defaults to stdout') do |output|
+  opts.on('-o', '--output=FILE', 'Write the output to FILE. Defaults to stdout.') do |output|
     options[:output] = File.open(output, 'w')
   end
   
-  opts.on('-r', '--root=DIR', 'Set DIR as root directory. Defaults to the directory containing FILE') do |root|
+  opts.on('-r', '--root=DIR', 'Set DIR as root directory. Defaults to the directory containing FILE.') do |root|
     options[:root] = root
   end
   
-  opts.on_tail('-h', '--help', 'Show this message') do
+  opts.on('--lazy-eval [MODULES]', Array,
+    'Enable lazy evaluation of all JS modules or of those specified by MODULES.',
+    'MODULES accepts a comma-separated list of identifiers.') do |modules|
+    modules = true unless modules
+    options[:lazy_eval] = modules
+  end
+  
+  opts.on_tail('-h', '--help', 'Show this message.') do
     puts opts
     exit
   end

data/lib/modulr/collector.rb

@@ -1,60 +1,49 @@
-require 'rkelly'
-
 module Modulr
   class Collector
-    attr_reader :modules, :aliases, :main
+    attr_reader :modules, :main
     
-    def initialize(root = nil)
-      @root = root
-      @modules = {}
-      @aliases = {}
+    def initialize(options = {})
+      @root = options[:root]
+      @lazy_eval = options[:lazy_eval]
+      @modules = []
     end
     
     def parse_file(path)
       @src = File.read(path)
       @root ||= File.dirname(path)
       @main = JSModule.new(File.basename(path, '.js'), @root, path)
-      modules[main.id] = main
-      find_dependencies(@src, path)
+      modules << main
+      collect_dependencies(main)
     end
     
-    def parser
-      @parser ||= RKelly::Parser.new
-    end
-    
-    def parse(src)
-      parser.parse(src)
+    def to_js(buffer = '')
+      buffer << File.read(PATH_TO_MODULR_JS)
+      modules.each do |js_module|
+        if lazy_eval_module?(js_module)
+          js_module.to_js_string(buffer)
+        else
+          js_module.to_js(buffer)
+        end
+      end
+      buffer << "\nmodulr.require('#{main.identifier}');\n"
     end
     
-    def find_dependencies(src, path)
-      parse(src).each do |exp|
-        if is_a_require_expression?(exp)
-          js_module = JSModule.from_expression(exp, @root, path)
-          if cached_module = modules[js_module.id]
-            if cached_module.identifier != js_module.identifier
-              aliases[js_module.identifier] = js_module.id
-            end
-          else
-            modules[js_module.id] = js_module
-            find_dependencies(js_module.src, js_module.path)
+    private
+      def collect_dependencies(js_module)
+        js_module.dependencies.each do |dependency|
+          unless modules.include?(dependency)
+            modules << dependency
+            collect_dependencies(dependency)
           end
         end
       end
-    end
-    
-    def is_a_require_expression?(node)
-      node.is_a?(RKelly::Nodes::FunctionCallNode) &&
-      node.value.is_a?(RKelly::Nodes::ResolveNode) &&
-      node.value.value == 'require'
-    end
-    
-    def to_js(buffer = '')
-      buffer << File.read(PATH_TO_MODULR_JS);
-      modules.each { |id, js_module| js_module.to_js(buffer) }
-      aliases.each do |identifier, id|
-        buffer << "modulr.alias('#{identifier}', '#{id}');\n"
+      
+      def lazy_eval_module?(js_module)
+        return false unless @lazy_eval
+        return true if @lazy_eval === true
+        return true if @lazy_eval.include?(js_module.identifier)
+        return true if @lazy_eval.include?(js_module.id)
+        false
       end
-      buffer << "\nmodulr.require('#{main.identifier}');\n"
-    end
   end
 end

data/lib/modulr/js_module.rb

@@ -1,10 +1,28 @@
 module Modulr
   class JSModule
-    def self.from_expression(exp, root, file)
-      str = exp.arguments.first.value.first
-      new(str.value[1...-1], root, file, str.line.to_i)
+    include Comparable
+    
+    JS_ESCAPE_MAP = {
+      '\\'    => '\\\\',
+      '</'    => '<\/',
+      "\r\n"  => '\n',
+      "\n"    => '\n',
+      "\r"    => '\n',
+      '"'     => '\\"',
+      "'"     => "\\'"
+    }
+    
+    def self.parser
+      @dependency_finder ||= Parser.new
     end
-
+    
+    def self.find_dependencies(js_module)
+      expressions = parser.get_require_expressions(js_module.src)
+      expressions.map do |exp|
+        new(exp[:identifier], js_module.root, js_module.path, exp[:line])
+      end
+    end
+    
     attr_reader :identifier, :root, :terms, :file, :line
     
     def initialize(identifier, root, file=nil, line=nil)
@@ -15,6 +33,10 @@ module Modulr
       @terms = identifier.split('/').reject { |term| term == '' }
       raise ModuleIdentifierError.new(self) unless identifier_valid?
     end
+    
+    def <=> (other_module)
+      id <=> other_module.id
+    end
 
     def inspect
       "#<#{self.class.name} \"#{identifier}\">"
@@ -26,8 +48,12 @@ module Modulr
     
     def id
       return @id if @id
-      @id = File.expand_path(partial_path, directory)
-      @id.sub!("#{File.expand_path(root)}/", '')
+      if top_level?
+        @id = identifier
+      else
+        @id = File.expand_path(partial_path, directory)
+        @id.sub!("#{File.expand_path(root)}/", '')
+      end
     end
 
     def relative?
@@ -51,9 +77,25 @@ module Modulr
       end
     end
     
+    def escaped_src
+      @escaped_src ||= src.gsub(/(\\|<\/|\r\n|[\n\r"'])/) {
+        JS_ESCAPE_MAP[$1]
+      }
+    end
+    
+    def dependencies
+      @dependencies ||= self.class.find_dependencies(self)
+    end
+
     def to_js(buffer = '')
+      call_alias_js_function(buffer)
       fn = "function(require, exports, module) {\n#{src}\n}"
-      buffer << "modulr.cache('#{identifier}', '#{id}', #{fn});"
+      buffer << "\nmodulr.cache('#{id}', #{fn});\n"
+    end
+    
+    def to_js_string(buffer = '')
+      call_alias_js_function(buffer)
+      buffer << "\nmodulr.cache('#{id}', '#{escaped_src}');\n"
     end
     
     protected
@@ -62,10 +104,12 @@ module Modulr
       end
       
       def directory
+        relative? ? File.dirname(file) : root
+      end
+      
+      def call_alias_js_function(buffer)
         if relative?
-          File.dirname(file)
-        else
-          root
+          buffer << "\nmodulr.alias('#{identifier}', '#{id}');"
         end
       end
   end

data/lib/modulr/parser.rb

@@ -0,0 +1,35 @@
+require 'rkelly'
+
+module Modulr
+  class Parser
+    
+    def parse(src)
+      parser.parse(src)
+    end
+    
+    def get_require_expressions(src)
+      nodes = parse(src)
+      nodes = nodes.select { |node| is_a_require_expression?(node) }
+      nodes.map { |node| normalize(node) }
+    end
+    
+    private                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
+      def parser
+        @parser ||= RKelly::Parser.new
+      end
+      
+      def is_a_require_expression?(node)
+        node.is_a?(RKelly::Nodes::FunctionCallNode) &&
+        node.value.is_a?(RKelly::Nodes::ResolveNode) &&
+        node.value.value == 'require'
+      end
+      
+      def normalize(node)
+        str = node.arguments.first.value.first
+        {
+          :identifier => str.value[1...-1],
+          :line => str.line.to_i
+        }
+      end
+  end
+end

data/lib/modulr.rb

@@ -8,13 +8,14 @@ module Modulr
   end
   
   require 'modulr/js_module'
+  require 'modulr/parser'
   require 'modulr/collector'
   require 'modulr/version'
   
   PATH_TO_MODULR_JS = File.join(LIB_DIR, '..', 'assets', 'modulr.js')
   
   def self.ize(input_filename, options = {})
-    collector = Collector.new(options[:root])
+    collector = Collector.new(options)
     collector.parse_file(input_filename)
     collector.to_js
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: modulr
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tobie Langel
@@ -38,6 +38,7 @@ files:
 - lib/modulr.rb
 - lib/modulr/collector.rb
 - lib/modulr/js_module.rb
+- lib/modulr/parser.rb
 - lib/modulr/version.rb
 - vendor/rkelly/CHANGELOG.rdoc
 - vendor/rkelly/Manifest.txt