govuk_content_models 32.2.0 → 32.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa9614ff18d6424badcb16a5a972bf66e13e121b
-  data.tar.gz: 106c23fef7501232f6193eaf7c8d34c03b04e11b
+  metadata.gz: 0ffd082b3277c164319de729908a7db69bf74b69
+  data.tar.gz: a9260435afd6fc9c3449213c771ac70d138d856d
 SHA512:
-  metadata.gz: f1137d9954ddf99cd1bb814638f23b77921520c06ed205dd83d0e2c7e666391bf0938433ea9f7c6a14e7c74dc4930656237782d690aab8097933c6d8323f6e8c
-  data.tar.gz: 3c161e491c8b70c2e3f6e28cbdf41cf1809dd126ef246fcc246139904d985c6c495d0e0f98f51df7140605b78d8ec5e0abaa0527262ba7971ded35ea04107373
+  metadata.gz: dc37f5693293e233a5e801a79c60e7e12b32fbcadaa177dd1b0a06e81df71129704687018c44966e895e3f1630f82fec7863a1176d4566fed8faf48691b8e27b
+  data.tar.gz: fd53211639556b8b28f7242ed6ce0f4073c21b607614854de91f24d8e6c468f782888b85cd78cb3eee7885aa0eafa127e86326b0924bee476b05928385efac97

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 32.3.0
+
+- Add `save_as_task` method to Artefact model [#360](https://github.com/alphagov/govuk_content_models/pull/360)
+
 ## 32.2.0
 
 - Add `homepage_url` attribute to `LocalAuthority` model

data/app/models/artefact.rb

@@ -318,6 +318,17 @@ class Artefact
     save(options)
   end
 
+  # We should use this method when performing save actions from rake tasks,
+  # message queue consumer or any other performed tasks that have no user associated
+  # as we are still interested to know what triggered the action.
+  def save_as_task(task_name, options = {})
+    default_action = new_record? ? "create" : "update"
+    action_type = options.delete(:action_type) || default_action
+
+    record_action(action_type, task_name: task_name)
+    save(options)
+  end
+
   def record_create_action
     record_action "create"
   end
@@ -328,14 +339,21 @@ class Artefact
 
   def record_action(action_type, options={})
     user = options[:user]
+    task_name = options[:task_name]
     current_snapshot = snapshot
-    last_snapshot = actions.last ? actions.last.snapshot : nil
+    last_snapshot = actions.last.snapshot if actions.last
+
     unless current_snapshot == last_snapshot
-      new_action = actions.build(
-        user: user,
+
+      attributes = {
         action_type: action_type,
-        snapshot: current_snapshot
-      )
+        snapshot: current_snapshot,
+      }
+
+      attributes.merge!(user: user) if user
+      attributes.merge!(task_performed_by: task_name) if task_name
+
+      new_action = actions.build(attributes)
       # Mongoid will not fire creation callbacks on embedded documents, so we
       # need to trigger this manually. There is a `cascade_callbacks` option on
       # `embeds_many`, but it doesn't appear to trigger creation events on

data/app/models/artefact_action.rb

@@ -6,6 +6,7 @@ class ArtefactAction
 
   field "action_type", type: String
   field "snapshot", type: Hash
+  field "task_performed_by", type: String
 
   embedded_in :artefact
 

data/lib/govuk_content_models/version.rb

@@ -1,4 +1,4 @@
 module GovukContentModels
   # Changing this causes Jenkins to tag and release the gem into the wild
-  VERSION = "32.2.0"
+  VERSION = "32.3.0"
 end

data/test/models/artefact_action_test.rb

@@ -39,86 +39,96 @@ class ArtefactActionTest < ActiveSupport::TestCase
     }
   end
 
+  def setup
+    @artefact = Artefact.create!(base_fields)
+  end
+
   test "a new artefact should have a create action" do
-    a = Artefact.create!(base_fields)
-    a.reload
+    @artefact.reload
 
-    assert_equal 1, a.actions.size
-    action = a.actions.first
+    assert_equal 1, @artefact.actions.size
+    action = @artefact.actions.first
     assert_equal "create", action[:action_type]
     assert_equal merge_attributes(DEFAULTS, base_fields), action.snapshot
     assert action.created_at, "Action has no creation timestamp"
   end
 
   test "an updated artefact should have two actions" do
-    a = Artefact.create!(base_fields)
-    a.description = "An artefact of shining wonderment."
-    a.save!
-    a.reload
+    @artefact.description = "An artefact of shining wonderment."
+    @artefact.save!
+    @artefact.reload
 
-    assert_equal 2, a.actions.size
-    assert_equal ["create", "update"], a.actions.map(&:action_type)
+    assert_equal 2, @artefact.actions.size
+    assert_equal ["create", "update"], @artefact.actions.map(&:action_type)
     create_snapshot = merge_attributes(DEFAULTS, base_fields)
-    update_snapshot = create_snapshot.merge("description" => a.description)
-    assert_equal create_snapshot, a.actions[0].snapshot
-    assert_equal update_snapshot, a.actions[1].snapshot
-    a.actions.each do |action|
+    update_snapshot = create_snapshot.merge("description" => @artefact.description)
+    assert_equal create_snapshot, @artefact.actions[0].snapshot
+    assert_equal update_snapshot, @artefact.actions[1].snapshot
+    @artefact.actions.each do |action|
       assert action.created_at, "Action has no creation timestamp"
     end
   end
 
   test "saving with no tracked changes will not create a new snapshot" do
-    a = Artefact.create!(base_fields)
-    a.updated_at = Time.zone.now + 5.minutes
-    a.save!
-    assert_equal 1, a.actions.size
+    @artefact.updated_at = Time.zone.now + 5.minutes
+    @artefact.save!
+    assert_equal 1, @artefact.actions.size
   end
 
   test "updating attributes as a user should record a user action" do
-    a = Artefact.create!(base_fields)
     user = FactoryGirl.create :user
     updates = {description: "Shiny shiny description"}
-    a.update_attributes_as user, updates
-    a.reload
+    @artefact.update_attributes_as user, updates
+    @artefact.reload
 
-    assert_equal "Shiny shiny description", a.description
-    assert_equal 2, a.actions.size
-    assert_equal ["create", "update"], a.actions.map(&:action_type)
-    assert_equal user, a.actions.last.user
+    assert_equal "Shiny shiny description", @artefact.description
+    assert_equal 2, @artefact.actions.size
+    assert_equal ["create", "update"], @artefact.actions.map(&:action_type)
+    assert_equal user, @artefact.actions.last.user
     assert_equal(
         merge_attributes(DEFAULTS, base_fields, updates),
-        a.actions.last.snapshot
+        @artefact.actions.last.snapshot
     )
   end
 
+  test "saving a task should record the task action" do
+    @artefact.description = "Updated automatically"
+    @artefact.save_as_task('TaggingUpdater')
+    @artefact.reload
+
+    assert_equal 2, @artefact.actions.size
+    assert_equal ["create", "update"], @artefact.actions.map(&:action_type)
+
+    assert_equal 'TaggingUpdater', @artefact.actions.last.task_performed_by
+    assert_equal nil, @artefact.actions.last.user
+  end
+
   test "saving as a user should record a user action" do
-    a = Artefact.create!(base_fields)
     user = FactoryGirl.create :user
     updates = {description: "Shiny shiny description"}
-    a.description = updates[:description]
-    a.save_as user
-    a.reload
-
-    assert_equal "Shiny shiny description", a.description
-    assert_equal 2, a.actions.size
-    assert_equal ["create", "update"], a.actions.map(&:action_type)
-    assert_equal user, a.actions.last.user
+    @artefact.description = updates[:description]
+    @artefact.save_as user
+    @artefact.reload
+
+    assert_equal "Shiny shiny description", @artefact.description
+    assert_equal 2, @artefact.actions.size
+    assert_equal ["create", "update"], @artefact.actions.map(&:action_type)
+    assert_equal user, @artefact.actions.last.user
     assert_equal(
         merge_attributes(DEFAULTS, base_fields, updates),
-        a.actions.last.snapshot
+        @artefact.actions.last.snapshot
     )
   end
 
   test "saving as a user with an action type" do
-    a = Artefact.create!(base_fields)
     user = FactoryGirl.create :user
     updates = {description: "Shiny shiny description"}
-    a.description = updates[:description]
-    a.save_as user, action_type: "awesome"
-    a.reload
+    @artefact.description = updates[:description]
+    @artefact.save_as user, action_type: "awesome"
+    @artefact.reload
 
-    assert_equal user, a.actions.last.user
-    assert_equal "awesome", a.actions.last.action_type
+    assert_equal user, @artefact.actions.last.user
+    assert_equal "awesome", @artefact.actions.last.action_type
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 32.2.0
+  version: 32.3.0
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext