opal-sprockets 0.4.8.1.0.3.7 → 1.0.2

data/lib/opal/sprockets/server.rb

@@ -2,115 +2,111 @@ require 'erb'
 require 'rack'
 require 'sprockets'
 
-module Opal
-  module Sprockets
-    class Server
-      attr_accessor :debug, :use_index, :index_path, :main, :public_root,
-                    :public_urls, :sprockets, :prefix
-
-      def initialize options = {}
-        @use_index   = true
-        @public_root = nil
-        @public_urls = ['/']
-        @sprockets   = options.fetch(:sprockets, ::Sprockets::Environment.new)
-        @debug       = options.fetch(:debug, true)
-        @prefix      = options.fetch(:prefix, '/assets')
-
-        Opal.paths.each { |p| @sprockets.append_path(p) }
-
-        yield self if block_given?
-        create_app
-      end
+class Opal::Sprockets::Server
+  attr_accessor :debug, :use_index, :index_path, :main, :public_root,
+                :public_urls, :sprockets, :prefix
+
+  def initialize options = {}
+    @use_index   = true
+    @public_root = nil
+    @public_urls = ['/']
+    @sprockets   = options.fetch(:sprockets, ::Sprockets::Environment.new)
+    @debug       = options.fetch(:debug, true)
+    @prefix      = options.fetch(:prefix, '/assets')
+
+    Opal.paths.each { |p| @sprockets.append_path(p) }
+
+    yield self if block_given?
+    create_app
+  end
 
-      def public_dir=(dir)
-        @public_root = dir
-        @public_urls = ["/"]
-      end
+  def public_dir=(dir)
+    @public_root = dir
+    @public_urls = ["/"]
+  end
 
-      def source_map=(enabled)
-        Opal::Config.source_map_enabled = enabled
-      end
+  def source_map=(enabled)
+    Opal::Config.source_map_enabled = enabled
+  end
 
-      def source_map_enabled
-        Opal::Config.source_map_enabled
-      end
+  def source_map_enabled
+    Opal::Config.source_map_enabled
+  end
 
-      def append_path path
-        @sprockets.append_path path
-      end
+  def append_path path
+    @sprockets.append_path path
+  end
 
-      def use_gem gem_name
-        @sprockets.use_gem gem_name
-      end
+  def use_gem gem_name
+    @sprockets.use_gem gem_name
+  end
 
-      def create_app
-        server, sprockets, prefix = self, @sprockets, self.prefix
-        sprockets.logger.level ||= Logger::DEBUG
-
-        @app = Rack::Builder.app do
-          not_found = lambda { |env| [404, {}, []] }
-          use Rack::Deflater
-          use Rack::ShowExceptions
-          use Index, server if server.use_index
-          map(prefix)      { run sprockets }
-          run Rack::Static.new(not_found, root: server.public_root, urls: server.public_urls)
-        end
-      end
+  def create_app
+    server, sprockets, prefix = self, @sprockets, self.prefix
+    sprockets.logger.level ||= Logger::DEBUG
+
+    @app = Rack::Builder.app do
+      not_found = lambda { |env| [404, {}, []] }
+      use Rack::Deflater
+      use Rack::ShowExceptions
+      use Index, server if server.use_index
+      map(prefix)      { run sprockets }
+      run Rack::Static.new(not_found, root: server.public_root, urls: server.public_urls)
+    end
+  end
+
+  def call(env)
+    @app.call env
+  end
+
+  class Index
+
+    def initialize(app, server)
+      @app = app
+      @server = server
+      @index_path = server.index_path
+    end
 
-      def call(env)
+    def call(env)
+      if %w[/ /index.html].include? env['PATH_INFO']
+        [200, { 'Content-Type' => 'text/html' }, [html]]
+      else
         @app.call env
       end
+    end
 
-      class Index
-
-        def initialize(app, server)
-          @app = app
-          @server = server
-          @index_path = server.index_path
-        end
-
-        def call(env)
-          if %w[/ /index.html].include? env['PATH_INFO']
-            [200, { 'Content-Type' => 'text/html' }, [html]]
-          else
-            @app.call env
-          end
-        end
-
-        # Returns the html content for the root path. Supports ERB
-        def html
-          if @index_path
-            raise "index does not exist: #{@index_path}" unless File.exist?(@index_path)
-            Tilt.new(@index_path).render(self)
-          else
-            raise "Main asset path not configured (set 'main' within Opal::Server.new block)" if @server.main.nil?
-            source
-          end
-        end
-
-        def javascript_include_tag name
-          sprockets = @server.sprockets
-          prefix = @server.prefix
-          debug = @server.debug
-
-          ::Opal::Sprockets.javascript_include_tag(name, sprockets: sprockets, prefix: prefix, debug: debug)
-        end
-
-        def source
-          <<-HTML
-            <!DOCTYPE html>
-            <html>
-            <head>
-              <meta charset="utf-8">
-              <title>Opal Server</title>
-            </head>
-            <body>
-              #{javascript_include_tag @server.main}
-            </body>
-            </html>
-          HTML
-        end
+    # Returns the html content for the root path. Supports ERB
+    def html
+      if @index_path
+        raise "index does not exist: #{@index_path}" unless File.exist?(@index_path)
+        Tilt.new(@index_path).render(self)
+      else
+        raise "Main asset path not configured (set 'main' within Opal::Server.new block)" if @server.main.nil?
+        source
       end
     end
+
+    def javascript_include_tag name
+      sprockets = @server.sprockets
+      prefix = @server.prefix
+      debug = @server.debug
+
+      ::Opal::Sprockets.javascript_include_tag(name, sprockets: sprockets, prefix: prefix, debug: debug)
+    end
+
+    def source
+      <<-HTML
+        <!DOCTYPE html>
+        <html>
+        <head>
+          <meta charset="utf-8">
+          <title>Opal Server</title>
+        </head>
+        <body>
+          #{javascript_include_tag @server.main}
+        </body>
+        </html>
+      HTML
+    end
   end
 end

data/lib/opal/sprockets/version.rb

@@ -1,12 +1,5 @@
 module Opal
   module Sprockets
-    BASE_VERSION = '0.4.8'
-    OPAL_VERSION = '1.0.0'
-    SPROCKETS_VERSION = '3.7'
-
-    # Just keep the first two segments of dependencies' versions
-    v = -> v { v.split('.')[0..1].compact.join('.') }
-
-    VERSION = "#{BASE_VERSION}.#{v[OPAL_VERSION]}.#{v[SPROCKETS_VERSION]}"
+    VERSION = '1.0.2'
   end
 end

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.require("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.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 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/opal-sprockets.gemspec

@@ -1,25 +1,39 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/opal/sprockets/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name         = 'opal-sprockets'
-  s.version      = Opal::Sprockets::VERSION
-  s.authors      = ['Elia Schito', 'Adam Beynon']
-  s.email        = 'elia@schito.me'
-  s.homepage     = 'https://github.com/opal/opal-sprockets#readme'
-  s.summary      = 'Sprockets support for Opal.'
-  s.description  = 'Sprockets support for Opal.'
-
-  s.files          = `git ls-files`.split("\n")
-  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths  = ['lib']
-
-  s.add_dependency 'sprockets', "~> #{Opal::Sprockets::SPROCKETS_VERSION}"
-  s.add_dependency 'opal', "~> #{Opal::Sprockets::OPAL_VERSION}"
-  s.add_dependency 'tilt', '>= 1.4'
-
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'sourcemap'
+require_relative 'lib/opal/sprockets/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'opal-sprockets'
+  spec.version      = Opal::Sprockets::VERSION
+  spec.authors      = ['Elia Schito', 'Adam Beynon']
+  spec.email        = 'elia@schito.me'
+
+  spec.summary      = 'Sprockets support for Opal.'
+  spec.homepage     = 'https://github.com/opal/opal-sprockets#readme'
+  spec.license      = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/opal/opal-sprockets'
+  spec.metadata['changelog_uri'] = 'https://github.com/opal/opal-sprockets/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 3.1')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sprockets', "~> 4.0"
+  spec.add_dependency 'opal', [">= 1.0", "< 2.0"]
+  spec.add_dependency 'tilt', '>= 1.4'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'sourcemap'
+  spec.add_development_dependency 'ejs'
+  spec.add_development_dependency 'pry'
 end

data/spec/fixtures/complex_sprockets.js.rb.erb

@@ -1,5 +1,5 @@
 #= require no_requires
-//= require jst_file
+#= require ./jst_file
 #= require_tree ./required_tree_test
 require 'file_with_directives'
 require <%= "base64".inspect %>

data/spec/spec_helper.rb

@@ -1,2 +1,9 @@
 require 'bundler'
 Bundler.require
+
+RSpec.configure do |config|
+  config.before do
+    Opal::Config.reset!
+    Opal::Sprockets::Processor.reset_cache_key!
+  end
+end

data/spec/sprockets/erb_spec.rb

@@ -1,38 +1,28 @@
 require 'spec_helper'
 require 'opal/sprockets/erb'
 
-describe Opal::ERB::Processor do
+describe Opal::Sprockets::ERB do
   let(:pathname) { Pathname("/Code/app/mylib/opal/foo.#{ext}") }
-  let(:environment) { double(Sprockets::Environment,
-    cache: nil,
-    :[] => nil,
-    resolve: pathname.expand_path.to_s,
-    engines: double(keys: %w[.rb .js .erb .opal]),
-  ) }
-  let(:sprockets_context) { double(Sprockets::Context,
-    logical_path: "foo.#{ext}",
-    environment: environment,
-    pathname: pathname,
+  let(:data) { %{<% print("") %><a href="<%= url %>"><%= name %></a>} }
+  let(:input) { {
+    environment: Opal::Sprockets::Environment.new.tap {|e| e.append_path "/Code/app/mylib/opal"},
+    data: data,
     filename: pathname.to_s,
-    root_path: '/Code/app/mylib',
-    is_a?: true,
-  ) }
-  let(:required_assets) { [] }
-  let(:template) { described_class.new { |t| %Q{<% print("") %><a href="<%= url %>"><%= name %></a>} } }
-  before { allow(sprockets_context).to receive(:require_asset) {|asset| required_assets << asset } }
-
+    load_path: "/Code/app/mylib/opal",
+    metadata: {},
+    cache: Sprockets::Cache.new
+  } }
   let(:ext) { 'opalerb' }
 
-  it "is registered for '.opalerb' files" do
-    expect(Tilt["test.#{ext}"]).to eq(described_class)
-  end
-
   it 'renders the template' do
-    expect(template.render(sprockets_context)).to include('"<a href=\""')
+    result = described_class.call(input)
+
+    expect(result[:data]).to include('"<a href=\""')
   end
 
   it 'implicitly requires "erb"' do
-    template.render(sprockets_context)
-    expect(required_assets).to eq(['erb'])
+    result = described_class.call(input)
+
+    expect(result[:required].first).to include("stdlib/erb.rb")
   end
 end