govuk_content_models 23.0.0 → 24.0.0

data/lib/govuk_content_models/action_processors/create_edition_processor.rb

@@ -0,0 +1,22 @@
+module GovukContentModels
+  module ActionProcessors
+    class CreateEditionProcessor < BaseProcessor
+
+      def action_name
+        Action::CREATE
+      end
+
+      def process
+        format = event_attributes[:format]
+        format_name = "#{format}_edition" unless format.to_s.match(/edition$/)
+        publication_class = format_name.to_s.camelize.constantize
+        @edition = publication_class.create(event_attributes[:edition_attributes])
+      end
+
+      def record_action?
+        edition.persisted?
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/emergency_publish_processor.rb

@@ -0,0 +1,6 @@
+module GovukContentModels
+  module ActionProcessors
+    class EmergencyPublishProcessor < BaseProcessor
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/new_version_processor.rb

@@ -0,0 +1,23 @@
+module GovukContentModels
+  module ActionProcessors
+    class NewVersionProcessor < BaseProcessor
+
+      def process?
+        edition.published?
+      end
+
+      def process
+        convert_to = event_attributes[:convert_to]
+        @edition = if !convert_to.nil?
+          edition.build_clone(convert_to.to_s.camelize.constantize)
+        else
+          edition.build_clone
+        end
+      end
+
+      def record_action?
+        !!edition
+      end
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/publish_processor.rb

@@ -0,0 +1,6 @@
+module GovukContentModels
+  module ActionProcessors
+    class PublishProcessor < BaseProcessor
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/receive_fact_check_processor.rb

@@ -0,0 +1,18 @@
+module GovukContentModels
+  module ActionProcessors
+    class ReceiveFactCheckProcessor < BaseProcessor
+
+      # Always records the action.
+      def process
+        edition.perform_event_without_validations(:receive_fact_check)
+        # Fact checks are processed async, so the user doesn't get an opportunity
+        # to retry without the content that (inadvertantly) fails validation, which happens frequently.
+        record_action_without_validation
+      end
+
+      def record_action?
+        false
+      end
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/request_amendments_processor.rb

@@ -0,0 +1,15 @@
+module GovukContentModels
+  module ActionProcessors
+    class RequestAmendmentsProcessor < BaseProcessor
+
+      def process?
+        if edition.in_review?
+          requester_different?
+        else
+          true
+        end
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/request_review_processor.rb

@@ -0,0 +1,6 @@
+module GovukContentModels
+  module ActionProcessors
+    class RequestReviewProcessor < BaseProcessor
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/schedule_for_publishing_processor.rb

@@ -0,0 +1,14 @@
+module GovukContentModels
+  module ActionProcessors
+    class ScheduleForPublishingProcessor < BaseProcessor
+
+      def process
+        publish_at = action_attributes.delete(:publish_at).to_time.utc
+        action_attributes.merge!(request_details: { scheduled_time: publish_at })
+
+        edition.schedule_for_publishing(publish_at)
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/send_fact_check_processor.rb

@@ -0,0 +1,14 @@
+module GovukContentModels
+  module ActionProcessors
+    class SendFactCheckProcessor < BaseProcessor
+
+      def process
+        return false if action_attributes[:email_addresses].blank?
+        action_attributes[:comment] ||= "Fact check requested"
+
+        edition.send_fact_check
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/skip_fact_check_processor.rb

@@ -0,0 +1,6 @@
+module GovukContentModels
+  module ActionProcessors
+    class SkipFactCheckProcessor < BaseProcessor
+    end
+  end
+end

data/lib/govuk_content_models/test_helpers/action_processor_helpers.rb

@@ -0,0 +1,39 @@
+module GovukContentModels
+  module TestHelpers
+    module ActionProcessorHelpers
+      def request_review(user, edition)
+        user.progress(edition, { request_type: :request_review, comment: "Review this edition please." })
+      end
+
+      def approve_review(user, edition)
+        user.progress(edition, { request_type: :approve_review, comment: "I've reviewed it" })
+      end
+
+      def send_fact_check(user, edition, comment="Fact check this guide please.")
+        user.progress(edition,{ request_type: :send_fact_check, comment: comment, email_addresses: "test@test.com" })
+      end
+
+      def receive_fact_check(user, edition, comment="Please verify these facts.")
+        user.progress(edition, { request_type: :receive_fact_check, comment: comment })
+      end
+
+      def approve_fact_check(user, edition, comment="No changes needed, this is all correct")
+        user.progress(edition, { request_type: :approve_fact_check, comment: comment })
+      end
+
+      def request_amendments(user, edition)
+        user.progress(edition, { request_type: :request_amendments, comment: "More amendments are required" })
+      end
+
+      def publish(user, edition, comment='Yo!')
+        user.progress(edition, { request_type: :publish, comment: comment })
+      end
+
+      def schedule_for_publishing(user, edition, action_attributes)
+        user.progress(edition, { request_type: :schedule_for_publishing,
+          publish_at: action_attributes[:publish_at] || Time.zone.now.utc,
+          comment: action_attributes[:comment] || 'Schedule!' })
+      end
+    end
+  end
+end

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

data/test/models/action_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class ActionTest < ActiveSupport::TestCase
+  test "#to_s should return the humanized version of the request type" do
+    assert_equal "Approve review", Action.new(request_type: 'approve_review').to_s
+  end
+
+  test "#to_s should contain the scheduled time when request type is SCHEDULE_FOR_PUBLISHING" do
+    assert_equal "Scheduled for publishing on 12/12/2014 00:00 UTC",
+      Action.new(:request_type => 'schedule_for_publishing',
+                 :request_details => { 'scheduled_time' => Date.parse('12/12/2014').to_time.utc }).to_s
+  end
+end

data/test/models/edition_test.rb

@@ -68,18 +68,18 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "it should be able to find its siblings" do
-    @artefact2 = FactoryGirl.create(:artefact)
+    artefact2 = FactoryGirl.create(:artefact)
     g1 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, version_number: 1)
-    g2 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact2.id, version_number: 1)
+    g2 = FactoryGirl.create(:guide_edition, panopticon_id: artefact2.id, version_number: 1)
     g3 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, version_number: 2)
     assert_equal [], g2.siblings.to_a
     assert_equal [g3], g1.siblings.to_a
   end
 
   test "it should be able to find its previous siblings" do
-    @artefact2 = FactoryGirl.create(:artefact)
+    artefact2 = FactoryGirl.create(:artefact)
     g1 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, version_number: 1)
-    g2 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact2.id, version_number: 1)
+    g2 = FactoryGirl.create(:guide_edition, panopticon_id: artefact2.id, version_number: 1)
     g3 = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, version_number: 2)
 
     assert_equal [], g1.previous_siblings.to_a
@@ -108,6 +108,29 @@ class EditionTest < ActiveSupport::TestCase
     end
   end
 
+  context "change note" do
+    should "be a minor change by default" do
+      refute Edition.new.major_change
+    end
+    should "not be valid for major changes with a blank change note" do
+      edition = Edition.new(major_change: true, change_note: "")
+      refute edition.valid?
+      assert edition.errors.has_key?(:change_note)
+    end
+    should "be valid for major changes with a change note" do
+      edition = Edition.new(title: "Edition", version_number: 1, panopticon_id: 123, major_change: true, change_note: "Changed")
+      assert edition.valid?
+    end
+    should "be valid when blank for minor changes" do
+      edition = Edition.new(title: "Edition", version_number: 1, panopticon_id: 123, change_note: "")
+      assert edition.valid?
+    end
+    should "be valid when populated for minor changes" do
+      edition = Edition.new(title: "Edition", version_number: 1, panopticon_id: 123, change_note: "Changed")
+      assert edition.valid?
+    end
+  end
+
   test "it should build a clone" do
     edition = FactoryGirl.create(:guide_edition,
                                   state: "published",
@@ -634,11 +657,11 @@ class EditionTest < ActiveSupport::TestCase
     edition = FactoryGirl.create(:guide_edition_with_two_parts, panopticon_id: @artefact.id, state: "ready")
 
     user = User.create name: "bob"
-    user.publish edition, comment: "First publication"
+    publish(user, edition, "First publication")
 
     second_edition = edition.build_clone
     second_edition.state = "ready"
-    user.publish second_edition, comment: "Second publication"
+    publish(user, second_edition, "Second publication")
 
     # simulate link validation errors in published edition
     second_edition.parts.first.update_attribute(:body, "[register your vehicle](registering-an-imported-vehicle)")
@@ -647,7 +670,7 @@ class EditionTest < ActiveSupport::TestCase
     # fix link validation error in cloned edition by appending a '/' to the relative url
     third_edition.parts.first.body = "[register your vehicle](/registering-an-imported-vehicle)"
     third_edition.state = "ready"
-    user.publish third_edition, comment: "Third publication"
+    publish(user, third_edition, "Third publication")
 
     edition.reload
     assert edition.archived?
@@ -662,7 +685,7 @@ class EditionTest < ActiveSupport::TestCase
     user = FactoryGirl.create(:user)
     edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
 
-    user.publish edition, comment: "First publication"
+    publish(user, edition, "First publication")
 
     assert_nil edition.reload.publish_at
   end
@@ -670,7 +693,7 @@ class EditionTest < ActiveSupport::TestCase
   test "edition can return latest status action of a specified request type" do
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "draft")
     user = User.create(name: "George")
-    user.request_review edition, comment: "Requesting review"
+    request_review(user, edition)
 
     assert_equal edition.actions.size, 1
     assert edition.latest_status_action(Action::REQUEST_REVIEW).present?
@@ -688,17 +711,17 @@ class EditionTest < ActiveSupport::TestCase
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
 
     user = User.create name: "bob"
-    user.publish edition, comment: "First publication"
+    publish(user, edition, "First publication")
 
     second_edition = edition.build_clone
     second_edition.update_attribute(:state, "ready")
     second_edition.save!
-    user.publish second_edition, comment: "Second publication"
+    publish(user, second_edition, "Second publication")
 
     third_edition = second_edition.build_clone
     third_edition.update_attribute(:state, "ready")
     third_edition.save!
-    user.publish third_edition, comment: "Third publication"
+    publish(user, third_edition, "Third publication")
 
     edition.reload
     assert edition.actions.where("request_type" => "publish")
@@ -716,12 +739,12 @@ class EditionTest < ActiveSupport::TestCase
    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
 
    user = User.create name: "bob"
-   user.publish edition, comment: "First publication"
+   publish(user, edition, "First publication")
 
    new_edition = edition.build_clone
    new_edition.state = "ready"
    new_edition.save!
-   user.publish new_edition, comment: "Second publication"
+   publish(user, new_edition, "Second publication")
 
    edition = edition.reload
 
@@ -733,7 +756,7 @@ class EditionTest < ActiveSupport::TestCase
     edition.save!
 
     user = User.create name: "bob"
-    user.publish edition, comment: "First publication"
+    publish(user, edition, "First publication")
 
     new_edition = edition.build_clone
     new_edition.save!
@@ -771,8 +794,8 @@ class EditionTest < ActiveSupport::TestCase
 
     edition = ProgrammeEdition.new(title: "Childcare", slug: "childcare", panopticon_id: @artefact.id)
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this programme please."})
-    assert ! user.request_amendments(edition, {comment: "Well Done, but work harder"})
+    request_review(user, edition)
+    refute request_amendments(user, edition)
   end
 
   test "a published publication with a draft edition is in progress" do
@@ -800,37 +823,37 @@ class EditionTest < ActiveSupport::TestCase
   # test denormalisation
 
   test "should denormalise an edition with an assigned user and action requesters" do
-    @user1 = FactoryGirl.create(:user, name: "Morwenna")
-    @user2 = FactoryGirl.create(:user, name: "John")
-    @user3 = FactoryGirl.create(:user, name: "Nick")
+    user1 = FactoryGirl.create(:user, name: "Morwenna")
+    user2 = FactoryGirl.create(:user, name: "John")
+    user3 = FactoryGirl.create(:user, name: "Nick")
 
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived")
 
-    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived", assigned_to_id: @user1.id)
-    edition.actions.create request_type: Action::CREATE, requester: @user2
-    edition.actions.create request_type: Action::PUBLISH, requester: @user3
-    edition.actions.create request_type: Action::ARCHIVE, requester: @user1
+    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived", assigned_to_id: user1.id)
+    edition.actions.create request_type: Action::CREATE, requester: user2
+    edition.actions.create request_type: Action::PUBLISH, requester: user3
+    edition.actions.create request_type: Action::ARCHIVE, requester: user1
     edition.save! and edition.reload
 
-    assert_equal @user1.name, edition.assignee
-    assert_equal @user2.name, edition.creator
-    assert_equal @user3.name, edition.publisher
-    assert_equal @user1.name, edition.archiver
+    assert_equal user1.name, edition.assignee
+    assert_equal user2.name, edition.creator
+    assert_equal user3.name, edition.publisher
+    assert_equal user1.name, edition.archiver
   end
 
   test "should denormalise an assignee's name when an edition is assigned" do
-    @user1 = FactoryGirl.create(:user)
-    @user2 = FactoryGirl.create(:user)
+    user1 = FactoryGirl.create(:user)
+    user2 = FactoryGirl.create(:user)
 
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "draft")
-    @user1.assign edition, @user2
+    user1.assign edition, user2
 
-    assert_equal @user2, edition.assigned_to
-    assert_equal @user2.name, edition.assignee
+    assert_equal user2, edition.assigned_to
+    assert_equal user2.name, edition.assignee
   end
 
   test "should denormalise a creator's name when an edition is created" do
-    @user = FactoryGirl.create(:user)
+    user = FactoryGirl.create(:user)
     FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     artefact = FactoryGirl.create(:artefact,
         slug: "foo-bar",
@@ -842,53 +865,53 @@ class EditionTest < ActiveSupport::TestCase
         owning_app: "publisher",
     )
 
-    edition = AnswerEdition.find_or_create_from_panopticon_data(artefact.id, @user, {})
+    edition = AnswerEdition.find_or_create_from_panopticon_data(artefact.id, user, {})
 
-    assert_equal @user.name, edition.creator
+    assert_equal user.name, edition.creator
   end
 
   test "should denormalise a publishing user's name when an edition is published" do
-    @user = FactoryGirl.create(:user)
+    user = FactoryGirl.create(:user)
 
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
-    @user.publish edition, { }
+    publish(user, edition, "First publication")
 
-    assert_equal @user.name, edition.publisher
+    assert_equal user.name, edition.publisher
   end
 
   test "should set siblings in progress to nil for new editions" do
-    @user = FactoryGirl.create(:user)
-    @edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
-    @published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
-    assert_equal 1, @edition.version_number
-    assert_nil @edition.sibling_in_progress
+    user = FactoryGirl.create(:user)
+    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
+    published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
+    assert_equal 1, edition.version_number
+    assert_nil edition.sibling_in_progress
   end
 
   test "should update previous editions when new edition is added" do
-    @user = FactoryGirl.create(:user)
-    @edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived")
-    @published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
-    @new_edition = @published_edition.build_clone
-    @new_edition.save!
-    @published_edition.reload
+    user = FactoryGirl.create(:user)
+    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived")
+    published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
+    new_edition = published_edition.build_clone
+    new_edition.save!
+    published_edition.reload
 
-    assert_equal 3, @new_edition.version_number
-    assert_equal 3, @published_edition.sibling_in_progress
+    assert_equal 3, new_edition.version_number
+    assert_equal 3, published_edition.sibling_in_progress
   end
 
   test "should update previous editions when new edition is published" do
-    @user = FactoryGirl.create(:user)
-    @edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived")
-    @published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
-    @new_edition = @published_edition.build_clone
-    @new_edition.save!
-    @new_edition.update_attribute(:state, "ready")
-    @user.publish(@new_edition, comment: "Publishing this")
-    @published_edition.reload
-
-    assert_equal 3, @new_edition.version_number
-    assert_nil @new_edition.sibling_in_progress
-    assert_nil @published_edition.sibling_in_progress
+    user = FactoryGirl.create(:user)
+    edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "archived")
+    published_edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "published")
+
+    new_edition = published_edition.build_clone
+    new_edition.save!
+    new_edition.update_attribute(:state, "ready")
+    publish(user, new_edition, "First publication")
+
+    assert_equal 3, new_edition.version_number
+    assert_nil new_edition.sibling_in_progress
+    assert_nil published_edition.reload.sibling_in_progress
   end
 
   test "all subclasses should provide a working whole_body method for diffing" do