culturecode-track_changes 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cfddea8f7f37242ef70cad9d17b2bbbea5d610a6
-  data.tar.gz: 250ab77746cd7991f5eabe04b71dffec39be896a
+SHA256:
+  metadata.gz: 740a90693ee8263535857c6037b35d1f005a3ad3e9f6e1d200b8db1fefa82a89
+  data.tar.gz: df7bbc71ddfd165f0cc2cb347284b6fcb4aa334b58699e24e7294a35d8a540e2
 SHA512:
-  metadata.gz: 8f29bda1a82ad609e32868a3611be8ab996c52f496ff4b3150e64a46e6fbd0d6fc03d129b1bd4faae386b01a2e028154ac1e9922f1aa505c1c7ba83f1215d75c
-  data.tar.gz: 9da20ea1201d384476e2ab94d07cc577f1f419ec9dcd9a0190cf1074a861f168121f60c8e7a057a27f167f601e7fa01f5dc115848a19b6b1350911ba4d139cc3
+  metadata.gz: c06836667b94b7a4a873662a4ac105d4d4ad190b325c91f978147231d4cf107187c3d446f2e9d8250cb4e1a243166e712fed9a3c713c3bfe0db374620092db6d
+  data.tar.gz: 138ed42c7a8549ead7070afdc61fea6a0b00ea56745d2b3e906515eec785d81b73647a99eb0d5d80e608e3d0ebf9be404023caf4220d59b785609fcf1ae54587

data/README.md

@@ -40,6 +40,8 @@ By default all model attributes are tracked, except the primary_key, usually ```
 - ```:methods``` accepts a field name or array of field names to track in addition to the default fields
 - ```:track_timestamps``` accepts a boolean, enabling or disabling tracking of ```created_at``` and ```updated_at```
 - ```:track_primary_key``` accepts a boolean, enabling or disabling tracking of the model's primary key
+- ```:track_locking_column``` accepts a boolean, enabling or disabling tracking of the model's locking column
+
 
 ### Attribution
 Changes can be attributed to a particular source. The source is saved as a string
@@ -48,7 +50,8 @@ the record's id will be used.
 
 ```ruby
 # Model-level attribution
-person.save(:changes_by => 'Joe Changems')
+person.track_changes_by = 'Joe Changems'
+person.save
 
 # Block-level attribution
 TrackChanges.with_changes_attributed_to 'Joe Changems' do

data/app/helpers/track_changes/diff_helper.rb

@@ -33,8 +33,9 @@ module TrackChanges
       end
 
       if reflection
-        from = reflection.klass.find_by_id(from) || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if from.present?
-        to   = reflection.klass.find_by_id(to)   || content_tag(:span, 'DELETED', :class => 'deleted', :title => "This #{field_name} has been deleted") if to.present?
+        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?
       end
 
       if from.blank?

data/app/models/track_changes/diff.rb

@@ -7,6 +7,11 @@ module TrackChanges
     serialize :from, Hash
     serialize :to, Hash
 
+    # Returns changes but only those where the string representation of the value has changed
+    def visible_changes
+      changes.select {|key, (from, to)| (from.present? || to.present?) && (from.to_s != to.to_s) }
+    end
+
     # Returns a hash of changes where the key is the field name
     # and the value is an array of the from value and the to value
     def changes

data/lib/track_changes/configuration.rb

@@ -0,0 +1,6 @@
+module TrackChanges
+  module Configuration  
+    mattr_accessor :cascade_destroy # Destroy tracked changes when record is destroyed?
+    self.cascade_destroy = true
+  end
+end

data/lib/track_changes/engine.rb

@@ -1,3 +1,4 @@
+require 'track_changes/configuration'
 require 'track_changes/model'
 require 'track_changes/controller'
 require 'track_changes/attribution'

data/lib/track_changes/model.rb

@@ -11,8 +11,10 @@ module TrackChanges
         attr_accessor :track_changes # Faux attribute to allow disabling of change tracking on this record
         attr_writer   :track_changes_by # Faux attribute to store who made the changes so we can save it in the diff
 
-        has_one :snapshot, :as => :record, :class_name => 'TrackChanges::Snapshot' # A representation of this record as it was last saved
-        has_many :diffs, lambda { reorder('id DESC') }, :as => :record, :class_name => 'TrackChanges::Diff' # A representation of changes made between saves through this record's lifetime
+        # A representation of this record as it was last saved
+        has_one :snapshot, :as => :record, :class_name => 'TrackChanges::Snapshot', :dependent => Configuration.cascade_destroy ? :destroy : nil
+        # A representation of changes made between saves through this record's lifetime
+        has_many :diffs, lambda { reorder('id DESC') }, :as => :record, :class_name => 'TrackChanges::Diff', :dependent => Configuration.cascade_destroy ? :delete_all : nil
 
         after_save :persist_tracked_changes
       end
@@ -21,11 +23,18 @@ module TrackChanges
     module ClassMethods
       # Returns the method names to call to fetch the fields tracked for changes
       def track_changes_fields
-        fields =  Array(track_changes_options[:only]).collect(&:to_s).presence || self.attribute_names
+        fields =  Array(track_changes_options[:only]).collect(&:to_s).presence || default_track_changes_fields
         fields -= Array(track_changes_options[:except]).collect(&:to_s)
         fields += Array(track_changes_options[:methods]).collect(&:to_s)
         fields -= ['created_at', 'updated_at'] unless track_changes_options[:track_timestamps]
         fields -= [primary_key] unless track_changes_options[:track_primary_key]
+        fields -= [locking_column] unless track_changes_options[:track_locking_column]
+
+        return fields.uniq
+      end
+
+      def default_track_changes_fields
+        attribute_names - stored_attributes.keys.map(&:to_s) + stored_attributes.values.flatten.map(&:to_s)
       end
 
       # Create snapshots for all records so that the next changes made are captured
@@ -36,11 +45,18 @@ module TrackChanges
         # Create new snapshots
         where.not(:id => joins(:snapshot)).find_each(&:create_snapshot)
       end
+
+      # Record a diff and update the snapshot for all records in the scope
+      # This can be used to record a diff after an `update_all`.
+      def persist_tracked_changes(track_changes_by: nil)
+        find_each do |record|
+          record.track_changes_by = track_changes_by
+          record.persist_tracked_changes
+        end
+      end
     end
 
     module InstanceMethods
-      private
-
       def track_changes_by
         @track_changes_by || TrackChanges.default_attribution
       end
@@ -49,7 +65,7 @@ module TrackChanges
       def persist_tracked_changes
         return if track_changes == false
 
-        new_record = id_was.blank?
+        new_record = was_new_record_before_save?
         action     = new_record ? 'create' : 'update'
         changes_by = track_changes_by.is_a?(ActiveRecord::Base) ? track_changes_by.id : track_changes_by
 
@@ -64,6 +80,16 @@ module TrackChanges
           snapshot.create_diff(:action => action, :changes_by => changes_by, :from => {})
         end
       end
+
+      def was_new_record_before_save?
+        if !respond_to?(:attribute_before_last_save) # Rails < 6
+          id_was.blank?
+        elsif saved_change_to_attribute?(:id) # Rails <=5
+          attribute_before_last_save(:id).blank?
+        else # Allow this method to be used outside of a transaction, e.g. after a bulk update
+          new_record?
+        end
+      end
     end
   end
 end

data/lib/track_changes/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: culturecode-track_changes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Nicholas Jakobsen, Ryan Wallace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,7 @@ files:
 - lib/tasks/track_changes_tasks.rake
 - lib/track_changes.rb
 - lib/track_changes/attribution.rb
+- lib/track_changes/configuration.rb
 - lib/track_changes/controller.rb
 - lib/track_changes/engine.rb
 - lib/track_changes/model.rb
@@ -79,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.3.23
 signing_key: 
 specification_version: 4
 summary: Easily track changes to various ActiveRecord models