effective_developer 0.6.3 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e76b8818691ec2238e08a818d209ba7e4d1746734ef3c7c2c2cbe8f4e08aa12
-  data.tar.gz: a283fca85ffd1c0dc6d73287bd6c239c898e6b6e2aa8500ebc08642960f7ad5f
+  metadata.gz: 5ca9f6ec3b73f4a7f2e31b382f9030769e13b82b43835bd7a74f4efa41a07c24
+  data.tar.gz: f21c929b19f4d9c4e645f90cc85cda28f4d0e3c1413689b294b7326bde095359
 SHA512:
-  metadata.gz: 0dc45f6f25c607353f5ea9651cda2054e2d6f2996fac603ebd37df05191d4a2d7981662e7e68681163856a566eeb452c4b0030623d130f2d33507bea36956548
-  data.tar.gz: 8a4ec7eab0237e8f0ac37a80e1cb7ea3974514b8228a6f8711a9fa00b66e0d2cecb5b22d336c28afd954bb916337b809a1205b8820d3637fb66574829710b73d
+  metadata.gz: 8ce3d22243ef79b452009c2e20e993bea861489b4cca95f4eba7d27f0fa11a305e272298d19cbd8fab2b829d1004b690202c6769dfab239f671e82ddcc49a524
+  data.tar.gz: 54fd14f769c558937de317edb4e00dc3114775a1f58b948fe5723bea590cecd1a0c9d7958aefac45b06a82558582b527f3bf0dd0224f6dc6d61fd3eabe6cfb61

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/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,156 @@
+# 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!(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: 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(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/form_upgrader.rb

@@ -0,0 +1,197 @@
+# Upgrades simple_form_for to effective_form_with
+module Effective
+  class FormUpgrader
+
+    def initialize(folder: 'app/views/')
+      @folders = Array(folder)
+    end
+
+    def upgrade!
+      @folders.each do |folder|
+        Dir.glob(folder + '**/*').each do |path|
+          next if File.directory?(path)
+          next unless path.include?('.html')
+
+          writer = Effective::CodeWriter.new(path)
+
+          name = path.split('/')[0...-1] - ['app', 'views']
+          resource = Effective::Resource.new(name)
+
+          if writer.find { |line| line.include?('simple_form_for') }
+            upgrade_simple_form(writer, resource)
+          elsif writer.find { |line| line.include?('semantic_form_for') }
+            upgrade_formtastic(writer, resource)
+          elsif writer.find { |line| line.include?('form_for') }
+            upgrade_form_for(writer, resource)
+          else
+            next # Nothing to do
+          end
+
+          writer.write!
+        end
+      end
+
+      puts 'All Done. Have a great day.'
+      true
+    end
+
+    private
+
+    SIMPLE_FORM_FOR_REGEX = /simple_form_for( |\()(\[:[^,]+, ?[^,]+\])?(([^,]+),)?.+do \|(\w+)\|/
+    SIMPLE_FORM_INPUT_ATTRIBUTE = /\.input( |\():(\w+)/
+    SIMPLE_FORM_INPUT_AS_ONE = /(as: :(\w+))/
+    SIMPLE_FORM_INPUT_AS_TWO = /(:as => :(\w+))/
+    SIMPLE_FORM_INPUT_COLLECTION_ONE = /(collection: ([^,]+?))(,|$)/
+    SIMPLE_FORM_INPUT_COLLECTION_TWO = /(:collection => :([^,]+?))(,|$)/
+
+    def upgrade_simple_form(writer, resource)
+      puts "Upgrading simple form: #{writer.filename}"
+
+      letter = nil
+      model = nil
+
+      # Replace simple_form_for
+      writer.all { |line| line.include?('simple_form_for') }.each do |line|
+        content = writer.lines[line]
+        matched = content.match(SIMPLE_FORM_FOR_REGEX)
+        raise("unable to match simple_form_for from:\n#{content}") unless matched.present?
+
+        original = matched[0]
+        model = matched[2] || matched[4]
+        letter = matched[5]
+
+        raise("unable to determine simple_form_for subject from:\n#{content}") unless original && model && letter
+
+        content.sub!(original, "effective_form_with(model: #{model}) do |#{letter}|")
+        writer.replace(line, content)
+      end
+
+      # Try to figure out klass again if its missing from filename
+      if resource.klass.blank? && model.present?
+        name = model.sub('[', '').sub(']', '').sub(' ', '').split(',').map do |value|
+          value.sub('current_', '').sub('@', '').sub(':', '')
+        end
+
+        resource = Effective::Resource.new(name)
+      end
+
+      if resource.klass.blank? && writer.filename.include?('/devise/')
+        resource = Effective::Resource.new('user')
+      end
+
+      if resource.klass.blank?
+        puts " => Warning: Unable to determine klass of #{model}"
+      end
+
+      # Replace .input
+      writer.all { |line| line.include?('.input :') }.each do |line|
+        content = writer.lines[line]
+        attribute = content.match(SIMPLE_FORM_INPUT_ATTRIBUTE)
+        raise("unable to match simple_form_for input attribute from\n#{content}") unless attribute.present?
+
+        as = content.match(SIMPLE_FORM_INPUT_AS_ONE) || content.match(SIMPLE_FORM_INPUT_AS_TWO)
+        collection = content.match(SIMPLE_FORM_INPUT_COLLECTION_ONE) || content.match(SIMPLE_FORM_INPUT_COLLECTION_TWO)
+
+        if as.present?
+          content.sub!(",#{as[0]}", '')
+          content.sub!(", #{as[0]}", '')
+        end
+
+        if collection.present?
+          content.sub!(",#{collection[0]}", ',')
+          content.sub!(", #{collection[0]}", ',')
+          content.sub!(attribute[0], "#{attribute[0]} #{collection[2]},")
+        end
+
+        input_type = find_input_type(resource: resource, attribute: attribute[2], as: (as[2] if as))
+
+        content.sub!('input', input_type)
+        writer.replace(line, content)
+      end
+
+      # Replace simple_fields_for
+      writer.all { |line| line.include?(".simple_fields_for") }.each do |line|
+        content = writer.lines[line]
+
+        content.sub!(".simple_fields_for", ".has_many")
+        writer.replace(line, content)
+      end
+
+      # Replace f.submit
+      writer.all { |line| line.include?("#{letter}.submit") }.each do |line|
+        content = writer.lines[line]
+
+        content.sub!("#{letter}.submit", "#{letter}.save")
+        writer.replace(line, content)
+      end
+
+      # Replace f.button :submit
+      writer.all { |line| line.include?(".button :submit,") }.each do |line|
+        content = writer.lines[line]
+
+        content.sub!(".button :submit,", ".submit")
+        writer.replace(line, content)
+      end
+
+      # Replace .form-actions
+      writer.all { |line| line == '.form-actions' }.each do |line|
+        content = writer.lines[line]
+
+        content.sub!('.form-actions', "= #{letter}.submit do")
+        writer.replace(line, content)
+      end
+    end
+
+    def upgrade_formtastic(writer, resource)
+      puts "Detected formtastic: #{writer.filename}"
+    end
+
+    def upgrade_form_for(writer, resource)
+      puts "Detected rails form_for: #{writer.filename}"
+    end
+
+    def find_input_type(attribute:, resource:, as: nil)
+      input_type = (as || resource.sql_type(attribute)).to_s
+
+      case input_type
+      when 'asset_box_simple_form' then 'file_field'
+      when 'belongs_to', 'belongs_to_polymorphic' then 'select'
+      when 'boolean' then 'check_box'
+      when 'check_boxes' then 'checks'
+      when 'date' then 'date_field'
+      when 'datetime' then 'datetime_field'
+      when 'decimal' then 'float_field'
+      when 'effective_ckeditor_text_area' then 'rich_text_area' # I guess
+      when 'effective_date_picker' then 'date_field'
+      when 'effective_date_time_picker' then 'datetime_field'
+      when 'effective_email' then 'email_field'
+      when 'effective_price' then 'price_field'
+      when 'effective_radio_buttons' then 'radios'
+      when 'effective_select' then 'select'
+      when 'effective_static_control' then 'static_field'
+      when 'effective_tel' then 'phone_field'
+      when 'effective_time_picker' then 'time_field'
+      when 'effective_url' then 'url_field'
+      when 'email' then 'email_field'
+      when 'file' then 'file_field'
+      when 'hidden' then 'hidden_field'
+      when 'integer' then 'number_field'
+      when 'number' then 'number_field'
+      when 'password' then 'password_field'
+      when 'phone' then 'phone_field'
+      when 'price' then 'price_field'
+      when 'radio_buttons' then 'radios'
+      when 'search' then 'search_field'
+      when 'select' then 'select'
+      when 'static_control' then 'static_field'
+      when 'string' then 'text_field'
+      when 'tel', 'telephone' then 'phone_field'
+      when 'text' then 'text_area'
+      when 'url' then 'url_field'
+      else
+        raise("unknown input type #{input_type} (for attribute :#{attribute})")
+      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_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.3'.freeze
+  VERSION = '0.6.7'.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

data/lib/tasks/upgrade_forms.rake

@@ -0,0 +1,7 @@
+# bundle exec rake upgrade_forms
+# bundle exec rake upgrade_forms[app/views/admin/]
+desc 'Upgrades simple_form_for to effective_form_with'
+task :upgrade_forms, [:folder] => :environment do |t, args|
+  args.with_defaults(folder: 'app/views/')
+  Effective::FormUpgrader.new(folder: args.folder).upgrade!
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_developer
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.7
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,11 +48,16 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/jobs/effective/asset_replacer_job.rb
+- app/jobs/effective/snippet_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
@@ -100,7 +105,10 @@ files:
 - lib/tasks/effective_csv_importer.rake
 - lib/tasks/pg_pull.rake
 - lib/tasks/rename_class.rake
+- lib/tasks/replace_effective_assets.rake
+- lib/tasks/replace_effective_snippets.rake
 - lib/tasks/reset_pk_sequence.rake
+- lib/tasks/upgrade_forms.rake
 - lib/tasks/validate.rake
 homepage: https://github.com/code-and-effect/effective_developer
 licenses: