omg-audit-group 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c376f111fedecd658dac64a321545b036c3a672cb8a7b4e8f6c443a90fbe74
-  data.tar.gz: d8c9fa53d36b22ef3b57c41bf11a73131e6c90ac8e011c45604b155025db7251
+  metadata.gz: c2103693c9d639bfce07ecae254b8df32a5571ed8084a141aa3b7d072ea62632
+  data.tar.gz: 8b49dfc610cacdf906fa910414064ad4cec032a14809512111e22c3f290c5e38
 SHA512:
-  metadata.gz: 50c5f348251c2c296f3f778eb3704992b2c459926c0f4814e8a13cba5906a90349844037316aa682840518ca990312d5317ab2efaef40423fd5c41f27cb5d5fa
-  data.tar.gz: 9f49b04443555acd365e821367d378b63e832a76e16b8cf86d82a5dcfcca2d4356323330fe67712d40820676c8cda8f935d5d92547a225cc82847486a73bea09
+  metadata.gz: 11d2bd4799f4680ca1b20487e64cd90292a2993c3741bceaa4301fc2adc273de765a346360fbc35268f078b18a334256571f59e7898b227918c4ef743a2aff57
+  data.tar.gz: 910a307b97833b1542ec839bb9b20c5cbc9732bbeb316accd78140a8e7d102894240ddf2e3227cbc2ee8e79172514eecf07048863dbd579cec120ee02deeb22c

data/lib/audit_group.rb

@@ -1,60 +1,141 @@
 # frozen_string_literal: true
 
-require 'active_support/all'
 require 'audited'
 
 class AuditGroup
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 
-  attr_reader :block, :request_uuid
-
-  delegate :current, :unset_request_uuid, to: :class
+  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
 
-    delegate :request_uuid, :audits, to: :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
 
-    def request(&block)
-      raise ArgumentError, 'No block given and no active group' unless block_given?
+    ##
+    # 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
 
-      new.request(&block)
+    def audits
+      current.audits
     end
   end
 
-  def initialize(request_uuid = SecureRandom.uuid)
+  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
 
-    block.call if block.present?
+    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
 
-  def set_request_uuid
-    self.class.set_request_uuid(request_uuid)
+  ##
+  # @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,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: omg-audit-group
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Matthew Greenfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: audited
   requirement: !ruby/object:Gem::Requirement
@@ -58,19 +58,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- README.md
-- Rakefile
-- audit_group.gemspec
 - lib/audit_group.rb
-- spec/audit_group_spec.rb
-- spec/spec_helper.rb
-homepage: https://github.com/omgreenfield/omg-util/tree/main/audit_group
+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,14 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-sandbox.md
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/README.md

@@ -1,98 +0,0 @@
-# AuditGroup
-
-Group ActiveRecord operations together by assigning all of their audits the same `request_uuid`.
-
-## TODO
-
-- [ ] Add `rails` as dependency instead of `active_support`
-- [ ] Add `dry_run` method
-
-## Requirements
-
-- [Audited](https://github.com/collectiveidea/audited) gem
-
-## Installation
-
-### From RubyGems.org
-
-#### Globally
-
-```sh
-gem i omg-audit-group
-```
-
-#### In `Gemfile`
-
-```ruby
-gem 'omg-audit-group'
-```
-
-### Testing locally
-```sh
-# Build gem
-rake build
-
-# Install gem
-## From this directory
-rake install
-
-## From other directory
-gem i -l /path/to/this/folder/omg-audit-group-0.1.0.gem
-```
-
-## Usage
-
-For convenience, the following operations are delegated from the `AuditGroup` module to the `AuditGroup::Request` class:
-
-- `new`
-- `request`
-- `current`
-- `request_uuid`
-- `audits`
-
-### Using class methods
-
-```ruby
-# Group operations under the same request_uuid
-AuditGroup.request { perform_some_operations }
-
-# View the last request_uuid
-AuditGroup.request_uuid
-
-# View the audits from the last request
-AuditGroup.audits
-```
-
-### Saving Request object for later use
-
-```ruby
-# Group operations under the same request_uuid
-request = AuditGroup.request { perform_some_operations }
-
-# View the last request_uuid
-request.request_uuid
-
-# View the audits from the last request
-request.audits
-```
-
-### Instantiating a group
-
-You can also create separate `AuditGroup::Request` objects to reuse.
-
-```ruby
-group = AuditGroup.new
-group.request { perform_some_operations }
-...
-group.request { perform_more_operations }
-group.audits
-```
-
-## Running tests
-
-```ruby
-rspec
-
-# or
-bundle exec rspec
-```

data/Rakefile

@@ -1,17 +0,0 @@
-require_relative 'lib/audit_group'
-
-require 'rake'
-
-task :spec do
-  sh 'bundle exec rspec'
-end
-
-task :build do
-  sh 'gem build audit_group.gemspec'
-end
-
-task :push do
-  sh "gem push omg-audit-group-#{AuditGroup::VERSION}.gem"
-end
-
-task :publish => :push

data/audit_group.gemspec

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/audit_group'
-
-Gem::Specification.new do |spec|
-  spec.name = 'omg-audit-group'
-  spec.version = AuditGroup::VERSION
-  spec.authors = ['Matthew Greenfield']
-  spec.email = ['mattgreenfield1@gmail.com']
-
-  spec.summary = 'Groups transactions from the `audited` gem into a single request_uuid'
-  spec.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'
-
-  spec.homepage = 'https://github.com/omgreenfield/omg-util/tree/main/audit_group'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[spec/.git .github Gemfile])
-    end
-  end
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activesupport', '>= 6.0', '< 8.0'
-  spec.add_dependency 'audited', '>= 4.9', '< 6.0'
-end

data/spec/audit_group_spec.rb

@@ -1,108 +0,0 @@
-RSpec.describe AuditGroup do
-  describe 'class methods' do
-    describe '.current' do
-      it 'returns the last request created' do
-        request = described_class.request {}
-        expect(described_class.current).to eq(request)
-      end
-    end
-
-    describe '.set_request_uuid' do
-      it "sets the Audit store's current_request_uuid" do
-        described_class.set_request_uuid('123')
-        expect(Audited.store[:current_request_uuid]).to eq('123')
-
-        described_class.set_request_uuid
-        expect(Audited.store[:current_request_uuid]).to match(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
-      end
-    end
-
-    describe '.unset_request_uuid' do
-      it "resets the Audit store's current_request_uuid" do
-        Audited.store[:current_request_uuid] = '123'
-        described_class.unset_request_uuid
-        expect(Audited.store[:current_request_uuid]).to be_nil
-      end
-    end
-
-    describe '.reset' do
-      it 'unsets the request_uuid and current request' do
-        described_class.set_request_uuid('123')
-        described_class.current = 'some request'
-
-        expect(Audited.store[:current_request_uuid]).to eq('123')
-        expect(described_class.current).to eq('some request')
-
-        described_class.reset
-
-        expect(Audited.store[:current_request_uuid]).to be_nil
-        expect(described_class.current).to be_nil
-      end
-    end
-
-    describe '.request' do
-      it 'raises an ArgumentError if no block is given and no active group' do
-        expect { described_class.request }.to raise_error(ArgumentError, 'No block given and no active group')
-      end
-
-      it 'creates a new request if block is given' do
-        expect { |block| described_class.request(&block) }.to yield_control
-      end
-    end
-
-    describe '.request_uuid' do
-      it 'delegates to current' do
-        described_class.request {}
-        expect(described_class.request_uuid).to eq(described_class.current.request_uuid)
-      end
-    end
-
-    describe '.audits' do
-      it 'delegates to current' do
-        described_class.new('123')
-        audited_audit = class_double('Audited::Audit').as_stubbed_const
-        expect(audited_audit).to receive(:where).with(request_uuid: '123').and_return('some audits')
-        expect(described_class.audits).to eq('some audits')
-      end
-    end
-  end
-
-  describe 'instance methods' do
-    describe '#initialize' do
-      it 'sets the request_uuid and current request' do
-        request = described_class.new('123')
-        expect(request.request_uuid).to eq('123')
-        expect(described_class.current).to eq(request)
-      end
-    end
-
-    describe '#request' do
-      it 'sets the current_request_uuid, calls the block, then resets current_request_uuid' do
-        request = described_class.new('123')
-
-        request.request do
-          expect(Audited.store[:current_request_uuid]).to eq('123')
-        end
-
-        expect(Audited.store[:current_request_uuid]).to be_nil
-      end
-    end
-
-    describe '#set_request_uuid' do
-      it 'delegates to class' do
-        request = described_class.new('123')
-        expect(request).to receive(:set_request_uuid)
-        request.set_request_uuid
-      end
-    end
-
-    describe '#audits' do
-      it 'returns audits with request_uuid' do
-        request = described_class.new('123')
-        audited_audit = class_double('Audited::Audit').as_stubbed_const
-        expect(audited_audit).to receive(:where).with(request_uuid: '123').and_return('some audits')
-        expect(request.audits).to eq('some audits')
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'audit_group'
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = '.rspec_status'
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end