active_shrine 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 197975739ca00f2daa4c862413a372ee52ce634c308b6f5784d2b588d4f4e498
-  data.tar.gz: 5d6119a5f5d32d54a79adff404fce302c2aa170b0b62edb09486b6d510732185
+  metadata.gz: 00f454741e3498d96b3e51fe4069a3710c1da4dbf029c7217894ffd917818240
+  data.tar.gz: 70521e166a1f473a7ee7c40262e985c4cff3ada4001fc736196be9d7877020c6
 SHA512:
-  metadata.gz: cce39085bbe3593da28a9d845b9319343efead530dfd8177d62a4c3f9891cbdb771900772e7f4e561f31f5fe25def92eae07c237be3f6b547084093eecc68a3e
-  data.tar.gz: 66ecf1b6c13c4f0420a3e1ae45a554620a73c3f67ca96c7bca2c0dd0e72afdcad103596f66cac72bd974291a9e7008a0465e175a560299517b3ce1f83a2c28d6
+  metadata.gz: 83b210e7d6ecca7c906211d508617bbdcb6d04731b7652c764c1e6542cf5f75a71617301d50e339cafdf09b4714fcb2a59a712ade97a7ab06c5526b1971733d3
+  data.tar.gz: 340885a2d58807f7a227c62f2e2142def6629dbdec4ac25959fff05ee941c044078ec0f3e4a4b93381d63236b4a7858f30e1662c95f83936639a20c6e86f7c3d

data/Appraisals

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.3", ">= 7.1.3.4", "< 8.0.0"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails-8" do
+  gem "rails", "~> 8.0.0"
+  gem "sqlite3", "~> 2.1"
+end

data/README.md

@@ -105,6 +105,64 @@ class User < ApplicationRecord
 end
 ```
 
+## Updating Polymorphic Associations
+
+ActiveShrine uses polymorphic associations to link your models to their attachments. When you change an uploader for an existing attachment (for example, switching from the default `Shrine` uploader to a custom `ImageUploader`), you may need to update the polymorphic association data in existing records.
+
+The attachment class names are stored in the `active_shrine_attachments` table in the `record_type` column. When you change uploaders, these class names need to be updated to maintain the correct associations.
+
+### Example Migration
+
+If you previously had:
+
+```ruby
+class User < ApplicationRecord
+  include ActiveShrine::Model
+
+  has_one_attached :avatar  # Uses default Shrine uploader
+end
+```
+
+And you're changing to:
+
+```ruby
+class User < ApplicationRecord
+  include ActiveShrine::Model
+
+  has_one_attached :avatar, uploader: ::ImageUploader
+end
+```
+
+You'll need to create a migration to update existing attachment records:
+
+```ruby
+class UpdateAvatarAttachmentClasses < ActiveRecord::Migration[7.0]
+  def up
+    # Update existing avatar attachments to use the new ImageUploader attachment class
+    ActiveShrine::Attachment
+      .where(name: 'avatar', record_type: 'User')
+      .update_all(record_type: 'ActiveShrine::ImageUploaderAttachment')
+  end
+end
+```
+
+### Important Notes
+
+- **Backup First**: Always backup your database before running these migrations
+- **Test Thoroughly**: Test the migration on a copy of your production data first
+- **Class Names**: The attachment class names follow the pattern `ActiveShrine::{UploaderName}Attachment`
+
+### Verifying the Update
+
+After running the migration, you can verify that your attachments are working correctly:
+
+```ruby
+# Your existing attachments should continue to work
+user = User.find(1)
+user.avatar.url  # Should work correctly with the new uploader
+user.avatar.class  # Should be ActiveShrine::ImageUploaderAttachment
+```
+
 ## Development
 
 After checking out the repo:

data/Rakefile

@@ -1,4 +1,27 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+require "standard/rake"
+require "appraisal"
+
+task default: %i[test standard]
+
+# https://juincc.medium.com/how-to-setup-minitest-for-your-gems-development-f29c4bee13c2
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+desc "Run tests across all appraisals"
+task :test_all do
+  sh "bundle exec appraisal install"
+  sh "bundle exec appraisal test"
+end

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.3", ">= 7.1.3.4", "< 8.0.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_8.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 8.0.0"
+gem "sqlite3", "~> 2.1"
+
+gemspec path: "../"

data/lib/active_shrine/attached/changes/create_one.rb

@@ -27,7 +27,7 @@ module ActiveShrine
             attachment.errors.each do |error|
               record.errors.add(name, error.message)
             end
-            
+
             raise ActiveRecord::RecordInvalid.new(record)
           end
 

data/lib/active_shrine/attachment.rb

@@ -81,7 +81,7 @@ module ActiveShrine
           end
         end
 
-        super(value)
+        super
       rescue ActiveSupport::MessageVerifier::InvalidSignature
         errors.add(:file, "is invalid")
       end
@@ -101,10 +101,10 @@ module ActiveShrine
       end
 
       private
-  
+
       def maybe_store_record
         return unless record.present?
-  
+
         metadata.merge! record_type:, record_id:
       end
     end

data/lib/active_shrine/job/destroy_shrine_attachment.rb

@@ -7,7 +7,8 @@ module ActiveShrine
     module DestroyShrineAttachment
       private
 
-      def perform(attacher_class, data)
+      def perform(attacher_class, record_class, data)
+        record_class.constantize # materialize the uploader polymorphic class
         attacher_class = attacher_class.constantize
 
         attacher = attacher_class.from_data(data)

data/lib/active_shrine/job/promote_shrine_attachment.rb

@@ -7,11 +7,10 @@ module ActiveShrine
     module PromoteShrineAttachment
       private
 
-      def perform(attacher_class, record_class, record_id, name, file_data)
-        attacher_class = attacher_class.constantize
-        record = record_class.constantize.find(record_id)
-
-        attacher = attacher_class.retrieve(model: record, name:, file: file_data)
+      def perform(attacher_class, attachment_record_class, attachment_record_id, record_class, attribute_name, file_data)
+        record_class.constantize # materialize the uploader polymorphic class
+        attachment_record = attachment_record_class.constantize.find(attachment_record_id)
+        attacher = attacher_class.constantize.retrieve(model: attachment_record, name: attribute_name, file: file_data)
         attacher.atomic_promote
       rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
         # attachment has changed or record has been deleted, nothing to do

data/lib/active_shrine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveShrine
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/generators/active_shrine/install/install_generator.rb

@@ -15,10 +15,6 @@ module ActiveShrine
       directory "app"
       directory "config"
       migration_template "db/migrate/create_active_shrine_attachments.rb", "db/migrate/create_active_shrine_attachments.rb"
-
-      Bundler.with_unbundled_env do
-        run "bundle add fastimage"
-      end
     end
 
     def self.next_migration_number(dirname)

data/lib/generators/active_shrine/install/templates/config/initializers/shrine.rb

@@ -22,30 +22,20 @@ Shrine.plugin :determine_mime_type, analyzer: lambda { |io, analyzers|
 }
 Shrine.plugin :instrumentation
 Shrine.plugin :infer_extension, force: true
-Shrine.plugin :store_dimensions
+# Shrine.plugin :store_dimensions # Requires the fastimage gem
 Shrine.plugin :pretty_location
 Shrine.plugin :refresh_metadata
 
 Shrine.plugin :backgrounding
 
 Shrine::Attacher.promote_block do
-  if PromoteShrineAttachmentJob.respond_to? :perform_async
-    # sidekiq
-    PromoteShrineAttachmentJob.perform_async(self.class.name, record.class.name, record.id, name.to_s, file_data)
-  else
-    # activejob
-    PromoteShrineAttachmentJob.perform_later(self.class.name, record.class.name, record.id, name.to_s, file_data)
-  end
+  PromoteShrineAttachmentJob.perform_later(self.class.name, record.class.name, record.id, record.record_type, name.to_s, file_data)
 end
 
 Shrine::Attacher.destroy_block do
-  if PromoteShrineAttachmentJob.respond_to? :perform_async
-    # sidekiq
-    DestroyShrineAttachmentJob.perform_async(self.class.name, data)
-  else
-    # activejob
-    DestroyShrineAttachmentJob.perform_later(self.class.name, data)
-  end
+  DestroyShrineAttachmentJob.perform_later(self.class.name, record.record_type, data)
 end
 
 Shrine.plugin :upload_endpoint, url: true
+Shrine.plugin :derivatives, create_on_promote: true
+Shrine.plugin :processing

data/lib/generators/active_shrine/install/templates/db/migrate/create_active_shrine_attachments.rb

@@ -19,7 +19,7 @@ class CreateActiveShrineAttachments < ActiveRecord::Migration[7.0]
 
       t.timestamps
     end
-    
+
     add_index :active_shrine_attachments, :name
     if ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
       add_index :active_shrine_attachments, :file_data, using: :gin
@@ -31,12 +31,12 @@ class CreateActiveShrineAttachments < ActiveRecord::Migration[7.0]
   end
 
   private
-  
+
   def primary_and_foreign_key_types
     config = Rails.configuration.generators
     setting = config.options[config.orm][:primary_key_type]
     primary_key_type = setting || :primary_key
     foreign_key_type = setting || :bigint
-    [ primary_key_type, foreign_key_type ]
+    [primary_key_type, foreign_key_type]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_shrine
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Radioactive Labs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,12 +158,15 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".ruby-version"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - config.ru
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_8.gemfile
 - lib/active_shrine.rb
 - lib/active_shrine/attached.rb
 - lib/active_shrine/attached/base.rb