assets-redirect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73ff04d3845b908b24a79cbee6bf3ecc257008445c6245babf29f631750c6ce0
+  data.tar.gz: 192ad5c188be1a7a373730717e877633298cab8cc7ef8501371ebee4ab34ad57
+SHA512:
+  metadata.gz: cf6306a7a0622c8fdada4d7f07ccb6fb34d2f1c32b20626fd4d73f54e8ef82f8a18dacd36225b9b2fca12401d689f363300763e20269a25610bdeba42d7ef4ed
+  data.tar.gz: bd3477855c425146f750394c8ddccd9860259d8969b17ac521fa9ea51cc7ec4b2e9b6e7d8a2f33c2c8d6d1335842613ff2be119acf38eaca12243515a48de294

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jacopo
+
+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,47 @@
+# Assets::Redirect
+
+A Rack middleware for [Rails](https://github.com/rails/rails) with asset pipeline and asset digest enabled. This middleware is used to redirect any not found request to static asset to the latest version with digest in its filename by reading the  manifest file generated after you run `rake assets:precompile`
+
+For example, if a browser is requesting this URL, and the image with the digest has been removed:
+
+    http://example.org/assets/dog-faa42cf2fd5db7e7290baa07109bc82b.png
+
+They will get redirected to the current version pointed by the manifest:
+
+    http://example.org/assets/application-faa42cf2fd5db7e7290baa07109bc99b.png
+
+This gem is designed to run on your staging or production environment, where you already precompile all your assets, turn on your asset digest, and turn of asset compilation. This is useful if you're having a static page or email which refers to static assets in the asset pipeline, in this case the asset with the old digest can be lost after a deploymeny, and is convenient to automatically show the current version instead of a 404.
+
+This gem has been inspired from https://github.com/sikachu/sprockets-redirect, but with the difference that in this gem both digested/undigested links will automatically redirect to the latest digested version.
+
+## Requirements
+
+- Application running on [Ruby on Rails](http://github.com/rails/rails) version >= 4.2.0.
+- [Sprockets](https://github.com/rails/sprockets) or [Propshaft](https://github.com/rails/propshaft) as assets pipeline.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add assets-redirect
+
+## Usage
+
+This middleware will be enabled by default if you set `config.assets.compile = false` and `config.assets.digest = true` in your configuration file.
+
+### Running inside Docker with Sprockets
+
+If you run the app in a Docker container and are using Sprockets is suggested to keep the Sprockets cache (`tmp/cache/assets`) in the container, this allows faster redirect
+lookups for `.js` and `.css` files.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/basecamp/assets-redirect.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/assets-redirect.gemspec

@@ -0,0 +1,37 @@
+require_relative "lib/assets/redirect/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "assets-redirect"
+  spec.version = Assets::Redirect::VERSION
+  spec.authors = ["Jacopo"]
+  spec.email = ["jacopo@37signals.com"]
+
+  spec.summary = "Redirect assets not found to the manifest-digested version for the logical_path."
+  spec.description = <<-EOS
+    Rack middleware which will redirect every 404 assets requests
+    to the current digested version for the logical_path referenced in the manifest.
+    Useful to automate redirects from deleted assets when the old link can't be updated, e.g. emails.
+  EOS
+
+  spec.homepage = "https://github.com/basecamp/assets_redirect"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.8"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = %Q(#{spec.metadata["source_code_uri"]}/CHANGELOG.md)
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ .git .github Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+end

data/lib/assets/redirect/base.rb

@@ -0,0 +1,77 @@
+require "rack"
+require "rack/request"
+require "rack/mime"
+
+class Assets::Redirect::Base
+  def initialize(app, assets_pipeline, public_path: "/public", assets_prefix: "/assets", logger: nil)
+    @app = app
+    @assets_pipeline = assets_pipeline
+    @public_path = public_path
+    @assets_prefix = assets_prefix
+    @logger = logger
+  end
+
+  def call(env)
+    @request = Rack::Request.new(env)
+
+    if should_redirect?
+      redirect_to_resolved_version_from_manifest
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+    def should_redirect?
+      Assets::Redirect.enabled && asset_not_found? && file_exists?(redirect_path)
+    end
+
+    def asset_not_found?
+      @request.path.start_with?(@assets_prefix) && !file_exists?(@request.path)
+    end
+
+    def file_exists?(path)
+      full_path = File.join(@public_path, path)
+      File.exist?(full_path) && !File.directory?(full_path)
+    end
+
+    def redirect_path
+      "#{@assets_prefix}/#{path_from_manifest}"
+    end
+
+    def path_from_manifest
+      raise NotImplementedError, "ovverride in subclasses"
+    end
+
+    def computed_assets_pipeline
+      @computed_assets_pipeline ||= @assets_pipeline.respond_to?(:call) ? @assets_pipeline.call : @assets_pipeline
+    end
+
+    def logical_path
+      strip_assets_prefix(@request.path).sub(/-[a-z0-9]{7,128}\./i, ".")
+    end
+
+    def strip_assets_prefix(path)
+      path&.sub(/\/?^#{@assets_prefix}\//, "")
+    end
+
+    def redirect_to_resolved_version_from_manifest
+      url = URI(@request.url)
+      url.path = redirect_path
+
+      headers = { "Location"      => url.to_s,
+                  "Content-Type"  => Rack::Mime.mime_type(File.extname(path_from_manifest)),
+                  "Cache-Control" => "no-cache; max-age=0" }
+
+      log "assets-redirect: Redirecting to #{redirect_path}"
+      [ 302, headers, [ redirect_message(url) ] ]
+    end
+
+    def redirect_message(location)
+      %[Redirecting to <a href="#{location}">#{location}</a>]
+    end
+
+    def log(msg)
+      @logger&.info(msg)
+    end
+end

data/lib/assets/redirect/propshaft.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+class Assets::Redirect::Propshaft < Assets::Redirect::Base
+  private
+    def path_from_manifest
+      # Propshaft include /assets to the resolved logical_path
+      strip_assets_prefix computed_assets_pipeline.resolver.resolve(logical_path)
+    end
+end

data/lib/assets/redirect/railtie.rb

@@ -0,0 +1,23 @@
+if defined?(Rails)
+  class Assets::Redirect::Railtie < ::Rails::Railtie
+    initializer "insert_assets_redirect_middleware" do |app|
+      if !app.config.assets.compile && app.config.assets.digest
+        middleware_class = \
+          if defined?(Sprockets::Base)
+            Assets::Redirect::Sprockets
+          elsif defined?(Propshaft)
+            Assets::Redirect::Propshaft
+          else
+            raise "assets-redirect: Only Sprockets and Propshaft are supported."
+          end
+
+        app.middleware.insert 0,
+          middleware_class,
+          -> { Rails.application.assets },
+          public_path: app.config.paths["public"].first,
+          assets_prefix: app.config.assets.prefix,
+          logger: Rails.logger
+      end
+    end
+  end
+end

data/lib/assets/redirect/sprockets.rb

@@ -0,0 +1,8 @@
+require_relative "base"
+
+class Assets::Redirect::Sprockets < Assets::Redirect::Base
+  private
+    def path_from_manifest
+      computed_assets_pipeline[ logical_path ]&.digest_path
+    end
+end

data/lib/assets/redirect/version.rb

@@ -0,0 +1,5 @@
+module Assets
+  module Redirect
+    VERSION = "0.1.0"
+  end
+end

data/lib/assets/redirect.rb

@@ -0,0 +1,9 @@
+require_relative "redirect/version"
+require_relative "redirect/sprockets"
+require_relative "redirect/propshaft"
+require_relative "redirect/railtie"
+
+module Assets::Redirect
+  @enabled = true
+  class << self; attr_accessor :enabled end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: assets-redirect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacopo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Rack middleware which will redirect every 404 assets requests
+      to the current digested version for the logical_path referenced in the manifest.
+      Useful to automate redirects from deleted assets when the old link can't be updated, e.g. emails.
+email:
+- jacopo@37signals.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets-redirect.gemspec
+- lib/assets/redirect.rb
+- lib/assets/redirect/base.rb
+- lib/assets/redirect/propshaft.rb
+- lib/assets/redirect/railtie.rb
+- lib/assets/redirect/sprockets.rb
+- lib/assets/redirect/version.rb
+homepage: https://github.com/basecamp/assets_redirect
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/basecamp/assets_redirect
+  source_code_uri: https://github.com/basecamp/assets_redirect
+  changelog_uri: https://github.com/basecamp/assets_redirect/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Redirect assets not found to the manifest-digested version for the logical_path.
+test_files: []