parklife-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61520daa959509f52822c34d3b946dca45f285fbdc1389a628389440f7d32c1e
-  data.tar.gz: 75df6c7770beb136684d4c312faf97b78c0aaf67705c4fa67785c600a4b35122
+  metadata.gz: 57ab04a4d96ded8bcb081c1d3c6e7236e03d163052f409b4d281d4dffbcce966
+  data.tar.gz: 663b999db226fa73460e8c2ce526e987a2502e8d6f70d78782a75eadf367fc48
 SHA512:
-  metadata.gz: 2ead1d16e2162277d7d1d6900af837fbf4db4ac692d5be1515bb4e43f59566b8006bc0dd9be4710fdf5784399d10925e58c88fe79a8de308541b5ee6ffbd3dee
-  data.tar.gz: f56206e1a280ff942ad0014e24fca6c6434ca4dc73d4fdf4ec3e36061475e63ffed7ed16aa3e06a34a0bdacca905d71e1b304e8d84120dc36f620cebc802c686
+  metadata.gz: d8f33fe1826e01f722dafc0ef3a0513f6a72eb66e35bf1978c3529c3e33da6bbb474795efbe6bf3a59cc99f946f11761f5d1d264b995a21019bd401c464c1f07
+  data.tar.gz: f0f1a2181451e3e563033fffcd3ecf9393f7c6bfda165cce5bb20a26c8e20e038c522eba6f170b335395c8d1372209dce80d9e50db9a17db5891c5e0fb6ca230

data/Appraisals

@@ -3,6 +3,7 @@
 appraise 'rails_7.0' do
   gem 'concurrent-ruby', '< 1.3.5'
   gem 'rails', '~> 7.0.0'
+  gem 'sqlite3', '<2'
 end
 
 appraise 'rails_7.1' do

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
 
+## 0.3.0 - 2025-09-05
+
+- Allow passing an ActiveStorage blob/attachment/preview/variant to the usual tag helpers:
+
+  ```
+  image_tag(blog_post.hero_image.variant(:medium))
+
+  video_tag(product.intro_video)
+  ```
+
 ## 0.2.0 - 2025-08-21
 
 - ActiveStorage integration.

data/README.md

@@ -12,7 +12,7 @@ gem 'parklife-rails'
 
 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`:
+Enable the engine in `config/application.rb`:
 
 > [!NOTE]
 > This must be done before the app boots so can't be in an initializer.
@@ -29,12 +29,34 @@ local:
   root: <%= Rails.root.join("storage") %>
 ```
 
-Finally anywhere an attachment is referenced make sure to use the `processed` URL:
+Finally, use ActiveStorage (almost entirely) as usual:
 
 ```ruby
-image_tag(
-  blog_post.hero_image.representation(:medium).processed.url
+# Pass a blob/attachment/preview/variant directly to helpers as usual:
+image_tag(blog_post.hero_image.variant(:medium))
+# => <img src="/parklife/blobs/6adews39uehd44spynetigykwssh/cute-cat.jpg" />
+video_tag(product.intro_video)
+# => <video src="/parklife/blobs/x74tu8izjv141l8503gwkkruokca/cat-mug.mp4"></video>
+
+# Ask a variant for its path:
+blog_post.hero_image.variant(:medium).processed.url
+# => "/parklife/blobs/6adews39uehd44spynetigykwssh/cute-cat.jpg"
+
+# Use the route helper:
+Rails.application.routes.url_helpers.parklife_blob_path(
+  blog_post.hero_image.variant(:medium)
 )
+# => "/parklife/blobs/6adews39uehd44spynetigykwssh/cute-cat.jpg"
+```
+
+The only quirk is if you want to generate the full URL (including hostname etc), in that case `parklife_blob_url` doesn't behave as you'd expect and you must also pass `only_path: false`:
+
+```ruby
+Rails.application.routes.url_helpers.parklife_blob_url(
+  blog_post.hero_image.variant(:medium),
+  only_path: false,
+)
+# => "http://example.com/parklife/blobs/6adews39uehd44spynetigykwssh/cute-cat.jpg"
 ```
 
 ## Contributing

data/Rakefile

@@ -2,6 +2,10 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
+# Enable `db:setup` and friends.
+require_relative 'example-app/config/application'
+Rails.application.load_tasks
+
 RSpec::Core::RakeTask.new(:spec)
 
 require 'rubocop/rake_task'

data/config/routes.rb

@@ -6,17 +6,43 @@ Rails.application.routes.draw do
       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),
-    )
+  direct :parklife_blob do |obj, options|
+    blob = case obj
+    when ActiveStorage::Attachment
+      obj.blob
+    when ActiveStorage::Preview, ActiveStorage::VariantWithRecord
+      obj.processed.image.blob
+    else
+      obj
+    end
+
+    options = { only_path: true }.merge(options)
+    url = route_for(:parklife_blob_service, blob.key, blob.filename, options)
+
+    if Parklife::Rails::ActiveStorage.collect_assets
+      service = ActiveStorage::Blob.services.fetch(blob.service_name)
+
+      # When collecting ActiveStorage Blobs we only ever want the path and never
+      # its full URL.
+      path = if options[:only_path]
+        url
+      else
+        route_for(
+          :parklife_blob_service,
+          blob.key,
+          blob.filename,
+          options.merge(only_path: true),
+        )
+      end
+
+      Parklife::Rails::ActiveStorage.collect_asset(service, blob.key, path)
+    end
+
+    url
   end
 
-  resolve('ActiveStorage::Attachment')        { |attachment, options| route_for(:parklife_blob, attachment.blob, options) }
+  resolve('ActiveStorage::Attachment')        { |attachment, options| route_for(:parklife_blob, attachment, 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) }
+  resolve('ActiveStorage::Preview')           { |preview, options| route_for(:parklife_blob, preview, options) }
+  resolve('ActiveStorage::VariantWithRecord') { |variant, options| route_for(:parklife_blob, variant, options) }
 end

data/gemfiles/rails_7.0.gemfile

@@ -4,9 +4,20 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "rspec"
 gem "rubocop"
+gem "image_processing"
+gem "sprockets-rails"
+gem "sqlite3", "<2"
 gem "concurrent-ruby", "< 1.3.5"
 gem "rails", "~> 7.0.0"
 
+group :development, :test do
+  gem "rspec-rails"
+end
+
+group :test do
+  gem "capybara"
+  gem "factory_bot_rails"
+end
+
 gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -4,8 +4,19 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "rspec"
 gem "rubocop"
+gem "image_processing"
+gem "sprockets-rails"
+gem "sqlite3"
 gem "rails", "~> 7.1.0"
 
+group :development, :test do
+  gem "rspec-rails"
+end
+
+group :test do
+  gem "capybara"
+  gem "factory_bot_rails"
+end
+
 gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -4,8 +4,19 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "rspec"
 gem "rubocop"
+gem "image_processing"
+gem "sprockets-rails"
+gem "sqlite3"
 gem "rails", "~> 7.2.0"
 
+group :development, :test do
+  gem "rspec-rails"
+end
+
+group :test do
+  gem "capybara"
+  gem "factory_bot_rails"
+end
+
 gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -4,8 +4,19 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "rspec"
 gem "rubocop"
+gem "image_processing"
+gem "sprockets-rails"
+gem "sqlite3"
 gem "rails", "~> 8.0.0"
 
+group :development, :test do
+  gem "rspec-rails"
+end
+
+group :test do
+  gem "capybara"
+  gem "factory_bot_rails"
+end
+
 gemspec path: "../"

data/lib/active_storage/service/parklife_service.rb

@@ -4,9 +4,9 @@ require 'active_storage/service/disk_service'
 module ActiveStorage
   class Service::ParklifeService < Service::DiskService
     def url(key, **options)
-      super.tap do |url|
+      super.tap do |path|
         if Parklife::Rails::ActiveStorage.collect_assets
-          Parklife::Rails::ActiveStorage.collect_asset(self, key, url)
+          Parklife::Rails::ActiveStorage.collect_asset(self, key, path)
         end
       end
     end

data/lib/parklife/rails/activestorage.rb

@@ -2,7 +2,7 @@
 module Parklife
   module Rails
     module ActiveStorage
-      Asset = Struct.new(:service, :key, :url) do
+      Asset = Struct.new(:service, :key, :path) do
         def blob_path
           service.path_for(key)
         end
@@ -22,8 +22,8 @@ module Parklife
       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)
+      def self.collect_asset(service, key, path)
+        collected_assets[key] ||= Asset.new(service, key, path)
       end
     end
   end

data/lib/parklife/rails/build_integration.rb

@@ -61,7 +61,7 @@ module Parklife
 
           Parklife.application.after_build do
             ActiveStorage.collected_assets.each_value do |asset|
-              build_path = File.join(Parklife.application.config.build_dir, asset.url)
+              build_path = File.join(Parklife.application.config.build_dir, asset.path)
               FileUtils.mkdir_p(File.dirname(build_path))
               FileUtils.cp(asset.blob_path, build_path)
             end

data/lib/parklife/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parklife-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Pickles