govuk_content_models 23.0.0 → 24.0.0

data/test/models/user_test.rb

@@ -92,8 +92,8 @@ class UserTest < ActiveSupport::TestCase
     user = User.create(:name => "bob")
 
     trans = user.create_edition(:transaction, title: "test answer", slug: "test", panopticon_id: @artefact.id)
-    user.request_review(trans, {comment: "Hello"})
-    assert ! user.approve_review(trans, {comment: "Hello"})
+    request_review(user, trans)
+    refute approve_review(user, trans)
   end
 
   test "Edition becomes assigned to user when user is assigned an edition" do

data/test/models/workflow_test.rb

@@ -29,12 +29,13 @@ class WorkflowTest < ActiveSupport::TestCase
 
     guide = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
     edition = guide
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    user.send_fact_check(edition,{comment: "Review this guide please.", email_addresses: "test@test.com"})
-    user.receive_fact_check(edition, {comment: "No changes needed, this is all correct"})
-    other_user.approve_fact_check(edition, {comment: "Looks good to me"})
-    user.publish(edition, {comment: "PUBLISHED!"})
+
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    send_fact_check(user, edition)
+    receive_fact_check(user, edition)
+    other_user.progress(edition, { request_type: :approve_fact_check, comment: "Looks good to me" })
+    user.progress(edition, { request_type: :publish, comment: "PUBLISHED!" })
     return user, guide
   end
 
@@ -47,11 +48,11 @@ class WorkflowTest < ActiveSupport::TestCase
     transaction.expectation_ids = [expectation.id]
     transaction.save
 
-    user.request_review(transaction, {comment: "Review this guide please."})
+    request_review(user, transaction)
     transaction.save
-    other_user.approve_review(transaction, {comment: "I've reviewed it"})
+    approve_review(other_user, transaction)
     transaction.save
-    user.publish(transaction, {comment: "Let's go"})
+    user.progress(transaction, { request_type: :publish, comment: "Let's go"})
     transaction.save
     return user, transaction
   end
@@ -113,7 +114,7 @@ class WorkflowTest < ActiveSupport::TestCase
     guide = template_guide
     user = User.create(name:"Ben")
     refute guide.in_review?
-    user.request_review(guide, {comment: "Review this guide please."})
+    request_review(user, guide)
     assert guide.in_review?
   end
 
@@ -125,14 +126,14 @@ class WorkflowTest < ActiveSupport::TestCase
     edition = guide
 
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this guide please."})
+    request_review(user, edition)
     refute edition.can_request_review?
     assert edition.can_request_amendments?
-    other_user.request_amendments(edition, {comment: "I've reviewed it"})
+    request_amendments(other_user, edition)
     refute edition.can_request_amendments?
-    user.request_review(edition,{comment: "Review this guide please."})
+    request_review(user, edition)
     assert edition.can_approve_review?
-    other_user.approve_review(edition, {comment: "Looks good to me"})
+    approve_review(other_user, edition)
     assert edition.can_publish?
   end
 
@@ -142,11 +143,11 @@ class WorkflowTest < ActiveSupport::TestCase
 
     edition = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    user.send_fact_check(edition,{comment: "Review this guide please.", email_addresses: "test@test.com"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    send_fact_check(user, edition)
 
-    assert other_user.skip_fact_check(edition, {comment: 'Fact check not received in time'})
+    assert other_user.progress(edition, { request_type: :skip_fact_check, comment: 'Fact check not received in time' })
     edition.reload
     assert edition.can_publish?
     assert edition.actions.detect { |e| e.request_type == 'skip_fact_check' }
@@ -160,10 +161,10 @@ class WorkflowTest < ActiveSupport::TestCase
     guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
     edition = guide
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    user.send_fact_check(edition,{comment: "Review this guide please.", email_addresses: "test@test.com"})
-    user.receive_fact_check(edition, {comment: "Text.<l>content that the SafeHtml validator would catch</l>"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    send_fact_check(user, edition)
+    receive_fact_check(user, edition, "Text.<l>content that the SafeHtml validator would catch</l>")
 
     assert_equal "Text.<l>content that the SafeHtml validator would catch</l>", edition.actions.last.comment
   end
@@ -175,11 +176,11 @@ class WorkflowTest < ActiveSupport::TestCase
     guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
     edition = guide
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    user.send_fact_check(edition,{comment: "Review this guide please.", email_addresses: "test@test.com"})
-    user.receive_fact_check(edition, {comment: "Text.<l>content that the SafeHtml validator would catch</l>"})
-    user.send_fact_check(edition,{comment: "Out of office reply triggered receive_fact_check", email_addresses: "test@test.com"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    send_fact_check(user, edition)
+    receive_fact_check(user, edition, "Text.<l>content that the SafeHtml validator would catch</l>")
+    send_fact_check(user, edition, "Out of office reply triggered receive_fact_check")
 
     assert(edition.actions.last.comment.include? "Out of office reply triggered receive_fact_check")
   end
@@ -191,11 +192,12 @@ class WorkflowTest < ActiveSupport::TestCase
     guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
     edition = guide
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    user.send_fact_check(edition,{comment: "Review this guide please.", email_addresses: "test@test.com"})
-    other_user.request_amendments(edition,{comment: "More amendments are required", email_addresses: "foo@bar.com"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    send_fact_check(user, edition)
+    request_amendments(other_user, edition)
 
+    assert_equal 'request_amendments', edition.actions.last.request_type
     assert_equal "More amendments are required", edition.actions.last.comment
   end
 
@@ -207,9 +209,9 @@ class WorkflowTest < ActiveSupport::TestCase
     guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
     edition = guide
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "I've reviewed it"})
-    another_user.request_amendments(edition,{comment: "More amendments are required", email_addresses: "foo@bar.com"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
+    request_amendments(other_user, edition)
 
     assert_equal "More amendments are required", edition.actions.last.comment
   end
@@ -223,13 +225,13 @@ class WorkflowTest < ActiveSupport::TestCase
 
     assert_equal 0, guide.rejected_count
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.request_amendments(edition, {comment: "I've reviewed it"})
+    request_review(user, edition)
+    request_amendments(other_user, edition)
 
     assert_equal 1, guide.rejected_count
 
-    user.request_review(edition,{comment: "Review this guide please."})
-    other_user.approve_review(edition, {comment: "Looks good to me"})
+    request_review(user, edition)
+    approve_review(other_user, edition)
 
     assert_equal 1, guide.rejected_count
   end
@@ -241,9 +243,8 @@ class WorkflowTest < ActiveSupport::TestCase
     edition = guide
 
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this guide please."})
-    refute user.request_amendments(edition, {comment: "Well Done, but work harder"})
-    refute user.can_request_amendments?(edition)
+    request_review(user, edition)
+    refute request_amendments(user, edition)
   end
 
   test "user should not be able to okay a guide they requested review for" do
@@ -253,8 +254,8 @@ class WorkflowTest < ActiveSupport::TestCase
     edition = guide
 
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this guide please."})
-    refute user.approve_review(edition, "")
+    request_review(user, edition)
+    refute approve_review(user, edition)
   end
 
   test "a new programme has drafts but isn't published" do
@@ -268,7 +269,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user, other_user = template_users
 
     refute programme.in_review?
-    user.request_review(programme, {comment: "Review this programme please."})
+    request_review(user, programme)
     assert programme.in_review?, "A review was not requested for this programme."
   end
 
@@ -278,14 +279,14 @@ class WorkflowTest < ActiveSupport::TestCase
     edition = user.create_edition(:programme, panopticon_id: @artefact.id, title: "My title", slug: "my-slug")
 
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this guide please."})
+    request_review(user, edition)
     refute edition.can_request_review?
     assert edition.can_request_amendments?
-    other_user.request_amendments(edition, {comment: "I've reviewed it"})
+    request_amendments(other_user, edition)
     refute edition.can_request_amendments?
-    user.request_review(edition,{comment: "Review this guide please."})
+    request_review(user, edition)
     assert edition.can_approve_review?
-    other_user.approve_review(edition, {comment: "Looks good to me"})
+    approve_review(other_user, edition)
     assert edition.can_request_amendments?
     assert edition.can_publish?
   end
@@ -296,8 +297,8 @@ class WorkflowTest < ActiveSupport::TestCase
     edition = user.create_edition(:programme, panopticon_id: @artefact.id, title: "My title", slug: "my-slug")
 
     assert edition.can_request_review?
-    user.request_review(edition,{comment: "Review this programme please."})
-    refute user.approve_review(edition, "")
+    request_review(user, edition)
+    refute approve_review(user, edition)
   end
 
   test "you can only create a new edition from a published edition" do
@@ -311,7 +312,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user, other_user = template_users
 
     edition = user.create_edition(:programme, panopticon_id: @artefact.id, title: "My title", slug: "my-slug")
-    user.take_action!(edition, "archive")
+    user.progress(edition, { request_type: :archive })
     assert_equal "archived", edition.state
   end
 
@@ -337,14 +338,15 @@ class WorkflowTest < ActiveSupport::TestCase
     user_1, user_2 = template_users
     edition = user_1.create_edition(:answer, panopticon_id: @artefact.id, title: "Answer foo", slug: "answer-foo")
     edition.body = "body content"
+
     user_1.assign(edition, user_2)
-    user_1.request_review(edition,{comment: "Review this guide please."})
+    request_review(user_1, edition)
     assert edition.in_review?
 
-    user_2.approve_review(edition, {comment: "Looks good just now"})
+    approve_review(user_2, edition)
     assert edition.ready?
 
-    user_2.request_amendments(edition, {comment: "More work needed"})
+    request_amendments(user_2, edition)
     assert edition.amends_needed?
   end
 
@@ -352,10 +354,113 @@ class WorkflowTest < ActiveSupport::TestCase
     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')
+    request_review(user, edition)
     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
+
+  context "creating a new version of an edition" do
+    setup do
+      @user = User.new
+      @edition = FactoryGirl.create(:edition, state: :published)
+    end
+
+    should "return false if the edition is not published" do
+      @edition.update_attribute(:state, :in_review)
+      assert_nil @user.new_version(@edition)
+    end
+
+    should "record the action" do
+      new_version = @user.new_version(@edition)
+      assert_equal 'new_version', new_version.actions.last.request_type
+    end
+
+    should "return the new edition" do
+      new_version = @user.new_version(@edition)
+      assert_include new_version.previous_siblings.to_a, @edition
+    end
+
+    context "creating an edition of a different type" do
+      should "build a clone of a new type" do
+        assert_equal GuideEdition, @user.new_version(@edition, "GuideEdition").class
+      end
+
+      should "record the action" do
+        new_version = @user.new_version(@edition)
+        assert_equal 'new_version', new_version.actions.last.request_type
+      end
+    end
+
+    context "when building the edition fails" do
+      setup do
+        @edition.stubs(:build_clone).returns(nil)
+      end
+
+      should "not record the action" do
+        assert_no_difference '@edition.actions.count' do
+          @user.new_version(@edition)
+        end
+      end
+
+      should "return nil" do
+        assert_nil @user.new_version(@edition)
+      end
+    end
+  end
+
+  context "#receive_fact_check" do
+    setup do
+      @edition = FactoryGirl.create(:guide_edition_with_two_parts, state: :fact_check)
+      # Internal links must start with a forward slash eg [link text](/link-destination)
+      @edition.parts.first.update_attribute(:body,
+        "[register and tax your vehicle](registering-an-imported-vehicle)")
+    end
+
+    should "transition an edition with link validation errors to fact_check_received state" do
+      assert @edition.invalid?
+      receive_fact_check(User.new, @edition)
+      assert_equal "fact_check_received", @edition.reload.state
+    end
+
+    should "record the action" do
+      assert_difference '@edition.actions.count', 1 do
+        receive_fact_check(User.new, @edition)
+      end
+      assert_equal "receive_fact_check", @edition.actions.last.request_type
+    end
+  end
+
+  context "#schedule_for_publishing" do
+    setup do
+      @user = FactoryGirl.build(:user)
+      @publish_at = 1.day.from_now.utc
+      @activity_details = { publish_at: @publish_at, comment: "Go schedule !" }
+    end
+
+    should "return false when scheduling an already published edition" do
+      edition = FactoryGirl.create(:edition, state: 'published')
+      refute schedule_for_publishing(@user, edition, @activity_details)
+    end
+
+    should "schedule an edition for publishing if it is ready" do
+      edition = FactoryGirl.create(:edition, state: 'ready')
+
+      schedule_for_publishing(@user, edition, @activity_details)
+
+      assert edition.scheduled_for_publishing?
+      assert_equal @publish_at.to_i, edition.publish_at.to_i
+    end
+
+    should "record the action" do
+      edition = FactoryGirl.create(:edition, state: 'ready')
+      options = { comment: "Go schedule !", request_details: { scheduled_time: @publish_at } }
+
+      assert_difference 'edition.actions.count', 1 do
+        schedule_for_publishing(@user, edition, @activity_details)
+      end
+      assert_equal 'schedule_for_publishing', edition.actions.last.request_type
+    end
+  end
 end

data/test/test_helper.rb

@@ -11,6 +11,7 @@ require "database_cleaner"
 require "gds_api/test_helpers/panopticon"
 require "webmock/test_unit"
 require "govuk_content_models/test_helpers/factories"
+require 'govuk_content_models/test_helpers/action_processor_helpers'
 require "timecop"
 
 # The models depend on a zone being set, so tests will fail if we don't
@@ -27,6 +28,7 @@ class ActiveSupport::TestCase
   PROJECT_ROOT = File.expand_path("../..", __FILE__)
 
   include GdsApi::TestHelpers::Panopticon
+  include GovukContentModels::TestHelpers::ActionProcessorHelpers
 
   def without_metadata_denormalisation(*klasses, &block)
     klasses.each {|klass| klass.any_instance.stubs(:denormalise_metadata).returns(true) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 23.0.0
+  version: 24.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -381,8 +381,8 @@ files:
 - app/models/user.rb
 - app/models/video_edition.rb
 - app/models/workflow.rb
-- app/models/workflow_actor.rb
 - app/traits/attachable.rb
+- app/traits/recordable_actions.rb
 - app/traits/taggable.rb
 - app/validators/browse_page_validator.rb
 - app/validators/link_validator.rb
@@ -395,7 +395,25 @@ files:
 - jenkins.sh
 - jenkins_branches.sh
 - lib/govuk_content_models.rb
+- lib/govuk_content_models/action_processors.rb
+- lib/govuk_content_models/action_processors/approve_fact_check_processor.rb
+- lib/govuk_content_models/action_processors/approve_review_processor.rb
+- lib/govuk_content_models/action_processors/archive_processor.rb
+- lib/govuk_content_models/action_processors/assign_processor.rb
+- lib/govuk_content_models/action_processors/base_processor.rb
+- lib/govuk_content_models/action_processors/cancel_scheduled_publishing_processor.rb
+- lib/govuk_content_models/action_processors/create_edition_processor.rb
+- lib/govuk_content_models/action_processors/emergency_publish_processor.rb
+- lib/govuk_content_models/action_processors/new_version_processor.rb
+- lib/govuk_content_models/action_processors/publish_processor.rb
+- lib/govuk_content_models/action_processors/receive_fact_check_processor.rb
+- lib/govuk_content_models/action_processors/request_amendments_processor.rb
+- lib/govuk_content_models/action_processors/request_review_processor.rb
+- lib/govuk_content_models/action_processors/schedule_for_publishing_processor.rb
+- lib/govuk_content_models/action_processors/send_fact_check_processor.rb
+- lib/govuk_content_models/action_processors/skip_fact_check_processor.rb
 - lib/govuk_content_models/require_all.rb
+- lib/govuk_content_models/test_helpers/action_processor_helpers.rb
 - lib/govuk_content_models/test_helpers/factories.rb
 - lib/govuk_content_models/test_helpers/local_services.rb
 - lib/govuk_content_models/version.rb
@@ -403,6 +421,7 @@ files:
 - test/fixtures/contactotron_api_response.json
 - test/fixtures/specialist_document_fixtures.rb
 - test/fixtures/uploads/image.jpg
+- test/models/action_test.rb
 - test/models/artefact_action_test.rb
 - test/models/artefact_external_link_test.rb
 - test/models/artefact_tag_test.rb
@@ -438,7 +457,6 @@ files:
 - test/models/travel_advice_edition_test.rb
 - test/models/user_test.rb
 - test/models/video_edition_test.rb
-- test/models/workflow_actor_test.rb
 - test/models/workflow_test.rb
 - test/test_helper.rb
 - test/traits/attachable_test.rb
@@ -464,7 +482,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3179151873791569033
+      hash: -1768769484193942965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -473,7 +491,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3179151873791569033
+      hash: -1768769484193942965
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -484,6 +502,7 @@ test_files:
 - test/fixtures/contactotron_api_response.json
 - test/fixtures/specialist_document_fixtures.rb
 - test/fixtures/uploads/image.jpg
+- test/models/action_test.rb
 - test/models/artefact_action_test.rb
 - test/models/artefact_external_link_test.rb
 - test/models/artefact_tag_test.rb
@@ -519,7 +538,6 @@ test_files:
 - test/models/travel_advice_edition_test.rb
 - test/models/user_test.rb
 - test/models/video_edition_test.rb
-- test/models/workflow_actor_test.rb
 - test/models/workflow_test.rb
 - test/test_helper.rb
 - test/traits/attachable_test.rb