precompiled_assets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8def5c63790a7b16733d25ec1875e7fb294dca734ef389cc26f30b093b41c39
+  data.tar.gz: a3db5b16a4dd0fbd55d3e8d0f907de84b3db35269c5c005ee97891cb612d798a
+SHA512:
+  metadata.gz: a794f9316533f5422397e3ea950e1529cef6c64326bcec41df60ef122464833ca77e49222fe0c1ce9f7e21a963ddf8ba9007e2a774ffd8f5717187acf37b2a4c
+  data.tar.gz: cc1743713e3a27b962f0e4910cc5f67eec72ef00345b6d07da164d08748356382603900d3ee2d058fab02bb9411bcf80b43727408160eab60854142aa741dbd5

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  makandra-rubocop:
+    - config/default.yml
+    - config/ext/rails.yml
+    - config/ext/rspec.yml
+
+AllCops:
+  TargetRubyVersion: 2.6

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-27
+
+- First public release.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in precompiled_assets.gemspec
+gemspec
+
+gem 'rake'
+gem 'rubocop'
+gem 'makandra-rubocop'

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    precompiled_assets (0.1.0)
+      railties (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    erubi (1.10.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    makandra-rubocop (9.1.0)
+      rubocop (~> 1.25.0)
+      rubocop-rails (~> 2.11.3)
+      rubocop-rspec (~> 2.4.0)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-rails (2.11.3)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  makandra-rubocop
+  precompiled_assets!
+  rake
+  rubocop
+
+BUNDLED WITH
+   2.3.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Arne Hartherz
+
+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,65 @@
+# PrecompiledAssets
+
+Serve assets without any asset processing in Rails. 
+
+The gem is intended for applications where assets are digested externally, e.g. via esbuild.
+
+Our only requirements are
+- a manifest file which needs to be generated during the build process,
+- that the manifest lives somewhere inside `public/` (you are free to configure an `asset_host`, won't affect the gem),
+- and a matching Rails configuration setting.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add precompiled_assets
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install precompiled_assets
+
+## Usage
+
+In your `config/application.rb`, configure an `asset_path` which should be in your `public/` directory:
+
+```ruby
+config.asset_path = '/assets'
+```
+
+Inside that path, a `manifest.json` is expected to exist which resolves your undigested input names to digested output paths.
+If your manifest has a different filename, you may set `config.asset_manifest_filename`.
+
+A manifest file can look like this:
+
+```json
+{
+  "application.js": "application-HP2LS2UH.js",
+  "application.css": "application-BWAZLURC.css",
+  "images/example.png": "images/example-5N2N2WJM.png"
+}
+```
+
+Once that is set up, `javascript_include_tag('application.js')` or `image_path('example.png')` will resolve to their digested filenames and paths.
+
+In the `development` Rails environment, the gem detects changes to the manifest and reloads the manifest automatically.
+Hence, your development experience should be similar to other stacks, like with Propshaft or esbuild: You change assets, the manifest changes, Rails will then resolve to the updated asset paths. 🎉
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+I am very eager to keep this gem lightweight and on topic.
+If you are unsure whether a change would make it into the gem, please create an issue and discuss first.
+
+
+## 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 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/precompiled_assets/error.rb

@@ -0,0 +1,3 @@
+module PrecompiledAssets
+  class Error < StandardError; end
+end

data/lib/precompiled_assets/helper.rb

@@ -0,0 +1,18 @@
+module PrecompiledAssets
+  module Helper
+
+    ASSET_DIRECTORIES = ActionView::Helpers::AssetUrlHelper::ASSET_PUBLIC_DIRECTORIES.except(:javascript, :stylesheet).freeze
+
+    def asset_resolver
+      Thread.current['PrecompiledAssets::Helper#asset_resolver'] ||= Resolver.new
+    end
+
+    def compute_asset_path(path, options = {})
+      directory = ASSET_DIRECTORIES[options[:type]]
+      path_with_directory = File.join(*directory, path)
+
+      asset_resolver.resolve(path_with_directory.delete_prefix('/'))
+    end
+
+  end
+end

data/lib/precompiled_assets/local_path.rb

@@ -0,0 +1,12 @@
+module PrecompiledAssets
+  module LocalPath
+
+    module_function
+
+    def pathname
+      joinable_asset_path = Rails.configuration.asset_path.delete_prefix('/')
+      Rails.public_path.join(joinable_asset_path)
+    end
+
+  end
+end

data/lib/precompiled_assets/manifest.rb

@@ -0,0 +1,59 @@
+module PrecompiledAssets
+  class Manifest
+
+    DEFAULT_FILENAME = 'manifest.json'.freeze
+
+    class Error < PrecompiledAssets::Error; end
+    class NotFound < Error; end
+    class ParseError < Error; end
+
+    def resolve(path)
+      parsed_manifest[path]
+    end
+
+    def pathname
+      @pathname ||= LocalPath.pathname.join(filename)
+    end
+
+    def includes_digested_path?(path_or_pathname)
+      digested_paths.include?(path_or_pathname.to_s)
+    end
+
+    def expired?
+      # Not intended for use in production environments.
+      @mtime && @mtime != fetch_mtime
+    end
+
+    private
+
+    def filename
+      Rails.configuration.try(:asset_manifest_filename) || DEFAULT_FILENAME
+    end
+
+    def parsed_manifest
+      @parsed_manifest ||= parse_manifest
+    end
+
+    def parse_manifest
+      raise NotFound, "Manifest not found at #{pathname}" unless pathname.exist?
+
+      @mtime = fetch_mtime
+
+      json = pathname.read
+      JSON.parse(json)
+    rescue JSON::ParserError => error
+      raise ParseError, "Failed to parse manifest file: #{error.message}"
+    end
+
+    def fetch_mtime
+      File.mtime(pathname)
+    end
+
+    def digested_paths
+      @digested_paths ||= parsed_manifest
+        .values
+        .map { |asset_path| LocalPath.pathname.join(asset_path).to_s }
+    end
+
+  end
+end

data/lib/precompiled_assets/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails'
+
+module PrecompiledAssets
+  class Railtie < ::Rails::Railtie
+
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        require 'precompiled_assets/helper'
+        include PrecompiledAssets::Helper
+      end
+    end
+
+    rake_tasks do
+      load 'precompiled_assets/tasks/assets.rake'
+    end
+
+  end
+end

data/lib/precompiled_assets/resolver.rb

@@ -0,0 +1,29 @@
+module PrecompiledAssets
+  class Resolver
+
+    class Error < PrecompiledAssets::Error; end
+    class UnknownAsset < Error; end
+
+    def resolve(path)
+      reload_manifest if Rails.env.development? && manifest.expired?
+
+      digested_path = manifest.resolve(path.to_s)
+
+      if digested_path.present?
+        File.join(Rails.configuration.asset_path, digested_path)
+      else
+        raise UnknownAsset, "Could not find #{path.inspect} in manifest: #{manifest.inspect}"
+      end
+    end
+
+    def manifest
+      @manifest ||= Manifest.new
+    end
+
+    def reload_manifest
+      @manifest = nil
+      manifest
+    end
+
+  end
+end

data/lib/precompiled_assets/tasks/assets.rake

@@ -0,0 +1,17 @@
+require 'precompiled_assets/tasks'
+
+namespace :assets do
+  desc 'Empty task; assets should be compiled externally. Libraries like jsbundling-rails extend this task to do that.'
+  task precompile: :environment do # rubocop:disable Lint/EmptyBlock
+  end
+
+  desc 'Remove all assets inside the compiled asset path, but keep the directory itself'
+  task clobber: :environment do
+    PrecompiledAssets::Tasks.remove_all
+  end
+
+  desc 'Remove all assets not linked in the current manifest file'
+  task clean: :environment do
+    PrecompiledAssets::Tasks.remove_unused
+  end
+end

data/lib/precompiled_assets/tasks.rb

@@ -0,0 +1,36 @@
+module PrecompiledAssets
+  module Tasks
+
+    module_function
+
+    def remove_all
+      LocalPath.pathname.glob('*').each(&:rmtree)
+    end
+
+    def remove_unused
+      manifest = Manifest.new
+
+      pathnames = LocalPath.pathname.glob('**/*').sort
+
+      # Remove all files not listed in the manifest; also keep the manifest file itself.
+      pathnames.select(&:file?).each do |asset_pathname|
+        next if manifest.pathname == asset_pathname
+        next if manifest.includes_digested_path?(asset_pathname)
+        next if manifest.includes_digested_path?(asset_pathname.to_s.delete_suffix('.map'))
+
+        puts "Removing unused asset: #{asset_pathname}"
+        asset_pathname.delete
+      end
+
+      # After removing all unused files, remove any empty directories that remain.
+      # Iterating in reverse to start with most deeply nested directories first, allow to clean up empty branches.
+      pathnames.select(&:directory?).reverse_each do |directory|
+        next unless directory.empty?
+
+        puts "Removing empty directory: #{directory}"
+        directory.rmdir
+      end
+    end
+
+  end
+end

data/lib/precompiled_assets/version.rb

@@ -0,0 +1,3 @@
+module PrecompiledAssets
+  VERSION = '0.1.0'.freeze
+end

data/lib/precompiled_assets.rb

@@ -0,0 +1,6 @@
+require_relative 'precompiled_assets/error'
+require_relative 'precompiled_assets/local_path'
+require_relative 'precompiled_assets/manifest'
+require_relative 'precompiled_assets/resolver'
+
+require_relative 'precompiled_assets/railtie'

data/precompiled-assets.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require_relative 'lib/precompiled_assets/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'precompiled_assets'
+  spec.version = PrecompiledAssets::VERSION
+  spec.authors = ['Arne Hartherz']
+  spec.email = ['arne.hartherz@makandra.de']
+
+  spec.summary = 'Serve assets without any asset processing in Rails.'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/makandra/precompiled_assets'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => spec.homepage,
+    'changelog_uri' => "#{spec.homepage}/CHANGELOG.md",
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r(\Aexe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 6.0.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: precompiled_assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arne Hartherz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Serve assets without any asset processing in Rails.
+email:
+- arne.hartherz@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/precompiled_assets.rb
+- lib/precompiled_assets/error.rb
+- lib/precompiled_assets/helper.rb
+- lib/precompiled_assets/local_path.rb
+- lib/precompiled_assets/manifest.rb
+- lib/precompiled_assets/railtie.rb
+- lib/precompiled_assets/resolver.rb
+- lib/precompiled_assets/tasks.rb
+- lib/precompiled_assets/tasks/assets.rake
+- lib/precompiled_assets/version.rb
+- precompiled-assets.gemspec
+homepage: https://github.com/makandra/precompiled_assets
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/makandra/precompiled_assets
+  source_code_uri: https://github.com/makandra/precompiled_assets
+  changelog_uri: https://github.com/makandra/precompiled_assets/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Serve assets without any asset processing in Rails.
+test_files: []