sprockets-commoner 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c966579c74d914919277d60a4d2dc6f3738e4dc
-  data.tar.gz: e9121bab180fabdc0ba4336149f58a91847bcde5
+  metadata.gz: b5d2ada3e40387a555b4b1be5c0284eeb8b82078
+  data.tar.gz: 00145faf36173d45a06d3fd4e8bd840b31a80c72
 SHA512:
-  metadata.gz: 94ed97e08219884f90f18bbf8829ce061c9cc51d47adbeb21e3b3cf91209dc55b6307348f5e631a3d17f63658f07b369cae7420f5cf81d80185a0f7ef6b9baba
-  data.tar.gz: 2bedd0b57bfcbaa99e8ddb6e52f876d344619ad6212e8e010dd434cb8665407621fed4ddc95829c4b4142a69f9e482b4f95ed855692196e4aca8c3921a20f7bb
+  metadata.gz: 609da3bec1c0a44a191105feafbe84e29bea5d299651c391b58b2fa8b76c867afccb1e44e4c8b7fe41d596305a6d955515a72a545d544cf313e2ae17fdec4f36
+  data.tar.gz: a46ce177fc4f3d19aa70c1bb872526da7251dc59866df310b2ccacd7064395f938c4cb1990c3a39407d66a926c96a0b752276ee8863918c5b13119300f22186a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.6.0
+
+* Adds support for resolving files in other bundles to global variables.
+
 ## v0.5.1
 
 * Make sure we error out if an identifier is requested from a CoffeeScript file and there is none present.

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

@@ -28,6 +28,7 @@ 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');
+var pathToIdentifier = require('./path-to-identifier');
 
 module.exports = function (context) {
   var t = context.types;
@@ -106,19 +107,6 @@ module.exports = function (context) {
     return null;
   }
 
-
-  // Transform a path into a variable name
-  function pathToIdentifier(path) {
-    var escapedPath = path.replace(rootRegex, '').replace(/[^a-zA-Z0-9_]/g, function (match) {
-      if (match === '/') {
-        return '$';
-      } else {
-        return '_';
-      }
-    });
-    return '__commoner_module__' + escapedPath;
-  }
-
   function resolveTarget(file, path, ensureTargetIsProcessed) {
     var name = void 0;
     if (opts.globals != null && (name = opts.globals[path]) != null) {
@@ -145,7 +133,7 @@ module.exports = function (context) {
           file.metadata.targetsToProcess.push(resolvedPath);
         }
         // Otherwise we just look for the module by referencing its Special Identifier™.
-        return pathToIdentifier(resolvedPath);
+        return pathToIdentifier(resolvedPath.replace(rootRegex, ''));
       }
     }
   }
@@ -265,10 +253,11 @@ module.exports = function (context) {
           state.file.metadata.commonerEnabled = true;
 
           var node = path.node;
-          var identifier = pathToIdentifier(state.file.opts.filename);
+          var identifier = pathToIdentifier(state.file.opts.filename.replace(rootRegex, ''));
           var expose = findExpose(node.directives);
           if (expose != null) {
             node.body.push(exposeTemplate(t.identifier(expose)));
+            state.file.metadata.globalIdentifier = expose;
           }
 
           // Transform module to a variable assignment.

data/js/babel-plugin-sprockets-commoner-internal/path-to-identifier.js

@@ -0,0 +1,11 @@
+// Transform a path into a variable name
+module.exports = function pathToIdentifier(path) {
+  var escapedPath = path.replace(/[^a-zA-Z0-9_]/g, function (match) {
+    if (match === '/') {
+      return '$';
+    } else {
+      return '_';
+    }
+  });
+  return '__commoner_module__' + escapedPath;
+};

data/lib/sprockets/commoner.rb

@@ -10,6 +10,7 @@ module Sprockets
   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_required, Set.new, :+
   register_bundle_metadata_reducer 'application/javascript', :commoner_used_helpers, Set.new, :+
   register_bundle_processor 'application/javascript', ::Sprockets::Commoner::Bundle
 end

data/lib/sprockets/commoner/bundle.rb

@@ -3,20 +3,27 @@ require 'schmooze'
 module Sprockets
   module Commoner
     class Bundle < Schmooze::Base
+
+      InaccessibleStubbedFileError = Class.new(::StandardError)
+
+      JS_PACKAGE_PATH = File.expand_path('../../../js', __dir__)
+
       dependencies generator: 'babel-generator.default',
         babelHelpers: 'babel-helpers',
-        t: 'babel-types'
+        t: 'babel-types',
+        pathToIdentifier: 'babel-plugin-sprockets-commoner-internal/path-to-identifier'
 
-      method :generate_helpers, <<-JS
-function(helpers) {
-  if (helpers.length === 0) {
+      method :generate_header, <<-JS
+function(helpers, globalIdentifiers) {
+  var declarators = helpers.map(function(helper) {
+    return t.variableDeclarator(t.identifier('__commoner_helper__' + helper), babelHelpers.get(helper));
+  }).concat(globalIdentifiers.map(function(item) {
+    return t.variableDeclarator(t.identifier(pathToIdentifier(item[0])), t.identifier(item[1]));
+  }));
+  if (declarators.length === 0) {
     return '';
   }
-  var declaration = t.variableDeclaration('var',
-    helpers.map(function(helper) {
-      return t.variableDeclarator(t.identifier('__commoner_helper__' + helper), babelHelpers.get(helper));
-    })
-  );
+  var declaration = t.variableDeclaration('var', declarators);
   return generator(declaration).code;
 }
 JS
@@ -34,21 +41,40 @@ JS
       OUTRO = <<-JS.freeze
 }();
 JS
+      def initialize(root)
+        super(root, 'NODE_PATH' => JS_PACKAGE_PATH)
+      end
+
       def self.instance(env)
         @instance ||= new(env.root)
       end
 
       def self.call(input)
-        instance(input[:environment]).call(input)
+        env = input[:environment]
+        instance(env).call(input)
       end
 
       def call(input)
         return unless input[:metadata][:commoner_enabled]
+        env = input[:environment]
+        # Get the filenames of all the assets that are included in the bundle
+        assets_in_bundle = Set.new(input[:metadata][:included]) { |uri| env.load(uri).filename }
+        # Subtract the assets in the bundle from those that are required. The missing assets were excluded through stubbing.
+        assets_missing = input[:metadata][:commoner_required] - assets_in_bundle
+
+        global_identifiers = assets_missing.map do |filename|
+          uri, _ = env.resolve(filename, type: input[:content_type], pipeline: :self, compat: false)
+          asset = env.load(uri)
+          # Retrieve the global variable the file is exposed through
+          global = asset.metadata[:commoner_global_identifier]
+          raise InaccessibleStubbedFileError, "#{filename} is stubbed in #{input[:filename]} but doesn't define a global. Add an 'expose' directive." if global.nil?
+          [filename.slice(env.root.size + 1, filename.size), global]
+        end
 
-        used_helpers = input[:metadata][:commoner_used_helpers]
-        helpers = generate_helpers(used_helpers.to_a)
+        used_helpers = input[:metadata][:commoner_used_helpers].to_a
+        header_code = generate_header(used_helpers, global_identifiers)
         {
-          data: "#{PRELUDE}#{helpers}\n#{input[:data]}#{OUTRO}"
+          data: "#{PRELUDE}#{header_code}\n#{input[:data]}#{OUTRO}"
         }
       end
     end

data/lib/sprockets/commoner/processor.rb

@@ -87,19 +87,17 @@ module Sprockets
         babel_config = babelrc_data(filename)
         result = transform(input[:data], options(input), commoner_options(input))
 
-        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
+        commoner_required = Set.new(input[:metadata][:commoner_required])
+        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
+          commoner_required.add(t)
         end
 
-        if result['metadata'].has_key?('required')
-          result['metadata']['required'].each do |r|
-            asset = resolve(r, accept: input[:content_type], pipeline: :self)
-            @required.insert(insertion_index, asset)
-          end
+        result['metadata']['required'].each do |r|
+          asset = resolve(r, accept: input[:content_type], pipeline: :self)
+          @required.insert(insertion_index, asset)
         end
 
         {
@@ -107,6 +105,8 @@ module Sprockets
           dependencies: @dependencies,
           required: Set.new(@required),
 
+          commoner_global_identifier: result['metadata']['globalIdentifier'],
+          commoner_required: commoner_required,
           commoner_used_helpers: Set.new(input[:metadata][:commoner_used_helpers]) + result['metadata']['usedHelpers'],
           commoner_enabled: input[:metadata][:commoner_enabled] | result['metadata']['commonerEnabled'],
         }

data/lib/sprockets/commoner/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Commoner
-    VERSION = '0.5.1'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-commoner
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -153,6 +153,7 @@ files:
 - js/babel-plugin-sprockets-commoner-internal/node_modules/resolve/lib/sync.js
 - js/babel-plugin-sprockets-commoner-internal/node_modules/resolve/package.json
 - js/babel-plugin-sprockets-commoner-internal/package.json
+- js/babel-plugin-sprockets-commoner-internal/path-to-identifier.js
 - lib/sprockets/commoner.rb
 - lib/sprockets/commoner/bundle.rb
 - lib/sprockets/commoner/json_processor.rb