Ensure enum changes are stored consistently

CHANGELOG.md

@@ -24,7 +24,8 @@ Changed
 
 Fixed
 
-- None
+- Ensure enum changes are stored consistently
+  [#429](https://github.com/collectiveidea/audited/pull/429)
 
 ## 4.7.0 (2018-03-14)
 

lib/audited/auditor.rb

@@ -142,7 +142,8 @@ def revision_at(date_or_time)
 
       # List of attributes that are audited.
       def audited_attributes
-        attributes.except(*self.class.non_audited_columns)
+        audited_attributes = attributes.except(*self.class.non_audited_columns)
+        normalize_enum_changes(audited_attributes)
       end
 
       # Returns a list combined of record audits and associated audits.
@@ -196,11 +197,35 @@ def revision_with(attributes)
 
       def audited_changes
         all_changes = respond_to?(:changes_to_save) ? changes_to_save : changes
-        if audited_options[:only].present?
-          all_changes.slice(*self.class.audited_columns)
-        else
-          all_changes.except(*self.class.non_audited_columns)
+        filtered_changes = \
+          if audited_options[:only].present?
+            all_changes.slice(*self.class.audited_columns)
+          else
+            all_changes.except(*self.class.non_audited_columns)
+          end
+
+        filtered_changes = normalize_enum_changes(filtered_changes)
+        filtered_changes.to_hash
+      end
+
+      def normalize_enum_changes(changes)
+        self.class.defined_enums.each do |name, values|
+          if changes.has_key?(name)
+            changes[name] = \
+              if changes[name].is_a?(Array)
+                changes[name].map { |v| values[v] }
+              elsif rails_below?('5.0')
+                changes[name]
+              else
+                values[changes[name]]
+              end
+          end
         end
+        changes
+      end
+
+      def rails_below?(rails_version)
+        Gem::Version.new(Rails::VERSION::STRING) < Gem::Version.new(rails_version)
       end
 
       def audits_to(version = nil)

spec/audited/auditor_spec.rb

@@ -248,7 +248,7 @@ def non_column_attr=(val)
   end
 
   describe "on create" do
-    let( :user ) { create_user audit_comment: "Create" }
+    let( :user ) { create_user status: :reliable, audit_comment: "Create" }
 
     it "should change the audit count" do
       expect {
@@ -272,6 +272,10 @@ def non_column_attr=(val)
       expect(user.audits.first.audited_changes).to eq(user.audited_attributes)
     end
 
+    it "should store enum value" do
+      expect(user.audits.first.audited_changes["status"]).to eq(1)
+    end
+
     it "should store comment" do
       expect(user.audits.first.comment).to eq('Create')
     end
@@ -290,7 +294,7 @@ def non_column_attr=(val)
 
   describe "on update" do
     before do
-      @user = create_user( name: 'Brandon', audit_comment: 'Update' )
+      @user = create_user( name: 'Brandon', status: :active, audit_comment: 'Update' )
     end
 
     it "should save an audit" do
@@ -314,6 +318,11 @@ def non_column_attr=(val)
       expect(@user.audits.last.audited_changes).to eq({ 'name' => ['Brandon', 'Changed'] })
     end
 
+    it "should store changed enum values" do
+      @user.update_attributes status: 1
+      expect(@user.audits.last.audited_changes["status"]).to eq([0, 1])
+    end
+
     it "should store audit comment" do
       expect(@user.audits.last.comment).to eq('Update')
     end
@@ -350,7 +359,7 @@ def non_column_attr=(val)
 
   describe "on destroy" do
     before do
-      @user = create_user
+      @user = create_user(status: :active)
     end
 
     it "should save an audit" do
@@ -375,6 +384,11 @@ def non_column_attr=(val)
       expect(@user.audits.last.audited_changes).to eq(@user.audited_attributes)
     end
 
+    it "should store enum value" do
+      @user.destroy
+      expect(@user.audits.last.audited_changes["status"]).to eq(0)
+    end
+
     it "should be able to reconstruct a destroyed record without history" do
       @user.audits.delete_all
       @user.destroy
@@ -630,6 +644,16 @@ def stub_global_max_audits(max_audits)
       expect(u.revision(1).username).to eq('brandon')
     end
 
+    it "should correctly restore revision with enum" do
+      u = Models::ActiveRecord::User.create(status: :active)
+      u.update_attribute(:status, :reliable)
+      u.update_attribute(:status, :banned)
+
+      expect(u.revision(3)).to be_banned
+      expect(u.revision(2)).to be_reliable
+      expect(u.revision(1)).to be_active
+    end
+
     it "should be able to get time for first revision" do
       suspended_at = Time.zone.now
       u = Models::ActiveRecord::User.create(suspended_at: suspended_at)

spec/support/active_record/models.rb

@@ -7,6 +7,7 @@ class User < ::ActiveRecord::Base
       audited except: :password
       attribute :non_column_attr if Rails.version >= '5.1'
       attr_protected :logins if respond_to?(:attr_protected)
+      enum status: { active: 0, reliable: 1, banned: 2 }
 
       def name=(val)
         write_attribute(:name, CGI.escapeHTML(val))

spec/support/active_record/schema.rb

@@ -35,6 +35,7 @@
     t.column :username, :string
     t.column :password, :string
     t.column :activated, :boolean
+    t.column :status, :integer, default: 0
     t.column :suspended_at, :datetime
     t.column :logins, :integer, default: 0
     t.column :created_at, :datetime