feat: Track history of model changes (#161)

sman591 · web-flow · commit 4c62bd3699be · 2019-05-28T23:08:57.000-04:00
* feat: Track history of model changes

* Hound fixes
diff --git a/.rubocop-shared.yml b/.rubocop-shared.yml
@@ -51,6 +51,10 @@ Style/Documentation:
 Style/GuardClause:
   Enabled: false
 
+Style/HashSyntax:
+  Exclude:
+    - db/migrate/*
+
 Style/PercentLiteralDelimiters:
   Enabled: false
 
diff --git a/Gemfile b/Gemfile
@@ -68,9 +68,10 @@ gem 'bootstrap', '~> 4.3.1'
 # Markdown parsing
 gem 'redcarpet'
 
-# Model validation
+# Model extensions
 gem 'strip_attributes'
 gem 'validate_url'
+gem 'audited', '~> 4.7'
 
 # Background job processing
 gem 'sidekiq', '< 6'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -50,6 +50,8 @@ GEM
     archive-zip (0.12.0)
       io-like (~> 0.3.0)
     arel (9.0.0)
+    audited (4.8.0)
+      activerecord (>= 4.0, < 5.3)
     autoprefixer-rails (9.5.1.1)
       execjs
     aws-eventstream (1.0.3)
@@ -457,6 +459,7 @@ PLATFORMS
 
 DEPENDENCIES
   ajax-datatables-rails (~> 0.4.0)
+  audited (~> 4.7)
   aws-sdk-s3
   better_errors
   binding_of_caller
diff --git a/app/helpers/audit_helper.rb b/app/helpers/audit_helper.rb
@@ -0,0 +1,12 @@
+module AuditHelper
+  def display_audit_value(value, field)
+    return "(none)" if value.blank?
+    return Questionnaire::POSSIBLE_ACC_STATUS[value] if field == "acc_status"
+    return BusList.find(value)&.name || value if field == "bus_list_id"
+    return User.find(value)&.full_name || value if field == "checked_in_by_id"
+    return value.join(", ") if value.is_a? Array
+    return display_datetime(value, relative: false) if value.is_a? Time
+
+    value
+  end
+end
diff --git a/app/helpers/hackathon_manager_helper.rb b/app/helpers/hackathon_manager_helper.rb
@@ -92,8 +92,10 @@ def acc_status_class(acc_status)
   end
 
   def display_datetime(datetime, opts = {})
+    opts[:relative] = true if opts[:relative].nil?
+
     formatted = ""
-    if Time.now - datetime < 5.hours
+    if Time.now - datetime < 5.hours && opts[:relative]
       formatted << "#{time_ago_in_words(datetime, include_seconds: true)} ago"
     else
       format = datetime.year == Time.now.year ? "%b %-d <small>at %I:%M %P</small>" : "%b %-d, %Y <small>at %I:%M %P</small>"
diff --git a/app/models/bus_list.rb b/app/models/bus_list.rb
@@ -1,4 +1,6 @@
 class BusList < ApplicationRecord
+  audited
+
   validates_presence_of :name, :capacity
   validates_uniqueness_of :name
 
diff --git a/app/models/message.rb b/app/models/message.rb
@@ -1,4 +1,6 @@
 class Message < ApplicationRecord
+  audited
+
   self.inheritance_column = nil # To enable using "type" field
 
   validates_presence_of :name, :subject, :template
diff --git a/app/models/questionnaire.rb b/app/models/questionnaire.rb
@@ -1,4 +1,6 @@
 class Questionnaire < ApplicationRecord
+  audited
+
   include ActiveModel::Dirty
   include DeletableAttachment
 
diff --git a/app/models/school.rb b/app/models/school.rb
@@ -1,4 +1,6 @@
 class School < ApplicationRecord
+  audited
+
   validates_presence_of :name
 
   validates_uniqueness_of :name
diff --git a/app/models/trackable_tag.rb b/app/models/trackable_tag.rb
@@ -1,4 +1,6 @@
 class TrackableTag < ApplicationRecord
+  audited
+
   validates_presence_of :name
   validates_uniqueness_of :name
   strip_attributes
diff --git a/app/models/user.rb b/app/models/user.rb
@@ -1,4 +1,6 @@
 class User < ApplicationRecord
+  audited only: [:email, :role, :is_active, :receive_weekly_report]
+
   devise :database_authenticatable, :registerable, :timeoutable,
          :recoverable, :rememberable, :trackable, :validatable,
          :doorkeeper, :omniauthable, omniauth_providers: [:mlh]
diff --git a/app/views/manage/admins/show.html.haml b/app/views/manage/admins/show.html.haml
@@ -3,34 +3,39 @@
     = link_to 'Edit', edit_manage_admin_path(@user), class: 'btn btn-sm btn-outline-secondary'
     = link_to 'Delete', manage_admin_path(@user), method: :delete, data: { confirm: "Are you sure? #{@user.email} will be permanently deleted. This action is irreversible." }, class: 'btn btn-sm btn-outline-secondary'
 
-%div
-  %p
-    %b Email address:
-    = @user.email
+.row.mt-2.mb-4
+  .col-lg-6
+    %p
+      %b Email address:
+      = @user.email
 
-  %p
-    %b Role:
-    = @user.role.titleize
+    %p
+      %b Role:
+      = @user.role.titleize
 
-  %p
-    %b Login access:
-    - if @user.is_active
-      %span.badge.badge-success Active
-    - else
-      %span.badge.badge-danger Inactive
+    %p
+      %b Login access:
+      - if @user.is_active
+        %span.badge.badge-success Active
+      - else
+        %span.badge.badge-danger Inactive
 
-  %p
-    %b Receive weekly report:
-    - if @user.receive_weekly_report
-      %span.badge.badge-success Yes
-      - if !@user.is_active
-        %br
-        %small
-          %span.fa.fa-info-circle.icon-space-r-half
-          Will not receive while user is inactive
-    - else
-      %span.badge.badge-secondary No
+    %p
+      %b Receive weekly report:
+      - if @user.receive_weekly_report
+        %span.badge.badge-success Yes
+        - if !@user.is_active
+          %br
+          %small
+            %span.fa.fa-info-circle.icon-space-r-half
+            Will not receive while user is inactive
+      - else
+        %span.badge.badge-secondary No
 
-  %p
-    %b Registered:
-    = display_datetime(@user.created_at)
+    %p
+      %b Registered:
+      = display_datetime(@user.created_at)
+
+  .col-lg-6
+    %h4.border-bottom.pb-2.mb-3 Change History
+    = render "model_history", model: @user
diff --git a/app/views/manage/application/_model_history.html.haml b/app/views/manage/application/_model_history.html.haml
@@ -0,0 +1,44 @@
+:ruby
+  ignore_fields = ['acc_status_author_id', 'acc_status_date']
+  audits ||= model.audits if defined?(model)
+  audits = audits.sort_by(&:created_at).reverse
+
+- audits.each_with_index do |audit, index|
+  .d-xl-flex.justify-content-between
+    %div
+      - if audit.action == 'create'
+        %p.mb-1
+          = audit.auditable.model_name.human
+          created
+      - else
+        - audit.audited_changes.each do |field, value_pairs|
+          - next if ignore_fields.include? field
+          %p.mb-1
+            = t("simple_form.labels.#{audit.auditable.class.name.downcase}.#{field}")
+            - if audit.auditable.class.columns_hash[field].type == :text
+              changed
+            - else
+              changed to
+              %strong= display_audit_value(value_pairs[1], field)
+              %br
+              %small.text-secondary
+                Previously:
+                %strong= display_audit_value(value_pairs[0], field)
+    .text-secondary.d-flex.justify-content-between.flex-xl-column.justify-content-xl-start.text-xl-right
+      %p.mb-0
+        %small
+          %span.fa.fa-clock-o.icon-space-r-half
+          = display_datetime(audit.created_at)
+      %p.mb-2
+        - if audit.user
+          %small{"data-toggle" => "popover", "data-content" => audit.user.email, "data-trigger" => "hover"}
+            %span.fa.fa-user-o.icon-space-r-half
+            = audit.user.full_name
+        - else
+          &nbsp;
+  - unless (index + 1) == audits.count
+    %hr.mt-1.mb-2
+
+- if audits.empty?
+  %p.alert.alert-info
+    No history recorded.
diff --git a/app/views/manage/bus_lists/show.html.haml b/app/views/manage/bus_lists/show.html.haml
@@ -116,6 +116,10 @@
 
 .row.mt-2.mb-4
   .col
-    %h4.border-bottom.pb-2.mb-4
-      Passenger Distribution
+    %h4.border-bottom.pb-2.mb-4 Passenger Distribution
     = render partial: 'bus_list_stats', locals: { bus_list: @bus_list }
+
+.row.mt-2.mb-4
+  .col-lg-6
+    %h4.border-bottom.pb-2.mb-3 Change History
+    = render "model_history", model: @bus_list
diff --git a/app/views/manage/messages/show.html.haml b/app/views/manage/messages/show.html.haml
@@ -59,20 +59,28 @@
 
   %iframe.email-preview{src: preview_manage_message_path(@message)}
 
+.row.mt-3
+  .col-lg-6
+    .card.mb-3
+      .card-body.pb-1
+        %h5.card-title Change history
+        = render "model_history", model: @message
+
   - if @message.bulk?
-    .card.mt-3.mb-3
-      .card-body
-        %h5.card-title Bulk delivery details
-        %p.card-text
-          %b
-            Status:
-            = @message.status.titleize
-        %p.card-text
-          %b Queued At:
-          = @message.queued_at || "(n/a)"
-        %p.card-text
-          %b Started At:
-          = @message.started_at || "(n/a)"
-        %p.card-text
-          %b Delivered At:
-          = @message.delivered_at || "(n/a)"
+    .col-lg-6
+      .card.mb-3
+        .card-body
+          %h5.card-title Bulk delivery details
+          %p.card-text
+            %b
+              Status:
+              = @message.status.titleize
+          %p.card-text
+            %b Queued At:
+            = @message.queued_at || "(n/a)"
+          %p.card-text
+            %b Started At:
+            = @message.started_at || "(n/a)"
+          %p.card-text
+            %b Delivered At:
+            = @message.delivered_at || "(n/a)"
diff --git a/app/views/manage/questionnaires/_history.html.haml b/app/views/manage/questionnaires/_history.html.haml
@@ -1,5 +1,11 @@
 .row
-  .col-md-6
+  .col-lg-6
+    .card.mb-3
+      .card-header Recent Changes
+      .card-body.pb-2
+        = render "model_history", model: @questionnaire, audits: @questionnaire.audits + @questionnaire.user.audits
+
+  .col-lg-6
     .card.mb-3
       .card-header Recent Email Events
       .card-body
diff --git a/app/views/manage/schools/show.html.haml b/app/views/manage/schools/show.html.haml
@@ -98,3 +98,8 @@
             %td= q.email
             %td= "<span class=\"text-#{acc_status_class(q.acc_status)}\">#{Questionnaire::POSSIBLE_ACC_STATUS[q.acc_status]}</span>".html_safe
             %td= q.checked_in? ? "Yes" : "No"
+
+.row.mt-2.mb-4
+  .col-lg-6
+    %h4.border-bottom.pb-2.mb-3 Change History
+    = render "model_history", model: @school
diff --git a/app/views/manage/trackable_tags/show.html.haml b/app/views/manage/trackable_tags/show.html.haml
@@ -36,3 +36,8 @@
         %td
           - if current_user.admin? || current_user == trackable_event.user
             = link_to 'Edit', edit_manage_trackable_event_path(trackable_event)
+
+.row.mt-2.mb-4
+  .col-lg-6
+    %h4.border-bottom.pb-2.mb-3 Change History
+    = render "model_history", model: @trackable_tag
diff --git a/db/migrate/20190528155025_install_audited.rb b/db/migrate/20190528155025_install_audited.rb
@@ -0,0 +1,30 @@
+class InstallAudited < ActiveRecord::Migration[5.2]
+  def self.up
+    create_table :audits, :force => true do |t|
+      t.column :auditable_id, :integer
+      t.column :auditable_type, :string
+      t.column :associated_id, :integer
+      t.column :associated_type, :string
+      t.column :user_id, :integer
+      t.column :user_type, :string
+      t.column :username, :string
+      t.column :action, :string
+      t.column :audited_changes, :text
+      t.column :version, :integer, :default => 0
+      t.column :comment, :string
+      t.column :remote_address, :string
+      t.column :request_uuid, :string
+      t.column :created_at, :datetime
+    end
+
+    add_index :audits, [:auditable_type, :auditable_id, :version], :name => 'auditable_index'
+    add_index :audits, [:associated_type, :associated_id], :name => 'associated_index'
+    add_index :audits, [:user_id, :user_type], :name => 'user_index'
+    add_index :audits, :request_uuid
+    add_index :audits, :created_at
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_05_27_163723) do
+ActiveRecord::Schema.define(version: 2019_05_28_155025) do
 
   create_table "active_storage_attachments", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
     t.string "name", null: false
@@ -33,6 +33,28 @@
     t.index ["key"], name: "index_active_storage_blobs_on_key", unique: true
   end
 
+  create_table "audits", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+    t.integer "auditable_id"
+    t.string "auditable_type"
+    t.integer "associated_id"
+    t.string "associated_type"
+    t.integer "user_id"
+    t.string "user_type"
+    t.string "username"
+    t.string "action"
+    t.text "audited_changes"
+    t.integer "version", default: 0
+    t.string "comment"
+    t.string "remote_address"
+    t.string "request_uuid"
+    t.datetime "created_at"
+    t.index ["associated_type", "associated_id"], name: "associated_index"
+    t.index ["auditable_type", "auditable_id", "version"], name: "auditable_index"
+    t.index ["created_at"], name: "index_audits_on_created_at"
+    t.index ["request_uuid"], name: "index_audits_on_request_uuid"
+    t.index ["user_id", "user_type"], name: "user_index"
+  end
+
   create_table "blazer_audits", id: :integer, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
     t.integer "user_id"
     t.integer "query_id"
diff --git a/test/helpers/audit_helper_test.rb b/test/helpers/audit_helper_test.rb
diff --git a/vendor/cache/audited-4.8.0.gem b/vendor/cache/audited-4.8.0.gem
