pghero_assets 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e83b5fb670c4e164b6925cfb13dce15b5de832e26dcd287691956580d2383ae9
+  data.tar.gz: b549f82a4542a874aa902c1f3e409994bfa9471c43bc24c419d655ee1038a017
+SHA512:
+  metadata.gz: ac560b792ac554dce1e7a74aa5be580829b65e971b1ac389b462ebc3d8d812eb44f415a86f18765930ea516a963f614d5ee77c52ea45339286de1fdf8a9d1ad7
+  data.tar.gz: c9651cf1e98b1d8b4feaa5e56993a583934057e91989115fa9f28c321ce40b540ed1ed864a60e3a2f7b173677494f8a7d1622c131a562c1a77d1bf701b2ae194

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-09-23
+
+- Initial release

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,24 @@
+[![Gem Version](https://badge.fury.io/rb/pghero_assets.svg)](http://badge.fury.io/rb/pghero_assets)
+[![Build Status](https://github.com/jaynetics/pghero_assets/actions/workflows/main.yml/badge.svg)](https://github.com/jaynetics/pghero_assets/actions)
+
+# PgHeroAssets
+
+This gem is for you if you want to be able to run [PgHero](https://github.com/pghero/pghero) without the asset pipeline or in Rails' api mode.
+
+It serves all required PgHero assets from a custom middleware and disables the api mode check.
+
+## Caveats
+
+- This might break with PgHero updates, though I don't consider it likely so its not version-locked yet.
+
+## Installation / usage
+
+Add `pghero_assets` to your Gemfile.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jaynetics/pghero_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,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir['tasks/**/*.rake'].each { |file| load(file) }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:generate_spec_app, :spec]

data/lib/pghero_assets/asset_root.rb

@@ -0,0 +1,5 @@
+module PgHeroAssets
+  def self.asset_root
+    Rails.root.join("tmp/pghero_assets/#{PgHero::VERSION}/#{PgHeroAssets::VERSION}")
+  end
+end

data/lib/pghero_assets/disable_api_check.rb

@@ -0,0 +1,8 @@
+module PgHeroAssets
+  def self.disable_pghero_api_check
+    require 'pghero'
+    require PgHero::Engine.root.join('app/helpers/pg_hero/home_helper')
+    require PgHero::Engine.root.join('app/controllers/pg_hero/home_controller')
+    PgHero::HomeController.define_method(:check_api) {}
+  end
+end

data/lib/pghero_assets/middleware.rb

@@ -0,0 +1,36 @@
+require 'rack/mime'
+
+module PgHeroAssets
+  # Catches pghero asset requests and serves them from the gem.
+  class Middleware
+    def initialize(app, *)
+      @app = app
+      @regexp = %r{\A/(?:javascripts|images|stylesheets)/pghero}
+    end
+
+    def call(env)
+      @regexp.match?(env[Rack::PATH_INFO]) &&
+        serve(env[Rack::PATH_INFO]) ||
+        @app.call(env)
+    end
+
+    def serve(path)
+      PgHeroAssets.prepare_assets
+      send_data(path)
+    rescue StandardError => e
+      Rails.logger.warn("PgHeroAssets::Middleware: #{e.class} #{e.message}")
+      nil
+    end
+
+    def send_data(path)
+      prepared_asset_path = PgHeroAssets.asset_root.join(path.sub(%r{^/}, ''))
+      data = File.read(prepared_asset_path)
+      headers = {
+        'cache-control'  => 'public, max-age=86400',
+        'content-length' => data.bytesize.to_s,
+        'content-type'   => Rack::Mime.mime_type(File.extname(path)),
+      }
+      [200, headers, [data]]
+    end
+  end
+end

data/lib/pghero_assets/prepare_assets.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+# prepares assets for PgHero lazily / on demand
+# based on discussion in https://github.com/ankane/pghero/pull/421
+module PgHeroAssets
+  PREPARE_ASSETS_MUTEX = Mutex.new
+
+  def self.prepare_assets
+    root_dir = PgHeroAssets.asset_root
+    PREPARE_ASSETS_MUTEX.synchronize do
+      root_dir.exist? ? return : FileUtils.mkdir_p(root_dir)
+    end
+
+    # Create application.js file for PgHero
+    asset_src = PgHero::Engine.root.join('app/assets')
+    js_file = root_dir.join('javascripts/pghero/application.js')
+    js_file.dirname.mkpath
+    files = Dir[asset_src.join('javascripts/**/*.js')].sort_by { _1.index(/application\.\w+\z/) || 0 }
+    File.open(js_file, 'w') { |main| files.each { |f| main << File.read(f) << "\n\n" } }
+
+    # Create application.css file for PgHero
+    css_file = root_dir.join('stylesheets/pghero/application.css')
+    css_file.dirname.mkpath
+    files = Dir[asset_src.join('stylesheets/**/*.css')].sort_by { _1.index(/application\.\w+\z/) || 0 }
+    File.open(css_file, 'w') { |main| files.each { |f| main << File.read(f) << "\n\n" } }
+
+    # Symlink to PgHero's images
+    FileUtils.ln_sf asset_src.join('images'), root_dir.join('images')
+  end
+end

data/lib/pghero_assets/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+require 'rails/engine/railties'
+
+module PgHeroAssets
+  class Railtie < ::Rails::Railtie
+    initializer 'pghero_assets.initializer' do |app|
+      PgHeroAssets.disable_pghero_api_check
+      app.middleware.insert(0, PgHeroAssets::Middleware)
+    end
+  end
+end

data/lib/pghero_assets/version.rb

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

data/lib/pghero_assets.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'pghero_assets', '*.rb')].each { |f| require f }

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: pghero_assets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Janosch Müller
+bindir: bin
+cert_chain: []
+date: 2024-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pghero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+email:
+- janosch84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pghero_assets.rb
+- lib/pghero_assets/asset_root.rb
+- lib/pghero_assets/disable_api_check.rb
+- lib/pghero_assets/middleware.rb
+- lib/pghero_assets/prepare_assets.rb
+- lib/pghero_assets/railtie.rb
+- lib/pghero_assets/version.rb
+homepage: https://github.com/jaynetics/pghero_assets
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaynetics/pghero_assets
+  source_code_uri: https://github.com/jaynetics/pghero_assets
+  changelog_uri: https://github.com/jaynetics/pghero_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 PgHero without asset pipeline.
+test_files: []