cia 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 721b3ddd4c0d65f03c32681de80e18d7dc2709c9
-  data.tar.gz: 634c7289d85d4f7a8768e97abaec2a3acade6175
+SHA256:
+  metadata.gz: 800cc7be6c9f8e8287f0972939691bda201fce06afe9403c0d028410bb2f5d96
+  data.tar.gz: 0dd6a0d4b02b3c05fef5a4fd13dde1c409cb693d2780cd77859619b5e20f7896
 SHA512:
-  metadata.gz: 3757ab4bf222f509a11d10a084985eb7beffc34681a5076f26ad9471220bdf1f4283ccb6b999f2ba9a834ae09441b81f91bd1d7a59aacfd56be3ef9a72b4ca5e
-  data.tar.gz: 95b73f3e943191df350c9765716332638aa0cdd2975ec31465014f2bd1ba3a6007bcd7b2625b2620a9fb721d8be5650d6a3ecc5a3812b1e463b4c8df08f26f95
+  metadata.gz: 85a58c3adbd2e81c480e3b9dcd595b7bfef0f6ed337d4b83b3f196a411f3cf81715101a92efd27b86eddb2e4711cba5cd7539271425a4d8cd5c4adf9a9a96c47
+  data.tar.gz: 8068af8866e84e832503d0a2e45fcada45b082f13f8b29ea893151b71b0d8f041cf56ca657b289d80532e8a71105cb7d7c67185e37294d93a2c08b1e34e63fa7

data/Readme.md

@@ -5,7 +5,7 @@ Audit model actions like update/create/destroy/<custom> + attribute changes.
 
  - normalized and queryable through table layout
  - actors and subjects are polymorphic
- - works on ActiveRecord 3.2, 4.0 and 4.1
+ - works on ActiveRecord 5.2+
 
 Table layout:
 
@@ -22,6 +22,29 @@ gem install cia
 
 `rails g migration add_cia` + paste [Migration](https://raw.github.com/grosser/cia/master/MIGRATION.rb)
 
+Then, create these two models in `app/models/cia`:
+
+```ruby
+# app/models/cia/event.rb
+
+module CIA
+  class Event < ActiveRecord::Base
+    include EventMethods
+  end
+end
+```
+
+```ruby
+# app/models/cia/attribute_change.rb
+
+module CIA
+  class AttributeChange < ActiveRecord::Base
+    include AttributeChangeMethods
+  end
+end
+```
+
+If you’re using multiple databases, these models should inherit from an abstract class that specifies a database connection, not directly from ActiveRecord::Base.
 
 Usage
 =====
@@ -29,7 +52,7 @@ Usage
 ```Ruby
 class User < ActiveRecord::Base
   include CIA::Auditable
-  audited_attributes :email, :crypted_password
+  audit_attribute :email, :crypted_password
 end
 
 class ApplicationController < ActionController::Base
@@ -50,7 +73,7 @@ CIA.exception_handler = -> (e) { raise e unless Rails.env.production? }
 
 # conditional auditing
 class User < ActiveRecord::Base
-  audited_attributes :email, if: :interesting?
+  audit_attribute :email, if: :interesting?
 
   def interesting?
     ...
@@ -63,14 +86,14 @@ CIA.current_actor = @user
 # custom changes
 class User < ActiveRecord::Base
   def cia_changes
-    changes.merge("this" => ["always", "changes"])
+    super.merge("this" => ["always", "changes"])
   end
 end
 
 # using after_commit, useful if the CIA::Event is stored in a different database then the audited class
 class User < ActiveRecord::Base
   include CIA::Auditable
-  audited_attributes :email, :crypted_password, callback: :after_commit
+  audit_attribute :email, :crypted_password, callback: :after_commit
 end
 
 # passing arbitrary attributes into the .audit method
@@ -101,4 +124,4 @@ Author
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>
 License: MIT<br/>
-[![Build Status](https://travis-ci.org/grosser/cia.png)](https://travis-ci.org/grosser/cia)
+[![CI](https://github.com/grosser/cia/actions/workflows/actions.yml/badge.svg)](https://github.com/grosser/cia/actions/workflows/actions.yml)

data/lib/cia/attribute_change_methods.rb

@@ -0,0 +1,53 @@
+require "json"
+require_relative "./source_validation"
+
+module CIA
+  module AttributeChangeMethods
+    extend ActiveSupport::Concern
+    include SourceValidation
+    
+    included do
+      self.table_name = "cia_attribute_changes"
+
+      belongs_to :event, foreign_key: "cia_event_id", inverse_of: :attribute_changes
+      belongs_to :source, polymorphic: true
+
+      validates_presence_of :event, :attribute_name
+
+      scope :previous, lambda { order("id desc") }
+
+      delegate :created_at, to: :event
+    end
+
+    class_methods do
+      def on_attribute(attribute)
+        where(attribute_name: attribute)
+      end
+
+      def max_value_size
+        @max_value_size ||= (columns.detect { |c| c.name == "old_value" }.limit || 255)
+      end
+
+      def serialize_for_storage(item, &block)
+        raise "Pass me a block to reduce size" unless block_given?
+        before, json = nil
+
+        loop do
+          json = JSON.dump(item)
+          raise "The block did not reduce the size" if before && json.bytesize >= before
+          before = json.bytesize
+          break if max_value_size >= before
+          item = yield(item)
+        end
+
+        json
+      end
+    end
+
+    private
+
+    def source_must_be_present?
+      event.present? && event.source_must_be_present?
+    end
+  end
+end

data/lib/cia/auditable.rb

@@ -6,7 +6,15 @@ module CIA
     end
 
     def cia_changes
-      changes
+      if respond_to?(:has_changes_to_save?)
+        if has_changes_to_save?
+          changes_to_save
+        else
+          saved_changes
+        end
+      else
+        changes
+      end
     end
 
     def cia_previous_changes(changes=nil)

data/lib/cia/{event.rb → event_methods.rb}

@@ -1,16 +1,23 @@
+require_relative "./source_validation"
+
 module CIA
-  class Event < ActiveRecord::Base
+  module EventMethods
+    extend ActiveSupport::Concern
     include SourceValidation
-    self.table_name = "cia_events"
 
-    belongs_to :actor, polymorphic: true
-    belongs_to :source, polymorphic: true
-    has_many :attribute_changes, foreign_key: :cia_event_id, inverse_of: :event, dependent: :destroy
+    included do
+      self.table_name = "cia_events"
+      belongs_to :actor, polymorphic: true
+      belongs_to :source, polymorphic: true
+      has_many :attribute_changes, foreign_key: :cia_event_id, inverse_of: :event, dependent: :destroy
 
-    validates_presence_of :action
+      validates_presence_of :action
+    end
 
-    def self.previous
-      order("created_at desc")
+    class_methods do
+      def previous
+        order("created_at desc")
+      end
     end
 
     def attribute_change_hash

data/lib/cia/source_validation.rb

@@ -1,8 +1,9 @@
 module CIA
   module SourceValidation
-    def self.included(base)
-      base.validates_presence_of :source_id, :source_type, unless: :source_must_be_present?
-      base.validates_presence_of :source, if: :source_must_be_present?
+    extend ActiveSupport::Concern
+    included do
+      validates_presence_of :source_id, :source_type, unless: :source_must_be_present?
+      validates_presence_of :source, if: :source_must_be_present?
     end
   end
 end

data/lib/cia/version.rb

@@ -1,3 +1,3 @@
 module CIA
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/lib/cia.rb

@@ -1,12 +1,10 @@
 require 'active_record'
 require 'cia/version'
 require 'cia/auditable'
+require 'cia/event_methods'
+require 'cia/attribute_change_methods'
 
 module CIA
-  autoload 'Event', 'cia/event'
-  autoload 'AttributeChange', 'cia/attribute_change'
-  autoload 'SourceValidation', 'cia/source_validation'
-
   class << self
     attr_accessor :exception_handler
     attr_accessor :non_recordable_attributes

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: cia
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,34 +67,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.6.0
+description:
 email: michael@grosser.it
 executables: []
 extensions: []
@@ -116,16 +102,16 @@ extra_rdoc_files: []
 files:
 - Readme.md
 - lib/cia.rb
-- lib/cia/attribute_change.rb
+- lib/cia/attribute_change_methods.rb
 - lib/cia/auditable.rb
-- lib/cia/event.rb
+- lib/cia/event_methods.rb
 - lib/cia/source_validation.rb
 - lib/cia/version.rb
 homepage: https://github.com/grosser/cia
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,16 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Audit model events like update/create/delete + attribute changes + group
   them by transaction, in normalized table layout for easy query access.

data/lib/cia/attribute_change.rb

@@ -1,46 +0,0 @@
-require "json"
-
-module CIA
-  class AttributeChange < ActiveRecord::Base
-    include SourceValidation
-    self.table_name = "cia_attribute_changes"
-
-    belongs_to :event, foreign_key: "cia_event_id", inverse_of: :attribute_changes
-    belongs_to :source, polymorphic: true
-
-    validates_presence_of :event, :attribute_name
-
-    scope :previous, lambda { order("id desc") }
-
-    delegate :created_at, to: :event
-
-    def self.on_attribute(attribute)
-      where(attribute_name: attribute)
-    end
-
-    def self.max_value_size
-      @max_value_size ||= (columns.detect { |c| c.name == "old_value" }.limit || 255)
-    end
-
-    def self.serialize_for_storage(item, &block)
-      raise "Pass me a block to reduce size" unless block_given?
-      before, json = nil
-
-      loop do
-        json = JSON.dump(item)
-        raise "The block did not reduce the size" if before && json.bytesize >= before
-        before = json.bytesize
-        break if max_value_size >= before
-        item = yield(item)
-      end
-
-      json
-    end
-
-    private
-
-    def source_must_be_present?
-      event.present? && event.source_must_be_present?
-    end
-  end
-end