roli-sprockets-commonjs 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dc87438e56ebcd2b009e5d71ffdb9afdb017783
+  data.tar.gz: 4fe576465cebdbdb4ba8afb421574a3747a0c04f
+SHA512:
+  metadata.gz: 271f55c0469c463c738a79748ee8e4d9ab51f0d5b027aea7a79255b10321765fd0f5eb718ef93951e30658a0c85309ac5ddc476115253468094b9112faae7dc8
+  data.tar.gz: f00fbdca98911d151e1dedde17493b8d18de95d86f1a20fb980b3ccf9728c98f92c2f8e13d6d8fa7fede2242b4e2b84fdbd74b06096f3a2ed1721b4b2c3bf36c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,87 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Include:
+    - "**/*.jbuilder"
+    - "**/*.rake"
+    - "**/config.ru"
+    - "**/Gemfile"
+    - "**/Rakefile"
+    - "**/Capfile"
+    - "**/Guardfile"
+    - "**/Vagrantfile"
+  Exclude:
+    - "bin/*"
+    - "old/**/*"
+    - "db/schema.rb"
+    - "node_modules/**/*"
+    - "vendor/**/*"
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyLines:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+AndOr:
+  Enabled: false
+
+# Allow use of empty lines to visually group code into "paragraphs"
+EmptyLines:
+  Enabled: false
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/SpaceAroundOperators:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - "db/migrate/*"
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+# https://viget.com/extend/just-use-double-quoted-ruby-strings
+Style/StringLiterals:
+  EnforcedStyle: "double_quotes"
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: "double_quotes"
+
+Style/GuardClause:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

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,67 @@
+ROLI Sprockets CommonJS
+=======================
+
+This library adds CommonJS support to
+[Sprockets](https://github.com/rails/sprockets).
+
+A fork of [maccman's](https://github.com/maccman/sprockets-commonjs) library,
+which is sadly no longer maintained.
+
+
+## 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()`:
+
+```javascript
+var asset = require('models/asset');
+```
+
+2. You export properties using `module.exports`:
+
+```javascript
+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 by giving any JS
+files you want as modules, the `.module.js` extension.
+
+Sprockets will then wrap up the JS library when it's requested, with the
+following:
+
+```javascript
+require.define({'library/name': function(exports, require, module){
+  /* Your library */
+}});
+```
+
+`require.define()` is defined inside `commonjs.js`, which you'll need to
+include in the page before any modules are loaded.
+
+```javascript
+// Inside application.js
+//
+// require_tree .
+```
+
+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 "roli-sprockets-commonjs"` to your `Gemfile`
+1. Add `.module.js` to any JavaScript files you want as modules, i.e.
+   `users.module.js`
+1. Require all the modules, e.g.: `//= require_tree ./models`
+1. Or, require individual modules, e.g.: `//= require users.module`

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "sprockets"
+require "sprockets/commonjs"
+require "rake/testtask"
+
+task :example do
+  env = Sprockets::Environment.new(File.expand_path("..", __FILE__))
+  env.append_path "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.libs << "test"
+  t.warning = true
+end

data/assets/sprockets/commonjs.js

@@ -0,0 +1,60 @@
+(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) {
+          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/examples/application.js

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

data/examples/example.js

@@ -0,0 +1,73 @@
+(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) {
+          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);
+this.require.define({"modules/program.cjs":function(exports, require, module){module.exports = function(){
+  alert('Long live the Programs!');
+};
+;}});
+this.require.define({"modules/user":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/lib/roli-sprockets-commonjs.rb

@@ -0,0 +1,2 @@
+# rubocop:disable Style/FileName
+require "sprockets/commonjs"

data/lib/sprockets/commonjs.rb

@@ -0,0 +1,54 @@
+require "sprockets"
+require "tilt"
+
+module Sprockets
+  class CommonJS < Tilt::Template
+
+    EXTENSIONS = %w(.module .cjs).freeze
+
+    class << self
+      attr_accessor :default_namespace
+    end
+
+    self.default_mime_type = "application/javascript"
+    self.default_namespace = "this.require"
+
+    protected
+
+    def prepare
+      @namespace = self.class.default_namespace
+    end
+
+    def evaluate(scope, _locals, &_block)
+      if commonjs_module?(scope)
+        scope.require_asset "sprockets/commonjs"
+        wrap_code(namespace, module_name(scope), data)
+      else
+        data
+      end
+    end
+
+
+    private
+
+    attr_reader :namespace
+
+    def wrap_code(ns, name, code)
+      "#{ns}.define({#{name}:function(exports, require, module){#{code};}});\n"
+    end
+
+    def commonjs_module?(scope)
+      EXTENSIONS.include?(File.extname(scope.logical_path))
+    end
+
+    def module_name(scope)
+      scope.logical_path
+           .gsub(%r{\A\.?/}, "") # Remove relative paths
+           .chomp(".module")     # Remove module ext
+           .inspect
+    end
+  end
+
+  register_postprocessor "application/javascript", CommonJS
+  append_path File.expand_path("../../../assets", __FILE__)
+end

data/roli-sprockets-commonjs.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "roli-sprockets-commonjs"
+  s.version     = "0.0.10"
+  s.authors     = ["ROLI", "Alex MacCaw"]
+  s.email       = ["info@eribium.org"]
+  s.homepage    = ""
+  s.summary     = %q{Adds CommonJS support to Sprockets}
+  s.description = s.summary
+
+  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 "rubocop"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: roli-sprockets-commonjs
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- ROLI
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 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: rubocop
+  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"
+- ".rubocop.yml"
+- 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
+- lib/roli-sprockets-commonjs.rb
+- lib/sprockets/commonjs.rb
+- roli-sprockets-commonjs.gemspec
+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: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adds CommonJS support to Sprockets
+test_files: []