effective_resources 2.26.5 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bddc24c74eb0d2e435dde9fd9db596d4bd9f84712122d5b29193164d0e3074d
-  data.tar.gz: b70b54824daeaa93e75b4fdcfccc0ba6c19a3506ce50938645b1825175aa8f7f
+  metadata.gz: 0a8d7a783095b227ca8e11253cb186f4b06c2fb7ec8b42511251d925bfddf7e0
+  data.tar.gz: 53038ae639dc8fe0b9aa0764232b0ba4af4b94afe8f6f686c516bbfbbf153d82
 SHA512:
-  metadata.gz: 752c5d16966bcce3f11a685709fbbbb913f7c9169b4a3b796211ac2f0b6ea4bebfc8c24450a1faaa14b9e2c1490c6e3f4333914c078f1f71769dabb3781086a6
-  data.tar.gz: 28ca623466c6fc2672e5ab2ee80c91feb3523cff88ef3367d5d5d1976d0da4d95a266579609a2e201097112dcdc7a8e65c2e735514ca3208b0f8797b05471631
+  metadata.gz: ff8d6145dc5cbbfb86170194d60e295a1c31face8480be9b3cd893afb17bd96b785bf2f886457e5082fb7c37f952d5f2842b551cafc98f493e3f4209b6adc1a9
+  data.tar.gz: f2e4c9e106f3a16490807df977089f1a40f51eb3f9abc6d9dc09dc85c863d818113035769417923384b43ea5c278685dc81de7108c3fe1d912c9862b8853cd91

data/app/models/concerns/acts_as_job_status.rb

@@ -0,0 +1,111 @@
+# ActsAsJobStatus
+#
+# Tracks the status of background jobs. Intended to be used in a wizard.
+#
+# Mark your model with 'acts_as_job_status' 
+#
+# Add the the following columns
+#
+# job_status            :string
+# job_started_at        :datetime
+# job_ended_at          :datetime
+# job_error             :text
+#
+# Use with_job_status in your background job
+
+module ActsAsJobStatus
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_job_status(options = nil)
+      include ::ActsAsJobStatus
+    end
+  end
+
+  included do
+  end
+
+  module ClassMethods
+    def acts_as_job_status?; true; end
+  end
+
+  # Instance Methods
+
+  def perform_with_job_status!(&block)
+    assign_attributes(job_status: nil, job_started_at: nil, job_ended_at: nil, job_error: nil)
+
+    after_commit { yield }
+
+    save!
+  end
+
+  def job_status_display_item_counts?
+    job_status_completed_items_count.present? && job_status_total_items_count.present?
+  end
+
+  def job_status_completed_items_count
+    nil
+  end
+
+  def job_status_total_items_count
+    nil
+  end
+
+  def job_status_enqueued?
+    job_status == 'enqueued'
+  end
+
+  def job_status_running?
+    job_status == 'running'
+  end
+
+  def job_status_completed?
+    job_status == 'completed'
+  end
+
+  def job_status_error?
+    job_status == 'error'
+  end
+
+  def with_job_status(&block)
+    self.class.where(id: id).update_all(
+      job_status: :running,
+      job_started_at: Time.zone.now,
+      job_ended_at: nil,
+      job_error: nil
+    )
+
+    exception = nil
+    job_status = nil
+    job_error = nil
+
+    begin
+      success = yield
+      raise('Unexpected error') unless success
+
+      job_status = :completed
+    rescue Exception => e
+      exception = e
+      job_status = :error
+      job_error = e.message.presence || 'Unexpected error'
+    end
+
+    self.class.where(id: id).update_all(
+      job_status: job_status, 
+      job_ended_at: Time.zone.now, 
+      job_error: job_error
+    )
+
+    if job_status == :error
+      EffectiveLogger.error(exception.message, associated: self) if defined?(EffectiveLogger)
+      ExceptionNotifier.notify_exception(exception, data: { id: id, class_name: self.class.name }) if defined?(ExceptionNotifier)
+    end
+
+    if job_status == :error && !ENV['TESTING_ACTS_AS_JOB_STATUS']
+      raise(exception) unless Rails.env.production? || Rails.env.staging?
+    end
+
+    true
+  end
+
+end

data/app/models/concerns/acts_as_published.rb

@@ -23,7 +23,7 @@ module ActsAsPublished
     attr_writer :save_as_draft
 
     before_validation(if: -> { EffectiveResources.falsey?(@save_as_draft) && (@save_as_draft.present? || new_record?) }) do
-      self.published_start_at ||= Time.zone.now
+      self.published_start_at ||= Time.zone.now.beginning_of_day
     end
 
     before_validation(if: -> { EffectiveResources.truthy?(@save_as_draft) }) do
@@ -48,6 +48,24 @@ module ActsAsPublished
   end
 
   # Instance Methods
+  def publish!
+    now = Time.zone.now
+
+    if published_start_at.blank? || published_start_at > now
+      assign_attributes(published_start_at: now.beginning_of_day) 
+    end
+
+    if published_end_at.present? && (published_end_at <= now || published_end_at <= published_start_at)
+      assign_attributes(published_end_at: nil)
+    end
+
+    save!
+  end
+
+  def draft!
+    update!(published_start_at: nil, published_end_at: nil)
+  end
+
   def published?
     return false if published_start_at.blank? || published_start_at > Time.zone.now
     return false if published_end_at.present? && published_end_at <= Time.zone.now

data/app/views/effective/acts_as_job_status/_wizard_step.html.haml

@@ -0,0 +1,48 @@
+- if [nil, 'enqueued', 'running'].include?(resource.job_status)
+  %p The background job is running. Please wait.
+
+  %p.text-center
+    = icon('spinner')
+
+  - if resource.job_status_display_item_counts?
+    - completed = resource.job_status_completed_items_count
+    - total = resource.job_status_total_items_count
+    - percent = ((completed * 100).to_f / [total, 1].max).round(0)
+
+    .progress
+      .progress-bar{role: 'progressbar', 'aria-valuenow': completed, 'aria-valuemin': 0, 'aria-valuemax': total, style: "width: #{percent}%"}
+
+    %p.text-center
+      Completed #{completed} out of #{pluralize(total, 'item')} so far
+
+  :javascript
+    setTimeout(function() { window.location.reload(true) }, 5000);
+
+  %p.text-center
+    = link_to 'Refresh', wizard_path(step), class: 'btn btn-secondary'
+
+  %p.text-center
+    %small
+      %em This page will auto refresh every 5 seconds.
+
+- if resource.job_status_error?
+  %p The following error was encountered when running the background job:
+
+  .alert.alert-danger.my-4
+    = resource.job_error.html_safe
+
+  %p Please fix any error, then try again.
+
+  %p.text-center
+    = link_to 'Try Again', wizard_path(resource.previous_step(step)), class: 'btn btn-secondary'
+
+- if resource.job_status_completed?
+  %p.text-center
+    = icon('check')
+
+  %p.text-center
+    Job complete!
+
+    - if resource.job_status_display_item_counts?
+      = pluralize(resource.job_status_completed_items_count, 'item')
+      have been completed.

data/lib/effective_resources/effective_gem.rb

@@ -86,9 +86,23 @@ module EffectiveGem
       raise('gem does not respond to mailer_class') unless respond_to?(:mailer_class)
       raise('expected args to be an Array') unless args.kind_of?(Array)
 
-      mailer_class.send(email, *args).send(deliver_method)
-    end
+      begin
+        mailer_class.send(email, *args).send(deliver_method)
+      rescue => e
+        associated = args.first
+
+        if associated.kind_of?(ActiveRecord::Base)
+          EffectiveLogger.error(e.message, associated: associated, details: { email: email }) if defined?(EffectiveLogger)
+          ExceptionNotifier.notify_exception(e, data: { email: email, associated_id: associated.id, associated_type: associated.class.name }) if defined?(ExceptionNotifier)
+        else
+          args_to_s = args.to_s.gsub('<', '').gsub('>', '')
+          EffectiveLogger.error(e.message, details: { email: email, args: args_to_s }) if defined?(EffectiveLogger)
+          ExceptionNotifier.notify_exception(e, data: { email: email, args: args_to_s }) if defined?(ExceptionNotifier)
+        end
 
+        raise(e) unless Rails.env.production? || Rails.env.staging?
+      end
+    end
   end
 
 end

data/lib/effective_resources/engine.rb

@@ -23,6 +23,7 @@ module EffectiveResources
     initializer 'effective_resources.active_record' do |app|
       app.config.to_prepare do
         ActiveRecord::Base.extend(ActsAsArchived::Base)
+        ActiveRecord::Base.extend(ActsAsJobStatus::Base)
         ActiveRecord::Base.extend(ActsAsEmailForm::Base)
         ActiveRecord::Base.extend(ActsAsEmailNotification::Base)
         ActiveRecord::Base.extend(ActsAsTokened::Base)

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '2.26.5'.freeze
+  VERSION = '2.27.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 2.26.5
+  version: 2.27.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_developer
+  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: haml
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,7 @@ files:
 - app/models/concerns/acts_as_archived.rb
 - app/models/concerns/acts_as_email_form.rb
 - app/models/concerns/acts_as_email_notification.rb
+- app/models/concerns/acts_as_job_status.rb
 - app/models/concerns/acts_as_paginable.rb
 - app/models/concerns/acts_as_published.rb
 - app/models/concerns/acts_as_purchasable_wizard.rb
@@ -259,6 +274,7 @@ files:
 - app/views/application/update.js.erb
 - app/views/effective/acts_as_email_form/_fields.html.haml
 - app/views/effective/acts_as_email_notification/_fields.html.haml
+- app/views/effective/acts_as_job_status/_wizard_step.html.haml
 - app/views/effective/acts_as_published/_fields.html.haml
 - app/views/effective/acts_as_slugged/_fields.html.haml
 - app/views/effective/acts_as_wizard/_wizard_step.html.haml