opal-sprockets 0.4.2.pre.1.0.11.0.3.1 → 0.4.2.0.11.0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f4fd15ecf2dfdcb1d252b9fe800c835c106295c7a46494876f0c88ad1c3342
-  data.tar.gz: 6b142da62511a90f76d62546b832a9b7983fd8b59cee93ec5ea0b2db7be81d82
+  metadata.gz: dca9f9cc92bc73a4bdaa577f7a32b962af5ec4e535adbd3c06a5b80fc835af63
+  data.tar.gz: 5d2beb0fc445ba75afecec5e5c40344a6c561ce3a38b7c3d5a58dc6dc8a8c0b7
 SHA512:
-  metadata.gz: 5b8510a4797ea716f7c5b38d0a993dda59dc581dfcdfeb7387ad0f8e8204a04f27926f02103f0402c621351ea7e68374594aca009e7b80054d3a859261ced89d
-  data.tar.gz: 14c629c523cfa8a82e3c1f524fc9975048ac08bfdf11347d79b2022a9075131ce970155bd2d6c5979b1a61a22dc7a2c503d30fbf519a3a859a62ba2a2075bab8
+  metadata.gz: aa1dc4f51c6effa43f9c1fb73a6fc310a4e94ef111b32b0242d78498374f2f15a90a1687df73aa2ec63f823bf32c3b9795cc1e8bfe92bf478776a723665b397d
+  data.tar.gz: 9c79b7a79613d9e242621477f4a0e170811bdda6c013593d5bfba26830d15cb01f61b7ab8afdba565b0425caf272d7cf7e15b79ac05dd33d74ea2cd307d95b5c

data/.gitignore

@@ -2,7 +2,7 @@
 *.gem
 .yardoc
 .bundle
-Gemfile.lock
+/Gemfile.lock
 build/
 /.github_access_token
 /tmp

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 
+branches:
+  only:
+  - master
+  - /^.*-stable$/
+  - /^.*ci-check$/
+
 matrix:
   include:
     - rvm: 2.1.10
@@ -11,6 +17,18 @@ matrix:
     - rvm: 2.4.4
       env: SPROCKETS_VERSION='~> 3.7.1'
     - rvm: 2.5.1
+      env: SPROCKETS_VERSION='~> 3.7.1'
+
+    - rvm: 2.1.10
+      env: OPAL_VERSION='~> 0.11.3' RACK_VERSION='< 2.0.0' SPROCKETS_VERSION='~> 3.4.1'
+    - rvm: 2.2.10
+      env: OPAL_VERSION='~> 0.11.3' SPROCKETS_VERSION='~> 3.5.2'
+    - rvm: 2.3.7
+      env: OPAL_VERSION='~> 0.11.3' SPROCKETS_VERSION='~> 3.6.3'
+    - rvm: 2.4.4
+      env: OPAL_VERSION='~> 0.11.3' SPROCKETS_VERSION='~> 3.7.1'
+    - rvm: 2.5.1
+      env: OPAL_VERSION='~> 0.11.3' SPROCKETS_VERSION='~> 3.7.1'
 
 notifications:
   irc: "irc.freenode.org#opal"

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v0.4.2](https://github.com/opal/opal-sprockets/compare/v0.4.1.0.11.0.3.1...v0.4.2.0.11.0.3.1)
+
+*7 September 2018*
+
+- Inline source-maps with their source-contents for better performance and simpler architecture
+
+
 ## [v0.4.1](https://github.com/opal/opal-sprockets/compare/v0.4.0.0.10.0.3.0.0...v0.4.1.0.11.0.3.1)
 
 *30 December 2017*

data/Gemfile

@@ -2,7 +2,10 @@ source 'https://rubygems.org'
 gemspec
 
 opal_path = File.expand_path('../opal')
-if File.exist? opal_path
+
+if ENV['OPAL_VERSION']
+  gem 'opal', ENV['OPAL_VERSION']
+elsif File.exist? opal_path
   gem 'opal', path: opal_path
 else
   gem 'opal', github: 'opal/opal'

data/example/Gemfile.lock

@@ -0,0 +1,38 @@
+GIT
+  remote: git://github.com/opal/opal.git
+  revision: d77bd3ce19e101988578cdb6314d659491a77844
+  specs:
+    opal (0.11.99.dev)
+      ast (>= 2.3.0)
+      parser (= 2.5.1.0)
+
+PATH
+  remote: ..
+  specs:
+    opal-sprockets (0.4.2.pre.1.0.11.0.3.1)
+      opal (~> 0.11.0)
+      sprockets (~> 3.1)
+      tilt (>= 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    rack (2.0.5)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  opal!
+  opal-sprockets!
+
+BUNDLED WITH
+   1.16.4

data/lib/opal/sprockets/processor.rb

@@ -1,9 +1,9 @@
 require 'set'
+require 'base64'
 require 'tilt/opal'
 require 'sprockets'
 require 'opal/builder'
 require 'opal/sprockets/path_reader'
-require 'opal/sprockets/source_map_server'
 
 $OPAL_SOURCE_MAPS = {}
 
@@ -49,11 +49,13 @@ module Opal
       process_required_trees(compiler.required_trees, context)
 
       if Opal::Config.source_map_enabled
-        map_contents = compiler.source_map.as_json.to_json
-        ::Opal::SourceMapServer.set_map_cache(sprockets, logical_path, map_contents)
+        map_data = compiler.source_map.as_json
+        # Opal 0.11 doesn't fill sourcesContent
+        add_sources_content_if_missing(map_data, data)
+        "#{result}\n#{to_data_uri_comment(map_data.to_json)}"
+      else
+        result.to_s
       end
-
-      result.to_s
     end
 
     def self.sprockets_extnames_regexp(sprockets)
@@ -135,6 +137,14 @@ module Opal
 
     private
 
+    def add_sources_content_if_missing(data, content)
+      data[:sourcesContent] = data.delete(:sourcesContent) || data.delete('sourcesContent') || [content]
+    end
+
+    def to_data_uri_comment(map_to_json)
+      "//# sourceMappingURL=data:application/json;base64,#{Base64.encode64(map_to_json).delete("\n")}"
+    end
+
     def stubbed_files
       ::Opal::Config.stubbed_files
     end

data/lib/opal/sprockets/server.rb

@@ -1,15 +1,10 @@
+require 'erb'
 require 'rack'
-require 'opal/source_map'
 require 'sprockets'
-require 'erb'
-require 'opal/sprockets/source_map_server'
-require 'opal/sprockets/source_map_header_patch'
 
 module Opal
   module Sprockets
     class Server
-      SOURCE_MAPS_PREFIX_PATH = '/__OPAL_SOURCE_MAPS__'
-
       attr_accessor :debug, :use_index, :index_path, :main, :public_root,
                     :public_urls, :sprockets, :prefix
 
@@ -51,25 +46,12 @@ module Opal
       def create_app
         server, sprockets, prefix = self, @sprockets, self.prefix
         sprockets.logger.level ||= Logger::DEBUG
-        source_map_enabled = self.source_map_enabled
-        if source_map_enabled
-          maps_prefix = SOURCE_MAPS_PREFIX_PATH
-          maps_app = SourceMapServer.new(sprockets, maps_prefix)
-          ::Opal::Sprockets::SourceMapHeaderPatch.inject!(maps_prefix)
-        end
 
         @app = Rack::Builder.app do
           not_found = lambda { |env| [404, {}, []] }
           use Rack::Deflater
           use Rack::ShowExceptions
           use Index, server if server.use_index
-          if source_map_enabled
-            map(maps_prefix) do
-              use Rack::ConditionalGet
-              use Rack::ETag
-              run maps_app
-            end
-          end
           map(prefix)      { run sprockets }
           run Rack::Static.new(not_found, root: server.public_root, urls: server.public_urls)
         end

data/lib/opal/sprockets/version.rb

@@ -1,6 +1,6 @@
 module Opal
   module Sprockets
-    BASE_VERSION = '0.4.2.pre.1'
+    BASE_VERSION = '0.4.2'
     OPAL_VERSION = '0.11.0'
     SPROCKETS_VERSION = '3.1'
     VERSION = "#{BASE_VERSION}.#{OPAL_VERSION}.#{SPROCKETS_VERSION}"

data/spec/sprockets/server_spec.rb

@@ -5,8 +5,6 @@ require 'rack/test'
 describe Opal::Sprockets::Server do
   include Rack::Test::Methods
 
-  let(:maps_prefix) { described_class::SOURCE_MAPS_PREFIX_PATH }
-
   def app
     described_class.new { |s|
       s.main = 'opal'
@@ -42,67 +40,40 @@ describe Opal::Sprockets::Server do
   end
 
   describe 'source maps' do
-    it 'serves map on a top level file' do
-      get '/assets/source_map.js'
-      expect(last_response).to be_ok
-
-      get maps_prefix+'/source_map.self.map'
-      expect(last_response).to be_ok
+    RSpec::Matchers.define :include_inline_source_map do
+      match do |actual_response|
+        actual_response.ok? &&
+        actual_response.body.lines.last.start_with?('//# sourceMappingURL=data:application/json;base64,')
+      end
     end
 
-    it 'serves map on a subfolder file' do
-      js_path = '/assets/source_map/subfolder/other_file.self.js'
-      map_path = maps_prefix+'/source_map/subfolder/other_file.self.map'
-
-      get js_path
-
-      expect(last_response).to be_ok
-      received_map_path = extract_map_path(last_response)
-      expect(expand_path(received_map_path, js_path+'/..')).to eq(map_path)
-
-      get maps_prefix+'/source_map/subfolder/other_file.self.map'
-      expect(last_response).to be_ok
+    def extract_inline_map(response)
+      last_line   = response.body.lines.last
+      b64_encoded = last_line.split('//# sourceMappingURL=data:application/json;base64,', 2)[1]
+      json_string = Base64.decode64(b64_encoded)
+      JSON.parse(json_string, symbolize_names: true)
     end
 
-    it 'serves map on a subfolder file' do
-      js_path = '/assets/source_map/subfolder/other_file.self.js'
-      map_path = maps_prefix+'/source_map/subfolder/other_file.self.map'
-
-      get js_path
+    it 'serves map for a top level file' do
+      get '/assets/opal_file.js'
+      expect(last_response).to include_inline_source_map
 
-      expect(last_response).to be_ok
-      received_map_path = extract_map_path(last_response)
-      expect(expand_path(received_map_path, js_path+'/..')).to eq(map_path)
+      map = extract_inline_map(last_response)
 
-      get maps_prefix+'/source_map/subfolder/other_file.self.map'
-      expect(last_response).to be_ok
-      map = ::SourceMap::Map.from_json(last_response.body)
-
-      if Gem::Version.new(Opal::VERSION) >= Gem::Version.new('0.11.2')
-        expect(map.sources).to include(maps_prefix+'/source_map/subfolder/other_file.rb')
-      else
-        expect(map.sources).to include(maps_prefix+'/source_map/subfolder/other_file')
-      end
+      expect(map[:sources]).to eq(['opal_file.rb']).or eq(['opal_file'])
+      expect(map[:sourcesContent]).to eq(["require 'opal'\nputs 'hi from opal!'\n"])
     end
-  end
 
-  def extract_map_path(response)
-    source_map_comment_regexp = %r{//# sourceMappingURL=(.*)$}
+    it 'serves map for a subfolder file' do
+      get '/assets/source_map/subfolder/other_file.self.js'
+      expect(last_response).to include_inline_source_map
 
-    case
-    when response.body =~ source_map_comment_regexp
-      body.scan(source_map_comment_regexp).first.first
-    when response.headers['X-SourceMap']
-      response.headers['X-SourceMap']
-    else
-      raise "cannot find source map in response: #{response.inspect}"
-    end
-  end
+      map = extract_inline_map(last_response)
 
-  def expand_path(file_name, dir_string)
-    path = File.expand_path(file_name, dir_string)
-    # Remove Windows letter and colon (eg. C:) from path
-    path = path[2..-1] if !(RUBY_PLATFORM =~ /mswin|mingw/).nil?
-    path
+      expect(map[:sources])
+        .to eq(['source_map/subfolder/other_file.rb'])
+        .or eq(['source_map/subfolder/other_file'])
+      expect(map[:sourcesContent]).to eq(["puts 'other!'\n"])
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-sprockets
 version: !ruby/object:Gem::Version
-  version: 0.4.2.pre.1.0.11.0.3.1
+  version: 0.4.2.0.11.0.3.1
 platform: ruby
 authors:
 - Elia Schito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -123,6 +123,7 @@ files:
 - README.md
 - Rakefile
 - example/Gemfile
+- example/Gemfile.lock
 - example/app/application.rb
 - example/app/user.rb
 - example/config.ru
@@ -134,8 +135,6 @@ files:
 - lib/opal/sprockets/path_reader.rb
 - lib/opal/sprockets/processor.rb
 - lib/opal/sprockets/server.rb
-- lib/opal/sprockets/source_map_header_patch.rb
-- lib/opal/sprockets/source_map_server.rb
 - lib/opal/sprockets/version.rb
 - opal-sprockets.gemspec
 - spec/fixtures/complex_sprockets.js.rb.erb
@@ -148,7 +147,6 @@ files:
 - spec/fixtures/required_tree_test/required_file1.rb
 - spec/fixtures/required_tree_test/required_file2.rb
 - spec/fixtures/requires.rb
-- spec/fixtures/source_map.rb
 - spec/fixtures/source_map/subfolder/other_file.rb
 - spec/fixtures/sprockets_file.js.rb
 - spec/fixtures/sprockets_require_tree_test.rb
@@ -175,9 +173,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7
@@ -195,7 +193,6 @@ test_files:
 - spec/fixtures/required_tree_test/required_file1.rb
 - spec/fixtures/required_tree_test/required_file2.rb
 - spec/fixtures/requires.rb
-- spec/fixtures/source_map.rb
 - spec/fixtures/source_map/subfolder/other_file.rb
 - spec/fixtures/sprockets_file.js.rb
 - spec/fixtures/sprockets_require_tree_test.rb

data/lib/opal/sprockets/source_map_header_patch.rb

@@ -1,41 +0,0 @@
-require 'sprockets/server'
-
-module Opal
-  module Sprockets
-    module SourceMapHeaderPatch
-      # Adds the source map header to all sprocket responses for assets
-      # with a .rb or .opal extension in the extension chain.
-      def headers_with_opal_source_maps(env, asset, length)
-        headers_without_opal_source_maps(env, asset, length).tap do |current_headers|
-          if asset.pathname.to_s =~ /\.(rb|opal)\b/
-            base_path = asset.logical_path.gsub('.js', '')
-            current_headers['X-SourceMap'] = "#{::Opal::Sprockets::SourceMapHeaderPatch.prefix}/#{base_path}.map"
-          end
-        end
-      end
-
-      def self.included(base)
-        # Poor man's alias_method_chain :)
-        base.send(:alias_method, :headers_without_opal_source_maps, :headers)
-        base.send(:alias_method, :headers, :headers_with_opal_source_maps)
-      end
-
-      def self.inject!(prefix)
-        self.prefix = prefix
-        unless ::Sprockets::Server.ancestors.include?(self)
-          ::Sprockets::Server.send :include, self
-        end
-      end
-
-      def self.prefix
-        @prefix
-      end
-
-      def self.prefix= val
-        @prefix = val
-      end
-    end
-  end
-end
-
-

data/lib/opal/sprockets/source_map_server.rb

@@ -1,115 +0,0 @@
-module Opal
-  class SourceMapServer
-    # Carelessly taken from Sprockets::Caching (Sprockets v2)
-    class Cache
-      def initialize
-        @cache = {}
-      end
-
-      attr_reader :cache
-
-      def cache_get(key)
-        # `Cache#get(key)` for Memcache
-        if cache.respond_to?(:get)
-          cache.get(key)
-
-        # `Cache#[key]` so `Hash` can be used
-        elsif cache.respond_to?(:[])
-          cache[key]
-
-        # `Cache#read(key)` for `ActiveSupport::Cache` support
-        elsif cache.respond_to?(:read)
-          cache.read(key)
-
-        else
-          nil
-        end
-      end
-
-      def cache_set(key, value)
-        # `Cache#set(key, value)` for Memcache
-        if cache.respond_to?(:set)
-          cache.set(key, value)
-
-        # `Cache#[key]=value` so `Hash` can be used
-        elsif cache.respond_to?(:[]=)
-          cache[key] = value
-
-        # `Cache#write(key, value)` for `ActiveSupport::Cache` support
-        elsif cache.respond_to?(:write)
-          cache.write(key, value)
-        end
-
-        value
-      end
-    end
-
-    def self.get_map_cache(sprockets, logical_path)
-      logical_path = logical_path.gsub(/\.js#{REGEXP_END}/, '')
-      cache_key = cache_key_for_path(logical_path+'.map')
-      cache(sprockets).cache_get(cache_key)
-    end
-
-    def self.set_map_cache(sprockets, logical_path, map_contents)
-      logical_path = logical_path.gsub(/\.js#{REGEXP_END}/, '')
-      cache_key = cache_key_for_path(logical_path+'.map')
-      cache(sprockets).cache_set(cache_key, map_contents)
-    end
-
-    def self.cache(sprockets)
-      @cache ||= sprockets.cache ? sprockets : Cache.new
-    end
-
-    def self.cache_key_for_path(logical_path)
-      base_name = logical_path.gsub(/\.js#{REGEXP_END}/, '')
-      File.join('opal', 'source_maps', base_name)
-    end
-
-
-    def initialize sprockets, prefix = '/'
-      @sprockets = sprockets
-      @prefix = prefix
-    end
-
-    attr_reader :sprockets, :prefix
-
-    def inspect
-      "#<#{self.class}:#{object_id}>"
-    end
-
-    def call(env)
-      prefix_regex = %r{^(?:#{prefix}/|/)}
-      path_info = env['PATH_INFO'].to_s.sub(prefix_regex, '')
-
-      case path_info
-      when %r{^(.*)\.self\.map$}
-        path = $1
-        asset  = sprockets[path+'.js']
-        return not_found(path) if asset.nil?
-
-        # "logical_name" of a BundledAsset keeps the .js extension
-        source = SourceMapServer.get_map_cache(sprockets, asset.logical_path)
-        return not_found(asset) if source.nil?
-
-        map = JSON.parse(source)
-        map['sources'] = map['sources'].map {|s| "#{prefix}/#{s}"}
-        source = map.to_json
-
-        return [200, {"Content-Type" => "text/json"}, [source.to_s]]
-      when %r{^(.*)\.rb$}
-        begin
-          asset = sprockets.resolve(path_info.sub(/\.rb#{REGEXP_END}/,''))
-        rescue Sprockets::FileNotFound
-          return not_found(path_info)
-        end
-        return [200, {"Content-Type" => "text/ruby"}, [Pathname(asset).read]]
-      else
-        not_found(path_info)
-      end
-    end
-
-    def not_found(*messages)
-      not_found = [404, {}, [{not_found: messages}.inspect]]
-    end
-  end
-end

data/spec/fixtures/source_map.rb

@@ -1 +0,0 @@
-puts 'smap!'