duffy_log 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1ca47085a6b83d1df4421f75264659cfd0aaa2dea7228685a1ff1cc553a8cb
-  data.tar.gz: 1c99dc9adfe6f145e79f94d6028bc26d634523b4878a41eccee3de3dda39e863
+  metadata.gz: 0f67328fc570d1f2b751c9db0e63d69e63c2c57bc7f63f845b926efd289b5260
+  data.tar.gz: fb9c10e330b375637ffb13f16a22b84f3fb2f62d5fdad806db7a3a487edcc2ba
 SHA512:
-  metadata.gz: b7f8448737deff737c64222318278e694c904d91bc4fa2cd2da23005ea08c0e82784d231a5f43603dfc05e3caafc9f7f2ed92c15feee1beb3cc7c6cec1050f1b
-  data.tar.gz: b09cfff025a1b672b9a4e1e53c28bb4425a335096cf24efdaff929c61dede12c25625ad3cccb446bd8c5ca1c5bd80fedcb6046597710efd9a553e8ced2d3f845
+  metadata.gz: 5540d51483c31bee05e07e2ea08ca4bbd470f67eeb3281e599fc30e0873252e5481e9da335318b0f3cd38b75ab09bebb8d07f909e32701387676712fed3ace2e
+  data.tar.gz: ea375f339f35df1364f4277e16869c70d45ad2d043c7aa16ce14b9120c0a6b2bc05fc61cd978d80b0de6e7e2d9b37523f370e174c3ae3dc8b61aada1ee3f2f1c

data/app/models/concerns/process_log_base.rb

@@ -0,0 +1,109 @@
+module ProcessLogBase
+  extend ActiveSupport::Concern
+
+  included do
+
+    # Validations
+    validates :key,         presence: true
+    validates :start_time,  presence: true
+    validates :status,      presence: true
+
+    # Callbacks
+    after_initialize  :defaults
+    before_save       { self.elapsed          = end_time && end_time - start_time }
+    before_save       { self.average_elapsed  = siblings.completed.sorted.limit(10).average(:elapsed) }
+
+
+    # Scopes
+    scope :completed, -> { where.not(elapsed: nil) }
+    scope :failed,    -> { where(status: 'Fail') }
+    scope :sorted,    -> { order(start_time: :desc) }  # Newest first
+
+
+    # Methods
+
+
+    def completed?
+      !!read_attribute(:elapsed)
+    end
+
+    def elapsed
+      super || [(Time.now - start_time).to_i, 86400].min
+    rescue
+      0 # Prevent an invalid record from causing problems.
+    end
+
+    # Fail the Process Log.
+    # Pass in nothing for no comment or backtrace
+    # Pass in the Exception itself to automatically extract.
+    # Pass in comment and/or backtrace to set/overwrite.
+    def fail!(exception = nil, comment: nil, backtrace: nil)
+      self.status = "Fail"
+      self.end_time = Time.now
+
+      unless exception.blank?
+        self.comment = exception.to_s
+        self.backtrace = exception.backtrace.join("\n")
+      end
+
+      # Manually passed named arguments overwrite exception if that was also provided.
+      self.comment    = comment unless comment.blank?
+      self.comment  ||= 'Fail'
+      self.backtrace  = Array(backtrace).join("\n") unless backtrace.blank?
+
+      save
+    end
+
+    def fail?
+      status == "Fail"
+    end
+
+    def local_end
+      end_time&.localtime&.strftime("%F %-l:%M%P")
+    end
+
+    def local_start
+      start_time&.localtime&.strftime("%F %-l:%M%P")
+    end
+
+    def progress
+      success? ? 100 : [99, (100 * elapsed / average_elapsed).to_i].min rescue "?"
+    end
+
+    def siblings
+      ProcessLog.where(key: key)
+    end
+
+    def started?
+      status == "Started"
+    end
+
+    def status
+      elapsed >= 86400 ? "Fail" : super
+    end
+
+    def success!
+      self.status = "Success" unless status == "Fail"
+      self.end_time = Time.now
+      save!
+    end
+
+    def success?
+      status == "Success"
+    end
+
+    def to_s
+      key.to_s
+    end
+
+    private
+
+    # Initialize defaults only on create
+    def defaults
+      return if persisted?
+      self.start_time     ||= Time.now
+      self.status         ||= 'Started'
+    end
+
+  end
+end

data/app/models/process_log.rb

@@ -1,91 +1,3 @@
 class ProcessLog < ApplicationRecord
-
-  validates :key,         presence: true
-  validates :start_time,  presence: true
-  validates :status,      presence: true
-
-  before_validation { self.start_time     ||= Time.now }
-  before_validation { self.status         ||= "Started" }
-  before_save       { self.elapsed          = end_time && end_time - start_time }
-  before_save       { self.average_elapsed  = siblings.completed.sorted.limit(10).average(:elapsed) }
-
-
-  # Scopes
-  scope :completed, -> { where.not(elapsed: nil) }
-  scope :sorted,    -> { order(start_time: :desc) }  # Newest first
-
-
-  # Methods
-
-  def completed?
-    !!elapsed
-  end
-
-  def elapsed
-    super || [(Time.now - start_time).to_i, 86400].min
-  end
-
-  # Fail the Process Log.
-  # Pass in nothing for no comment or backtrace
-  # Pass in the Exception itself to automatically extract.
-  # Pass in comment and/or backtrace to set/overwrite.
-  def fail!(exception = nil, comment: nil, backtrace: nil)
-    self.status = "Fail"
-    self.end_time = Time.now
-
-    unless exception.blank?
-      self.comment = exception.to_s
-      self.backtrace = exception.backtrace.join("\n")
-    end
-
-    # Manually passed named arguments overwrite exception if that was also provided.
-    self.comment    = comment unless comment.blank?
-    self.comment  ||= 'Fail'
-    self.backtrace  = Array(backtrace).join("\n") unless backtrace.blank?
-
-    save
-  end
-
-  def fail?
-    status == "Fail"
-  end
-
-  def local_end
-    end_time&.localtime&.strftime("%F %-l:%M%P")
-  end
-
-  def local_start
-    start_time&.localtime&.strftime("%F %-l:%M%P")
-  end
-
-  def progress
-    success? ? 100 : [99, (100 * elapsed / average_elapsed).to_i].min rescue "?"
-  end
-
-  def siblings
-    ProcessLog.where(key: key)
-  end
-
-  def started?
-    status == "Started"
-  end
-
-  def status
-    elapsed >= 86400 ? "Fail" : super
-  end
-
-  def success!
-    self.status = "Success" unless status == "Fail"
-    self.end_time = Time.now
-    save!
-  end
-
-  def success?
-    status == "Success"
-  end
-
-  def to_s
-    key
-  end
-
+  include ProcessLogBase
 end

data/lib/duffy_log/version.rb

@@ -1,3 +1,8 @@
 module DuffyLog
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end
+
+# CHANGELOG
+#
+# 1.1.0   Non-breaking refactor of ProcessLog logic into Concern for easier host_app extension.
+# 1.0.0   Initial Release

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duffy_log
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jacob Duffy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -105,6 +105,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/process_logs_controller.rb
+- app/models/concerns/process_log_base.rb
 - app/models/process_log.rb
 - app/views/process_logs/_form.html.erb
 - app/views/process_logs/edit.html.erb