culturecode-track_changes 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740a90693ee8263535857c6037b35d1f005a3ad3e9f6e1d200b8db1fefa82a89
-  data.tar.gz: df7bbc71ddfd165f0cc2cb347284b6fcb4aa334b58699e24e7294a35d8a540e2
+  metadata.gz: 0c9bb5bdbc7a137501b16be9525858c58cd8665a673f0d81616e7ea08bda7c5b
+  data.tar.gz: 6b1b61340da3ca8e3af00f43cb8b4ed8fb634a03a5111301e9d30501258bccad
 SHA512:
-  metadata.gz: c06836667b94b7a4a873662a4ac105d4d4ad190b325c91f978147231d4cf107187c3d446f2e9d8250cb4e1a243166e712fed9a3c713c3bfe0db374620092db6d
-  data.tar.gz: 138ed42c7a8549ead7070afdc61fea6a0b00ea56745d2b3e906515eec785d81b73647a99eb0d5d80e608e3d0ebf9be404023caf4220d59b785609fcf1ae54587
+  metadata.gz: 458e536d0b57c406cc66b150b5be511a086aaf5b1fc6aad7e282d0aeb1d8bd4cfb1ce1296820ccfaf03098c25b6d38d6d8ddd4dbfce3195160c803666cd4b3da
+  data.tar.gz: da6901abda1bd01c87b01b0f7cc00be43226f0f7e29a1d480790542930d6a95e86d8a7d76b5a7c0d07839e79217d29a1eb9660318de29fbaf7f840775ec0d55f

data/README.md

@@ -24,6 +24,13 @@ class CreateTrackChangesTables < ActiveRecord::Migration
 end
 ```
 
+## Configuration
+
+```ruby
+TrackChanges::Configuration.cascade_destroy = false # Controls whether tracked changes are deleted when the record is deleted. Can be set to false if an audit trail of destroyed records is desired. Default: true
+TrackChanges::Configuration.serialize = false # Controls whether tracked changes are serialized as YAML before being written to the database. Can be set to false if the `state`, `from`, and `to` columns are JSON datatype instead of text. Default: true
+```
+
 ## Usage
 
 ```ruby
@@ -32,6 +39,11 @@ class Person < ActiveRecord::Base
 end
 ```
 
+```ruby
+Person.snapshot_all # Initialize snapshots for existing records so the next time the record is saved a diff can be generated.
+Person.tracked_change(status: "approved", assigned_to: "user_123") # Returns a list of diffs where specific attributes changed to the specified values.
+```
+
 ### Options
 By default all model attributes are tracked, except the primary_key, usually ```id```, ```created_at```, and ```updated_at```.
 

data/app/helpers/track_changes/diff_helper.rb

@@ -29,13 +29,14 @@ module TrackChanges
 
       if record = diff.record
         field_name = diff.record.class.human_attribute_name(field)
-        reflection = diff.record.class.reflections.values.detect {|reflection| reflection.foreign_key == field.to_s }
+        reflection = diff.record.class.reflect_on_association(field) # Look up association by name, e.g. users for has_many :users
+        reflection ||= diff.record.class.reflections.values.detect {|ref| ref.foreign_key == field.to_s } # Detect association by foreign key, e.g. user_id for belongs_to :user
       end
 
       if reflection
         primary_key = reflection.options.fetch(:primary_key, :id)
-        from = reflection.klass.find_by(primary_key => from) || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if from.present?
-        to   = reflection.klass.find_by(primary_key => to)   || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if to.present?
+        from = reflection.klass.where(primary_key => from) || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if from.present?
+        to   = reflection.klass.where(primary_key => to)   || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if to.present?
       end
 
       if from.blank?
@@ -49,8 +50,8 @@ module TrackChanges
 
     def link_diff_field_value(value, link_models = [])
       case value
-      when Array
-        value.collect{|v| link_diff_field_value(v, link_models) }.to_sentence.html_safe
+      when Array, ActiveRecord::Relation
+        safe_join(value.collect {|v| link_diff_field_value(v, link_models) }, ', ')
       when *link_models
         link_to(value.to_s, value)
       else

data/app/models/track_changes/diff.rb

@@ -4,8 +4,10 @@ module TrackChanges
 
     belongs_to :record, :polymorphic => true
 
-    serialize :from, Hash
-    serialize :to, Hash
+    if Configuration.serialize
+      serialize :from, Hash
+      serialize :to, Hash
+    end
 
     # Returns changes but only those where the string representation of the value has changed
     def visible_changes

data/app/models/track_changes/snapshot.rb

@@ -4,13 +4,26 @@ module TrackChanges
 
     belongs_to :record, :polymorphic => true
 
-    serialize :state, Hash
+    serialize :state, Hash if Configuration.serialize
 
     before_save :capture_record_state
 
     # Returns a hash of the current values for all tracked fields on the record
     def self.record_state(record)
-      Hash[record.class.track_changes_fields.collect {|method_name| [method_name, record.send(method_name)] }]
+      Hash[record.class.track_changes_fields.collect {|method_name| [method_name, dump_attribute_value(record.send(method_name))]   }]
+    end
+
+    def self.dump_attribute_value(value)
+      case value
+      when ActiveRecord::Relation
+        dump_attribute_value(value.to_a).sort
+      when Array
+        value.map {|member| dump_attribute_value(member) }
+      when ActiveRecord::Base
+        value.send(value.class.primary_key)
+      else
+        value
+      end
     end
 
     # Creates a diff object that shows the changes between this snapshot and the record's state
@@ -21,7 +34,7 @@ module TrackChanges
       to             = {}
 
       record.class.track_changes_fields.each do |key|
-        if snapshot_state.key?(key) && snapshot_state[key] != record_state[key]
+        if snapshot_state.key?(key) && snapshot_state[key] != record_state[key] # We check for the existence of the key in the snapshot before recording so we don't declare newly tracked attributes as "changed" on their first time recorded
           from[key] = snapshot_state[key]
           to[key] = record_state[key]
         end

data/lib/track_changes/configuration.rb

@@ -1,6 +1,6 @@
 module TrackChanges
-  module Configuration  
-    mattr_accessor :cascade_destroy # Destroy tracked changes when record is destroyed?
-    self.cascade_destroy = true
+  module Configuration
+    mattr_accessor :cascade_destroy, :default => true # Destroy tracked changes when record is destroyed?
+    mattr_accessor :serialize, :default => true # Serialize data in ruby before writing to the database. Not necessary if the diff and snapshot data columns are JSON.
   end
 end

data/lib/track_changes/model.rb

@@ -90,6 +90,27 @@ module TrackChanges
           new_record?
         end
       end
+
+      # Filters tracked change diffs to only those where the given attributes changed *to* the specified values.
+      #
+      # It builds a scope that matches records where each given attribute in `to` has the specified value.
+      #
+      # Example:
+      #   model.tracked_change(status: "approved", priority: "high")
+      #   # => returns diffs where status became "approved" and priority became "high"
+      #
+      # Params:
+      # - changes (keyword arguments): One or more attribute-value pairs to match against the `to` column.
+      #
+      # Returns:
+      # - ActiveRecord::Relation: A filtered scope on the diffs table.
+      def tracked_change(**changes)
+        table_name = diffs.quoted_table_name
+        column_name = diffs.connection.quote_column_name(:to)
+        changes.reduce(diffs) do |scope, (attribute, value)|
+          scope.where("#{table_name}.#{column_name} ->> ? = ?", attribute, value)
+        end
+      end
     end
   end
 end

data/lib/track_changes/version.rb

@@ -1,3 +1,3 @@
 module TrackChanges
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: culturecode-track_changes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Nicholas Jakobsen, Ryan Wallace
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,7 +64,6 @@ homepage: https://github.com/culturecode/track_changes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.23
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easily track changes to various ActiveRecord models
 test_files: []