sprockets-bumble_d 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e344b1743d35a046b99bbc04c8e28345d7d41214
+  data.tar.gz: 307b8f0365ae245ab881b5cff1f75d9163beaf9b
+SHA512:
+  metadata.gz: 6a751efa6deee7bb1b77e4acbf1acb7aee4d4063c91fd5746f184fe4ef58d51fe8329dedea49ff185997d62f355eb1bcce2e1551c2ca3616e4e235712f25e4d9
+  data.tar.gz: a539c07de181232403dffc71c06f9b8c887e0b97a7c38d94757b40678e0ebed5f91201231ce2628dda3b78d646e23857d566d9850ed5dd93a754ad4c6b85d0c3

data/lib/sprockets/bumble_d.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+require 'schmooze'
+require 'sprockets'
+require 'sprockets/bumble_d/dsl'
+require 'sprockets/bumble_d/errors'
+require 'sprockets/bumble_d/railtie'
+require 'sprockets/bumble_d/version'
+
+module Sprockets
+  module BumbleD
+  end
+end

data/lib/sprockets/bumble_d/config.rb

@@ -0,0 +1,33 @@
+require 'sprockets/bumble_d/errors'
+
+module Sprockets
+  module BumbleD
+    class Config
+      attr_accessor :babel_options, :babel_config_version, :root_dir, :transform_to_umd
+      attr_reader :globals_map
+
+      def initialize
+        @globals_map = {}.freeze
+        @transform_to_umd = true
+        @babel_options = {
+          presets: ['es2015'],
+          plugins: ['external-helpers']
+        }
+      end
+
+      def configure
+        yield self
+      end
+
+      def register_globals(globals_map)
+        duplicate_keys = @globals_map.keys & globals_map.keys
+        unless duplicate_keys.empty?
+          error_message = "Duplicate keys registered: #{duplicate_keys}"
+          raise ConflictingGlobalRegistrationError, error_message
+        end
+
+        @globals_map = @globals_map.merge(globals_map).freeze
+      end
+    end
+  end
+end

data/lib/sprockets/bumble_d/dsl.rb

@@ -0,0 +1,19 @@
+module Sprockets
+  module BumbleD
+    module DSL
+      def configure_sprockets_bumble_d(&block)
+        initializer 'configure_sprockets_bumble_d',
+                    before: 'sprockets-bumble_d.configure_transformer' do |app|
+          app.config.sprockets_bumble_d.configure(&block)
+        end
+      end
+
+      def register_umd_globals(module_name, globals_map)
+        initializer "#{module_name}.register_umd_globals",
+                    before: 'sprockets-bumble_d.configure_transformer' do |app|
+          app.config.sprockets_bumble_d.register_globals(globals_map)
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/bumble_d/errors.rb

@@ -0,0 +1,8 @@
+module Sprockets
+  module BumbleD
+    class Error < StandardError; end
+
+    class ConflictingGlobalRegistrationError < Error; end
+    class RootDirectoryDoesNotExistError < Error; end
+  end
+end

data/lib/sprockets/bumble_d/railtie.rb

@@ -0,0 +1,46 @@
+require 'sprockets/bumble_d/config'
+require 'sprockets/bumble_d/transformer'
+
+module Sprockets
+  module BumbleD
+    class Railtie < ::Rails::Railtie
+      config.before_configuration do
+        config.sprockets_bumble_d = Config.new
+      end
+
+      initializer 'sprockets-bumble_d.configure_transformer' do |app|
+        bumble_d_config = app.config.sprockets_bumble_d
+        root_dir = bumble_d_config.root_dir
+        babel_config_version = bumble_d_config.babel_config_version
+        babel_plugins = bumble_d_config.babel_options[:plugins]
+
+        if bumble_d_config.transform_to_umd
+          babel_plugins += [
+            ['transform-es2015-modules-umd', {
+              exactGlobals: true,
+              globals: bumble_d_config.globals_map
+            }]
+          ]
+        end
+
+        options = bumble_d_config.babel_options.merge(
+          plugins: babel_plugins,
+          root_dir: root_dir,
+          babel_config_version: babel_config_version
+        )
+        es6_transformer = Transformer.new(options)
+
+        # Using the deprecated register_engine rather than register_mime_type
+        # and register_transformer because otherwise .es6 files that aren't
+        # in the precompile list will get unnecessarily compiled. See
+        # https://github.com/rails/sprockets/issues/384
+        Sprockets.register_engine(
+          '.es6',
+          es6_transformer,
+          mime_type: 'application/javascript',
+          silence_deprecation: true
+        )
+      end
+    end
+  end
+end

data/lib/sprockets/bumble_d/resolver.rb

@@ -0,0 +1,29 @@
+module Sprockets
+  module BumbleD
+    class Resolver
+      def initialize(babel)
+        @babel = babel
+      end
+
+      def resolve_plugins(plugins)
+        resolve_them(plugins, type: 'Plugin')
+      end
+
+      def resolve_presets(presets)
+        resolve_them(presets, type: 'Preset')
+      end
+
+      private
+
+      def resolve_them(plugins_or_presets, type:)
+        plugins_or_presets.map do |item|
+          if item.is_a?(Array)
+            [@babel.send("resolve#{type}", item[0]), item[1]]
+          else
+            @babel.send("resolve#{type}", item)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/bumble_d/transformer.rb

@@ -0,0 +1,89 @@
+require 'schmooze/base'
+require 'sprockets/path_utils'
+require 'sprockets/bumble_d/errors'
+require 'sprockets/bumble_d/resolver'
+require 'sprockets/bumble_d/version'
+
+module Sprockets
+  module BumbleD
+    class Transformer
+      class BabelBridge < Schmooze::Base
+        dependencies babel: 'babel-core'
+
+        method :resolvePlugin, 'babel.resolvePlugin'
+        method :resolvePreset, 'babel.resolvePreset'
+        method :transform, 'babel.transform'
+      end
+
+      attr_reader :cache_key
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def initialize(options)
+        @options = options.dup
+        @root_dir = @options.delete(:root_dir)
+        babel_config_version = @options.delete(:babel_config_version)
+
+        unless @root_dir && File.directory?(@root_dir)
+          error_message =
+            'You must provide the `root_dir` directory from which ' \
+            'node modules are to be resolved'
+          raise RootDirectoryDoesNotExistError, error_message
+        end
+
+        resolver = Resolver.new(babel)
+        plugins = @options[:plugins]
+        presets = @options[:presets]
+        @options[:plugins] = resolver.resolve_plugins(plugins) if plugins.is_a?(Array)
+        @options[:presets] = resolver.resolve_presets(presets) if presets.is_a?(Array)
+
+        @cache_key = [
+          self.class.name,
+          VERSION,
+          babel_config_version,
+          @options
+        ].freeze
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def call(input)
+        data = input[:data]
+
+        result = input[:cache].fetch(cache_key_from_input(input)) do
+          filename_relative = Sprockets::PathUtils.split_subpath(
+            input[:load_path],
+            input[:filename]
+          )
+
+          options = {
+            moduleIds: true,
+            sourceRoot: input[:load_path],
+            moduleRoot: nil,
+            filename: input[:filename],
+            filenameRelative: filename_relative,
+            ast: false
+          }.merge(@options)
+
+          if options[:moduleIds] && options[:moduleRoot]
+            options[:moduleId] ||= File.join(options[:moduleRoot], input[:name])
+          elsif options[:moduleIds]
+            options[:moduleId] ||= input[:name]
+          end
+
+          babel.transform(data, options)
+        end
+
+        { data: result['code'] }
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      def cache_key_from_input(input)
+        @cache_key + [input[:filename]] + [input[:data]]
+      end
+
+      def babel
+        @babel ||= BabelBridge.new(@root_dir)
+      end
+    end
+  end
+end

data/lib/sprockets/bumble_d/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  module BumbleD
+    VERSION = '1.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-bumble_d
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richard Macklin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: schmooze
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |2
+      Babel + UMD = BumbleD
+      Facilitate incremental migration of a large Sprockets-powered javascript
+      codebase to ES6 modules by transforming them to UMD modules that preserve
+      your existing global references.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sprockets/bumble_d.rb
+- lib/sprockets/bumble_d/config.rb
+- lib/sprockets/bumble_d/dsl.rb
+- lib/sprockets/bumble_d/errors.rb
+- lib/sprockets/bumble_d/railtie.rb
+- lib/sprockets/bumble_d/resolver.rb
+- lib/sprockets/bumble_d/transformer.rb
+- lib/sprockets/bumble_d/version.rb
+homepage: https://github.com/rmacklin/sprockets-bumble_d
+licenses:
+- MIT
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Let Sprockets use Babel to transpile ES6 modules to UMD
+test_files: []