source_maps_fixer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46d1a5a92e0cfb9ce2cfa9fecc78ce1b16443677a4565fa9b7a0fee023bed8b
-  data.tar.gz: 30b57467453f4c40690e453e71c7442fa6ac83fb769008da7b475765d26b96b0
+  metadata.gz: 8359d9c4a3b6c24bca36cc77d9f53cf762e5a14fc58bae51ca4354ca8e4ce0fb
+  data.tar.gz: 942a8bc352604d24148a0200eb9c27e40c7ea234d3f4f8de021a9f486aa8a633
 SHA512:
-  metadata.gz: a8d4fed5ab9bfbab3d973dc102da6cba964b8505580169a9ba643405ed01e32741865bc5aac3e8ad4547daaffceb3fc843c14cc37fbe52e6c2e337e472b0627d
-  data.tar.gz: 8736a808ddc9c31169502ba78718fe169c589760823ce03419a7a858a4f7dc9e4913f581bb90f5694afcd39b9fee1e7c7374b0a66e8febad4ea2b8ccee1ed5a8
+  metadata.gz: 4c27c8b97e5cd3a5e9b8c366c876feb3f1ed00d94a28b01609d4ad67ccf91b1c9b4d6aef26e4c5fc58dfeb5b53310f2bd8d753fa0938d72c90731210cdba14ef
+  data.tar.gz: 13877418eba6cd5a8e14281205b009b4ece82fc72f95db4844d58599459919552f6b5fc3e5c5500c3705e1201978e024994a32cd2f37f5c796f36267db5a44a7

data/README.md

@@ -1,11 +1,37 @@
 # SourceMapsFixer
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+SourceMapsFixer 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.
 
-## Installation
-Add this line to your application's Gemfile:
+### 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
+
+_SourceMapsFixer_ 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 'source_maps_fixer'
@@ -21,8 +47,26 @@ Or install it yourself as:
 $ gem install source_maps_fixer
 ```
 
-## Contributing
-Contribution directions go here.
 
-## License
+# 📈 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/lib/source_maps_fixer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SourceMapsFixer
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/source_maps_fixer.rb

@@ -3,46 +3,66 @@
 require 'source_maps_fixer/railtie'
 
 module SourceMapsFixer
-  class Path
-    def self.files_with_source_maps
+  module Path
+    module_function
+
+    def files_with_source_maps(filter = '')
       Dir.glob("#{Rails.root.join 'app', 'assets'}/**/*")
-         .find_all { |name| name =~ /\.map\Z/ }
-         .map { |name| [name.sub('.map', ''), name] }
-         .to_h
+         .grep(/#{filter}\.map\Z/)
+         .to_h { |name| [name.sub('.map', ''), name] }
     end
 
-    def self.digest_path file_name
+    def digest_path(file_name)
       Rails.application.assets.find_asset(file_name).digest_path
     end
 
-    def self.source_mapping_url file_name
+    def self.source_mapping_url(file_name)
       case file_name.match?(/\.css/) ? :css : :js
       when :css
-        "/*# sourceMappingURL=#{file_name}*/"
+        %(/*# sourceMappingURL=#{file_name}*/)
       when :js
-        "//# sourceMappingURL=#{file_name}"
+        %(//# sourceMappingURL=#{file_name})
       end
     end
   end
 
-  class Executor
-    def self.call
-      Path.files_with_source_maps.each do |file_name, sm_name|
-        new_content = File.read(file_name).sub(
-          Path.source_mapping_url(File.basename(sm_name)),
-          Path.source_mapping_url(Path.digest_path(sm_name))
+  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.open(file_name, 'w') { |file| file.write new_content }
+        File.write(asset_path, new_content)
       end
     end
 
-    def self.undo
-      Path.files_with_source_maps.each do |file_name, sm_name|
-        new_content = File.read(file_name).sub(
-          Path.source_mapping_url(Path.digest_path(sm_name)),
-          Path.source_mapping_url(File.basename(sm_name))
+    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.open(file_name, 'w') { |file| file.write new_content }
+        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

data/lib/tasks/fix_source_maps.rake

@@ -4,14 +4,21 @@ namespace :assets do
   desc 'Fix URLs to source maps'
   task fix_source_maps: [:environment] do
     puts 'Fixing URLs to source maps...'
-    SourceMapsFixer::Executor.call
+    SourceMapsFixer::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...'
-    SourceMapsFixer::Executor.undo
+    SourceMapsFixer::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...'
+    SourceMapsFixer::ReplaceLinksWithPredicted.call
+    puts 'URLs to source maps have been fixed!'
+  end
 end

data/lib/tasks/prepare.rake

@@ -3,9 +3,9 @@
 namespace :assets do
   desc 'Fix URLs to source maps and compile assets'
   task prepare: [:environment] do
-    SourceMapsFixer::Executor.call
+    SourceMapsFixer::ReplaceLinksWithPredicted.call
     Rake::Task['assets:precompile'].invoke
-    SourceMapsFixer::Executor.undo
+    SourceMapsFixer::ReplaceLinksWithPredicted.undo
     puts 'Assets have been prepared!'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_maps_fixer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Zbigniew Humeniuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,49 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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
@@ -50,8 +92,9 @@ files:
 homepage: https://artofcode.co
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Rake tasks for fixing URLs to source maps
 test_files: []