opal-sprockets 0.4.5.1.0.3.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4fea42b4e089b7da5235e189941d2882c81e229f4016813ad1c431c1cb0937
-  data.tar.gz: da9543d5252c5ef2c906cf1bb6b6b9cda8fa654d3023800a7398ca39547b3160
+  metadata.gz: 3b7553caf49b2308f3315be681e7b7ab68d57eaf46b391927e6b1b5942aa8b4e
+  data.tar.gz: 846dd949a0c534c4053b0a298c927bbb101aa5788a7480ba7a855c902a1f599f
 SHA512:
-  metadata.gz: 86f846edd06ce32281a77233b7a160f2ff4ae197fd4b974fc7f58d551a68a84e27d93e693cdeb06f416b5620c459503b2cc2fca305f603ec28ee1afe96a61ca8
-  data.tar.gz: f8f35614551b30c6b9e49b0566cd61fb653860196c904a8b4c7b4d7b28fc3bca1f0b1068435e1cfa68fa87d6265b74928addef1effe8df66a909742d78e98778
+  metadata.gz: b0ed4adf7cab6d38ad475a2393a66ab65fefd0d9522a1aff5acd25fb107f6d56794508dc4fb774da2871fd6d52bb1e8e5823a53fa28dee973239d7585f1c84a5
+  data.tar.gz: 6e96b8ea2acdbd21f38ab91670d8f4c0cd2ed4b4ad3fb0d1c49f78eb45469241efb221bb5a72c0181654012796be7f9673789889c61391f19cfe3d6f688a71e6

data/.github/workflows/build.yml

@@ -0,0 +1,26 @@
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ 'ubuntu-latest' ]
+        ruby: [ "3.0", "2.7", "2.6", "2.5" ]
+        opal: [ "1.0.3", "1.1.0" ]
+
+    runs-on: ${{ matrix.os }}
+
+    env:
+      OPAL_VERSION: ${{ matrix.opal }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup project
+        run: bin/setup
+      - name: Run test
+        run: bin/rake

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## [1.0.0](https://github.com/opal/opal-sprockets/compare/v0.4.9.1.0.3.7...v1.0.0)
+
+*19 February 2021*
+
+- Bump the supported sprockets version to v4
+- Add support for Opal v1.1
+- Only support Ruby comments in directive preprocessor (no one should have ever used "//", ["/*", or "*/")
+- Fix the namespaces and move everything under Opal::Sprockets (the legacy namespaces will be dropped in version 1.1)
+- The version schema has been simplified, not expecting sprockets to have major earthquakes like it was for v4
+
+
+## [v0.4.9](https://github.com/opal/opal-sprockets/compare/v0.4.8.1.0.3.7...v0.4.9.1.0.3.7)
+
+*11 September 2020*
+
+- Avoid OpalLoaded undefined when applications have no dependencies.
+
+
+## [v0.4.8](https://github.com/opal/opal-sprockets/compare/v0.4.7.1.0.3.7...v0.4.8.1.0.3.7)
+
+*14 September 2019*
+
+- Revert the changes in 0.4.7
+
+
+## [v0.4.7](https://github.com/opal/opal-sprockets/compare/v0.4.6.1.0.3.7...v0.4.7.1.0.3.7)
+
+*14 September 2019*
+
+- Require `opal/sprockets` before calling `Opal::Sprockets.loaded_asset`
+
+
+## [v0.4.6](https://github.com/opal/opal-sprockets/compare/v0.4.5.1.0.3.7...v0.4.6.1.0.3.7)
+
+*24 July 2019*
+
+- Allow multiple calls to the code produced by `Opal::Sprockets.load_asset`
+
+
 ## [v0.4.5](https://github.com/opal/opal-sprockets/compare/v0.4.4.1.0.3.7...v0.4.5.1.0.3.7)
 
 *25 May 2019*

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+
+bundle update

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    opal-sprockets (0.4.4.1.0.3.7)
+    opal-sprockets (0.4.5.1.0.3.7)
       opal (~> 1.0.0)
       sprockets (~> 3.7)
       tilt (>= 1.4)

data/lib/opal/environment.rb

@@ -0,0 +1,4 @@
+warn "Opal::Environment is deprecated, please switch to Opal::Sprockets::Environment.", uplevel: 1
+
+require 'opal/sprockets/environment'
+Opal::Environment = Opal::Sprockets::Environment

data/lib/opal/processor.rb

@@ -0,0 +1,4 @@
+warn "Opal::Processor is deprecated, please switch to Opal::Sprockets::Processor.", uplevel: 1
+
+require 'opal/sprockets/processor'
+Opal::Processor = Opal::Sprockets::Processor

data/lib/opal/sprockets.rb

@@ -1,87 +1,19 @@
 require 'opal'
-require 'opal/sprockets/processor'
-require 'opal/sprockets/erb'
-require 'opal/sprockets/server'
+require 'opal/sprockets/version'
 
 module Opal
   module Sprockets
-    # Bootstraps modules loaded by sprockets on `Opal.modules` marking any
-    # non-Opal asset as already loaded.
-    #
-    # @example
-    #
-    #   Opal::Sprockets.load_asset('application')
-    #
-    # @example Will output the following JavaScript:
-    #
-    #   Opal.loaded("jquery.self", "yet_another_carousel.self");
-    #   Opal.load("opal", "application");
-    #
-    # @param name [String] The logical name of the main asset to be loaded (without extension)
-    #
-    # @return [String] JavaScript code
-    def self.load_asset(*names)
-      if names.last.is_a?(::Sprockets::Environment)
-        unless @load_asset_warning_displayed
-          @load_asset_warning_displayed = true
-          warn "Passing a sprockets environment to Opal::Sprockets.load_asset no more needed.\n  #{caller(1, 3).join("\n  ")}"
-        end
-        names.pop
-      end
-
-      names = names.map { |name| name.sub(/(\.(js|rb|opal))*\z/, '') }
-      stubbed = ::Opal::Config.stubbed_files.to_a
-
-      loaded = 'OpalLoaded || []'
-      loaded = "#{stubbed.to_json}.concat(#{loaded})" if stubbed.any?
-
-      [
-        "Opal.loaded(#{loaded});",
-        *names.map { |name| "Opal.load(#{name.to_json});" }
-      ].join("\n")
-    end
-
-    # Mark an asset as already loaded.
-    # This is useful for requiring JavaScript files which are not managed by Opal's laoding system.
-    #
-    # @param [String] name The "logical name" of the asset
-    # @return [String] JavaScript code
-    def self.loaded_asset(name)
-      %{if (typeof(OpalLoaded) === 'undefined') OpalLoaded = []; OpalLoaded.push(#{name.to_json});}
-    end
-
-    # Generate a `<script>` tag for Opal assets.
-    #
-    # @param [String] name     The logical name of the asset to be loaded (without extension)
-    # @param [Hash]   options  The options about sprockets
-    # @option options [Sprockets::Environment] :sprockets  The sprockets instance
-    # @option options [String]                 :prefix     The prefix String at which is mounted Sprockets, e.g. '/assets'
-    # @option options [Boolean]                :debug      Wether to enable debug mode along with sourcemaps support
-    #
-    # @return a string of HTML code containing `<script>` tags.
-    def self.javascript_include_tag(name, options = {})
-      sprockets = options.fetch(:sprockets)
-      prefix    = options.fetch(:prefix)
-      debug     = options.fetch(:debug)
-
-      # Avoid double slashes
-      prefix = prefix.chop if prefix.end_with? '/'
-
-      asset = sprockets[name]
-      raise "Cannot find asset: #{name}" if asset.nil?
-      scripts = []
-
-      if debug
-        asset.to_a.map do |dependency|
-          scripts << %{<script src="#{prefix}/#{dependency.digest_path}?body=1"></script>}
-        end
-      else
-        scripts << %{<script src="#{prefix}/#{name}.js"></script>}
-      end
-
-      scripts << %{<script>#{load_asset('opal', name)}</script>}
-
-      scripts.join "\n"
-    end
+    require 'opal/sprockets/assets_helper'
+    require 'opal/sprockets/mime_types'
+    extend AssetsHelper
+    extend MimeTypes
+
+    require 'opal/sprockets/environment'
+    require 'opal/sprockets/erb'
+    require 'opal/sprockets/processor'
+    require 'opal/sprockets/server'
   end
+
+  autoload :Processor, 'opal/processor'
+  autoload :Environment, 'opal/environment'
 end

data/lib/opal/sprockets/assets_helper.rb

@@ -0,0 +1,78 @@
+module Opal::Sprockets::AssetsHelper
+  # Bootstraps modules loaded by sprockets on `Opal.modules` marking any
+  # non-Opal asset as already loaded.
+  #
+  # @example
+  #
+  #   Opal::Sprockets.load_asset('application')
+  #
+  # @example Will output the following JavaScript:
+  #
+  #   Opal.loaded("jquery.self", "yet_another_carousel.self");
+  #   Opal.require("opal", "application");
+  #
+  # @param name [String] The logical name of the main asset to be loaded (without extension)
+  #
+  # @return [String] JavaScript code
+  def load_asset(*names)
+    if names.last.is_a?(::Sprockets::Environment)
+      unless @load_asset_warning_displayed
+        @load_asset_warning_displayed = true
+        warn "Passing a sprockets environment to Opal::Sprockets.load_asset no more needed.\n  #{caller(1, 3).join("\n  ")}"
+      end
+      names.pop
+    end
+
+    names = names.map { |name| name.sub(/(\.(js|rb|opal))*\z/, '') }
+    stubbed = ::Opal::Config.stubbed_files.to_a
+
+    loaded = 'typeof(OpalLoaded) === "undefined" ? [] : OpalLoaded'
+    loaded = "#{stubbed.to_json}.concat(#{loaded})" if stubbed.any?
+
+    [
+      "Opal.loaded(#{loaded});",
+      *names.map { |name| "Opal.require(#{name.to_json});" }
+    ].join("\n")
+  end
+
+  # Mark an asset as already loaded.
+  # This is useful for requiring JavaScript files which are not managed by Opal's laoding system.
+  #
+  # @param [String] name The "logical name" of the asset
+  # @return [String] JavaScript code
+  def loaded_asset(name)
+    %{if (typeof(OpalLoaded) === 'undefined') OpalLoaded = []; OpalLoaded.push(#{name.to_json});}
+  end
+
+  # Generate a `<script>` tag for Opal assets.
+  #
+  # @param [String] name     The logical name of the asset to be loaded (without extension)
+  # @param [Hash]   options  The options about sprockets
+  # @option options [Sprockets::Environment] :sprockets  The sprockets instance
+  # @option options [String]                 :prefix     The prefix String at which is mounted Sprockets, e.g. '/assets'
+  # @option options [Boolean]                :debug      Wether to enable debug mode along with sourcemaps support
+  #
+  # @return a string of HTML code containing `<script>` tags.
+  def javascript_include_tag(name, options = {})
+    sprockets = options.fetch(:sprockets)
+    prefix    = options.fetch(:prefix)
+    debug     = options.fetch(:debug)
+
+    # Avoid double slashes
+    prefix = prefix.chop if prefix.end_with? '/'
+
+    asset = sprockets[name, accept: "application/javascript", pipeline: debug ? :debug : nil]
+    raise "Cannot find asset: #{name}" if asset.nil?
+    scripts = []
+
+    if debug
+      scripts << %{<script src="#{prefix}/#{asset.digest_path}"></script>}
+    else
+      scripts << %{<script src="#{prefix}/#{name}.js"></script>}
+    end
+
+    scripts << %{<script>#{load_asset('opal', name)}</script>}
+
+    scripts.join "\n"
+  end
+end

data/lib/opal/sprockets/environment.rb

@@ -2,22 +2,20 @@ require 'sprockets'
 require 'opal/sprockets/processor'
 require 'opal/sprockets/erb'
 
-module Opal
-  class Environment < ::Sprockets::Environment
-    def initialize *args
-      super
-      append_opal_paths
-    end
+class Opal::Sprockets::Environment < ::Sprockets::Environment
+  def initialize *args
+    super
+    append_opal_paths
+  end
 
-    def use_gem gem_name
-      Opal.use_gem gem_name
-      append_opal_paths
-    end
+  def use_gem gem_name
+    Opal.use_gem gem_name
+    append_opal_paths
+  end
 
-    private
+  private
 
-    def append_opal_paths
-      Opal.paths.each { |p| append_path p }
-    end
+  def append_opal_paths
+    Opal.paths.each { |p| append_path p }
   end
 end

data/lib/opal/sprockets/erb.rb

@@ -1,23 +1,19 @@
 require 'tilt'
 require 'sprockets'
 require 'opal/sprockets/processor'
+require 'opal/erb'
 
-module Opal
-  module ERB
-    class Processor < ::Opal::Processor
-      def initialize_engine
-        super
-        require_template_library 'opal/erb'
-      end
-
-      def evaluate(context, locals, &block)
-        compiler = Opal::ERB::Compiler.new(@data, context.logical_path.sub(/#{REGEXP_START}templates\//, ''))
-        @data = compiler.prepared_source
-        super
-      end
-    end
+class Opal::Sprockets::ERB < ::Opal::Sprockets::Processor
+  def call
+    compiler = Opal::ERB::Compiler.new(@data, logical_path.sub(/#{Opal::REGEXP_START}templates\//, ''))
+    @data = compiler.prepared_source
+    super
   end
+
+  # @deprecated
+  ::Opal::ERB::Processor = self
 end
 
-Tilt.register 'opalerb', Opal::ERB::Processor
-Sprockets.register_engine '.opalerb', Opal::ERB::Processor, mime_type: 'application/javascript', silence_deprecation: true
+Sprockets.register_mime_type 'application/html+javascript+ruby', extensions: ['.opalerb', '.opal.erb', '.html.opal.erb']
+Sprockets.register_transformer 'application/html+javascript+ruby', 'application/javascript', Opal::ERB::Processor
+Opal::Sprockets.register_mime_type 'application/html+javascript+ruby'

data/lib/opal/sprockets/mime_types.rb

@@ -0,0 +1,19 @@
+module Opal::Sprockets::MimeTypes
+  def register_mime_type(mime_type)
+    mime_types << mime_type
+  end
+
+  def mime_types
+    @mime_types ||= []
+  end
+
+  def sprockets_extnames_regexp(sprockets, opal_only: false)
+    opal_extnames = sprockets.mime_types.map do |type, hash|
+      hash[:extensions] if !opal_only || Opal::Sprockets.mime_types.include?(type)
+    end.compact.flatten
+
+    opal_extnames << ".js" unless opal_only
+
+    Regexp.union(opal_extnames.map { |i| /#{Regexp.escape(i)}\z/ })
+  end
+end