effective_assets 1.11.5 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707e5ea1b01c0563aa8331e9fc33f374a455cbbd96da811cc1e760550018a3de
-  data.tar.gz: 81b9a2f560e72c9a1000bc4b0f5838ab73a91a2f2b4994c6307958bd5c44250c
+  metadata.gz: 8fc2ceb913a834e2d5a6c163e8aeccac4fd57f116239b59f1956c51c3a90053a
+  data.tar.gz: 6f24ae8f628864f2da0ab6ef66fb3cd9737c99fc3769c11c02e3aa9b7977a1bf
 SHA512:
-  metadata.gz: b817d4c9c537d44ed1b6533d9ae26e0965a2e0ac2067e9579df56a348a66e6d41d48b5c6bfec9b71e11c54cadb97214cf36d9ee563a4d9c94bbb711385d3c9f3
-  data.tar.gz: c278a7b17cc5723a67a0799b3812239632a8a8ef2422a705e3bca6f4ff34433a6a80517ae03e60e8b2e7b4bcd19b16130bdc529294d6f5b2b24d20dbccb5b1ee
+  metadata.gz: 4fc658672d3da2b57f573d3c3558d68028df4924e8982c8ac068d5dabddefaa5cd87942afeffbc95a2b7930310b23e8adac8eb21226cb29cba60b7fdafb008cf
+  data.tar.gz: b9690fd04a64c874d37d34453776ef065293461eb67b01ad1fa4019275151ab73c15973376425e36d370df898d21cea2d8e348fad7289524e0715bc520337d54

data/app/jobs/effective/asset_replacer_job.rb

@@ -0,0 +1,17 @@
+module Effective
+  class AssetReplacerJob < ::ApplicationJob
+
+    queue_as :default
+
+    if defined?(Sidekiq)
+      # The retry setting works. But none of these waits seem to. Still getting exponential backoff.
+      sidekiq_options retry: 2, retry_in: 10, wait: 10
+      sidekiq_retry_in { |count, exception| 10 }
+    end
+
+    def perform(attachment, box)
+      Effective::AssetReplacer.new.replace_attachment!(attachment, box)
+    end
+
+  end
+end

data/app/jobs/effective/snippet_replacer_job.rb

@@ -0,0 +1,17 @@
+module Effective
+  class SnippetReplacerJob < ::ApplicationJob
+
+    queue_as :default
+
+    if defined?(Sidekiq)
+      # The retry setting works. But none of these waits seem to. Still getting exponential backoff.
+      sidekiq_options retry: 2, retry_in: 10, wait: 10
+      sidekiq_retry_in { |count, exception| 10 }
+    end
+
+    def perform(region)
+      Effective::SnippetReplacer.new.replace_region!(region)
+    end
+
+  end
+end

data/app/models/effective/asset_replacer.rb

@@ -0,0 +1,157 @@
+# Looks at the Effective::Asset and Effective::Attachments and converts to ActiveStorage
+#
+# 1. Put in the has_attached_files to each model to be upgraded
+# 2. Remove the acts_as_asset_box
+
+require 'timeout'
+require 'cgi'
+
+module Effective
+  class AssetReplacer
+    include ActiveStorage::Blob::Analyzable
+
+    BATCH_SIZE = 500
+    TIMEOUT = 120
+
+    def replace!(skip_existing: false)
+      verify!
+
+      attachments = attachments_to_process().to_a
+
+      while(true)
+        wait_for_active_job!
+
+        puts "\nEnqueuing #{attachments.length} attachments with ids #{attachments.first.id} to #{attachments.last.id}"
+
+        attachments.each do |attachment|
+          asset = attachment.asset
+          attachable = attachment.attachable
+          next if asset.blank? || attachable.blank?
+
+          box = attachment.box.singularize
+          boxes = attachment.box
+
+          one = attachable.respond_to?(box) && attachable.send(box).kind_of?(ActiveStorage::Attached::One)
+          many = attachable.respond_to?(boxes) && attachable.send(boxes).kind_of?(ActiveStorage::Attached::Many)
+          box = (one ? box : boxes)
+
+          if skip_existing
+            existing = Array(attachable.send(box))
+
+            if existing.any? { |obj| obj.respond_to?(:filename) && obj.filename.to_s == asset.file_name }
+              puts("Skipping existing #{attachable.class.name} #{attachable.id} #{box} #{asset.file_name}.")
+              next
+            end
+          end
+
+          Effective::AssetReplacerJob.perform_later(attachment, box)
+        end
+
+        attachments = attachments_to_process().where.not(id: attachments.map(&:id))
+        break if attachments.to_a.blank?
+
+        GC.start
+      end
+
+      puts "\nAll Done. Have a great day."
+      true
+    end
+
+    # This is called on the background by the AssetReplacerJob
+    def replace_attachment!(attachment, box)
+      raise('expected an Effective::Attachment') unless attachment.kind_of?(Effective::Attachment)
+      puts("Processing attachment ##{attachment.id}")
+
+      asset = attachment.asset
+      attachable = attachment.attachable
+
+      attachable.replacing_asset = true if attachable.respond_to?(:replacing_asset=)
+
+      Timeout.timeout(TIMEOUT) do
+        attachable.send(box).attach(
+          io: URI.open(asset.url),
+          filename: CGI.unescape(asset.file_name.to_s),
+          content_type: asset.content_type.presence,
+          identify: (asset.content_type.blank?)
+        )
+
+        attachment.update_column(:replaced, true)
+      end
+
+      true
+    end
+
+    def verify!
+      raise('expected effective assets') unless defined?(Effective::Asset)
+      raise('expected active storage') unless defined?(ActiveStorage)
+
+      unless Effective::Attachment.new.respond_to?(:replaced?)
+        raise('please add a replaced boolean to Effective::Attachment. add_column :attachments, :replaced, :boolean')
+      end
+
+      (Effective::Attachment.all.pluck(:attachable_type, :box).uniq).each do |name, boxes|
+        next if name.blank? || boxes.blank?
+
+        box = boxes.singularize
+
+        klass = name.safe_constantize
+        raise("invalid class #{klass}") unless klass.present?
+
+        instance = klass.new
+
+        if instance.respond_to?(:effective_assets)
+          raise("please remove acts_as_asset_box() from #{klass.name}")
+        end
+
+        unless instance.respond_to?(box) || instance.respond_to?(boxes)
+          raise("expected #{klass.name} to has_one_attached :#{box} or has_many_attached :#{boxes}")
+        end
+
+        one = instance.respond_to?(box) && instance.send(box).kind_of?(ActiveStorage::Attached::One)
+        many = instance.respond_to?(boxes) && instance.send(boxes).kind_of?(ActiveStorage::Attached::Many)
+
+        unless one.present? || many.present?
+          raise("expected #{klass.name} to has_one_attached :#{box} or has_many_attached :#{boxes}")
+        end
+      end
+
+      puts 'All attachment classes verified.'
+
+      true
+    end
+
+    def reset!
+      Effective::Attachment.update_all(replaced: false)
+    end
+
+    private
+
+    def wait_for_active_job!
+      while(true)
+        if(jobs = enqueued_jobs_count) > (BATCH_SIZE / 10)
+          print '.'; sleep(3)
+        else
+          break
+        end
+      end
+    end
+
+    # The last BATCH_SIZE attachments
+    def attachments_to_process
+      Effective::Attachment.all
+        .includes(:asset)
+        .where(replaced: [nil, false])
+        .reorder(id: :desc)
+        .limit(BATCH_SIZE)
+    end
+
+    def enqueued_jobs_count
+      if Rails.application.config.active_job.queue_adapter == :sidekiq
+        Sidekiq::Stats.new.enqueued.to_i
+      else
+        ActiveJob::Base.queue_adapter.enqueued_jobs.count
+      end
+    end
+
+  end
+end

data/app/models/effective/snippet_replacer.rb

@@ -0,0 +1,67 @@
+# Replaces the [snippet_x] in all effective regions with static content
+
+module Effective
+  class SnippetReplacer
+    include ActiveStorage::Blob::Analyzable
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::AssetTagHelper
+
+    def replace!
+      raise('expected effective regions') unless defined?(Effective::Region)
+      raise('expected effective assets') unless defined?(Effective::Asset)
+      raise('expected active storage') unless defined?(ActiveStorage)
+
+      Effective::Region.with_snippets.find_each do |region|
+        Effective::SnippetReplacerJob.perform_later(region)
+      end
+
+      puts 'All Done. Background jobs are running. Have a great day.'
+      true
+    end
+
+    def replace_region!(region)
+      region.snippet_objects.each do |snippet|
+        print('.')
+
+        begin
+          case snippet.class.name
+          when 'Effective::Snippets::EffectiveAsset'
+            replace_effective_asset(region, snippet)
+          else
+            raise("unsupported snippet: #{snippet.class.name}")
+          end
+        rescue => e
+          puts "\nError: #{e}\n"
+          remove_snippet(region, snippet)
+        end
+      end
+
+      region.save!
+    end
+
+    def replace_effective_asset(region, snippet)
+      asset = snippet.asset
+      raise("Effective:Asset id=#{snippet.asset_id || 'none'} does not exist") unless asset.present?
+
+      blob = ActiveStorage::Blob.create_and_upload!(io: URI.open(asset.url), filename: asset.file_name)
+      url = Rails.application.routes.url_helpers.rails_blob_url(blob, only_path: true)
+
+      content = if asset.image?
+        image_tag(url, class: snippet.html_class, alt: snippet.link_title)
+      else
+        link_to(snippet.link_title, url, class: snippet.html_class, title: snippet.link_title)
+      end
+
+      region.content.sub!("[#{snippet.id}]", content.to_s)
+      region.snippets.delete(snippet.id)
+
+      true
+    end
+
+    def remove_snippet(region, snippet)
+      region.content.sub!("[#{snippet.id}]", '')
+      region.snippets.delete(snippet.id)
+    end
+
+  end
+end

data/lib/effective_assets/engine.rb

@@ -8,14 +8,18 @@ module EffectiveAssets
 
     # Include acts_as_addressable concern and allow any ActiveRecord object to call it
     initializer 'effective_assets.active_record' do |app|
-      ActiveSupport.on_load :active_record do
-        ActiveRecord::Base.extend(ActsAsAssetBox::ActiveRecord)
+      app.config.to_prepare do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.extend(ActsAsAssetBox::ActiveRecord)
+        end
       end
     end
 
     initializer 'effective_assets.action_view' do |app|
-      ActiveSupport.on_load :action_view do
-        ActionView::Helpers::FormBuilder.send(:include, AssetBoxFormInput)
+      app.config.to_prepare do
+        ActiveSupport.on_load :action_view do
+          ActionView::Helpers::FormBuilder.send(:include, AssetBoxFormInput)
+        end
       end
     end
 

data/lib/effective_assets/version.rb

@@ -1,3 +1,3 @@
 module EffectiveAssets
-  VERSION = '1.11.5'.freeze
+  VERSION = '1.12.2'.freeze
 end

data/lib/tasks/replace_effective_assets.rake

@@ -0,0 +1,5 @@
+# bundle exec rake replace_effective_assets
+desc 'Replaces effective_assets with ActiveStorage'
+task :replace_effective_assets => :environment do
+  Effective::AssetReplacer.new.replace!
+end

data/lib/tasks/replace_effective_snippets.rake

@@ -0,0 +1,5 @@
+# bundle exec rake replace_effective_snippets
+desc 'Replaces effective_assets snippets with ActiveStorage uploads'
+task :replace_effective_snippets => :environment do
+  Effective::SnippetReplacer.new.replace!
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_assets
 version: !ruby/object:Gem::Version
-  version: 1.11.5
+  version: 1.12.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -165,14 +165,17 @@ files:
 - app/controllers/effective/s3_uploads_controller.rb
 - app/helpers/effective_assets_helper.rb
 - app/helpers/effective_assets_s3_helper.rb
+- app/jobs/effective/asset_replacer_job.rb
 - app/jobs/effective/process_with_active_job.rb
 - app/jobs/effective/process_with_sucker_punch_job.rb
+- app/jobs/effective/snippet_replacer_job.rb
 - app/models/concerns/acts_as_asset_box.rb
 - app/models/effective/access_denied.rb
 - app/models/effective/asset.rb
+- app/models/effective/asset_replacer.rb
 - app/models/effective/attachment.rb
 - app/models/effective/iframe_upload.rb
-- app/models/effective/snippets/effective_asset.rb
+- app/models/effective/snippet_replacer.rb
 - app/uploaders/effective_assets_uploader.rb
 - app/uploaders/test_asset_uploader.rb
 - app/views/active_admin/effective_assets/_edit.html.haml
@@ -201,6 +204,8 @@ files:
 - lib/inputs/asset_box_input.rb
 - lib/inputs/asset_box_simple_form_input.rb
 - lib/tasks/effective_assets_tasks.rake
+- lib/tasks/replace_effective_assets.rake
+- lib/tasks/replace_effective_snippets.rake
 - lib/validators/asset_box_length_validator.rb
 - lib/validators/asset_box_presence_validator.rb
 homepage: https://github.com/code-and-effect/effective_assets

data/app/models/effective/snippets/effective_asset.rb

@@ -1,37 +0,0 @@
-if defined?(EffectiveRegions)
-  module Effective
-    module Snippets
-      class EffectiveAsset < Snippet
-        # attr_accessor :asset_id     #, Integer
-        # attr_accessor :html_class   #, String
-        # attr_accessor :link_title   #, String
-        # attr_accessor :private_url  # , Boolean
-
-        def snippet_attributes
-          super + [:asset_id, :html_class, :link_title, :private_url]
-        end
-
-        def asset
-          @asset ||= (Effective::Asset.where(:id => asset_id).first if asset_id)
-        end
-
-        def snippet_tag
-          :span
-        end
-
-        def private_url
-          super || aws_private?
-        end
-
-        def is_private?
-          [true, 'true', '1'].include?(private_url)
-        end
-
-        def aws_private?
-          (asset.try(:aws_acl) == EffectiveAssets::AWS_PRIVATE)
-        end
-
-      end
-    end
-  end
-end