sprockets_terser_with_source_maps 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79fd8bbc6060ac2dc72a05d181e2448755c52a7bccc79b132e3152b2bd2218b1
+  data.tar.gz: 4b740851e0ce654c583cf7b2cb7c3f68315fd65f0816ed7304b3f8d6cc0973d0
+SHA512:
+  metadata.gz: 0fb9f658e50a1d90b490a88c2a914735efe1322b454d6eb799c321e1f20d6cb2d6386ab74a2d4b646daa38224dda345a87b82ad1f17b0bc578e21cf3a168b880
+  data.tar.gz: 3dc5f11e5fc43ea549c458b23756ba8f7623a64d177c8b5b6df8396959731469e7e868f1490217f357755f54ea93badbdbb671bcbe0a742d913fe2a22e87d63c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Javier Menéndez Rizo
+
+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,101 @@
+[![Gem Version](https://badge.fury.io/rb/sprockets_terser_with_source_maps.svg)](https://badge.fury.io/rb/sprockets_terser_with_source_maps)
+[![CI](https://github.com/javier-menendez/sprockets_terser_with_source_maps/actions/workflows/ci.yml/badge.svg)](https://github.com/javier-menendez/sprockets_terser_with_source_maps/actions/workflows/ci.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+# SprocketsTerserWithSourceMaps
+
+Create source maps when compressing assets in your Rails applications.
+
+This gem uses Terser to create source maps for your concatenated javascripts in Rails.
+It is meant to be used as a replacement for javascript compressor.
+
+This gem is ported from [sprockets_uglifier_with_source_maps](https://github.com/AlexanderPavlenko/sprockets_uglifier_with_source_maps)
+to generate source maps using terser as compressor.
+
+Rails versions supported: 4.2, 5.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sprockets_terser_with_source_maps'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sprockets_terser_with_source_maps
+
+## Usage
+
+In your Rails applications environment configuration:
+
+    config.assets.js_compressor = :terser_with_source_maps
+
+If you need to pass options to terser:
+
+    config.assets.terser = {output: {beautify: true, indent_level: 2}, compress: {drop_console: true}}
+
+Your assets will be built as normal, also maps and concatenated sources will be provided as well in `public/assets/maps` and `public/assets/sources`.
+These subdirs may be configured:
+
+    config.assets.sourcemaps_prefix = 'my_maps'
+    config.assets.uncompressed_prefix = 'my_sources'
+
+Alternatively, sources can be embedded into sourcemaps' `sourcesContent` field:
+
+    config.assets.sourcemaps_embed_source = true
+
+You can optionally skip gzipping your maps and sources:
+
+    config.assets.sourcemaps_gzip = false
+
+By default maps and sources are defined relatively and will be fetched from the same domain your js file is served from. If you are using a CDN you may not want this - instead you might want to use a direct link to your site so you can more easily implement IP or Basic Auth protection:
+
+    # set to a url - js will be served from 'http://cdn.host.com' but source map links will use 'http://some.host.com/'
+
+    config.assets.sourcemaps_url_root = 'http://some.host.com/'
+
+If you use CloudFront you might want to generate a signed url for these files that limits access based on IP address. You can do that by setting sourcemaps_url_root to a Proc and handling your URL signing there:
+
+    # using a Proc - see the AWS SDK docs for everything required to make this work
+    config.assets.sourcemaps_url_root = Proc.new { |file| MyApp.generate_a_signed_url_for file }
+
+## Example
+
+    $ rm -rf tmp/cache && rm -rf public/assets && DISABLE_SPRING=true RAILS_ENV=production bin/rake assets:precompile
+
+    $ tree public/assets
+    public/assets
+    ├── application-f925f01bc55e9831029c1eb2c20ee889.js
+    ├── maps
+    │   └── application-a3aff92c860f3876615c2d158f724865.js.map
+    └── sources
+        └── application-73a007cf2d51c423a4420b649344b52e.js
+
+    $ tail -n1 public/assets/application-f925f01bc55e9831029c1eb2c20ee889.js
+    //# sourceMappingURL=/assets/maps/application-a3aff92c860f3876615c2d158f724865.js.map
+
+    $ head -c115 public/assets/maps/application-a3aff92c860f3876615c2d158f724865.js.map
+    {"version":3,"file":"application.js","sources":["/assets/sources/application-73a007cf2d51c423a4420b649344b52e.js"],
+
+## Troubleshooting
+
+If sourcemaps are not generated, try `rm -rf tmp/cache`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sprockets_terser_with_source_maps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sprockets_terser_with_source_maps/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SprocketsTerserWithSourceMaps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sprockets_terser_with_source_maps/blob/master/CODE_OF_CONDUCT.md).

data/lib/sprockets_terser_with_source_maps/compressor.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'sprockets/digest_utils'
+require 'terser/compressor'
+
+module SprocketsTerserWithSourceMaps
+  class Compressor < Terser::Compressor # :nodoc:
+    def initialize(options = {})
+      @options = options.merge(Rails.application.config.assets.terser.to_h)
+      super @options
+    end
+
+    def call(input)
+      input_options = { source_map: { filename: input[:filename] } }
+
+      data = input.fetch(:data)
+      name = input.fetch(:name)
+
+      compressed_js, map = @terser.compile_with_map(data, input_options)
+
+      sourcemap = JSON.parse(map)
+
+      if Rails.application.config.assets.sourcemaps_embed_source
+        sourcemap['sourcesContent'] = [data]
+      else
+        # Generate uncompressed asset
+        uncompressed_url = generate_asset_file(name, data, Rails.application.config.assets.uncompressed_prefix)
+
+        sourcemap['sources'] = [uncompressed_url]
+      end
+
+      sourcemap['file'] = "#{name}.js"
+      sourcemap_json = sourcemap.to_json
+
+      # Generate sourcemap file
+      sourcemap_url = generate_asset_file(
+        name, sourcemap_json,
+        Rails.application.config.assets.sourcemaps_prefix,
+        'js.map'
+      )
+
+      compressed_js.concat "\n//# sourceMappingURL=#{sourcemap_url}\n"
+    end
+
+    private
+
+    def generate_asset_file(name, data, prefix, extension = 'js')
+      filename = File.join(Rails.application.config.assets.prefix, prefix, "#{name}-#{digest(data)}.#{extension}")
+      file_path = File.join(Rails.public_path, filename)
+      file_url = filename_to_url(filename)
+
+      FileUtils.mkdir_p File.dirname(file_path)
+      File.write(file_path, data)
+      gzip_file(file_path) if gzip?
+      file_url
+    end
+
+    def filename_to_url(filename)
+      url_root = Rails.application.config.assets.sourcemaps_url_root
+      case url_root
+      when FalseClass
+        filename
+      when Proc
+        url_root.call filename
+      else
+        File.join url_root.to_s, filename
+      end
+    end
+
+    def gzip?
+      config = Rails.application.config.assets
+      config.sourcemaps_gzip || (config.sourcemaps_gzip.nil? && config.gzip)
+    end
+
+    def gzip_file(path)
+      Zlib::GzipWriter.open("#{path}.gz") do |gz|
+        gz.mtime = File.mtime(path)
+        gz.orig_name = path
+        gz.write File.binread(path)
+      end
+    end
+
+    def digest(io)
+      Sprockets::DigestUtils.pack_hexdigest Sprockets::DigestUtils.digest(io)
+    end
+  end
+end

data/lib/sprockets_terser_with_source_maps/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'action_controller/railtie'
+
+module SprocketsTerserWithSourceMaps
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer 'sprockets-terser-with-source-maps.environment', group: :all do |app|
+      config = app.config
+      config.assets.sourcemaps_prefix ||= 'maps'
+      config.assets.uncompressed_prefix ||= 'sources'
+      config.assets.sourcemaps_url_root ||= false
+    end
+  end
+end

data/lib/sprockets_terser_with_source_maps/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SprocketsTerserWithSourceMaps
+  VERSION = '1.0.0'
+end

data/lib/sprockets_terser_with_source_maps.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sprockets'
+require 'sprockets_terser_with_source_maps/version'
+require 'sprockets_terser_with_source_maps/compressor'
+require 'sprockets_terser_with_source_maps/railtie' if defined? Rails::Railtie
+require 'terser'
+
+Sprockets.register_compressor 'application/javascript',
+                              :terser_with_source_maps,
+                              SprocketsTerserWithSourceMaps::Compressor

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sprockets_terser_with_source_maps
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Javier Menéndez Rizo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: terser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Create source maps for your javascript assets along with their compression
+  using terser.
+email:
+- jmenendez087@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sprockets_terser_with_source_maps.rb
+- lib/sprockets_terser_with_source_maps/compressor.rb
+- lib/sprockets_terser_with_source_maps/railtie.rb
+- lib/sprockets_terser_with_source_maps/version.rb
+homepage: https://github.com/javier-menendez/sprockets_terser_with_source_maps
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/javier-menendez/sprockets_terser_with_source_maps
+  source_code_uri: https://github.com/javier-menendez/sprockets_terser_with_source_maps
+  changelog_uri: https://github.com/javier-menendez/sprockets_terser_with_source_maps
+  rubygems_mfa_required: 'true'
+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.4.19
+signing_key: 
+specification_version: 4
+summary: Create javascript source maps for your Rails applications
+test_files: []