activeadmin_assets 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d923dc66ce84a31f0b8d63fa80bfecca10bf0ea68b16b47aff3b986ab891a94
+  data.tar.gz: 78d631e9c607b7abd459baf10ec67365952bf4ccf06337511cc84974b064b02a
+SHA512:
+  metadata.gz: 6d682e3a5ea3144dbc32845fb97b990168e8dbccb20b16a564825f90bfccad04e6a208ccd2fc9650de3570aae417f4374205ce113779d21ac5cd4faf96405f54
+  data.tar.gz: 82a8bd5f4b4ff16ffb1aeafc33479a3e628e17d9f0bb81a27864f8fe7632cb7ce10d2830ecef4c69242b1073bb84dad0280058268a58761e8544ff260bb14e58

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [1.0.1] - 2024-07-14
+
+- Actually include assets in gem 😅
+
+## [1.0.0] - 2024-07-14
+
+- Initial release (yanked)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Janosch Müller
+
+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,39 @@
+[![Gem Version](https://badge.fury.io/rb/activeadmin_assets.svg)](http://badge.fury.io/rb/activeadmin_assets)
+[![Build Status](https://github.com/jaynetics/activeadmin_assets/actions/workflows/main.yml/badge.svg)](https://github.com/jaynetics/activeadmin_assets/actions)
+[![Coverage](https://codecov.io/github/jaynetics/activeadmin_assets/graph/badge.svg?token=7fCHVrCeFv)](https://codecov.io/github/jaynetics/activeadmin_assets)
+
+# ActiveAdminAssets
+
+This gem is for you if you want to be able to run [ActiveAdmin](https://github.com/activeadmin/activeadmin) v4+ without any asset setup, e.g.:
+
+- no `cssbundling-rails` or `tailwindcss-rails`
+- no `sprockets` or `propshaft`
+- no `assets:precompile` or similar build steps
+
+Like the asset gems of old, it includes static copies of all required assets and injects them automatically.
+
+## Caveats
+
+- This will prevent you from customizing ActiveAdmin's tailwind config, making theming more hacky.
+- This will prevent you from using tailwind classes that are not used by ActiveAdmin itself.
+- This might break with ActiveAdmin updates, though I don't consider it likely so its not version-locked yet.
+
+## Installation
+
+Add `activeadmin_assets` to your Gemfile.
+
+## Usage
+
+That's it 😁. If you want, you can configure the path to serve static assets from:
+
+```ruby
+ActiveAdminAssets.path = '/x/admin-assets' # default: '/active_admin_assets'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jaynetics/activeadmin_assets.
+
+## 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,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir['tasks/**/*.rake'].each { |file| load(file) }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:css, :js, :generate_spec_app, :spec]
+
+# ensure fresh assets are included when packaging the gem
+task build: %i[css js]

data/lib/activeadmin_assets/compatibility_check.rb

@@ -0,0 +1,16 @@
+module ActiveAdminAssets
+  # Checks if custom/manual asset provisioning is in place.
+  # To be more thorough, this could also check for usage of new tailwind classes
+  # in any admin controllers or partials, though that might be a bit expensive.
+  module CompatibilityCheck
+    def self.call(app)
+      return unless %w[development test].include?(ENV['RAILS_ENV'])
+
+      customizations = Dir[app.root.join('app/assets/{builds,stylesheets}/active_admin.*')]
+      customizations.any? and warn ""\
+        "The activeadmin_assets gem is not compatible with providing core "\
+        "activeadmin assets yourself. Please remove either the gem "\
+        "or your custom files: #{customizations}"
+    end
+  end
+end

data/lib/activeadmin_assets/middleware.rb

@@ -0,0 +1,33 @@
+module ActiveAdminAssets
+  # Catches active admin asset requests and serves them from the gem.
+  class Middleware
+    def initialize(app, *)
+      @app = app
+      @regexp = /\A#{ActiveAdminAssets.path}(.+)/
+    end
+
+    def call(env)
+      serve(env[Rack::PATH_INFO]) || @app.call(env)
+    end
+
+    def serve(path)
+      return unless asset_path = path[@regexp, 1]
+
+      static_path = File.join(__dir__, 'assets', "#{asset_path}.gz")
+      send_data(static_path)
+    end
+
+    # This could be made more efficient with sendfile,
+    # perhaps after checking config.action_dispatch.x_sendfile_header
+    def send_data(path)
+      data = File.read(path)
+      headers = {
+        'cache-control'    => 'public, max-age=86400',
+        'content-encoding' => 'gzip',
+        'content-length'   => data.bytesize.to_s,
+        'content-type'     => path['.css'] ? 'text/css' : 'text/javascript',
+      }
+      [200, headers, [data]]
+    end
+  end
+end

data/lib/activeadmin_assets/path.rb

@@ -0,0 +1,12 @@
+require 'active_admin/version'
+
+module ActiveAdminAssets
+  # Add VERSIONs to invalidate browser caches on gem updates.
+  def self.path
+    "#{@path || '/active_admin_assets'}/#{ActiveAdmin::VERSION}/#{VERSION}/"
+  end
+
+  def self.path=(arg)
+    @path = arg && !arg.empty? && "/#{arg.gsub(%r{\A/|/\z}, '')}"
+  end
+end

data/lib/activeadmin_assets/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+require 'rails/engine/railties'
+
+module ActiveAdminAssets
+  class Railtie < ::Rails::Railtie
+    initializer 'activeadmin_assets.initializer' do |app|
+      ActiveAdminAssets::CompatibilityCheck.call(app)
+      app.middleware.insert(0, ActiveAdminAssets::Middleware)
+    end
+
+    ActiveSupport.on_load(:active_admin_controller) do
+      ActiveAdmin::LayoutHelper.prepend(ActiveAdminAssets::URLPatch)
+    end
+  end
+end

data/lib/activeadmin_assets/url_patch.rb

@@ -0,0 +1,23 @@
+module ActiveAdminAssets
+  # Modify asset URLs for active admins assets:
+  # - prepend special path (includes VERSIONs to bust caches on gem updates)
+  # - prevent sprockets or propshaft from adding digests to the asset URLs
+  module URLPatch
+    def stylesheet_link_tag(path, ...)
+      return super unless active_admin_asset?(path)
+
+      tag.link(rel: :stylesheet, href: path_to_asset("#{path.chomp('.css')}.css"))
+    end
+
+    # this is called by importmap-rails, too
+    def path_to_asset(path, ...)
+      return super unless active_admin_asset?(path)
+
+      path.sub(%r{\A/?}, ActiveAdminAssets.path)
+    end
+
+    def active_admin_asset?(path)
+      %r{\A/?(?:active_admin|flowbite|rails_ujs_esm)(?:[/.]|\z)}.match?(path)
+    end
+  end
+end

data/lib/activeadmin_assets/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveAdminAssets
+  VERSION = '1.0.1'
+end

data/lib/activeadmin_assets.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "activeadmin_assets", "*.rb")].each { |f| require f }

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_assets
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Janosch Müller
+bindir: bin
+cert_chain: []
+date: 2024-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+email:
+- janosch84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activeadmin_assets.rb
+- lib/activeadmin_assets/assets/active_admin.css.gz
+- lib/activeadmin_assets/assets/active_admin.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/batch_actions.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/dark_mode_toggle.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/filters.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/has_many.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/main_menu.js.gz
+- lib/activeadmin_assets/assets/active_admin/features/per_page.js.gz
+- lib/activeadmin_assets/assets/active_admin/utils/dom.js.gz
+- lib/activeadmin_assets/assets/flowbite.js.gz
+- lib/activeadmin_assets/assets/rails_ujs_esm.js.gz
+- lib/activeadmin_assets/compatibility_check.rb
+- lib/activeadmin_assets/middleware.rb
+- lib/activeadmin_assets/path.rb
+- lib/activeadmin_assets/railtie.rb
+- lib/activeadmin_assets/url_patch.rb
+- lib/activeadmin_assets/version.rb
+homepage: https://github.com/jaynetics/activeadmin_assets
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaynetics/activeadmin_assets
+  source_code_uri: https://github.com/jaynetics/activeadmin_assets
+  changelog_uri: https://github.com/jaynetics/activeadmin_assets/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Run ActiveAdmin v4 without asset setup.
+test_files: []