sprockets-sidecar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc25a689fb6a1b3e2ec3623a05af41c58c188855fe0212e18541dc992773a6b2
+  data.tar.gz: 2b6deec9ab7d7527c5a6f89b4332a2a50e378945b5f2ebddeac572d5b5f6f110
+SHA512:
+  metadata.gz: cc0bd4609bab38d5a5710f14c23b2bb4b1d1b34e0f8eaab22600f97c8b8f42b3096ef4f11c1be1873786c3409b3ec6144285a276dc23eb5b597be2e71a4dc45b
+  data.tar.gz: 8c9006b2697e8dacfd5a3ce3ae76f1c710f41e89cd013978c3450b5aa7223d11a5c98dd98179398e708ddeb612085c44a656e3ce15b37d23be90a390e5c6147a

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hans Otto Wirtz
+Copyright (c) 2026 Pavlo Bilyak
+
+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,76 @@
+# Sprockets::Sidecar
+
+Writes precompressed sidecar files (`.br`, `.zst`) next to [sprockets][rails/sprockets] assets.
+
+This is a fork of [sprockets-exporters_pack][hansottowirtz/sprockets-exporters_pack] gem that adds support of Zstd compression and asset cleanup.
+
+Currently, it has:
+
+- a Brotli exporter, which can be used with Nginx [ngx_brotli][google/ngx_brotli] module and Caddy [file_server.precompressed] subdirective.
+- a Zstd exporter, which can be used with Nginx [zstd-nginx-module][tokers/zstd-nginx-module] module and Caddy [file_server.precompressed] subdirective.
+
+## Installation
+
+Add this line to your `Gemfile`:
+
+```ruby
+gem 'sprockets-sidecar'
+```
+
+If you used `sprockets-exporters_pack` before, remove it from your `Gemfile` and replace `Sprockets::ExportersPack` with `Sprockets::Sidecar`.
+
+You probably need these too, as sprockets hasn't been updated yet:
+
+```ruby
+gem 'sprockets', '>= 4.0.0.beta3', github: 'rails/sprockets'
+gem 'sprockets-rails', '>= 3.1.0'
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+With Rails, in `application.rb`:
+
+```ruby
+config.assets.configure do |env|
+  # Brotli
+  env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::Sidecar::BrotliExporter
+  # Zstd
+  env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::Sidecar::ZstdExporter
+end
+```
+
+Without Rails:
+
+```ruby
+env = Sprockets::Environment.new
+# Brotli
+env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::Sidecar::BrotliExporter
+# Zstd
+env.register_exporter %w(text/css application/javascript image/svg+xml), Sprockets::Sidecar::ZstdExporter
+```
+
+## Contributing
+
+Yes please! Open an issue with exporters you want to see added.
+
+## Tests
+
+```bash
+bundle install
+bundle exec rake
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[rails/sprockets]: https://github.com/rails/sprockets
+[hansottowirtz/sprockets-exporters_pack]: https://github.com/hansottowirtz/sprockets-exporters_pack
+[rails/rails]: https://github.com/rails/rails
+[google/ngx_brotli]: https://github.com/google/ngx_brotli
+[tokers/zstd-nginx-module]: https://github.com/tokers/zstd-nginx-module
+[file_server.precompressed]: https://caddyserver.com/docs/caddyfile/directives/file_server#precompressed

data/lib/sprockets/sidecar/brotli_exporter.rb

@@ -0,0 +1,57 @@
+require 'sprockets/exporters/base'
+require 'brotli'
+
+module Sprockets
+  module Sidecar
+    class BrotliExporter < ::Sprockets::Exporters::Base
+      def setup
+        @brotli_target = "#{ target }.br"
+      end
+
+      def skip?(logger)
+        if ::File.exist?(@brotli_target)
+          logger.debug "Skipping #{ @brotli_target }, already exists"
+          true
+        else
+          logger.info "Writing #{ @brotli_target }"
+          false
+        end
+      end
+
+      def call
+        data = File.binread(target)
+        mode = if asset.content_type.match self.class.font_regex
+          :font
+        elsif asset.content_type.match self.class.text_regex
+          :text
+        else
+          :generic
+        end
+        brotli = Brotli.deflate(data, mode: mode, quality: self.class.quality)
+
+        write(@brotli_target) do |file|
+          file.write(brotli)
+          file.close
+        end
+      end
+
+      class << self
+        attr_writer :quality
+        attr_writer :font_regex
+        attr_writer :text_regex
+
+        def quality
+          @quality || 9
+        end
+
+        def font_regex
+          @font_regex || /font|otf/
+        end
+
+        def text_regex
+          @text_regex || /text|(application\/(javascript|json|xml))/
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sidecar/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  module Sidecar
+    VERSION = '0.1.0'
+  end
+end

data/lib/sprockets/sidecar/zstd_exporter.rb

@@ -0,0 +1,40 @@
+require 'sprockets/exporters/base'
+require 'zstd-ruby'
+
+module Sprockets
+  module Sidecar
+    class ZstdExporter < ::Sprockets::Exporters::Base
+      def setup
+        @zstd_target = "#{ target }.zst"
+      end
+
+      def skip?(logger)
+        if ::File.exist?(@zstd_target)
+          logger.debug "Skipping #{ @zstd_target }, already exists"
+          true
+        else
+          logger.info "Writing #{ @zstd_target }"
+          false
+        end
+      end
+
+      def call
+        data = File.binread(target)
+        zstd = Zstd.compress(data, level: self.class.quality)
+
+        write(@zstd_target) do |file|
+          file.write(zstd)
+          file.close
+        end
+      end
+
+      class << self
+        attr_writer :quality
+
+        def quality
+          @quality || 9
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sidecar.rb

@@ -0,0 +1,19 @@
+require 'sprockets/sidecar/version'
+require 'sprockets/sidecar/brotli_exporter'
+require 'sprockets/sidecar/zstd_exporter'
+require 'sprockets/manifest'
+
+module Sprockets
+  module Sidecar
+    module ManifestCleanup
+      def remove(filename)
+        result = super
+        path = File.join(directory, filename)
+        FileUtils.rm_f(["#{path}.br", "#{path}.zst"])
+        result
+      end
+    end
+  end
+end
+
+Sprockets::Manifest.prepend(Sprockets::Sidecar::ManifestCleanup)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-sidecar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavlo Bilyak
+- Hans Otto Wirtz
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: zstd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+email:
+- 48239848+PavloBilyak@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sprockets/sidecar.rb
+- lib/sprockets/sidecar/brotli_exporter.rb
+- lib/sprockets/sidecar/version.rb
+- lib/sprockets/sidecar/zstd_exporter.rb
+homepage: https://github.com/PavloBilyak/sprockets-exporters_pack
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.22
+specification_version: 4
+summary: Writes precompressed Brotli and Zstd sidecar files for Sprockets assets
+test_files: []