jass-rollup 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 366d04569adca5967e9fdfe78513f5d5002def5f08d271f8ba87a52cde06ae4f
+  data.tar.gz: 25490df65797582e189ff087ad8ec8e3a639280ee8f5d87b24b5c7e5ad6fb6a5
+SHA512:
+  metadata.gz: 44823decd0e6d4da71e854e465d2f8a71e50b13186bdb57085e19580fe02c62e390ec406d04664841aa9e54d32bf40c80260a5564b8792a38dc9236aefbba62e
+  data.tar.gz: f7c0a706a9341fc9c079c4c7a802210065b5c63b6787818daaee4ea7918cc404725281a9460cf7944cbe3a449f75e812e55795fa4a2f12d295a20b37b2846bda

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Matthias Grosser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+[![Gem Version](https://badge.fury.io/rb/jass-rollup.svg)](http://badge.fury.io/rb/nodo)  [![build](https://github.com/mtgrosser/jass-rollup/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/jass-rollup/actions/workflows/build.yml)
+
+# Jass::Rollup – Rollup for Sprockets and the Rails asset pipeline
+
+`Jass::Rollup` integrates the [Rollup](https://rollupjs.org) JS bundler with Sprockets and the Rails asset pipeline.
+
+## 💡 Motivation
+
+JavaScript build pipelines tend to be a complicated mess consisting of dev servers,
+an infinite number of `npm` dependencies and other "opinionated" conventions (and lack thereof).
+
+The `Jass` gem series provide a straightforward way of integrating modern JS tooling
+with the existing Rails asset pipeline, while adhering to established workflows
+for asset processing in Rails applications.
+
+## 📦 Installation
+
+### Gemfile
+
+```ruby
+gem 'jass-rollup'
+```
+
+### JS dependencies
+
+Add `rollup` to your JS dependencies:
+
+```sh
+$ yarn add rollup @rollup/plugin-commonjs @rollup/plugin-node-resolve
+```
+
+### Node.js
+
+`Jass::Rollup` depends on [Nodo](https://github.com/mtgrosser/nodo), which requires a working Node.js installation.
+
+## ⚡️ Usage
+
+`Jass::Rollup` provides two new directives to use in your JS assets, as well as
+a new Sprockets file extension for rollup bundle config files.
+
+### rollup
+
+The `rollup` directive will invoke `Rollup` with the given entry point
+relative to your `Rails.root`.
+
+To bundle an entry point as ES module:
+
+```js
+//= rollup app/javascript/entry.js
+```
+
+To bundle a `npm` module as ES module:
+
+```js
+//= rollup vendor/node_modules/rxjs/dist/esm5/index.js
+```
+
+### rollup_esm
+
+The `require_esm` directive will bundle a `npm` module referenced by its
+name as ES module:
+
+```js
+//= rollup_esm currency.js
+```
+
+### Bundling with custom rollup configurations
+
+If your Rollup bundle requires extra configuration options, e.g. plugins, the file
+extension `.rollup` can be used:
+
+```js
+// assets/javascript/main.js.rollup
+export default {
+  input: 'app/javascript/entry.js',
+  output: {
+    format: 'es'
+  }
+};
+```
+
+This asset will be bundled to `main.js`.
+
+
+## 💎 Other Jass gems for the asset pipeline
+
+[Jass::Esbuild](https://github.com/mtgrosser/jass-esbuild) – esbuild support for Sprockets
+
+[Jass::Vue::SFC](https://github.com/mtgrosser/jass-vue-sfc) – Vue Single File Component support for Sprockets
+
+[Jass::React::JSX](https://github.com/mtgrosser/jass-react-jsx) – React JSX support for Sprockets

data/lib/jass/rollup/compiler.rb

@@ -0,0 +1,74 @@
+class Jass::Rollup::Compiler < Nodo::Core
+  require :rollup,
+          commonjs: '@rollup/plugin-commonjs', 
+          nodeResolve: '@rollup/plugin-node-resolve'
+
+  # workaround for https://github.com/rollup/rollup/issues/4251
+  script <<~'JS'
+    const loadConfigFile = require(path.join(path.dirname(require.resolve('rollup')), 'loadConfigFile'));
+  JS
+
+  class_function def compile(config)
+    result = bundle(config)
+    result.fetch('output').first.slice('code', 'map')
+  end
+  
+  class_function def compile_esm(mod)
+    result = bundle_esm(mod)
+    result.fetch('output').first.slice('code', 'map')
+  end
+  
+  class_function def compile_entry(entry)
+    result = bundle_entry(entry)
+    result.fetch('output').first.slice('code', 'map')
+  end
+  
+  function :default_plugins, <<~'JS'
+    () => [
+      nodeResolve.nodeResolve({ moduleDirectories: [process.env.NODE_PATH] }),
+      commonjs({ requireReturnsDefault: 'namespace', defaultIsModuleExports: true })
+    ]
+  JS
+  
+  function :bundle_esm, <<~'JS'
+    async (mod) => {
+      const entry = require.resolve(mod);
+      return await bundle_entry(entry);
+    }
+  JS
+  
+  function :bundle, <<~'JS'
+    async (config) => {
+      const { options, warnings } = await loadConfigFile(config, { format: 'es' });
+      
+      warnings.flush();
+      
+      let inputOptions = options[0];
+      let outputOptions = options[0].output[0];
+      let inputPlugins = inputOptions.plugins;
+
+      if (inputPlugins && inputPlugins.length == 1 && inputPlugins[0].name == 'stdin') {
+        inputPlugins.push(...default_plugins().reverse());
+      }
+
+      const bundle = await rollup.rollup(inputOptions);
+      return await bundle.generate(outputOptions);
+    }
+  JS
+  
+  function :bundle_entry, <<~'JS'
+    async (entry) => {
+      const inputOptions = {
+        input: entry,
+        plugins: default_plugins()
+      };
+      const outputOptions = {
+        format: 'es',
+        exports: 'named'
+      };
+      const bundle = await rollup.rollup(inputOptions);
+      return await bundle.generate(outputOptions);
+    }
+  JS
+
+end

data/lib/jass/rollup/directive_processor.rb

@@ -0,0 +1,45 @@
+module Jass
+  module Rollup
+    class DirectiveProcessor
+      DIRECTIVES = %w[rollup rollup_esm require_npm].freeze
+      
+      class << self
+        def instance
+          @instance ||= new
+        end
+        
+        def call(input)
+          instance.call(input)
+        end
+      end
+
+      def call(input)
+        data = "#{input[:data] || ''}"
+        data.gsub!(%r{^//=\s*(?<directive>#{DIRECTIVES.join('|')})\s+(?<args>.+)$}) do
+          match = Regexp.last_match
+          process_matching_directive(match[:directive], match[:args].squish.split(' '))
+        end
+        { data: data }
+      end
+      
+      def process_matching_directive(name, args)
+        "#{send("process_#{name}_directive", *args)}\n"
+      rescue => e
+        e.set_backtrace(["#{@filename}:0"] + e.backtrace)
+        raise e
+      end
+      
+      def process_rollup_esm_directive(mod)
+        Compiler.compile_esm(mod).fetch('code')
+      end
+
+      def process_rollup_directive(entry, *args)
+        Compiler.compile_entry(entry).fetch('code')
+      end
+      
+      def process_require_npm_directive(path, *args)
+        File.read(File.expand_path(path, Nodo.modules_root))
+      end
+    end
+  end
+end

data/lib/jass/rollup/processor.rb

@@ -0,0 +1,22 @@
+module Jass::Rollup::Processor
+  VERSION = '1'
+
+  class << self
+    
+    def cache_key
+      @cache_key ||= "#{name}:#{VERSION}".freeze
+    end
+    
+    def call(input)
+      data = input[:data]
+
+      code, map = input[:cache].fetch([self.cache_key, data]) do
+        result = Jass::Rollup::Compiler.compile(input[:filename])
+        [result['code'], nil]
+      end
+
+      { data: code }
+    end
+  
+  end
+end

data/lib/jass/rollup/version.rb

@@ -0,0 +1,5 @@
+module Jass
+  module Rollup
+    VERSION = '0.6.0'
+  end
+end

data/lib/jass/rollup.rb

@@ -0,0 +1,19 @@
+require 'nodo'
+
+require_relative 'rollup/version'
+require_relative 'rollup/compiler'
+
+begin
+  require 'sprockets'
+rescue LoadError
+  # Sprockets not available
+end
+
+if defined?(Sprockets)
+  require_relative 'rollup/processor'
+  require_relative 'rollup/directive_processor'
+  
+  Sprockets.register_mime_type 'application/javascript+rollup-config', extensions: %w[.js.rollup .rollup], charset: :unicode
+  Sprockets.register_transformer 'application/javascript+rollup-config', 'application/javascript', Jass::Rollup::Processor
+  Sprockets.register_preprocessor 'application/javascript', Jass::Rollup::DirectiveProcessor
+end

data/lib/jass-rollup.rb

@@ -0,0 +1 @@
+require_relative 'jass/rollup'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: jass-rollup
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Matthias Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nodo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 
+email:
+- mtgrosser@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jass-rollup.rb
+- lib/jass/rollup.rb
+- lib/jass/rollup/compiler.rb
+- lib/jass/rollup/directive_processor.rb
+- lib/jass/rollup/processor.rb
+- lib/jass/rollup/version.rb
+homepage: https://github.com/mtgrosser/jass-rollup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Rollup for Sprockets and the Rails asset pipeline
+test_files: []