sprockets-commoner 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5d2ada3e40387a555b4b1be5c0284eeb8b82078
-  data.tar.gz: 00145faf36173d45a06d3fd4e8bd840b31a80c72
+SHA256:
+  metadata.gz: 5ed9326282bf87b5df475f96c527717170a5c7fc4a5913892f5f9b59d95e32b2
+  data.tar.gz: 1ee006c7d7fa8667b49fe8dd59dec1bcdb65ecf8a18db87e9348188dd826fa69
 SHA512:
-  metadata.gz: 609da3bec1c0a44a191105feafbe84e29bea5d299651c391b58b2fa8b76c867afccb1e44e4c8b7fe41d596305a6d955515a72a545d544cf313e2ae17fdec4f36
-  data.tar.gz: a46ce177fc4f3d19aa70c1bb872526da7251dc59866df310b2ccacd7064395f938c4cb1990c3a39407d66a926c96a0b752276ee8863918c5b13119300f22186a
+  metadata.gz: 0153d804065935185b1bb8eaf5e986e9aeb87d765da59a41818926dfe18fd563bfa8f292ddf8eba43803fc78d731de8480b0c6fe6f4bf2734eb0027c6e6eef77
+  data.tar.gz: 3e71a85683eaa949ce70306d8cc26b89d10d97a1f46d37b1a3ce5dcbf82bd8cf04e8c5b77d4386fbec54ea6f87921cda041e125b493f8095d314d396b3ba998c

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 node_modules
 npm-debug.log
+yarn.lock

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.6.5
+
+* Add file to follow `Bundler.require` convention.
+
+## v0.6.4
+
+* Add support for ExecJS.
+
+## v0.6.2
+
+* Add support for Sprockets 4
+
+## v0.6.1
+
+* Ensure a file's cache is busted if it depends on an environment variable.
+
 ## v0.6.0
 
 * Adds support for resolving files in other bundles to global variables.

data/Gemfile

@@ -1,3 +1,13 @@
 source 'https://rubygems.org'
 
+group :development, :test do
+  gem 'sprockets', github: 'rails/sprockets'
+end
+
+group :development do
+  gem 'pry'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+end
+
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Sprockets::Commoner
 
+### ⚠️ This gem is unmaintained. I advise you to use [Webpacker](https://github.com/rails/webpacker) in any new project ⚠️
+
 `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
@@ -17,7 +19,7 @@
 ### Requirements
 
 1. Ruby v2+.
-2. Rails/Any other application that uses Sprockets.
+2. Rails 4+/Any other application that uses Sprockets 3+.
 2. NPM v3+. We only support version 3 because commoner doesn't do any sort of deduplication of dependencies, so you could end up with a huge bundle if you don't want out. We only test against version 3, so you will definitely run into issues when running version 2.
 3. We recommend and support version 4+ of Node.js.
 
@@ -37,7 +39,7 @@ console.log(_.map([1, 2, 3], function(n) { return n * 3; }));
 ### Enabling Babel transforms
 
 1. Install any Babel plugins or presets you want to use. We'll use the default ES2015 preset; `npm install babel-preset-es2015`.
-1. Add a `.babelrc` with you required configuration. We just need to do `echo '{presets: ["es2015"]}' > .babelrc`.
+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
@@ -57,11 +59,11 @@ By default, commoner will process any file under the application root directory.
 Rails.application.config.assets.configure do |env|
   Sprockets::Commoner::Processor.configure(env,
     # include, exclude, and babel_exclude patterns can be path prefixes or regexes.
-    # Explicitely list paths to include. The default is `[env.root]`
+    # Explicitly list paths to include. The default is `[env.root]`
     include: ['app/assets/javascripts/subdirectory'],
     # List files to ignore and not process require calls or apply any Babel transforms to. Default is ['vendor/bundle'].
     exclude: ['vendor/bundle', /ignored/],
-    # Anything listed in babel_exclude has its require calls resolved, but no transforms listed in .babelrcs applied.
+    # Anything listed in babel_exclude has its require calls resolved, but no transforms listed in .babelrc applied.
     # Default is [/node_modules/]
     babel_exclude: [/node_modules/]
   )

data/bin/setup

@@ -4,12 +4,15 @@ set -euo pipefail
 gem install bundler --version '1.11.2'
 bundle check || bundle install -j 4
 
-for path in "./test/fixtures" "./test/fixtures/vendor-stub" "./js/babel-plugin-sprockets-commoner-internal" "./test/fixtures/root-node-modules" "./test/demo"; do
+for path in "./test/fixtures" "./test/fixtures/vendor-stub" "./test/fixtures/root-node-modules" "./test/demo"; do
   pushd "$path" >/dev/null
-  npm install
+  yarn install
   popd >/dev/null
 done
+pushd "./js/babel-plugin-sprockets-commoner-internal"
+npm install
+popd>/dev/null
 
 pushd "./test/demo"
 bundle check || bundle install -j 4
-popd
+popd>/dev/null

data/circle.yml

@@ -6,7 +6,12 @@ machine:
 
 dependencies:
   override:
+    - curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+    - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+    - sudo apt-get update && sudo apt-get install yarn
     - bin/setup
+  cache_directories:
+    - ~/.cache/yarn
 
 test:
   override:

data/js/babel-plugin-sprockets-commoner-internal/README.md

@@ -2,23 +2,4 @@
 
 ## Usage
 
-`babel-plugin-commoner` should be included in your `.babelrc` by adding `commoner`. You can't install it through npm, but this directory is automatically added to the path by the Sprockets plugin.
-
-## Options
-
-* `globals`: A mapping of module name to global variable name, which will ovveride any import of that package with a global variable reference.
-
-## Example
-
-```json
-{
-  presets: ["es2015"],
-  plugins: [
-    ["commoner", {
-      globals: {
-        "jquery": "$"
-      }
-    }]
-  ]
-}
-```
+`babel-plugin-commoner` is an internal plugin to Commoner, and not something you should add to your Babel configuration.

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

@@ -158,12 +158,8 @@ module.exports = function (context) {
       if (name === false) {
         path.get('init').replaceWith(t.objectExpression([]));
       } else {
-        if (path.scope.hasBinding(name)) {
-          path.scope.rename(name);
-        }
         path.scope.rename(path.node.id.name, name);
         path.remove();
-        path.scope.removeBinding(name);
       }
     },
     CallExpression: function CallExpression(path, state) {
@@ -203,13 +199,17 @@ module.exports = function (context) {
       if (file.metadata.targetsToProcess == null) {
         file.metadata.targetsToProcess = [];
       }
+      if (file.metadata.includedEnvironmentVariables == null) {
+        file.metadata.includedEnvironmentVariables = [];
+      }
     },
 
     visitor: {
-      MemberExpression: function MemberExpression(path) {
+      MemberExpression: function MemberExpression(path, state) {
         if (path.get("object").matchesPattern("process.env")) {
           var key = path.toComputedKey();
           if (t.isStringLiteral(key)) {
+            state.file.metadata.includedEnvironmentVariables.push(key.value);
             path.replaceWith(t.valueToNode(process.env[key.value]));
           }
         }

data/lib/sprockets-commoner.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sprockets/commoner'

data/lib/sprockets/commoner.rb

@@ -5,6 +5,9 @@ require 'sprockets/commoner/bundle'
 
 module Sprockets
   module Commoner
+    def self.sprockets4?
+      @@sprockets4 ||= Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('4.0.0.beta')
+    end
   end
 
   register_postprocessor 'application/javascript', ::Sprockets::Commoner::Processor
@@ -13,6 +16,10 @@ module Sprockets
   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
+  register_dependency_resolver 'commoner-environment-variable' do |env, str|
+    _, variable = str.split(':', 2)
+    ENV[variable]
+  end
 end
 
 require 'sprockets/commoner/railtie' if defined?(Rails)

data/lib/sprockets/commoner/bundle.rb

@@ -29,17 +29,16 @@ function(helpers, globalIdentifiers) {
 JS
 
       PRELUDE = <<-JS.freeze
-!function() {
+!function(global) {
 var __commoner_initialize_module__ = function(f) {
   var module = {exports: {}};
   f.call(module.exports, module, module.exports);
   return module.exports;
 };
-var global = window;
 JS
 
       OUTRO = <<-JS.freeze
-}();
+}(typeof global != 'undefined' ? global : typeof window != 'undefined' ? window : this);
 JS
       def initialize(root)
         super(root, 'NODE_PATH' => JS_PACKAGE_PATH)
@@ -63,7 +62,11 @@ JS
         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)
+          uri, _ = if Commoner.sprockets4?
+            env.resolve(filename, accept: input[:content_type], pipeline: :self)
+          else
+            env.resolve(filename, accept: input[:content_type], pipeline: :self, compat: false)
+          end
           asset = env.load(uri)
           # Retrieve the global variable the file is exposed through
           global = asset.metadata[:commoner_global_identifier]
@@ -74,9 +77,26 @@ JS
         used_helpers = input[:metadata][:commoner_used_helpers].to_a
         header_code = generate_header(used_helpers, global_identifiers)
         {
-          data: "#{PRELUDE}#{header_code}\n#{input[:data]}#{OUTRO}"
+          data: "#{PRELUDE}#{header_code}\n#{input[:data]}#{OUTRO}",
+          map:  shift_map(input[:metadata][:map], PRELUDE.lines.count + header_code.lines.count),
         }
       end
+
+      private
+
+      def shift_map(map, offset)
+        return unless map && Commoner.sprockets4?
+        index_map = Sprockets::SourceMapUtils.make_index_map(map)
+        index_map.merge({
+          "sections" => index_map["sections"].map { |section|
+            section.merge({
+              "offset" => section["offset"].merge({
+                "line" => section["offset"]["line"] + offset
+              })
+            })
+          }
+        })
+      end
     end
   end
 end

data/lib/sprockets/commoner/processor.rb

@@ -7,7 +7,7 @@ module Sprockets
 
       ExcludedFileError = Class.new(::StandardError)
 
-      VERSION = '2'.freeze
+      VERSION = '3'.freeze
       BABELRC_FILE = '.babelrc'.freeze
       PACKAGE_JSON = 'package.json'.freeze
       JS_PACKAGE_PATH = File.expand_path('../../../js', __dir__)
@@ -100,10 +100,17 @@ module Sprockets
           @required.insert(insertion_index, asset)
         end
 
+        result['metadata']['includedEnvironmentVariables'].each do |env|
+          @dependencies << "commoner-environment-variable:#{env}"
+        end
+
+        map = process_map(input[:metadata][:map], result['map'], input)
+
         {
           data: result['code'],
           dependencies: @dependencies,
           required: Set.new(@required),
+          map: map,
 
           commoner_global_identifier: result['metadata']['globalIdentifier'],
           commoner_required: commoner_required,
@@ -113,6 +120,13 @@ module Sprockets
       end
 
       private
+        def process_map(oldmap, map, input)
+          if Commoner.sprockets4?
+            formatted_map = Sprockets::SourceMapUtils.format_source_map(map, input)
+            Sprockets::SourceMapUtils.combine_source_maps(oldmap, formatted_map)
+          end
+        end
+
         def compute_cache_key
           package_file = File.join(@root, 'node_modules', 'babel-core', 'package.json')
           raise Schmooze::DependencyError, 'Cannot determine babel version as babel-core has not been installed' unless File.exist?(package_file)
@@ -193,7 +207,6 @@ module Sprockets
         end
 
         def options(input)
-          # TODO(bouk): Fix sourcemaps. Sourcemaps are only available in Sprockets v4
           {
             'ast' => false,
             'babelrc' => !match_any?(self.babel_exclude, input[:filename]),
@@ -201,6 +214,7 @@ module Sprockets
             'filenameRelative' => PathUtils.split_subpath(input[:load_path], input[:filename]),
             'moduleRoot' => nil,
             'sourceRoot' => @env.root,
+            'sourceMaps' => Commoner.sprockets4?,
           }
         end
 

data/lib/sprockets/commoner/railtie.rb

@@ -3,7 +3,8 @@ module Sprockets
     class Railtie < ::Rails::Railtie
       initializer 'sprockets-commoner' do
         # We need to disable debugging because otherwise Rails will include each file individually, while we need everything to be bundled up together into a single file.
-        config.assets.debug = false
+        # ^ Not applicable to sprockets 4+
+        config.assets.debug = false unless Commoner.sprockets4?
         config.assets.paths << 'node_modules'
       end
     end

data/lib/sprockets/commoner/version.rb

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

data/sprockets-commoner.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-commoner
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: schmooze
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +154,7 @@ files:
 - 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.rb
 - lib/sprockets/commoner/bundle.rb
 - lib/sprockets/commoner/json_processor.rb
@@ -181,8 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Use Babel in Sprockets to compile modules for the browser