rake_source_maps_fixer 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c54ebb9354aa3d2256298c98513c7168c36a03e1f37a5dca4bfd2ef0ecdf05d2
+  data.tar.gz: 1c59da177bf8833c84a3db5925ecceff3f7deb68c846e936dd21ed39ec0bded1
+SHA512:
+  metadata.gz: 3fcd892fe68beaa35699d88ba7a3588777372a97f5206cbe66ee9783e48f1f27051d6520806b511ea0e483986bd3a30dceb1b0f4e0cc0a499efb22c837bf7389
+  data.tar.gz: c4e77f657e9576c918821cfb655ccc08d9ade659af88703fa3b31dddb447f649385803d30b4cecb634dc7fbec04f9182ee5ad9e5bb92369bc9aff2da4ba74a6d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Zbigniew Humeniuk
+
+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,72 @@
+# RakeSourceMapsFixer
+
+RakeSourceMapsFixer is a set of [Rake](https://ruby.github.io/rake/) tasks for fixing **sourceMappingURL**s.
+It is helpful for [Rails](https://rubyonrails.org) apps where the main front-end code lives in the separate directory like `frontend`. But the app also uses [Sprockets](https://github.com/rails/sprockets-rails) to process outputted bundles and additional assets inside `app/assets` directory. `bin/rails assets:precompile` command compiles assets to `public/assets` directory. Fingerprints are added to asset filenames during compilation by default. It is useful in conjunction with far-future headers.
+
+### Problem
+
+When [webpack](https://webpack.js.org) produces bundles to `app/assets/bundles`, each contains **sourceMappingURL** at the bottom (if configured). This URL links to the corresponding source map.
+But when _Sprockets_ compile assets to `public/assets`, fingerprints are added to all asset filenames.
+**sourceMappingURL**s are intact, which makes them point to invalid files without fingerprints.
+
+### Solution
+
+_RakeSourceMapsFixer_ fixes **sourceMappingURL**s inside bundles.
+
+
+## 🎮 Usage
+
+Instead of running
+
+```bash
+$ bin/rails assets:precompile
+```
+
+run
+
+```bash
+$ bin/rails assets:prepare
+```
+
+
+## 📥 Installation
+
+Add *source\_maps\_fixer* to your application's Gemfile:
+
+```ruby
+gem 'rake_source_maps_fixer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rake_source_maps_fixer
+```
+
+
+## 📈 Changelog
+
+### Major releases 🎙
+
+#### 0.2 _(2022-02-11)_
+##### 💥 breaking changes
+
+* *source\_maps\_fixer* works with Rails 7 and Ruby 3.1.
+* it drops support for Ruby 2.6
+* it supports sprockets-rails ~> 3.3.0. Version 3.4.0 works differently. `bin/rails assets:precompile` correctly replaces *sourceMappingURL*s for JS files but adds unnecessary comments
+
+
+## 📜 License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## 👨‍🏭 Author
+Zbigniew Humeniuk from [Art of Code](https://artofcode.co)
+
+
+## 👀 See also
+If you want to make your life easier in other areas of web app development, I strongly recommend you to take a look at my other project called the [Loco framework](http://locoframework.org) 🙂. It is pretty powerful and makes a front-end <-> back-end communication a breeze (among other things).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RakeSourceMapsFixer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rake_source_maps_fixer/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RakeSourceMapsFixer
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each do |f|
+        load f
+      end
+    end
+  end
+end

data/lib/rake_source_maps_fixer/version.rb

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

data/lib/rake_source_maps_fixer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'rake_source_maps_fixer/railtie'
+
+module RakeSourceMapsFixer
+  module Path
+    module_function
+
+    def files_with_source_maps(filter = '')
+      Dir.glob("#{Rails.root.join 'app', 'assets'}/**/*")
+         .grep(/#{filter}\.map\Z/)
+         .to_h { |name| [name.sub('.map', ''), name] }
+    end
+
+    def digest_path(file_name)
+      Rails.application.assets.find_asset(file_name).digest_path
+    end
+
+    def self.source_mapping_url(file_name)
+      case file_name.match?(/\.css/) ? :css : :js
+      when :css
+        %(/*# sourceMappingURL=#{file_name}*/)
+      when :js
+        %(//# sourceMappingURL=#{file_name})
+      end
+    end
+  end
+
+  module ReplaceLinksWithPredicted
+    module_function
+
+    def call
+      Path.files_with_source_maps.each do |asset_path, sm_path|
+        new_content = File.read(asset_path).sub(
+          Path.source_mapping_url(File.basename(sm_path)),
+          "#{Path.source_mapping_url(Path.digest_path(sm_path))}\n\n"
+        )
+        File.write(asset_path, new_content)
+      end
+    end
+
+    def undo
+      Path.files_with_source_maps.each do |asset_path, sm_path|
+        new_content = File.read(asset_path).sub(
+          "#{Path.source_mapping_url(Path.digest_path(sm_path))}\n\n",
+          Path.source_mapping_url(File.basename(sm_path))
+        )
+        File.write(asset_path, new_content)
+      end
+    end
+  end
+
+  module FixCompiled
+    module_function
+
+    def call
+      Path.files_with_source_maps('js').each do |asset_path, _sm_path|
+        public_path = Dir.glob("#{Rails.root.join 'public', 'assets'}/**/*")
+                         .find do |path|
+                           File.basename(path) == Path.digest_path(asset_path)
+                         end
+        lines = File.readlines(public_path)
+        next unless lines[-2] == "//!\n" && lines[-1] == ";\n"
+
+        File.write(public_path, lines[0..-3].join)
+      end
+    end
+  end
+end

data/lib/tasks/fix_source_maps.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+namespace :assets do
+  desc 'Fix URLs to source maps'
+  task fix_source_maps: [:environment] do
+    puts 'Fixing URLs to source maps...'
+    RakeSourceMapsFixer::ReplaceLinksWithPredicted.call
+    puts 'URLs to source maps have been fixed!'
+  end
+
+  desc 'Revert fixed URLs to source maps'
+  task undo_fix_source_maps: [:environment] do
+    puts 'Reverting fixed URLs to source maps...'
+    RakeSourceMapsFixer::ReplaceLinksWithPredicted.undo
+    puts 'URLs to source maps have been reverted!'
+  end
+
+  desc 'Fix generated URLs to source maps'
+  task fix_compiled: [:environment] do
+    puts 'Fixing URLs to source maps...'
+    RakeSourceMapsFixer::ReplaceLinksWithPredicted.call
+    puts 'URLs to source maps have been fixed!'
+  end
+end

data/lib/tasks/prepare.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :assets do
+  desc 'Fix URLs to source maps and compile assets'
+  task prepare: [:environment] do
+    RakeSourceMapsFixer::ReplaceLinksWithPredicted.call
+    Rake::Task['assets:precompile'].invoke
+    RakeSourceMapsFixer::ReplaceLinksWithPredicted.undo
+    puts 'Assets have been prepared!'
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rake_source_maps_fixer
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Zbigniew Humeniuk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: listen
+  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: rubocop
+  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: Rake tasks that fix sourceMappingURL in JavaScript and CSS bundles generated
+  by webpack to match the final fingerprinted names generated by Sprockets after assets'
+  precompilation
+email:
+- hello@artofcode.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rake_source_maps_fixer.rb
+- lib/rake_source_maps_fixer/railtie.rb
+- lib/rake_source_maps_fixer/version.rb
+- lib/tasks/fix_source_maps.rake
+- lib/tasks/prepare.rake
+homepage: https://artofcode.co
+licenses:
+- MIT
+metadata:
+  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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Rake tasks for fixing URLs to source maps
+test_files: []