sprockets-commonjs-mindreframer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8d7b206d2851f6a79a4498970a19b1e1a5f8c45
+  data.tar.gz: 7e859a407497ac4072c229092cc5ee4a72e20de4
+SHA512:
+  metadata.gz: 8d2de6c65f7adea8deb2afa622a85d72ace4967523c2eecfc7b61e79ba4ff712703096733c960550b125d8354e828a6c011a08256ca3c829dfc9abd51686dc62
+  data.tar.gz: 7d97d103f2db075cd613cd59a3c8c85696cb6213096083db8bd41a536cb2f0da319a05c5008cb29a2b999302c74bfa5cef738c3304c3eb318f0a71c4b3bdaf5b

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+gemfiles/*.lock
+pkg/*
+.DS_Store

data/Appraisals

@@ -0,0 +1,31 @@
+appraise "sprockets-2-1" do
+  gem 'sprockets', '~> 2.1.3'
+end
+
+appraise "sprockets-2-2" do
+  gem 'sprockets', '~> 2.2.2'
+end
+
+appraise "sprockets-2-3" do
+  gem 'sprockets', '~> 2.3.2'
+end
+
+appraise "sprockets-2-4" do
+  gem 'sprockets', '~> 2.4.5'
+end
+
+appraise "sprockets-2-5" do
+  gem 'sprockets', '~> 2.5.0'
+end
+
+appraise "sprockets-2-6" do
+  gem 'sprockets', '~> 2.6.0'
+end
+
+appraise "sprockets-2-7" do
+  gem 'sprockets', '~> 2.7.0'
+end
+
+appraise "sprockets-2-8" do
+  gem 'sprockets', '~> 2.8.2'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sprockets-commonjs.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+This library adds CommonJS support to [Sprockets](https://github.com/sstephenson/sprockets).
+
+## This is a fork, since the original was not published for ages.
+
+Also this includes the changes from wazeHQ/sprockets-commonjs to allow you transparent requires without the `.module`-part in filename.
+
+  # in Gemfile
+  gem 'sprockets-commonjs-mindreframer'
+
+  # install
+  $ bundle install
+
+
+## What is CommonJS?
+
+The CommonJS module format is a way of encapsulating JavaScript libraries, ensuring they have to explicitly require and export properties they use. In a nutshell:
+
+1. You require in files using `require()`:
+
+    var Asset = require('models/asset');
+
+2. You export properties using `module.exports`:
+
+    var Asset = function(){ /* ... */ };
+    module.exports = Asset;
+
+## This library
+
+This library adds CommonJS support to Sprockets, so it can wrap up JavaScript files as modules, and serve them appropriately.
+
+This is done transparently by checking for `require('...')` or `module.exports = ...`-statements in the source-code.
+
+
+Sprockets will then wrap up the JS library when it's requested, with the following:
+
+    require.define({'library/name': function(exports, require, module){ /* Your library */ }});
+
+`require.define()` is defined inside `commonjs.js`, which will be included, if any CommonJS modules were found.
+
+
+One caveat to the approach this library takes, is that dependencies loaded through `require()` will not be added to the dependency graph. This library will not parse the AST tree for require calls. This decision has been made for a variety of reasons, but it does mean you need to require files through both CommonJS and Sprockets.
+
+## Usage
+
+1. Add `gem 'sprockets-commonjs-mindreframer'` to your `Gemfile`
+2. Configure Sprockets::CommonJS.module_paths, e.g.:
+    `Sprockets::CommonJS.module_paths += [Rails.root.to_s]`
+
+3. Require all the modules, e.g.: `//= require_tree ./models`
+4. Or, require individual modules, e.g.: `//= require users`

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'sprockets'
+require 'sprockets/commonjs'
+require 'rake/testtask'
+require 'appraisal'
+
+task :example do
+  example_dir = File.expand_path('..', __FILE__)
+  env         = Sprockets::Environment.new(example_dir)
+  env.append_path 'examples/'
+  Sprockets::CommonJS.module_paths += [File.join(example_dir, 'examples') ]
+
+  target = File.expand_path('../examples/example.js', __FILE__)
+  env['application.js'].write_to target
+end
+
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'lib' << 'test'
+  t.warning = true
+end

data/assets/sprockets/commonjs.js

@@ -0,0 +1,64 @@
+(function() {
+  if (!this.require) {
+    var modules = {}, cache = {};
+
+    var require = function(name, root) {
+      var path = expand(root, name), indexPath = expand(path, './index'), module, fn;
+      module   = cache[path] || cache[indexPath];
+      if (module) {
+        if (module.__define_in_progress) {
+          throw new Error("Circular dependency: " + name + " already required.");
+        }
+        return module;
+      } else if (fn = modules[path] || modules[path = indexPath]) {
+        module = {id: path, exports: { __define_in_progress: true } };
+        cache[path] = module.exports;
+        fn(module.exports, function(name) {
+          return require(name, dirname(path));
+        }, module);
+        delete module.exports.__define_in_progress;
+        return cache[path] = module.exports;
+      } else {
+        throw 'module ' + name + ' not found';
+      }
+    };
+
+    var expand = function(root, name) {
+      var results = [], parts, part;
+      // If path is relative
+      if (/^\.\.?(\/|$)/.test(name)) {
+        parts = [root, name].join('/').split('/');
+      } else {
+        parts = name.split('/');
+      }
+      for (var i = 0, length = parts.length; i < length; i++) {
+        part = parts[i];
+        if (part == '..') {
+          results.pop();
+        } else if (part != '.' && part != '') {
+          results.push(part);
+        }
+      }
+      return results.join('/');
+    };
+
+    var dirname = function(path) {
+      return path.split('/').slice(0, -1).join('/');
+    };
+
+    this.require = function(name) {
+      return require(name, '');
+    };
+
+    this.require.define = function(bundle) {
+      for (var key in bundle) {
+        modules[key] = bundle[key];
+      }
+    };
+
+    this.require.modules = modules;
+    this.require.cache   = cache;
+  }
+
+  return this.require;
+}).call(this);

data/examples/application.js

@@ -0,0 +1,3 @@
+//= require_tree ./modules
+
+var self = 'application.js';

data/examples/example.js

@@ -0,0 +1,77 @@
+(function() {
+  if (!this.require) {
+    var modules = {}, cache = {};
+
+    var require = function(name, root) {
+      var path = expand(root, name), indexPath = expand(path, './index'), module, fn;
+      module   = cache[path] || cache[indexPath];
+      if (module) {
+        if (module.__define_in_progress) {
+          throw new Error("Circular dependency: " + name + " already required.");
+        }
+        return module;
+      } else if (fn = modules[path] || modules[path = indexPath]) {
+        module = {id: path, exports: { __define_in_progress: true } };
+        cache[path] = module.exports;
+        fn(module.exports, function(name) {
+          return require(name, dirname(path));
+        }, module);
+        delete module.exports.__define_in_progress;
+        return cache[path] = module.exports;
+      } else {
+        throw 'module ' + name + ' not found';
+      }
+    };
+
+    var expand = function(root, name) {
+      var results = [], parts, part;
+      // If path is relative
+      if (/^\.\.?(\/|$)/.test(name)) {
+        parts = [root, name].join('/').split('/');
+      } else {
+        parts = name.split('/');
+      }
+      for (var i = 0, length = parts.length; i < length; i++) {
+        part = parts[i];
+        if (part == '..') {
+          results.pop();
+        } else if (part != '.' && part != '') {
+          results.push(part);
+        }
+      }
+      return results.join('/');
+    };
+
+    var dirname = function(path) {
+      return path.split('/').slice(0, -1).join('/');
+    };
+
+    this.require = function(name) {
+      return require(name, '');
+    };
+
+    this.require.define = function(bundle) {
+      for (var key in bundle) {
+        modules[key] = bundle[key];
+      }
+    };
+
+    this.require.modules = modules;
+    this.require.cache   = cache;
+  }
+
+  return this.require;
+}).call(this);
+this.require.define({"modules/program.cjs":function(exports, require, module){module.exports = function(){
+  alert('Long live the Programs!');
+};
+;}});
+this.require.define({"modules/user.module":function(exports, require, module){var Program = require('modules/program');
+
+module.exports = function(){
+  alert('Long live the Users');
+  Program();
+};
+;}});
+
+var self = 'application.js';

data/examples/index.html

@@ -0,0 +1,4 @@
+<script src="example.js" type="text/javascript" charset="utf-8"></script>
+<script type="text/javascript" charset="utf-8">
+  require('modules/user')();
+</script>

data/examples/modules/program.cjs.js

@@ -0,0 +1,3 @@
+module.exports = function(){
+  alert('Long live the Programs!');
+};

data/examples/modules/user.module.js

@@ -0,0 +1,6 @@
+var Program = require('modules/program');
+
+module.exports = function(){
+  alert('Long live the Users');
+  Program();
+};

data/gemfiles/sprockets_2_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.1.3"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.2.2"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.3.2"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.4.5"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.5.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.6.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.7.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.8.2"
+
+gemspec :path=>"../"

data/lib/assets/javascripts/sprockets/commonjs.js

@@ -0,0 +1,61 @@
+(function() {
+  if (!this.require) {
+    var modules = {}, cache = {};
+
+    var require = function(name, root) {
+      var path = expand(root, name), indexPath = expand(path, './index'), module, fn;
+      module   = cache[path] || cache[indexPath];
+      if (module) {
+        return module;
+      } else if (fn = modules[path] || modules[path = indexPath]) {
+        module = {id: path, exports: {}};
+        cache[path] = module.exports;
+        fn(module.exports, function(name) {
+          cache[path] = module.exports;
+          return require(name, dirname(path));
+        }, module);
+        return cache[path] = module.exports;
+      } else {
+        throw 'module ' + name + ' not found';
+      }
+    };
+
+    var expand = function(root, name) {
+      var results = [], parts, part;
+      // If path is relative
+      if (/^\.\.?(\/|$)/.test(name)) {
+        parts = [root, name].join('/').split('/');
+      } else {
+        parts = name.split('/');
+      }
+      for (var i = 0, length = parts.length; i < length; i++) {
+        part = parts[i];
+        if (part == '..') {
+          results.pop();
+        } else if (part != '.' && part != '') {
+          results.push(part);
+        }
+      }
+      return results.join('/');
+    };
+
+    var dirname = function(path) {
+      return path.split('/').slice(0, -1).join('/');
+    };
+
+    this.require = function(name) {
+      return require(name, '');
+    };
+
+    this.require.define = function(bundle) {
+      for (var key in bundle) {
+        modules[key] = bundle[key];
+      }
+    };
+
+    this.require.modules = modules;
+    this.require.cache   = cache;
+  }
+
+  return this.require;
+}).call(this);

data/lib/sprockets-commonjs.rb

@@ -0,0 +1 @@
+require 'sprockets/commonjs'

data/lib/sprockets/commonjs.rb

@@ -0,0 +1,70 @@
+require 'sprockets'
+require 'tilt'
+
+module Sprockets
+  class CommonJS < Tilt::Template
+
+    WRAPPER = '%s.define({"%s":' +
+                     "function(exports, require, module){" +
+                     '%s' +
+                     ";}});\n"
+
+    class << self
+      attr_accessor :default_namespace
+      attr_accessor :module_paths
+    end
+
+    self.default_mime_type = 'application/javascript'
+    self.default_namespace = 'this.require'
+    self.module_paths = []
+
+    protected
+
+    def prepare
+      @namespace = self.class.default_namespace
+    end
+
+    def evaluate(scope, locals, &block)
+      if commonjs_module?(scope)
+        scope.require_asset 'sprockets/commonjs'
+        WRAPPER % [ namespace, module_name(scope), data ]
+      else
+        data
+      end
+    end
+
+    private
+
+    attr_reader :namespace
+
+    def commonjs_module?(scope)
+      in_path?(scope) && (exports_module? || has_dependencies?)
+    end
+
+    def in_path?(scope)
+      self.class.module_paths.any? do |path|
+        scope.pathname.to_s.start_with? path
+      end
+    end
+
+    def exports_module?
+      data.include?('module.exports')
+    end
+
+    def dependencies
+      @dependencies ||= data.scan(/require\(['"](.*)['"]\)/).map(&:last)
+    end
+
+    def has_dependencies?
+      dependencies.length > 0
+    end
+
+    def module_name(scope)
+      scope.logical_path.gsub(/^\.?\//, '') # Remove relative paths
+    end
+
+  end
+
+  register_postprocessor 'application/javascript', CommonJS
+  append_path File.expand_path('../../../assets', __FILE__)
+end

data/sprockets-commonjs.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-commonjs-mindreframer"
+  s.version     = '0.1.0'
+  s.authors     = ["Alex MacCaw"]
+  s.email       = ["info@eribium.org"]
+  s.homepage    = ""
+  s.summary     = %q{Adds CommonJS support to Sprockets}
+  s.description = s.summary
+
+  s.rubyforge_project = "sprockets-commonjs"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "sprockets", "~>2.10.1"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "appraisal"
+end

data/test/bar.js

@@ -0,0 +1 @@
+window.bar = "Bar!"

data/test/foo.module.js

@@ -0,0 +1 @@
+module.exports = "Foo!";

data/test/source.js

@@ -0,0 +1,2 @@
+//= require foo.module.js
+//= require bar.js

data/test/sprockets_commonjs_test.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'tempfile'
+require 'sprockets-commonjs'
+
+class SprocketsCommonjsTest < Test::Unit::TestCase
+
+  TEST_DIR = File.expand_path('..', __FILE__)
+  LIB_DIR  = File.expand_path('../lib/assets/javascripts', TEST_DIR)
+
+  attr_reader :output
+
+  def setup
+    env = Sprockets::Environment.new
+    env.register_postprocessor 'application/javascript', Sprockets::CommonJS
+    env.append_path TEST_DIR
+    env.append_path LIB_DIR
+    outfile = Tempfile.new('sprockets-output')
+    env['source.js'].write_to outfile.path
+    @output = File.read outfile.path
+  end
+
+  def test_adds_commonjs_require
+    assert_match %r[var require = function\(name, root\) \{], @output
+  end
+
+  def test_modularizes_modules
+    assert_match %r[require.define\(\{\"foo\":function], @output
+    assert_match %r["Foo!"], @output
+  end
+
+  def test_does_not_modularize_non_modules
+    assert_no_match %r[require.define\(\{\"bar\":function], @output
+  end
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-commonjs-mindreframer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds CommonJS support to Sprockets
+email:
+- info@eribium.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- assets/sprockets/commonjs.js
+- examples/application.js
+- examples/example.js
+- examples/index.html
+- examples/modules/program.cjs.js
+- examples/modules/user.module.js
+- gemfiles/sprockets_2_1.gemfile
+- gemfiles/sprockets_2_2.gemfile
+- gemfiles/sprockets_2_3.gemfile
+- gemfiles/sprockets_2_4.gemfile
+- gemfiles/sprockets_2_5.gemfile
+- gemfiles/sprockets_2_6.gemfile
+- gemfiles/sprockets_2_7.gemfile
+- gemfiles/sprockets_2_8.gemfile
+- lib/assets/javascripts/sprockets/commonjs.js
+- lib/sprockets-commonjs.rb
+- lib/sprockets/commonjs.rb
+- sprockets-commonjs.gemspec
+- test/bar.js
+- test/foo.module.js
+- test/source.js
+- test/sprockets_commonjs_test.rb
+homepage: ''
+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: []
+rubyforge_project: sprockets-commonjs
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds CommonJS support to Sprockets
+test_files:
+- test/bar.js
+- test/foo.module.js
+- test/source.js
+- test/sprockets_commonjs_test.rb