sprockets-commoner 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72d705ccec2dcfa3c419987dffd054c3c9718905
-  data.tar.gz: 71803b7576ae34379d0ea53b8182edca664076ec
+  metadata.gz: 8a5ceb584e1eacf7990a65e0dfb94534f9d2fdd2
+  data.tar.gz: 4ba4cc82f4df684af207003516778fa80ee9fd81
 SHA512:
-  metadata.gz: 73d3e0c02678fc1a72a3aa5b33319dcc35874c38d8aa4d2eb9fcd62be1aeab6a3e5a8d2a58f55363b46f3c906e0bb3cee68479616289d729d1b8b06e8e83e2f7
-  data.tar.gz: 0d14803ec4e7d8bc7bc4d843fe4aacb12071f337c503ee8f8ddffa6fcb01e3c602ae19b1c23da9d91350d5b080ea17ae3782560ff4d9dde31c1fd818c49fa7a8
+  metadata.gz: 424bfe23119eef889e07d452835e7bae3ca03f96017e4be8614792aaedf6b2172a93abdb577263953641fba60a95d0641fdddae9a1eef67bf29ee77a1871723d
+  data.tar.gz: f094b1ba53d8da39d3fd06272960a5af01d8e366dc67abb6e740b8466b6990b184537b7a27d72b79e9ac096357a6687ad3d7ec99f901d6d42f88c4b381f58866

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## v0.2.0
+
+Add support for requiring JSON files.
+
+## v0.1.0
+
+Initial version.

data/README.md

@@ -1,6 +1,6 @@
 # Sprockets::Commoner
 
-`Sprockets::Commoner` is a gem that enables JavaScript package and Babel transformation in Sprockets.
+`Sprockets::Commoner` is a gem that enables JavaScript package and Babel transformation in Sprockets. It is meant as a replacement for [Browserify](http://browserify.org/) or [Webpack](https://webpack.github.io/) in Rails.
 
 ## Features
 
@@ -28,7 +28,7 @@ To get started, let's begin with the simplest possible set up: just enabling res
 1. Add `sprockets-commoner` to Gemfile, run `bundle install`, and restart your Rails server.
 1. Add package.json with `babel-core` version 6 and any packages you want. For the example, we'll use the excellent [lodash](https://lodash.com) library. `npm install -S babel-core@6 lodash`
 1. `require` your client-side JavaScript packages from `application.js`!
-```
+```javascript
 var _ = require('lodash');
 
 console.log(_.map([1, 2, 3], function(n) { return n * 3; }));
@@ -40,7 +40,7 @@ console.log(_.map([1, 2, 3], function(n) { return n * 3; }));
 1. Add a `.babelrc` with you required configuration. We just need to do `echo '{presets: ["es2015"]}' > .babelrc`.
 1. Use any feature you want! For example, let's use `import` and arrow functions in our `application.js`:
 
-```
+```javascript
 import {map} from 'lodash';
 
 console.log(map([1, 2, 3], (n) => n * 3));
@@ -52,7 +52,7 @@ console.log(map([1, 2, 3], (n) => n * 3));
 
 By default, commoner will process any file under the application root directory. If you want more fine-tuned control over which files to process, you can specify which paths to include or exclude. To do so, you will need to re-register the Sprockets processor. For example:
 
-```
+```ruby
 # In config/initializers/sprockets_commoner.rb
 Rails.application.config.assets.configure do |env|
   env.unregister_postprocessor('application/javascript', Sprockets::Commoner::Processor)
@@ -83,12 +83,12 @@ Commoner is designed from the start to facilitate a transition from CoffeeScript
 Any JavaScript file can `require` a CoffeeScript file, which will cause that CoffeeScript file to be scanned for a global variable reference and the `require` call to be replaced with a reference.
 If we have the following two files:
 
-```
+```coffeescript
 # file.coffee
 class window.ImportantClass
 ```
 
-```
+```javascript
 // main.js
 var klass = require('./file');
 
@@ -101,15 +101,15 @@ Then the second file will just be compiled down to `new window.ImportantClass()`
 
 We have added a custom directive that makes it very easy to expose an ES2015 module to the global namespace so it can be used by CoffeeScript files or any other code. For example:
 
-```
-'expose window.MyClass`;
+```javascript
+'expose window.MyClass';
 
 export default class MyClass {}
 ```
 
 `expose` will use the default export if available, otherwise the whole module namespace will be assigned to the global variable. For example:
 
-```
+```javascript
 // constants.js
 'expose window.Constants';
 
@@ -138,7 +138,7 @@ After the regular Babel plugins are done doing their thing, `babel-plugin-common
 * It finds any `require` calls and rewires them to variable references (as detailed in [`require` support](#require-support))
 * It wraps the module in a function and supplies it with `module` and `exports`. The end value of `module.exports` gets assigned to the module identifier, which is referenced by other files (as specified in '`require` support') Example:
 
-```
+```javascript
 var __commoner_module__node_modules$package$index_js = __commoner_initialize_module__(function (module, exports) {
   exports.default = 123;
 });
@@ -151,14 +151,14 @@ After all the files have been transformed, there is a bundle step which combines
 
 For example, if we have the following two files:
 
-```
+```javascript
 // module.js
 export default function a() {
   return 1;
 };
 ```
 
-```
+```javascript
 // application.js
 import a from './module';
 
@@ -167,7 +167,7 @@ a();
 
 We will end up with the following (browser-runnable) file:
 
-```
+```javascript
 !function() {
 var __commoner_initialize_module__ = function(f) {
   var module = {exports: {}};
@@ -202,4 +202,3 @@ var __commoner_module__app$assets$javascripts$application_js = __commoner_initia
 ```
 
 This file is meant to be compressed, and does incredibly well when processed by UglifyJS.
-

data/js/babel-plugin-sprockets-commoner-internal/index.js

@@ -25,9 +25,7 @@ if (typeof Object.assign != 'function') {
 
 var fs = require('fs');
 var dirname = require('path').dirname;
-var join = require('path').join;
 var resolve = require('browser-resolve').sync;
-var emptyModule = join(__dirname, 'node_modules', 'browser-resolve', 'empty.js');
 
 module.exports = function (context) {
   var t = context.types;
@@ -65,7 +63,7 @@ module.exports = function (context) {
     }
 
     if (identifiers.length === 0) {
-      return false;
+      throw new Error('No identifiers found in ' + path);
     } else if (identifiers.length > 1) {
       throw new Error('Multiple identifiers found in ' + path);
     }
@@ -116,16 +114,12 @@ module.exports = function (context) {
     return '__commoner_module__' + escapedPath;
   }
 
-  function resolveTarget(file, path, ensureTargetIsProcessed) {
+  function resolveTarget(file, path) {
     var name = void 0;
     if (opts.globals != null && (name = opts.globals[path]) != null) {
       return name;
     } else {
       var resolvedPath = resolve(path, opts);
-      if (resolvedPath === emptyModule) {
-        return false;
-      }
-
       file.metadata.required.push(resolvedPath);
 
       // Check if the path is under sourceRoot
@@ -135,13 +129,10 @@ module.exports = function (context) {
       }
 
       if (/\.coffee$/.test(resolvedPath)) {
-        // If it's a coffee script file, look for global variable assignments.
+        // If it's a coffee script file, look for global variable assignments
         return findDeclarationInCoffeeFile(resolvedPath);
       } else {
-        if (ensureTargetIsProcessed) {
-          file.metadata.targetsToProcess.push(resolvedPath);
-        }
-        // Otherwise we just look for the module by referencing its Special Identifier™.
+        // Otherwise we just look for the module by referencing its Special Identifier™
         return pathToIdentifier(resolvedPath);
       }
     }
@@ -163,14 +154,10 @@ module.exports = function (context) {
         return;
       }
 
-      var name = resolveTarget(state.file, target, true);
-      if (name === false) {
-        path.get('init').replaceWith(t.objectExpression([]));
-      } else {
-        path.scope.rename(name);
-        path.scope.rename(path.node.id.name, name);
-        path.remove();
-      }
+      var name = resolveTarget(state.file, target);
+      path.scope.rename(name);
+      path.scope.rename(path.node.id.name, name);
+      path.remove();
     },
     CallExpression: function CallExpression(path, state) {
       if (!isRequire(path)) {
@@ -182,21 +169,16 @@ module.exports = function (context) {
         return;
       }
 
+      var replacement = resolveTarget(state.file, target);
       switch (path.parent.type) {
-      case "ExpressionStatement":
-        // We just need to know there's a dependency, we can remove the `require` call.
-        resolveTarget(state.file, target, false);
-        path.remove();
-        break;
-      default:
-        // Otherwise we just look for the module by referencing its Special Identifier™.
-        var replacement = resolveTarget(state.file, target, true);
-        if (replacement === false) {
-          path.replaceWith(t.objectExpression([]));
-        } else {
+        case "ExpressionStatement":
+          // We just need to know there's a dependency, we can remove it then
+          path.remove();
+          break;
+        default:
+          // Otherwise we just look for the module by referencing its Special Identifier™
           path.replaceWith(t.identifier(replacement));
-        }
-        break;
+          break;
       }
     }
   };
@@ -206,9 +188,6 @@ module.exports = function (context) {
       if (file.metadata.required == null) {
         file.metadata.required = [];
       }
-      if (file.metadata.targetsToProcess == null) {
-        file.metadata.targetsToProcess = [];
-      }
     },
 
     visitor: {

data/lib/sprockets/commoner/json_processor.rb

@@ -0,0 +1,9 @@
+module Sprockets
+  module Commoner
+    class JSONProcessor
+      def self.call(input)
+        { data: "module.exports = #{input[:data]};" }
+      end
+    end
+  end
+end

data/lib/sprockets/commoner/processor.rb

@@ -4,19 +4,14 @@ require 'open3'
 module Sprockets
   module Commoner
     class Processor < Schmooze::Base
-
-      ExcludedFileError = Class.new(::StandardError)
-
-      VERSION = '1'.freeze
       BABELRC_FILE = '.babelrc'.freeze
       PACKAGE_JSON = 'package.json'.freeze
       JS_PACKAGE_PATH = File.expand_path('../../../js', __dir__)
-      ALLOWED_EXTENSIONS = /\.js(?:\.erb)?\z/
-      COFFEE_EXTENSION = /\.coffee(:?\.erb)?\z/
+      ALLOWED_EXTENSIONS = /\.js(?:on)?(?:\.erb)?\z/
 
       dependencies babel: 'babel-core', commoner: 'babel-plugin-sprockets-commoner-internal'
 
-      method :version, 'function() { return babel.version; }'
+      method :version, 'function() { return [process.version, babel.version]; }'
       method :transform, %q{function(code, opts, commonerOpts) {
   try {
     var file = new babel.File(opts);
@@ -49,25 +44,20 @@ module Sprockets
       end
 
       attr_reader :include, :exclude, :babel_exclude
-      def initialize(root, include: [root], exclude: ['vendor/bundle'], babel_exclude: [/node_modules/])
+      def initialize(root, include: [root], exclude: [], babel_exclude: [/node_modules/])
         @include = include.map {|path| expand_to_root(path, root) }
         @exclude = exclude.map {|path| expand_to_root(path, root) }
         @babel_exclude = babel_exclude.map {|path| expand_to_root(path, root) }
         super(root, 'NODE_PATH' => JS_PACKAGE_PATH)
       end
 
-      def cache_key
+      def call(input)
         @cache_key ||= [
           self.class.name,
-          VERSION,
           version,
-          @include.map(&:to_s),
-          @exclude.map(&:to_s),
-          @babel_exclude.map(&:to_s),
-        ]
-      end
+          VERSION,
+        ].freeze
 
-      def call(input)
         filename = input[:filename]
 
         return unless should_process?(filename)
@@ -80,14 +70,8 @@ module Sprockets
 
         babel_config = babelrc_data(filename)
 
-        result = transform(input[:data], options(input), paths: @env.paths)
-
-        if result['metadata'].has_key?('targetsToProcess')
-          result['metadata']['targetsToProcess'].each do |t|
-            unless should_process?(t)
-              raise ExcludedFileError, "#{t} was imported from #{filename} but this file won't be processed by Sprockets::Commoner"
-            end
-          end
+        result = input[:cache].fetch([filename, @cache_key, input[:data], babel_config]) do
+          transform(input[:data], options(input), paths: @env.paths)
         end
 
         if result['metadata'].has_key?('required')

data/lib/sprockets/commoner/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Commoner
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   end
 end

data/lib/sprockets/commoner.rb

@@ -1,4 +1,5 @@
 require 'sprockets'
+require 'sprockets/commoner/json_processor'
 require 'sprockets/commoner/processor'
 require 'sprockets/commoner/bundle'
 
@@ -7,6 +8,7 @@ module Sprockets
   end
 
   register_postprocessor 'application/javascript', ::Sprockets::Commoner::Processor
+  register_transformer 'application/json', 'application/javascript', ::Sprockets::Commoner::JSONProcessor
   register_bundle_metadata_reducer 'application/javascript', :commoner_enabled, false, :|
   register_bundle_metadata_reducer 'application/javascript', :commoner_used_helpers, Set.new, :+
   register_bundle_processor 'application/javascript', ::Sprockets::Commoner::Bundle

data/sprockets-commoner.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "sprockets", ">= 3", "< 4"
-  spec.add_dependency "schmooze", "~> 0.1.6"
+  spec.add_dependency "schmooze", "~> 0.1.5"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-commoner
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".nvmrc"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -153,6 +154,7 @@ files:
 - js/babel-plugin-sprockets-commoner/package.json
 - lib/sprockets/commoner.rb
 - lib/sprockets/commoner/bundle.rb
+- lib/sprockets/commoner/json_processor.rb
 - lib/sprockets/commoner/processor.rb
 - lib/sprockets/commoner/railtie.rb
 - lib/sprockets/commoner/version.rb
@@ -178,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Use Babel in Sprockets to compile modules for the browser