propshaft-compressor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae21d35868b662276eadac320870558edd5d2ff66ae95dfd7c20debf6a548099
+  data.tar.gz: 18644d8d89a1d7094174a475b56182bd0dc9e49c562e9bc731d0fceeefcbc397
+SHA512:
+  metadata.gz: 0f58623def363231939821a7eb19ee0b08b3695fd27b991df7b2f3f64c70b249794ec41ab72c2a2d994a86c55f0d65ae708fd12521bb837a371bcce413711e42
+  data.tar.gz: 88ecb506e40fb61b87581fb8198a3c069ab8b45b08d83d11701bc88f470adbe9cd50f51f61e1605cde0420ed590208851723f42b508e1321065bc5133aa74843

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2024 thomas morgan
+
+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,60 @@
+# Propshaft::Compressor
+
+`Propshaft::Compressor` is an extension for the Propshaft asset pipeline for Rails. It adds automatic compression of assets. It is intended to be as plug-and-play as possible.
+
+It is designed to be compatible with the new Rails 8 deployment idioms, but works with Rails 7.x too. Since it's a plugin to Propshaft, it requires the app to use Propshaft instead of Sprockets.
+
+This gem will always compile `.gz` (gzip) versions of assets. It will add `.br` (brotli) versions if the `brotli` gem is present. Likewise, it will add `.zst` (zstandard) versions if the `zstd-ruby` gem is present.
+
+All formats compile at max-compression.
+
+Some common file types are automatically excluded from compression since they already contain dense or compressed content. These include: jpg, mp3, mp4, png, webp, woff, woff2.
+
+
+## Installation
+
+Just add the gem to your app's Gemfile. It will automatically hook into the `assets:precompile` task and compress all assets after compiling.
+
+```ruby
+gem "propshaft-compressor"
+
+# optional (either or both)
+gem "brotli"
+gem "zstd-ruby"
+```
+
+
+## Usage
+
+To make use of the precompressed assets, something needs to recognize and serve the compressed version when requested by client browsers.
+
+If your app is using the built-in Rails file server (many do), no additional config is required. The Rails file server will automatically recognize and serve `gz` and `br`, but not `zst`.
+
+Nginx has a built-in module that can recognize and use `gz` files. There are also addon modules for both `br` and `zst`.
+
+Other webservers have varying support for serving pre-compressed assets.
+
+This gem makes no effort to cleanup stale assets. If using Dockerfile-based deployments, this should be no problem. If using a deployment mechanism that leaves old assets behind, it may be necessary to periodically run `assets:clobber` (before `assets:precompile`).
+
+
+## FAQ
+
+Q: My webserver or CDN automatically compresses assets. Do I need this?
+A: Possibly. Most on-the-fly compression will use lower compression levels to improve compression speed. Precompressing at a higher compression level will result in smaller files, faster downloads, and smaller bandwidth bills.
+Additionally, some webservers and CDNs limit which formats they will use to dynamically compress content. Precompressing may give you more control over this.
+
+Q: Does this compress dynamic content?
+A: No, just static assets that are precompiled as part of the asset pipeline.
+
+Q: Can I use this with Sprockets?
+A: No, it's just for Propshaft.
+
+
+## Contributing
+
+Contributions welcomed. Please use standard GitHub Pull Requests.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = true
+end
+
+task default: :test

data/lib/propshaft/compressor/assets.rake

@@ -0,0 +1,9 @@
+namespace :assets do
+  Rake::Task['assets:precompile'].enhance do
+    Rake::Task['assets:compress'].invoke
+  end
+
+  task :compress do
+    Propshaft::Compressor.compress_assets Rails.application.assets.processor
+  end
+end

data/lib/propshaft/compressor/railtie.rb

@@ -0,0 +1,11 @@
+module Propshaft
+  module Compressor
+    class Railtie < ::Rails::Railtie
+
+      rake_tasks do
+        load 'propshaft/compressor/assets.rake'
+      end
+
+    end
+  end
+end

data/lib/propshaft/compressor/version.rb

@@ -0,0 +1,5 @@
+module Propshaft
+  module Compressor
+    VERSION = '0.2.0'
+  end
+end

data/lib/propshaft/compressor/writer.rb

@@ -0,0 +1,86 @@
+require 'zlib'
+begin
+  require 'brotli'
+rescue LoadError
+end
+begin
+  require 'zstd-ruby'
+rescue LoadError
+end
+
+module Propshaft
+  module Compressor
+
+    FORMATS = {}  # { '.ext' => [GzipWriter, 9] }
+
+    class Writer
+      def self.compress(...)
+        new(...).compress
+      end
+
+      def initialize(from:, to:, level: 8)
+        @from  = from
+        @to    = to
+        @level = level
+      end
+
+      def compress
+        File.open(@from, 'rb') do |from_io|
+          File.open(@to, 'wb+') do |to_io|
+            writer = build_writer to_io, from_io.mtime
+            from_io.each do |blk|
+              writer.write blk
+            end
+          ensure
+            writer&.close
+          end
+          File.utime from_io.atime, from_io.mtime, @to
+        end
+      end
+
+      def build_writer(io)
+        raise 'abstract'
+      end
+    end
+
+    if defined? Brotli::Writer
+      class BrotliWriter < Writer
+        def build_writer(io, _)
+          Brotli::Writer.new io, quality: @level
+        end
+      end
+      FORMATS['.br'] = [ BrotliWriter, 11 ]
+    end
+
+    class GzipWriter < Writer
+      def build_writer(io, mtime)
+        Zlib::GzipWriter.new(io, @level).tap do |gz|
+          gz.mtime = mtime
+        end
+      end
+    end
+    FORMATS['.gz'] = [ GzipWriter, 9 ]
+
+    if defined? Zstd::StreamWriter
+      class ZstdWriter < Writer
+        def build_writer(io, _)
+          Zstd::StreamWriter.new io, level: @level
+        end
+      end
+      FORMATS['.zst'] = [ ZstdWriter, 22 ]
+
+      if Zstd::VERSION <= '1.5.6.6'
+        module ZstdStreamWriterPatch
+          # monkeypatch to silence deprecation warning
+          def initialize(io, level: nil)
+            @io = io
+            @stream = Zstd::StreamingCompress.new level: level
+          end
+        end
+        Zstd::StreamWriter.prepend ZstdStreamWriterPatch
+      end
+    end
+
+  end
+end
+

data/lib/propshaft/compressor.rb

@@ -0,0 +1,33 @@
+require 'propshaft'
+
+%w(
+  version
+  writer
+  railtie
+).each do |f|
+  require_relative "compressor/#{f}"
+end
+
+
+module Propshaft
+  module Compressor
+
+    SKIP_EXTS = %w(jpg mp3 mp4 png webp woff woff2)
+
+    def self.compress_assets(processor)
+      processor.load_path.assets.each do |asset|
+        in_path = processor.output_path.join(asset.digested_path).to_s
+        next if SKIP_EXTS.any?{|ext| in_path.ends_with? ".#{ext}" }
+
+        FORMATS.each do |ext, (klass, level)|
+          out_path = processor.output_path.join(asset.digested_path.to_s+ext)
+          unless out_path.exist?
+            Propshaft.logger.info "Writing #{asset.digested_path}#{ext}"
+            klass.compress from: in_path, to: out_path, level: level
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: propshaft-compressor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Adds asset compression to Propshaft. Compresses with gzip, brotli, and/or
+  zstandard.
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/propshaft/compressor.rb
+- lib/propshaft/compressor/assets.rake
+- lib/propshaft/compressor/railtie.rb
+- lib/propshaft/compressor/version.rb
+- lib/propshaft/compressor/writer.rb
+homepage: https://github.com/zarqman/propshaft-compressor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Extends Propshaft to add asset compression using gzip, brotli, zstandard
+test_files: []