omg-audit-group 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aefcd1c0eb006272723f7ed68f14cd719e6480d833e9354730ee42340d6b814
-  data.tar.gz: 418949a9ea417499e1ff0566f1255940c273bcc5404311bfd4352eecc34b3196
+  metadata.gz: 8826c5193da34c27182b2f70bdf09828c3fbc9044a483540cba3ae491147e3ea
+  data.tar.gz: 46b18034462d5c30df7d028e3b4bb337e4bd221d522f430646b4b50304663c30
 SHA512:
-  metadata.gz: 1ef815f6b87adb3fe2df279b84dd94a7ff48f8075fa2e91292680b270bec764ff1800b38b90523d02c7f5ed92d936fcdc95bf56548a454f4e899ad9e47672f29
-  data.tar.gz: 7ce8a2a142907e59690af0cf912302aed6fe607cefd1b133b43520517a68dd1049845d6ef32155c73c088eaebe7ab4011899e3ed859ec48c8934567f788b2299
+  metadata.gz: 783b7104fd8427d4183c8d777f9c91ad0129a5b8a24e65a50a252061579d183756c926564fa8e75caa09ec6146206d5852f020af984ae29b1d49fb17e1c7219e
+  data.tar.gz: ae01514472dd81d6f209b2a5a3e99623a8e497687024aacc790073c71965b88c5512d75491a186449cda76105da4161c2737d1dfa45febf974aa8e4645a9ad10

data/README.md

@@ -2,19 +2,42 @@
 
 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
-gem build audit_group.gemspec
+rake build
 
 # Install gem
-gem i -l /path/to/this/repo/omg-audit_group-0.1.0.gem
+## From this directory
+rake install
+
+## From other directory
+gem i -l /path/to/this/folder/omg-audit-group-0.1.0.gem
 ```
 
 ## Usage
@@ -27,19 +50,34 @@ For convenience, the following operations are delegated from the `AuditGroup` mo
 - `request_uuid`
 - `audits`
 
-Here are some use cases:
+### Using class methods
 
 ```ruby
 # Group operations under the same request_uuid
 AuditGroup.request { perform_some_operations }
 
-# View the last request_uuid (the above also returns it)
+# 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

data/Rakefile

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

data/audit_group.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'lib/audit_group/version'
+require_relative 'lib/audit_group'
 
 Gem::Specification.new do |spec|
   spec.name = 'omg-audit-group'
@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['rubygems_mfa_required'] = 'true'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
@@ -32,7 +30,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 6.0', '< 8.0'
   spec.add_dependency 'audited', '>= 4.9', '< 6.0'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/audit_group.rb

@@ -1,13 +1,60 @@
 # frozen_string_literal: true
 
-require_relative 'audit_group/request'
-require_relative 'audit_group/version'
-
 require 'active_support/all'
 require 'audited'
 
-module AuditGroup
+class AuditGroup
+  VERSION = '0.1.1'
+
+  attr_reader :block, :request_uuid
+
+  delegate :current, :unset_request_uuid, to: :class
+
   class << self
-    delegate :new, :request, :current, :request_uuid, :audits, to: Request
+    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

data/spec/audit_group_spec.rb

@@ -1,44 +1,108 @@
-# frozen_string_literal: true
-
 RSpec.describe AuditGroup do
-  it 'has a version number' do
-    expect(AuditGroup::VERSION).not_to be_nil
-  end
+  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 '.new' do
-    it 'delegates to Request' do
-      expect(AuditGroup.new).to be_a(AuditGroup::Request)
+    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
-  end
 
-  describe '.request' do
-    it 'creates a new Request' do
-      request = AuditGroup.request { puts 'Hi, Mom!' }
+    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
 
-      expect(request).to be_a(AuditGroup::Request)
+    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
-  end
 
-  describe '.current' do
-    it 'returns the last created Request object' do
-      request = AuditGroup.request { puts 'Hi, Dad!' }
-      expect(AuditGroup.current).to eq(request)
+    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
-  end
 
-  describe '.request_uuid' do
-    it 'returns the current request_uuid' do
-      request = AuditGroup.request { puts 'Hi, Steve!' }
-      expect(AuditGroup.request_uuid).to eq(request.request_uuid)
+    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 '.audits' do
-    it 'delegates to Request' do
-      AuditGroup.request { puts "Who's Steve?" }
-      audited_audit = class_double('Audited::Audit').as_stubbed_const
-      expect(audited_audit).to receive(:where).with(request_uuid: an_instance_of(String)).and_return('some audits')
-      expect(AuditGroup.audits).to eq('some audits')
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omg-audit-group
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matthew Greenfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,11 +61,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - README.md
+- Rakefile
 - audit_group.gemspec
 - lib/audit_group.rb
-- lib/audit_group/request.rb
-- lib/audit_group/version.rb
-- spec/audit_group/request_spec.rb
 - spec/audit_group_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/omgreenfield/omg-util/tree/main/audit_group

data/lib/audit_group/request.rb

@@ -1,59 +0,0 @@
-require 'active_support/all'
-require 'audited'
-require 'pry-byebug'
-
-module AuditGroup
-  class Request
-    attr_reader :block, :request_uuid
-
-    delegate :current, :unset_request_uuid, to: :class
-
-    class << self
-      delegate :request_uuid, :audits, to: :current
-
-      attr_accessor :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
-end

data/lib/audit_group/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module AuditGroup
-  VERSION = "0.1.0"
-end

data/spec/audit_group/request_spec.rb

@@ -1,110 +0,0 @@
-require 'audit_group/request'
-
-RSpec.describe AuditGroup::Request 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