parklife-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab76eceaed9401e81a67c48ee2ca9b55e7e90ce62b7bf31549e358d838c0106b
-  data.tar.gz: a230681dfc800e4700dc6218dde011dca3c93e6bebc2af500932d74814e3b249
+  metadata.gz: 61520daa959509f52822c34d3b946dca45f285fbdc1389a628389440f7d32c1e
+  data.tar.gz: 75df6c7770beb136684d4c312faf97b78c0aaf67705c4fa67785c600a4b35122
 SHA512:
-  metadata.gz: 1f9c7f1613d0888bc1e1114c0bb4a2d366e337982c990920c290adc09bd452855297cf2d24dcb8c00f702394d206a69078e152441a413934fe68579e9dcb8c70
-  data.tar.gz: bcf023342973cb13d307160bf106f9e2b1e66c55b0a1e3cb35f5d8946238da9677b4d1944cf44d0d693313771421ba86e101d5a32ecbd744cc87ba9fc957a4b3
+  metadata.gz: 2ead1d16e2162277d7d1d6900af837fbf4db4ac692d5be1515bb4e43f59566b8006bc0dd9be4710fdf5784399d10925e58c88fe79a8de308541b5ee6ffbd3dee
+  data.tar.gz: f56206e1a280ff942ad0014e24fca6c6434ca4dc73d4fdf4ec3e36061475e63ffed7ed16aa3e06a34a0bdacca905d71e1b304e8d84120dc36f620cebc802c686

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 0.2.0 - 2025-08-21
+
+- ActiveStorage integration.
+
 ## 0.1.0 - 2025-08-10
 
 - Initial release extracted from Parklife 0.7.0.

data/README.md

@@ -8,6 +8,35 @@ Add the gem to your application's `Gemfile`:
 gem 'parklife-rails'
 ```
 
+## ActiveStorage integration
+
+Parklife's ActiveStorage integration allows you to use ActiveStorage as normal in development, then during a Parklife build any encountered attachments are collected and copied to the build directory so they can be served alongside the rest of your static files. This is achieved via a Rails Engine and custom ActiveStorage DiskService which work together to tweak ActiveStorage URLs so they're suitable for a static web server.
+
+Enable the engine at the bottom of `config/application.rb`:
+
+> [!NOTE]
+> This must be done before the app boots so can't be in an initializer.
+
+```ruby
+require 'parklife-rails/activestorage'
+```
+
+Then switch to Parklife's ActiveStorage service in `config/storage.yml`:
+
+```yml
+local:
+  service: Parklife
+  root: <%= Rails.root.join("storage") %>
+```
+
+Finally anywhere an attachment is referenced make sure to use the `processed` URL:
+
+```ruby
+image_tag(
+  blog_post.hero_image.representation(:medium).processed.url
+)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/benpickles/parklife-rails>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/benpickles/parklife-rails/blob/main/CODE_OF_CONDUCT.md).

data/app/controllers/parklife/rails/active_storage/blobs_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Parklife
+  module Rails
+    module ActiveStorage
+      class BlobsController < ActionController::Base
+        include ::ActiveStorage::FileServer
+
+        def show
+          blob = ::ActiveStorage::Blob.find_by!(key: params[:key])
+
+          serve_file(
+            named_disk_service(blob.service_name).path_for(blob.key),
+            content_type: blob.content_type,
+            disposition: :inline,
+          )
+        rescue Errno::ENOENT
+          head :not_found
+        end
+
+        private
+          def named_disk_service(name)
+            ::ActiveStorage::Blob.services.fetch(name)
+          end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+Rails.application.routes.draw do
+  scope Parklife::Rails::ActiveStorage.routes_prefix do
+    get 'blobs/:key/*filename',
+      to: 'parklife/rails/active_storage/blobs#show',
+      as: :parklife_blob_service
+  end
+
+  direct :parklife_blob do |blob, options|
+    route_for(
+      :parklife_blob_service,
+      blob.key,
+      blob.filename,
+      { only_path: true }.merge(options),
+    )
+  end
+
+  resolve('ActiveStorage::Attachment')        { |attachment, options| route_for(:parklife_blob, attachment.blob, options) }
+  resolve('ActiveStorage::Blob')              { |blob, options| route_for(:parklife_blob, blob, options) }
+  resolve('ActiveStorage::Preview')           { |preview, options| route_for(:parklife_blob, preview.blob, options) }
+  resolve('ActiveStorage::VariantWithRecord') { |variant, options| route_for(:parklife_blob, variant.blob, options) }
+end

data/lib/active_storage/service/parklife_service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'active_storage/service/disk_service'
+
+module ActiveStorage
+  class Service::ParklifeService < Service::DiskService
+    def url(key, **options)
+      super.tap do |url|
+        if Parklife::Rails::ActiveStorage.collect_assets
+          Parklife::Rails::ActiveStorage.collect_asset(self, key, url)
+        end
+      end
+    end
+
+    private
+      def generate_url(key, expires_in:, filename:, content_type:, disposition:) # rubocop:disable Lint/UnusedMethodArgument
+        url_helpers.parklife_blob_service_path(key: key, filename: filename)
+      end
+  end
+end

data/lib/parklife/rails/activestorage.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Parklife
+  module Rails
+    module ActiveStorage
+      Asset = Struct.new(:service, :key, :url) do
+        def blob_path
+          service.path_for(key)
+        end
+      end
+
+      class Engine < ::Rails::Engine
+        isolate_namespace Parklife::Rails::ActiveStorage
+
+        initializer 'parklife.app_integration' do |app|
+          # Disable the standard ActiveStorage routes that will otherwise
+          # prevent a blob being served by Parklife's controller.
+          app.config.active_storage.draw_routes = false
+        end
+      end
+
+      mattr_accessor :collect_assets, default: false
+      mattr_accessor :collected_assets, default: {}
+      mattr_accessor :routes_prefix, default: 'parklife'
+
+      def self.collect_asset(service, key, url)
+        collected_assets[key] ||= Asset.new(service, key, url)
+      end
+    end
+  end
+end

data/lib/parklife/rails/build_integration.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'parklife'
+require 'rails'
+require_relative 'config_refinements'
+require_relative 'route_set_refinements'
+
+module Parklife
+  module Rails
+    class BuildIntegration < ::Rails::Railtie
+      initializer 'parklife.build_integration' do |app|
+        # The offending middleware is included in Rails (6+) development mode and
+        # rejects a request with a 403 response if its host isn't present in the
+        # allowlist (a security feature). This prevents Parklife from working in
+        # a Rails app out of the box unless you manually add the expected
+        # Parklife base to the hosts allowlist or set it to nil to disable it -
+        # both of which aren't great because they disable the security feature
+        # whenever the development server is booted.
+        #
+        # https://guides.rubyonrails.org/configuring.html#actiondispatch-hostauthorization
+        #
+        # However it's safe to remove the middleware at this point because it
+        # won't be executed in the normal Rails development flow, only via a
+        # Parkfile when parklife/rails is required.
+        if defined?(ActionDispatch::HostAuthorization)
+          app.middleware.delete(ActionDispatch::HostAuthorization)
+        end
+
+        Parklife.application.config.app = app
+
+        # This ensures next tweak is compatibile with Rails 8+ lazy routes.
+        Parklife.application.routes.extend(RouteSetRefinements)
+
+        # Allow use of the Rails application's route helpers when defining
+        # Parklife routes in the block form.
+        Parklife.application.routes.singleton_class.include(app.routes.url_helpers)
+
+        Parklife.application.config.extend(ConfigRefinements)
+      end
+
+      config.after_initialize do |app|
+        # Read the Rails app's URL config and apply it to Parklife's so that the
+        # Rails config can be used as the single source of truth.
+        host, port, protocol = app.default_url_options.values_at(:host, :port, :protocol)
+        protocol = 'https' if app.config.force_ssl
+        path = ActionController::Base.relative_url_root
+
+        Parklife.application.config.base.scheme = protocol if protocol
+        Parklife.application.config.base.host = host if host
+        Parklife.application.config.base.port = port if port
+        Parklife.application.config.base.path = path if path
+
+        # If the host Rails app includes Parklife's ActiveStorage integration
+        # then automatically collect attachments encountered during a build and
+        # copy them to the build directory.
+        if defined?(Parklife::Rails::ActiveStorage)
+          Parklife.application.before_build do
+            ActiveStorage.collected_assets.clear
+            ActiveStorage.collect_assets = true
+          end
+
+          Parklife.application.after_build do
+            ActiveStorage.collected_assets.each_value do |asset|
+              build_path = File.join(Parklife.application.config.build_dir, asset.url)
+              FileUtils.mkdir_p(File.dirname(build_path))
+              FileUtils.cp(asset.blob_path, build_path)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parklife/rails/config_refinements.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Parklife
+  module Rails
+    module ConfigRefinements
+      # When setting Parklife's base also configure the Rails app's
+      # default_url_options and relative_url_root to match.
+      def base=(value)
+        super.tap { |uri|
+          app.default_url_options = {
+            host: Utils.host_with_port(uri),
+            protocol: uri.scheme,
+          }
+
+          base_path = !uri.path.empty? && uri.path != '/' ? uri.path : nil
+          ActionController::Base.relative_url_root = base_path
+        }
+      end
+    end
+  end
+end

data/lib/parklife/rails/route_set_refinements.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Parklife
+  module Rails
+    module RouteSetRefinements
+      def default_url_options
+        ::Rails.application.default_url_options
+      end
+    end
+  end
+end

data/lib/parklife/rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Parklife
   module Rails
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/parklife/rails.rb

@@ -1,70 +1,9 @@
 # frozen_string_literal: true
-require 'parklife'
-require 'rails'
 
-module Parklife
-  module RailsConfigRefinements
-    # When setting Parklife's base also configure the Rails app's
-    # default_url_options and relative_url_root to match.
-    def base=(value)
-      super.tap { |uri|
-        app.default_url_options = {
-          host: Utils.host_with_port(uri),
-          protocol: uri.scheme,
-        }
-
-        base_path = !uri.path.empty? && uri.path != '/' ? uri.path : nil
-        ActionController::Base.relative_url_root = base_path
-      }
-    end
-  end
-
-  module RailsRouteSetRefinements
-    def default_url_options
-      ::Rails.application.default_url_options
-    end
-  end
-
-  class Railtie < ::Rails::Railtie
-    initializer 'parklife.disable_host_authorization' do |app|
-      # The offending middleware is included in Rails (6+) development mode and
-      # rejects a request with a 403 response if its host isn't present in the
-      # allowlist (a security feature). This prevents Parklife from working in
-      # a Rails app out of the box unless you manually add the expected
-      # Parklife base to the hosts allowlist or set it to nil to disable it -
-      # both of which aren't great because they disable the security feature
-      # whenever the development server is booted.
-      #
-      # https://guides.rubyonrails.org/configuring.html#actiondispatch-hostauthorization
-      #
-      # However it's safe to remove the middleware at this point because it
-      # won't be executed in the normal Rails development flow, only via a
-      # Parkfile when parklife/rails is required.
-      if defined?(ActionDispatch::HostAuthorization)
-        app.middleware.delete(ActionDispatch::HostAuthorization)
-      end
-
-      Parklife.application.config.app = app
-
-      # Allow use of the Rails application's route helpers when defining
-      # Parklife routes in the block form.
-      Parklife.application.routes.singleton_class.include(RailsRouteSetRefinements)
-      Parklife.application.routes.singleton_class.include(app.routes.url_helpers)
-
-      Parklife.application.config.extend(RailsConfigRefinements)
-    end
-
-    config.after_initialize do |app|
-      # Read the Rails app's URL config and apply it to Parklife's so that the
-      # Rails config can be used as the single source of truth.
-      host, port, protocol = app.default_url_options.values_at(:host, :port, :protocol)
-      protocol = 'https' if app.config.force_ssl
-      path = ActionController::Base.relative_url_root
-
-      Parklife.application.config.base.scheme = protocol if protocol
-      Parklife.application.config.base.host = host if host
-      Parklife.application.config.base.port = port if port
-      Parklife.application.config.base.path = path if path
-    end
-  end
+# Only require the build integration when running from a Parklife CLI command.
+#
+# This means that the gem can safely be included in the app's Gemfile without
+# applying any of its build-time tweaks.
+if defined?(Parklife::CLI)
+  require_relative 'rails/build_integration'
 end

data/lib/parklife-rails/activestorage.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative '../parklife/rails/activestorage'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parklife-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Pickles
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parklife
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - spideryoung@gmail.com
 executables: []
@@ -51,12 +49,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/parklife/rails/active_storage/blobs_controller.rb
+- config/routes.rb
 - gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- lib/active_storage/service/parklife_service.rb
 - lib/parklife-rails.rb
+- lib/parklife-rails/activestorage.rb
 - lib/parklife/rails.rb
+- lib/parklife/rails/activestorage.rb
+- lib/parklife/rails/build_integration.rb
+- lib/parklife/rails/config_refinements.rb
+- lib/parklife/rails/route_set_refinements.rb
 - lib/parklife/rails/version.rb
 homepage: https://parklife.dev/rails
 licenses:
@@ -66,7 +72,6 @@ metadata:
   homepage_uri: https://parklife.dev/rails
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/benpickles/parklife-rails
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Rails integration for Parklife
 test_files: []