Skip to content

Commit 38b4972

Browse files
tvdeyentvdeyen
committed
Add upgrader for active storage
1 parent 853d5ad commit 38b4972

19 files changed

+368
-28
lines changed

‎app/models/alchemy/attachment.rb

+13
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ class Attachment < BaseRecord
2424
include Alchemy::Taggable
2525
include Alchemy::TouchElements
2626

27+
attr_readonly(
28+
:legacy_image_file_name,
29+
:legacy_image_file_size,
30+
:legacy_image_file_uid
31+
)
32+
33+
deprecate(
34+
:legacy_image_file_name,
35+
:legacy_image_file_size,
36+
:legacy_image_file_uid,
37+
deprecator: Alchemy::Deprecation
38+
)
39+
2740
# Use ActiveStorage file attachments
2841
has_one_attached :file, service: :alchemy_cms
2942

‎app/models/alchemy/picture.rb

+19
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,25 @@ def self.preprocessor_class=(klass)
8080
@_preprocessor_class = klass
8181
end
8282

83+
attr_readonly(
84+
:legacy_image_file_format,
85+
:legacy_image_file_height,
86+
:legacy_image_file_name,
87+
:legacy_image_file_size,
88+
:legacy_image_file_uid,
89+
:legacy_image_file_width
90+
)
91+
92+
deprecate(
93+
:legacy_image_file_format,
94+
:legacy_image_file_height,
95+
:legacy_image_file_name,
96+
:legacy_image_file_size,
97+
:legacy_image_file_uid,
98+
:legacy_image_file_width,
99+
deprecator: Alchemy::Deprecation
100+
)
101+
83102
# Use ActiveStorage image processing
84103
has_one_attached :image_file, service: :alchemy_cms do |attachable|
85104
# Only works in Rails 7.1

‎db/migrate/20240611080918_rename_alchemy_attachment_file.rb

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
class RenameAlchemyAttachmentFile < ActiveRecord::Migration[7.0]
2+
COLUMNS = %i[
3+
file_name
4+
file_size
5+
file_uid
6+
]
7+
8+
def change
9+
COLUMNS.each do |column|
10+
rename_column :alchemy_attachments, column, :"legacy_#{column}"
11+
end
12+
end
13+
end

‎db/migrate/20240611080918_rename_alchemy_picture_image_file.rb

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
class RenameAlchemyPictureImageFile < ActiveRecord::Migration[7.0]
2+
COLUMNS = %i[
3+
image_file_format
4+
image_file_height
5+
image_file_name
6+
image_file_size
7+
image_file_uid
8+
image_file_width
9+
]
10+
11+
def change
12+
COLUMNS.each do |column|
13+
rename_column :alchemy_pictures, column, :"legacy_#{column}"
14+
end
15+
end
16+
end

‎lib/alchemy/test_support/factories/attachment_factory.rb

-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,5 @@
2020
end
2121

2222
name { "image" }
23-
file_name { "image.png" }
2423
end
2524
end

‎lib/alchemy/upgrader/eight_zero.rb

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
require "alchemy/shell"
2+
require "alchemy/upgrader/tasks/active_storage_migration"
3+
require "benchmark"
4+
require "dragonfly"
5+
require "dragonfly_svg"
6+
require "fileutils"
7+
require "thor"
8+
9+
module Alchemy
10+
class Upgrader::EightZero < Upgrader
11+
include Thor::Base
12+
include Thor::Actions
13+
14+
class << self
15+
def install_active_storage
16+
Rake::Task["active_storage:install"].invoke
17+
Rake::Task["db:migrate"].invoke
18+
19+
text = <<-YAML.strip_heredoc
20+
21+
alchemy_cms:
22+
service: Disk
23+
root: <%= Rails.root.join("storage") %>
24+
YAML
25+
26+
storage_yml = Rails.application.root.join("config/storage.yml")
27+
if File.exist?(storage_yml)
28+
task.insert_into_file(storage_yml, text)
29+
else
30+
task.create_file(storage_yml, text)
31+
end
32+
end
33+
34+
def prepare_dragonfly_config
35+
task.prepend_to_file "config/initializers/dragonfly.rb", <<~RUBY
36+
require "dragonfly"
37+
require "dragonfly_svg"
38+
RUBY
39+
end
40+
41+
def migrate_pictures_to_active_storage
42+
Dragonfly.logger = Rails.logger
43+
44+
Alchemy::Picture.class_eval do
45+
extend Dragonfly::Model
46+
dragonfly_accessor :legacy_image_file, app: :alchemy_pictures
47+
end
48+
49+
pictures_without_as_attachment = Alchemy::Picture.where.missing(:image_file_attachment)
50+
count = pictures_without_as_attachment.count
51+
if count > 0
52+
log "Migrating #{count} Dragonfly image file(s) to ActiveStorage."
53+
realtime = Benchmark.realtime do
54+
pictures_without_as_attachment.find_each do |picture|
55+
Alchemy::Upgrader::Tasks::ActiveStorageMigration.migrate_picture(picture)
56+
print "."
57+
end
58+
end
59+
puts "\nDone in #{realtime.round(2)}s!"
60+
else
61+
log "No Dragonfly image files for migration found.", :skip
62+
end
63+
end
64+
65+
def migrate_attachments_to_active_storage
66+
Dragonfly.logger = Rails.logger
67+
68+
Alchemy::Attachment.class_eval do
69+
extend Dragonfly::Model
70+
dragonfly_accessor :legacy_file, app: :alchemy_attachments
71+
end
72+
73+
attachments_without_as_attachment = Alchemy::Attachment.where.missing(:file_attachment)
74+
count = attachments_without_as_attachment.count
75+
if count > 0
76+
log "Migrating #{count} Dragonfly attachment file(s) to ActiveStorage."
77+
realtime = Benchmark.realtime do
78+
attachments_without_as_attachment.find_each do |attachment|
79+
Alchemy::Upgrader::Tasks::ActiveStorageMigration.migrate_attachment(attachment)
80+
print "."
81+
end
82+
end
83+
puts "\nDone in #{realtime.round(2)}s!"
84+
else
85+
log "No Dragonfly attachment files for migration found.", :skip
86+
end
87+
end
88+
89+
def remove_dragonfly_todo
90+
todo <<-TXT.strip_heredoc
91+
Please check if all pictures and attachments are migrated to ActiveStorage.
92+
93+
If so, you can remove the Dragonfly gem, its configuration and storage by running:
94+
95+
rm config/initializers/dragonfly.rb
96+
rm -rf uploads
97+
98+
TXT
99+
end
100+
101+
private
102+
103+
def task
104+
@_task || new
105+
end
106+
end
107+
end
108+
end

‎lib/alchemy/upgrader/tasks/active_storage_migration.rb

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
require "active_storage/service"
2+
require "active_storage/service/disk_service"
3+
4+
module Alchemy
5+
class Upgrader
6+
module Tasks
7+
class ActiveStorageMigration
8+
DEFAULT_CONTENT_TYPE = "application/octet-stream"
9+
DISK_SERVICE = ActiveStorage::Service::DiskService
10+
SERVICE_NAME = :alchemy_cms
11+
12+
METADATA = {
13+
identified: true, # Skip identifying file type
14+
analyzed: true, # Skip analyze job
15+
composed: true # Skip checksum check
16+
}
17+
18+
class << self
19+
def migrate_picture(picture)
20+
Alchemy::Deprecation.silence do
21+
uid = picture.legacy_image_file_uid
22+
key = key_for_uid(uid)
23+
content_type = Mime::Type.lookup_by_extension(picture.legacy_image_file_format) || DEFAULT_CONTENT_TYPE
24+
Alchemy::Picture.transaction do
25+
blob = ActiveStorage::Blob.create!(
26+
key: key,
27+
filename: picture.legacy_image_file_name,
28+
byte_size: picture.legacy_image_file_size,
29+
content_type: content_type,
30+
# Prevents (down)loading the original file
31+
metadata: METADATA.merge(
32+
width: picture.legacy_image_file_width,
33+
height: picture.legacy_image_file_height
34+
),
35+
service_name: SERVICE_NAME
36+
)
37+
picture.create_image_file_attachment!(
38+
name: :image_file,
39+
record: picture,
40+
blob: blob
41+
)
42+
end
43+
move_file(Rails.root.join("uploads/pictures", uid), key)
44+
end
45+
end
46+
47+
def migrate_attachment(attachment)
48+
Alchemy::Deprecation.silence do
49+
uid = attachment.legacy_file_uid
50+
key = key_for_uid(uid)
51+
Alchemy::Attachment.transaction do
52+
blob = ActiveStorage::Blob.create!(
53+
key: key,
54+
filename: attachment.legacy_file_name,
55+
byte_size: attachment.legacy_file_size,
56+
content_type: attachment.file_mime_type.presence || DEFAULT_CONTENT_TYPE,
57+
metadata: METADATA,
58+
service_name: SERVICE_NAME
59+
)
60+
attachment.create_file_attachment!(
61+
record: attachment,
62+
name: :file,
63+
blob: blob
64+
)
65+
end
66+
move_file(Rails.root.join("uploads/attachments", uid), key)
67+
end
68+
end
69+
70+
private
71+
72+
# ActiveStorage::Service::DiskService stores files in a folder structure
73+
# based on the first two characters of the file uid.
74+
def key_for_uid(uid)
75+
case service
76+
when DISK_SERVICE
77+
uid.split("/").last
78+
else
79+
uid
80+
end
81+
end
82+
83+
def move_file(uid, key)
84+
case service
85+
when DISK_SERVICE
86+
if File.exist?(uid)
87+
service.send(:make_path_for, key)
88+
FileUtils.cp uid, service.send(:path_for, key)
89+
end
90+
end
91+
end
92+
93+
def service
94+
ActiveStorage::Blob.services.fetch(SERVICE_NAME)
95+
end
96+
end
97+
end
98+
end
99+
end
100+
end

‎lib/generators/alchemy/install/install_generator.rb

+13
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,19 @@ def install_assets
7171
end
7272
end
7373

74+
def install_active_storage
75+
rake "active_storage:install:migrations"
76+
end
77+
78+
def set_active_storage_service
79+
insert_into_file app_config_path.join("storage.yml"), <<-YAML.strip_heredoc
80+
81+
alchemy_cms:
82+
service: Disk
83+
root: <%= Rails.root.join("storage") %>
84+
YAML
85+
end
86+
7487
def copy_demo_views
7588
return if options[:skip_demo_files]
7689

‎lib/tasks/alchemy/upgrade.rake

+31-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ require "alchemy/version"
66
namespace :alchemy do
77
desc "Upgrades your app to AlchemyCMS v#{Alchemy::VERSION}."
88
task upgrade: [
9-
"alchemy:upgrade:prepare"
9+
"alchemy:upgrade:prepare",
10+
"alchemy:upgrade:8.0:run"
1011
] do
1112
Alchemy::Upgrader.display_todos
1213
end
@@ -28,5 +29,34 @@ namespace :alchemy do
2829
task config: [:environment] do
2930
Alchemy::Upgrader.copy_new_config_file
3031
end
32+
33+
namespace "8.0" do
34+
task "run" => [
35+
"alchemy:upgrade:8.0:install_active_storage",
36+
"alchemy:upgrade:8.0:prepare_dragonfly_config",
37+
"alchemy:upgrade:8.0:migrate_pictures_to_active_storage",
38+
"alchemy:upgrade:8.0:migrate_attachments_to_active_storage"
39+
]
40+
41+
desc "Install active_storage"
42+
task :install_active_storage do
43+
Alchemy::Upgrader::EightZero.install_active_storage
44+
end
45+
46+
desc "Prepare Dragonfly config"
47+
task :prepare_dragonfly_config do
48+
Alchemy::Upgrader::EightZero.prepare_dragonfly_config
49+
end
50+
51+
desc "Migrate pictures to active_storage"
52+
task :migrate_pictures_to_active_storage do
53+
Alchemy::Upgrader::EightZero.migrate_pictures_to_active_storage
54+
end
55+
56+
desc "Migrate attachments to active_storage"
57+
task :migrate_attachments_to_active_storage do
58+
Alchemy::Upgrader::EightZero.migrate_attachments_to_active_storage
59+
end
60+
end
3161
end
3262
end

‎spec/dummy/config/initializers/dragonfly.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
require "dragonfly"
2+
require "dragonfly_svg"
13
# frozen_string_literal: true
24

35
# AlchemyCMS Dragonfly configuration.

‎spec/dummy/config/storage.yml

+4
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,7 @@ local:
3232
# service: Mirror
3333
# primary: local
3434
# mirrors: [ amazon, google, microsoft ]
35+
36+
alchemy_cms:
37+
service: Disk
38+
root: <%= Rails.root.join("storage") %>

‎spec/dummy/db/migrate/20240611152553_rename_alchemy_attachment_file.alchemy.rb

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# This migration comes from alchemy (originally 20240611080918)
2+
class RenameAlchemyAttachmentFile < ActiveRecord::Migration[7.0]
3+
COLUMNS = %i[
4+
file_name
5+
file_size
6+
file_uid
7+
]
8+
9+
def change
10+
COLUMNS.each do |column|
11+
rename_column :alchemy_attachments, column, :"legacy_#{column}"
12+
end
13+
end
14+
end

0 commit comments

Comments
 (0)