omg-audit-group 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20e5522972e49c63dc37ea573d6f17b9a9f96c86c9ee754c688dc64d304273a7
-  data.tar.gz: 0f6d2979feaf9721716ed88a318707e279bfbadc32bf35c450ec69497d248f53
+  metadata.gz: 5feeb4940b13e67597f83165aeb3d0baa88cf42ee4d5691e6747a156ec593c9e
+  data.tar.gz: a11899134e6b74c55f005b989bad74455c4b60e3d9f3b31385c023dea85e11c2
 SHA512:
-  metadata.gz: ca13f29190d4020aafb6765a6f9294c9aa6f712bb6cfd0e9e86e9a902b8a3ba2767e5bb36c71a1d6026fc434df4ca6d11e5280be2b52ac5dfd3be859acdc6dcb
-  data.tar.gz: 75bb4c7909885993f31fe383b7c74598b4fc0ebf239e2c6b3a34eb8757ecc88242e23d58dd08e4d10a215f0341a7b7493d0f4740dfe3048c0df7b4812aa79369
+  metadata.gz: 87306868f208f8703297e011810d564699d383854e4f9bd9d0e547a6b1260d51bfaa70529858f52b13a69ef1ef2af2fb296323ff368fff17e606b1e10a39e453
+  data.tar.gz: 61de6f5955daa22904c777c30452adcd5d66eb125f8eeb076d73bee5e97829fbc2b873587ce647bd32c6eba0061906248399c52ae6ec6ef1996c8a93ae0e91be

data/lib/omg-audit-group.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'audited'
+
+class AuditGroup
+  class LockError < StandardError
+    def initialize
+      super('Request is locked and cannot be run again. If you want to add operations to an existing request_uuid, create a new instance')
+    end
+  end
+
+  class << self
+    attr_accessor :current
+
+    ##
+    # Updates `audited` gem to make every operation use the same `request_uuid`.
+    #
+    # @param request_uuid [String] The `request_uuid` to use for all operations within the block.
+    def set_request_uuid(request_uuid = SecureRandom.uuid)
+      Audited.store[:current_request_uuid] = request_uuid
+    end
+
+    ##
+    # Resets `audited` gem to generate a new `request_uuid` for each operation.
+    def unset_request_uuid
+      Audited.store.delete(:current_request_uuid)
+    end
+
+    ##
+    # Clears out any current `request_uuid` or AuditGroup request.
+    def reset
+      unset_request_uuid
+      @current = nil
+    end
+
+    ##
+    # Creates a new AuditGroup and runs operations to be all given the same `request_uuid`
+    #
+    # @yield operations whose audits should be associated with the same request_uuid.
+    def request(dry_run: false, &block)
+      new(dry_run: dry_run).request(&block)
+    end
+
+    def request_uuid
+      current.request_uuid
+    end
+
+    def audits
+      current.audits
+    end
+  end
+
+  attr_reader :block, :request_uuid, :dry_run, :locked
+
+  ##
+  # Creates a new AuditGroup instance and updates `AuditGroup.current` to it.
+  #
+  # @param request_uuid [String] What all audits within the group will have assigned as their request_uuid.
+  #   Useful if you want to group additional operations under a `request_uuid` that already exists in the DB.
+  # @param dry_run [Boolean] If true, the transaction will be rolled back after the block is executed.
+  # @yield operations whose audits should be associated with the same request_uuid.
+  def initialize(request_uuid = SecureRandom.uuid, dry_run: false, &block)
+    @request_uuid = request_uuid
+    @dry_run = dry_run
+    @locked = false
+
+    self.class.current = self
+
+    request(&block) if block_given?
+  end
+
+  ##
+  # Sets the `request_uuid` used by the `audited` store, runs the passed in block, then clears the `request_uuid`.
+  #   Subsequent `request` calls will also be given the same `request_uuid`.
+  #
+  # @yield operations whose audits should be associated with the same request_uuid.
+  # @return [AuditGroup] itself
+  def request(&block)
+    raise ArgumentError, 'No block given' unless block_given?
+    raise LockError if locked?
+
+    set_request_uuid
+
+    if dry_run?
+      ActiveRecord::Base.transaction do
+        block.call
+
+        # Calls .to_a to keep records in memory after rollback
+        @audits = audits.to_a
+
+        raise ActiveRecord::Rollback
+      end
+    else
+      block.call
+    end
+
+    lock!
+
+    self
+  ensure
+    unset_request_uuid
+  end
+
+  ##
+  # @return [Boolean] whether this request is a dry run and will therefore not persist changes.
+  def dry_run?
+    dry_run
+  end
+
+  ##
+  # @return [Boolean] whether this request has already been run and is therefore locked.
+  def locked?
+    locked
+  end
+
+  def lock!
+    @locked = true
+  end
+
+  ##
+  # Returns all associated audits. If `dry_run` is true, these will not be persistent in DB.
+  #
+  # @return [ActiveRecord::Relation] all audits associated with the request.
+  def audits
+    Audited::Audit.where(request_uuid: request_uuid)
+  end
+
+  def set_request_uuid
+    self.class.set_request_uuid(request_uuid)
+  end
+
+  def unset_request_uuid
+    self.class.unset_request_uuid
+  end
+
+  def current
+    self.class.current
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: omg-audit-group
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Matthew Greenfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-18 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -50,20 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
-description: Create, update, and delete records within a block, assign the same request_uuid
-  to them, and be able to easily view and undo them
+description: "Create, update, and delete records within a block, assign \nthe same
+  request_uuid to them, and be able to easily view \nand undo them\n"
 email:
 - mattgreenfield1@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/audit_group.rb
-homepage: https://github.com/omgreenfield/omg-util/tree/main/audit_group
+- lib/omg-audit-group.rb
+homepage: https://github.com/omgreenfield/audit-group
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/omgreenfield/omg-util/tree/main/audit_group
+  homepage_uri: https://github.com/omgreenfield/audit-group
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.17
 signing_key: 
 specification_version: 4
 summary: Groups transactions from the `audited` gem into a single request_uuid

data/lib/audit_group.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/all'
-require 'audited'
-
-class AuditGroup
-  VERSION = '0.1.3'
-
-  attr_reader :block, :request_uuid
-
-  delegate :current, :unset_request_uuid, to: :class
-
-  class << self
-    attr_accessor :current
-
-    delegate :request_uuid, :audits, to: :current
-
-    def set_request_uuid(request_uuid = SecureRandom.uuid)
-      Audited.store[:current_request_uuid] = request_uuid
-    end
-
-    def unset_request_uuid
-      Audited.store.delete(:current_request_uuid)
-    end
-
-    def reset
-      unset_request_uuid
-      @current = nil
-    end
-
-    def request(&block)
-      raise ArgumentError, 'No block given and no active group' unless block_given?
-
-      new.request(&block)
-    end
-  end
-
-  def initialize(request_uuid = SecureRandom.uuid)
-    @request_uuid = request_uuid
-    self.class.current = self
-  end
-
-  def request(&block)
-    set_request_uuid
-
-    block.call if block.present?
-
-    self
-  ensure
-    unset_request_uuid
-  end
-
-  def set_request_uuid
-    self.class.set_request_uuid(request_uuid)
-  end
-
-  def audits
-    Audited::Audit.where(request_uuid: request_uuid)
-  end
-end