govuk_content_models 22.2.0 → 23.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 23.0.0
+
+* Remove important_notes field from Edition
+* Add IMPORTANT_NOTE and IMPORTANT_NOTE_RESOLVED request_types to Action
+* Add methods to find, create and resolve important note actions to Workflow and WorkflowActor.
+
 ## 22.2.0
 
 * Allow new formats for raib_report for Artefacts

data/app/models/action.rb

@@ -21,6 +21,8 @@ class Action
 
   NON_STATUS_ACTIONS = [
     NOTE                 = "note",
+    IMPORTANT_NOTE       = "important_note",
+    IMPORTANT_NOTE_RESOLVED = "important_note_resolved",
     ASSIGN               = "assign",
   ]
 

data/app/models/edition.rb

@@ -19,7 +19,6 @@ class Edition
   field :slug,                 type: String
   field :department,           type: String
   field :rejected_count,       type: Integer,  default: 0
-  field :important_note,       type: String
 
   field :browse_pages,         type: Array, default: []
   field :primary_topic,        type: String

data/app/models/workflow.rb

@@ -216,6 +216,11 @@ module Workflow
     save(validate: false)
   end
 
+  def important_note
+    action = actions.where(:request_type.in => [Action::IMPORTANT_NOTE, Action::IMPORTANT_NOTE_RESOLVED]).last
+    action if action.try(:request_type) == Action::IMPORTANT_NOTE
+  end
+
   private
 
     def publish_at_is_in_the_future

data/app/models/workflow_actor.rb

@@ -54,8 +54,12 @@ module WorkflowActor
     edition.save if edition
   end
 
-  def record_note(edition, comment)
-    edition.new_action(self, "note", comment: comment)
+  def record_note(edition, comment, type = Action::NOTE)
+    edition.new_action(self, type, comment: comment)
+  end
+
+  def resolve_important_note(edition)
+    record_note(edition, nil, Action::IMPORTANT_NOTE_RESOLVED)
   end
 
   def create_edition(format, attributes = {})

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 = "22.2.0"
+  VERSION = "23.0.0"
 end

data/test/models/edition_test.rb

@@ -1001,34 +1001,6 @@ class EditionTest < ActiveSupport::TestCase
     end
   end
 
-  context "Important note" do
-    def set_note(edition, note)
-      edition.important_note = note
-      edition.save
-      edition.reload
-    end
-
-    setup do
-      @edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
-      set_note(@edition, "This is an important note.")
-    end
-
-    should "be able to add a important note to an edition" do
-      assert_equal "This is an important note.", @edition.important_note
-    end
-
-    should "be able to update an existing important note" do
-      set_note(@edition, "New note.")
-      assert_equal "New note.", @edition.important_note
-    end
-
-    should "should not exist when creating new editions" do
-      Edition.subclasses.each do |klass|
-        refute klass.fields_to_clone.include?(:important_note), "Important note is cloned in a #{klass}"
-      end
-    end
-  end
-
   context "Tagging to collections" do
     setup do
       @edition = FactoryGirl.create(:guide_edition)

data/test/models/workflow_test.rb

@@ -347,4 +347,15 @@ class WorkflowTest < ActiveSupport::TestCase
     user_2.request_amendments(edition, {comment: "More work needed"})
     assert edition.amends_needed?
   end
+
+  test "important_note returns last non-resolved important note" do
+    user = User.create(name: "Ben")
+    edition = template_guide
+    user.record_note(edition, 'this is an important note', Action::IMPORTANT_NOTE)
+    user.record_action(edition, 'request_review')
+    assert_equal edition.important_note.comment, 'this is an important note'
+
+    user.record_note(edition, nil, Action::IMPORTANT_NOTE_RESOLVED)
+    assert_nil edition.important_note
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 22.2.0
+  version: 23.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -464,7 +464,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4313756439197638091
+      hash: -3179151873791569033
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -473,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4313756439197638091
+      hash: -3179151873791569033
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23