effective_developer 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d495b7c0e191545d03edac8297a4e6d70b0e73c60e3e750a7746a43a9c45ae0
-  data.tar.gz: fda29335818a87f2e76bd21c4f8018aab29833082682ca931339a127d7a9d1d0
+  metadata.gz: d5ec0b8ebeb89650bcd3faa9d72db0a63e59d412da44774ddf243cb41e2e27f9
+  data.tar.gz: 030ee9a657eecd09ecbe4b35340c7a50d05128b7320ad8b098449088bd9b55d9
 SHA512:
-  metadata.gz: 4bbed134e5bc6f0b78231501cd866a581a878dd4b5734ca74b480bfc49bc014c25a5e2a23074a62ccdc4ac90d40220ed6a7f5fb42a8c68c44979fd909d427635
-  data.tar.gz: b97abb74e30855a39100c9ca66785e89148bfda8e1cc427170b67767007078a5818e194adf34541806d6c4809a3b45bf1bfba97305bff663c4643c21c319d347
+  metadata.gz: 710dc72a3a8e31c031e7c357429e721ae4b550facca68fcf70054e6bcd1b3f6275e12619e4bbc5174e49077f6803290b6e5e2fe5c955a9d028630ff5815210ba
+  data.tar.gz: d57c9a3f9697100ea078dbd6de9be128935349ec98380da04336c0a0d24edd6699fa4286b14464b834ed85fb813f3da7c7f3a16e129506be80ee2bbe6c95b46e

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 Code and Effect Inc.
+Copyright 2021 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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/models/effective/asset_replacer.rb

@@ -0,0 +1,143 @@
+# 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'
+
+module Effective
+  class AssetReplacer
+    include ActiveStorage::Blob::Analyzable
+
+    BATCH_SIZE = 500
+    TIMEOUT = 120
+
+    def replace!(force: false)
+      verify!
+
+      attachments_to_process().find_in_batches(batch_size: BATCH_SIZE).each do |attachments|
+        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)
+
+          unless force
+            existing = Array(attachable.send(box))
+
+            if existing.any? { |obj| obj.respond_to?(:filename) && obj.filename.to_s == asset.file_name }
+              puts("Skipping: #{attachable.class.name} #{attachable.id} #{box} #{asset.file_name}. Already exists."); next
+            end
+          end
+
+          Effective::AssetReplacerJob.perform_later(attachment, box)
+        end
+      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.upgrading = true if attachable.respond_to?(:upgrading=)
+
+      Timeout.timeout(TIMEOUT) do
+        attachable.send(box).attach(
+          io: URI.open(asset.url),
+          filename: asset.file_name,
+          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(2)
+        else
+          break
+        end
+      end
+    end
+
+    def attachments_to_process
+      Effective::Attachment.all.where(replaced: [nil, false]).order(:id).where('id < ?', 10000)
+    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,66 @@
+# 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|
+        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
+
+      puts 'All Done. Have a great day.'
+      true
+    end
+
+    private
+
+    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_developer/engine.rb

@@ -2,6 +2,9 @@ module EffectiveDeveloper
   class Engine < ::Rails::Engine
     engine_name 'effective_developer'
 
+    config.autoload_paths += Dir["#{config.root}/models/jobs/"]
+    config.eager_load_paths += Dir["#{config.root}/models/jobs/"]
+
     # Set up our default configuration options.
     initializer 'effective_developer.defaults', before: :load_config_initializers do |app|
       # Set up our defaults, as per our initializer template

data/lib/effective_developer/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDeveloper
-  VERSION = '0.6.4'.freeze
+  VERSION = '0.6.5'.freeze
 end

data/lib/tasks/replace_assets.rake

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

data/lib/tasks/replace_snippets.rake

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_developer
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,12 +48,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/jobs/effective/asset_replacer_job.rb
 - app/models/effective/annotator.rb
+- app/models/effective/asset_replacer.rb
 - app/models/effective/code_writer.rb
 - app/models/effective/csv_importer.rb
 - app/models/effective/form_upgrader.rb
 - app/models/effective/live_generator.rb
 - app/models/effective/profiler.rb
+- app/models/effective/snippet_replacer.rb
 - config/effective_developer.rb
 - lib/effective_developer.rb
 - lib/effective_developer/engine.rb
@@ -101,6 +104,8 @@ files:
 - lib/tasks/effective_csv_importer.rake
 - lib/tasks/pg_pull.rake
 - lib/tasks/rename_class.rake
+- lib/tasks/replace_assets.rake
+- lib/tasks/replace_snippets.rake
 - lib/tasks/reset_pk_sequence.rake
 - lib/tasks/upgrade_forms.rake
 - lib/tasks/validate.rake