rails-assets-manifest 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74ada8a7abade960a8bbb990ef4bcf5b9f042e09024d1de5b39cbf1a2ccf1ec
-  data.tar.gz: d45b22c32fe3981382d47c9680e3102e48c2d30211c24a1eac1e7baab8cd24a6
+  metadata.gz: 36c667b7c457d214df43ac5f4c9e54f5baac237c0f9a61ac3eeedc6d1d458ab9
+  data.tar.gz: 1a7c777200e2087c05be7759091007857861261a5d00912256f35f5ff98d2a6c
 SHA512:
-  metadata.gz: d993c84c80510ab83df09c15838c8a07fc909d8d90b7891f340fb7501319bbac75d934d8f5fbfc52864d62ed47c560da9bbd93687b2d9dc5ce3d8d6abac94ec1
-  data.tar.gz: a6543487813204d1061a4db57edaaa3fe721c90b51f71ca787d2d858873719491a71e159ffa1618cb2edd5e579e77eefeb16771aff81313cdec9d66e2f36c421
+  metadata.gz: 6117f1e88a27ba3dd5ce5edc85a21952e91de97abd3d72bc9b37a1527aa8352a7170371acf2bec29a268a8aced6b3519af4d9e4409848f041c9d950090ca38cb
+  data.tar.gz: 2f38b29bf90d82cd5a4a8e039a2fef2bd536326d1fe81eb3ee9e04d5b2637f4f3114a5deeb75ce6a6aec332cdf7874056033d4dde53d8bea7bc5d053774dbc6a

data/.github/workflows/test.yml

@@ -3,32 +3,40 @@ name: test
 on: push
 jobs:
   rspec:
-    name: "Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}"
+    name: "ruby:${{ matrix.ruby }} rails:${{ matrix.rails }} ${{ matrix.variant }}"
     runs-on: ubuntu-20.04
 
     strategy:
       fail-fast: false
       matrix:
         ruby:
+          - "3.1"
           - "3.0"
           - "2.7"
-          - "2.6"
-          - "2.5"
         rails:
+          - "7.0"
           - "6.1"
           - "6.0"
           - "5.2"
-          - master
+        variant:
+          - ""
+          - "no-sprockets"
         exclude:
+          - ruby: "3.1"
+            rails: "6.1"
+          - ruby: "3.1"
+            rails: "6.0"
+          - ruby: "3.1"
+            rails: "5.2"
           - ruby: "3.0"
             rails: "5.2"
-          - ruby: "2.6"
-            rails: master
-          - ruby: "2.5"
-            rails: master
 
     env:
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.gemfile
+      BUNDLE_WITHOUT: development
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+      VARIANT: ${{ matrix.variant }}
 
     steps:
       - uses: actions/checkout@master
@@ -36,10 +44,6 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-        env:
-          BUNDLE_WITHOUT: development
-          BUNDLE_JOBS: 4
-          BUNDLE_RETRY: 3
 
       - run: bundle exec rspec --color
 
@@ -47,15 +51,16 @@ jobs:
     name: rubocop
     runs-on: ubuntu-20.04
 
+    env:
+      BUNDLE_WITHOUT: development
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+
     steps:
       - uses: actions/checkout@master
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.1
           bundler-cache: true
-        env:
-          BUNDLE_WITHOUT: development
-          BUNDLE_JOBS: 4
-          BUNDLE_RETRY: 3
 
       - run: bundle exec rubocop --parallel --fail-level E

data/.rubocop.yml

@@ -1,48 +1,7 @@
+inherit_gem:
+  rubocop-config: default.yml
+
 AllCops:
-  Include:
-    - '**/*.rb'
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
+  SuggestExtensions: False
   NewCops: enable
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-  IndentOneStep: true
-  SupportedStyles:
-    - case
-    - end
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: no_space
-  SpaceBeforeBlockParameters: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Metrics/LineLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/TrivialAccessors:
-  AllowPredicates: true

data/Appraisals

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+appraise 'rails-7.0' do
+  gem 'rails', '~> 7.0.0'
+end
+
 appraise 'rails-6.1' do
   gem 'rails', '~> 6.1.0'
 end
@@ -11,7 +15,3 @@ end
 appraise 'rails-5.2' do
   gem 'rails', '~> 5.2.0'
 end
-
-appraise 'rails-master' do
-  gem 'rails', github: 'rails/rails'
-end

data/CHANGELOG.md

@@ -17,6 +17,21 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch
 ### Breaks
 
 
+## 3.0.0 - (2022-02-08)
+---
+
+### New
+* Test integration with a Rails application without sprockets
+* Add support for Rails 7.0 and Ruby 3.1
+
+
+### Breaks
+* Default to `public/assets/assets-manifest.json` manifest path matching new default from `webpack-assets-manifest` plugin
+* Only support single manifest source file and error if not found (#9)
+* Use `config.assets_manifest` as the config base to avoid conflicts in apps without sprockets (#9)
+* Drop support for Ruby <2.7
+
+
 ## 2.1.2 - (2021-09-05)
 ---
 

data/Gemfile

@@ -5,14 +5,17 @@ source 'https://rubygems.org'
 # Load gem's dependencies
 gemspec
 
-gem 'rails'
+gem 'net-smtp', require: false # not bundled in Ruby 3.1+
+gem 'rails', require: false
+gem 'sprockets-rails', require: false # not included by default in Rails 7+
+gem 'sqlite3', require: false
 
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-rails', '~> 5.0'
-gem 'rubocop', '~> 1.14'
 
 gem 'pry'
+gem 'rubocop-config', github: 'jgraichen/rubocop-config', ref: 'v7', require: false
 
 group :development do
   gem 'appraisal'

data/README.md

@@ -1,8 +1,11 @@
 # Rails::Assets::Manifest
 
-Load all assets in your rails application from a `manifest.json`, e.g. generated by [webpack-assets-manifest](https://github.com/webdeveric/webpack-assets-manifest).
+[![Gem Version](https://img.shields.io/gem/v/rails-assets-manifest?logo=ruby)](https://rubygems.org/gems/rails-assets-manifest)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jgraichen/rails-assets-manifest/test?logo=github)](https://github.com/jgraichen/rails-assets-manifest/actions)
 
-This gem does not make any assumption on which tool to use to make your assets not how to configure or invoke it. It only requires a manifest JSON. The Manifest must either be a simple string map or must map to objects having a `'src'` attribute. Subresource integrity is supported too:
+Load all assets in your Rails application from a `manifest.json`, e.g. generated by [webpack-assets-manifest](https://github.com/webdeveric/webpack-assets-manifest).
+
+This gem does not make any assumption on which tool to use to make your assets not how to configure or invoke it. It only requires a manifest JSON. The manifest must either be a simple string map or must map to objects having a `'src'` attribute. Sub-resource integrity is supported too:
 
 ```json
 {
@@ -41,22 +44,39 @@ gem 'rails-assets-manifest'
 
 ## Usage
 
-The manifest path can be configured e.g. in an environment:
+The manifest path can be configured e.g. in an `environments/*.rb` file:
 
 ```ruby
-  config.assets.manifests = %w(public/.asset-manifest.json)
+  config.assets_manifest.path = "public/.asset-manifest.json"
 ```
 
-If `config.cache_classes` is set to `true` the manifest file be loaded once on boot.
+If `config.cache_classes` is set to `true` the manifest file be loaded once on boot. Assets included with `integrity: true` will raise an error if the integrity option is missing in the manifest.
 
-Assets included with `integrity: true` will raise an error if the integrity option is missing in the manifest.
+## Webpack Assets Manifest Example
 
-Multiple manifests can be loaded by specifying multiple files. Glob patterns are supported:
+The following snippet provides an example configuration for the[webpack-assets-manifest](https://github.com/webdeveric/webpack-assets-manifest) plugin to generating a compatible assets manifest file.
 
-```ruby
-  config.assets.manifests = %w(public/.manifest.*.json lib/manifest.json)
+```ts
+new WebpackAssetsManifest({
+  integrity: true,
+  integrityHashes: ["sha384"],
+  writeToDisk: true,
+  entrypoints: false,
+  entrypointsUseAssets: true,
+  publicPath,
+  // Ignore a source maps and compressed files.
+  customize(e) {
+    if (e.key.endsWith(".map") || e.key.endsWith(".gz")) {
+      return false;
+    }
+
+    return e;
+  },
+})
 ```
 
+Specifying `writeToDisk: true` allows running the `webpack-dev-server` as proxy to the Rails application, and still generate correct assets links in Rails code. `rails-assets-manifest` defaults to using `public/assets/assets-manifest.json` as the manifest path.
+
 ## TODO
 
 * Override/Join with `asset_host` URL?
@@ -72,7 +92,7 @@ Multiple manifests can be loaded by specifying multiple files. Glob patterns are
 
 ## MIT License
 
-Copyright (c) 2018 Jan Graichen
+Copyright (c) 2018-2022 Jan Graichen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/gemfiles/rails_5.2.gemfile

@@ -3,7 +3,10 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.2.0"
-gem "rake", "~> 12.0"
+gem "sprockets-rails", require: false
+gem "net-smtp", require: false
+gem "sqlite3", require: false
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rspec-rails", "~> 5.0"
 gem "rubocop", "~> 1.14"

data/gemfiles/rails_6.0.gemfile

@@ -3,7 +3,10 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 6.0.0"
-gem "rake", "~> 12.0"
+gem "sprockets-rails", require: false
+gem "net-smtp", require: false
+gem "sqlite3", require: false
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rspec-rails", "~> 5.0"
 gem "rubocop", "~> 1.14"

data/gemfiles/rails_6.1.gemfile

@@ -3,7 +3,10 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 6.1.0"
-gem "rake", "~> 12.0"
+gem "sprockets-rails", require: false
+gem "net-smtp", require: false
+gem "sqlite3", require: false
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rspec-rails", "~> 5.0"
 gem "rubocop", "~> 1.14"

data/gemfiles/{rails_master.gemfile → rails_7.0.gemfile}

@@ -2,8 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "rails", github: "rails/rails"
-gem "rake", "~> 12.0"
+gem "rails", "~> 7.0.0"
+gem "sprockets-rails", require: false
+gem "net-smtp", require: false
+gem "sqlite3", require: false
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rspec-rails", "~> 5.0"
 gem "rubocop", "~> 1.14"

data/lib/rails/assets/manifest/helper.rb

@@ -67,10 +67,6 @@ module Rails::Assets::Manifest
       respond_to?(:request) && request && (request.local? || request.ssl?)
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Style/IfUnlessModifier
     def with_integrity(sources, required, type, **kwargs)
       sources.map do |source|
         path = path_with_extname(source, type: type, **kwargs)
@@ -103,10 +99,6 @@ module Rails::Assets::Manifest
         yield(source, **kwargs)
       end.join.html_safe
     end
-    # rubocop:enable Style/IfUnlessModifier
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/AbcSize
 
     def path_with_extname(path, options)
       path = path.to_s

data/lib/rails/assets/manifest/manifest.rb

@@ -4,8 +4,8 @@ module Rails::Assets::Manifest
   class Manifest
     attr_reader :path
 
-    def initialize(files:, cache: true)
-      @files = Array(files).flatten.each(&:freeze).freeze
+    def initialize(path, cache: true)
+      @path = Rails.root.join(path).to_s.freeze
       @cache = cache
     end
 
@@ -20,7 +20,7 @@ module Rails::Assets::Manifest
     def lookup!(name)
       lookup(name) || begin
         raise EntryMissing.new <<~ERROR
-          Can't find #{name} in #{path}. Your manifests contain:
+          Can't find #{name} in #{path}. Your manifest contain:
           #{JSON.pretty_generate(data.keys)}
         ERROR
       end
@@ -50,13 +50,9 @@ module Rails::Assets::Manifest
       end
     end
 
-    def files
-      @files.map {|path| Dir.glob(path) }.flatten
-    end
-
     def load
-      files.each_with_object({}) do |file, entries|
-        JSON.parse(File.read(file)).each_pair do |key, entry|
+      {}.tap do |entries|
+        JSON.parse(File.read(path)).each_pair do |key, entry|
           if entry.is_a?(String)
             entries[key] = Entry.new(entry, nil)
           elsif entry.is_a?(Hash) && entry.key?('src')

data/lib/rails/assets/manifest/railtie.rb

@@ -4,19 +4,14 @@ module Rails
   module Assets
     module Manifest
       class Railtie < ::Rails::Railtie
-        # If this plugin is used with sprockets this option
-        # already exists and must not be overridden. Otherwise
-        # all sprockets default options are removed breaking
-        # sprockets.
-        config.assets = ::ActiveSupport::OrderedOptions.new unless config.respond_to?(:assets)
+        config.assets_manifest = ::ActiveSupport::OrderedOptions.new
 
-        # Path where the manifest files are loaded from.
-        config.assets.manifests = ['public/assets/manifest.json']
+        # Path where the manifest file is loaded from.
+        config.assets_manifest.path = 'public/assets/assets-manifest.json'
 
-        # If set to true missing assets will not raise an
-        # exception but are passed through to sprockets
-        # or rails own asset methods.
-        config.assets.passthrough = false
+        # If set to true missing assets will not raise an exception but are
+        # passed through to sprockets or rails own asset methods.
+        config.assets_manifest.passthrough = false
 
         config.after_initialize do |_|
           ActiveSupport.on_load(:action_view) do

data/lib/rails/assets/manifest/version.rb

@@ -4,12 +4,12 @@ module Rails
   module Assets
     module Manifest
       module VERSION
-        MAJOR = 2
-        MINOR = 1
-        PATCH = 2
+        MAJOR = 3
+        MINOR = 0
+        PATCH = 0
         STAGE = nil
 
-        STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+        STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.')
 
         def self.to_s
           STRING

data/lib/rails/assets/manifest.rb

@@ -29,9 +29,10 @@ module Rails
           @instance = begin
             config = Rails.application.config
 
-            Manifest.new \
-              files: config.assets.manifests.map {|path| Rails.root.join(path) },
-              cache: config.cache_classes
+            Manifest.new(
+              config.assets_manifest.path,
+              cache: config.cache_classes,
+            )
           end
         end
 
@@ -42,7 +43,7 @@ module Rails
         end
 
         def passthrough?
-          Rails.application.config.assets.passthrough
+          Rails.application.config.assets_manifest.passthrough
         end
       end
     end

data/rails-assets-manifest.gemspec

@@ -14,9 +14,10 @@ Gem::Specification.new do |spec|
   spec.description   = 'Load all rails assets from an external manifest.'
   spec.homepage      = 'https://github.com/jgraichen/rails-assets-manifest'
 
-  spec.metadata['homepage_uri']    = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/jgraichen/rails-assets-manifest'
-  spec.metadata['changelog_uri']   = 'https://github.com/jgraichen/rails-assets-manifest/blob/master/CHANGELOG.md'
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = 'https://github.com/jgraichen/rails-assets-manifest'
+  spec.metadata['changelog_uri']         = 'https://github.com/jgraichen/rails-assets-manifest/blob/master/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -28,6 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.7.0'
+
   spec.add_dependency 'activesupport', '> 4.2'
   spec.add_dependency 'railties', '> 4.2'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-assets-manifest
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,7 +75,7 @@ files:
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
-- gemfiles/rails_master.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/rails/assets/manifest.rb
 - lib/rails/assets/manifest/helper.rb
 - lib/rails/assets/manifest/manifest.rb
@@ -89,6 +89,7 @@ metadata:
   homepage_uri: https://github.com/jgraichen/rails-assets-manifest
   source_code_uri: https://github.com/jgraichen/rails-assets-manifest
   changelog_uri: https://github.com/jgraichen/rails-assets-manifest/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -97,14 +98,14 @@ 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.2.22
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Load all rails assets from an external manifest.