govuk_content_models 8.1.0 → 8.2.0

data/app/models/action.rb

@@ -4,17 +4,19 @@ class Action
   include Mongoid::Document
 
   STATUS_ACTIONS = [
-    CREATE              = "create",
-    REQUEST_REVIEW      = "request_review",
-    APPROVE_REVIEW      = "approve_review",
-    APPROVE_FACT_CHECK  = "approve_fact_check",
-    REQUEST_AMENDMENTS  = "request_amendments",
-    SEND_FACT_CHECK     = "send_fact_check",
-    RECEIVE_FACT_CHECK  = "receive_fact_check",
-    SKIP_FACT_CHECK     = "skip_fact_check",
-    PUBLISH             = "publish",
-    ARCHIVE             = "archive",
-    NEW_VERSION         = "new_version",
+    CREATE                      = "create",
+    REQUEST_REVIEW              = "request_review",
+    APPROVE_REVIEW              = "approve_review",
+    APPROVE_FACT_CHECK          = "approve_fact_check",
+    REQUEST_AMENDMENTS          = "request_amendments",
+    SEND_FACT_CHECK             = "send_fact_check",
+    RECEIVE_FACT_CHECK          = "receive_fact_check",
+    SKIP_FACT_CHECK             = "skip_fact_check",
+    SCHEDULE_FOR_PUBLISHING     = "schedule_for_publishing",
+    CANCEL_SCHEDULED_PUBLISHING = "cancel_scheduled_publishing",
+    PUBLISH                     = "publish",
+    ARCHIVE                     = "archive",
+    NEW_VERSION                 = "new_version",
   ]
 
   NON_STATUS_ACTIONS = [

data/app/models/artefact.rb

@@ -1,4 +1,3 @@
-require "slug_validator"
 require "plek"
 require "traits/taggable"
 require "artefact_action"  # Require this when running outside Rails

data/app/models/curated_list.rb

@@ -1,4 +1,3 @@
-require "slug_validator"
 require "traits/taggable"
 require "safe_html"
 

data/app/models/edition.rb

@@ -13,6 +13,7 @@ class Edition
 
   field :title,                type: String
   field :created_at,           type: DateTime, default: lambda { Time.zone.now }
+  field :publish_at,           type: DateTime
   field :overview,             type: String
   field :alternative_title,    type: String
   field :slug,                 type: String
@@ -30,16 +31,12 @@ class Edition
 
   belongs_to :assigned_to, class_name: "User"
 
-  scope :draft,               where(state: "draft")
-  scope :amends_needed,       where(state: "amends_needed")
-  scope :in_review,           where(state: "in_review")
-  scope :fact_check,          where(state: "fact_check")
-  scope :fact_check_received, where(state: "fact_check_received")
-  scope :ready,               where(state: "ready")
-  scope :published,           where(state: "published")
-  scope :archived,            where(state: "archived")
-  scope :in_progress,         where(:state.nin => ["archived", "published"])
-  scope :assigned_to,         lambda { |user|
+  # state_machine comes from Workflow
+  state_machine.states.map(&:name).each do |state|
+    scope state, where(state: state)
+  end
+  scope :in_progress, where(:state.nin => ["archived", "published"])
+  scope :assigned_to, lambda { |user|
     if user
       where(assigned_to_id: user.id)
     else
@@ -50,6 +47,7 @@ class Edition
   validates :title, presence: true
   validates :version_number, presence: true
   validates :panopticon_id, presence: true
+  validate  :publish_at_is_in_the_future
   validates_with SafeHtml
 
   before_save :check_for_archived_artefact
@@ -286,4 +284,10 @@ class Edition
       Artefact.find(self.panopticon_id).destroy
     end
   end
+
+  private
+
+    def publish_at_is_in_the_future
+      errors.add(:publish_at, "can't be a time in the past") if publish_at.present? && publish_at < Time.zone.now
+    end
 end

data/app/models/workflow.rb

@@ -22,6 +22,14 @@ module Workflow
         edition.mark_as_rejected
       end
 
+      before_transition on: :schedule_for_publishing do |edition, transition|
+        edition.publish_at = transition.args.first
+      end
+
+      before_transition on: [:publish, :cancel_scheduled_publishing] do |edition, transition|
+        edition.publish_at = nil
+      end
+
       after_transition on: :publish do |edition, transition|
         edition.was_published
       end
@@ -60,8 +68,16 @@ module Workflow
         transition fact_check: :fact_check_received
       end
 
+      event :schedule_for_publishing do
+        transition ready: :scheduled_for_publishing
+      end
+
+      event :cancel_scheduled_publishing do
+        transition scheduled_for_publishing: :ready
+      end
+
       event :publish do
-        transition ready: :published
+        transition [:ready, :scheduled_for_publishing] => :published
       end
 
       event :emergency_publish do
@@ -71,6 +87,10 @@ module Workflow
       event :archive do
         transition all => :archived, :unless => :archived?
       end
+
+      state :scheduled_for_publishing do
+        validates_presence_of :publish_at
+      end
     end
   end
 
@@ -78,8 +98,10 @@ module Workflow
     (self.actions.where(request_type: Action::APPROVE_FACT_CHECK).count > 0)
   end
 
-  def capitalized_state_name
-    self.human_state_name.capitalize
+  def status_text
+    text = human_state_name.capitalize
+    text += ' on ' + publish_at.strftime("%d/%m/%Y %H:%M") if scheduled_for_publishing?
+    text
   end
 
   def update_user_action(property, statuses)
@@ -146,26 +168,8 @@ module Workflow
     self.actions.sort_by(&:created_at).reverse.find(&blk)
   end
 
-  def not_editing_published_item
-    if changed? and ! state_changed?
-      if archived?
-        errors.add(:base, "Archived editions can't be edited")
-      end
-      if published?
-        changes_allowed_when_published = ["slug", "section",
-                                          "department", "business_proposition"]
-        illegal_changes = changes.keys - changes_allowed_when_published
-        if illegal_changes.empty?
-          # Allow it
-        else
-          errors.add(:base, "Published editions can't be edited")
-        end
-      end
-    end
-  end
-
   def can_destroy?
-    ! published? and ! archived?
+    ! scheduled_for_publishing? && ! published? && ! archived?
   end
 
   def check_can_delete_and_notify
@@ -206,4 +210,25 @@ module Workflow
   def in_progress?
     ! ["archived", "published"].include? self.state
   end
+
+  private
+
+    def not_editing_published_item
+      if changed? and ! state_changed?
+        if archived?
+          errors.add(:base, "Archived editions can't be edited")
+        end
+        if scheduled_for_publishing? || published?
+          changes_allowed_when_published = ["slug", "section",
+                                            "department", "business_proposition"]
+          illegal_changes = changes.keys - changes_allowed_when_published
+          if illegal_changes.empty?
+            # Allow it
+          else
+            edition_description = published? ? 'Published editions' : 'Editions scheduled for publishing'
+            errors.add(:base, "#{edition_description} can't be edited")
+          end
+        end
+      end
+    end
 end

data/app/models/workflow_actor.rb

@@ -6,8 +6,14 @@ require "programme_edition"
 require "transaction_edition"
 
 module WorkflowActor
-  SIMPLE_WORKFLOW_ACTIONS = %W[request_review
-    request_amendments approve_review approve_fact_check archive]
+  SIMPLE_WORKFLOW_ACTIONS = %w(
+    request_review
+    request_amendments
+    approve_review
+    approve_fact_check
+    archive
+    cancel_scheduled_publishing
+  )
 
   def record_action(edition, type, options={})
     type = Action.const_get(type.to_s.upcase)
@@ -27,8 +33,8 @@ module WorkflowActor
     respond_to?(:"can_#{action}?") ? __send__(:"can_#{action}?", edition) : true
   end
 
-  def take_action(edition, action, details = {})
-    if can_take_action(action, edition) and edition.send(action)
+  def take_action(edition, action, details = {}, action_parameters = [])
+    if can_take_action(action, edition) && edition.send(action, *action_parameters)
       record_action(edition, action, details)
       edition
     else
@@ -36,8 +42,8 @@ module WorkflowActor
     end
   end
 
-  def take_action!(edition, action, details = {})
-    edition = take_action(edition, action, details)
+  def take_action!(edition, action, details = {}, action_parameters = [])
+    edition = take_action(edition, action, details, action_parameters)
     edition.save if edition
   end
 
@@ -109,6 +115,11 @@ module WorkflowActor
     end
   end
 
+  def schedule_for_publishing(edition, details)
+    publish_at = details.delete(:publish_at)
+    take_action(edition, __method__, details, [publish_at])
+  end
+
   def publish(edition, details)
     if edition.published_edition
       details.merge!({ diff: edition.edition_changes })
@@ -118,16 +129,16 @@ module WorkflowActor
   end
 
   def can_approve_review?(edition)
-    # To accommodate latest_status_action being nil, we'll always return true in
-    # those cases
-    # This is intended as a v.temporary fix until we can remedy the root cause
-    if edition.latest_status_action
-      edition.latest_status_action.requester_id != self.id
+    requester_different?(edition)
+  end
+
+  def can_request_amendments?(edition)
+    if edition.in_review?
+      requester_different?(edition)
     else
       true
     end
   end
-  alias :can_request_amendments? :can_approve_review?
 
   def assign(edition, recipient)
     edition.assigned_to_id = recipient.id
@@ -138,4 +149,17 @@ module WorkflowActor
     edition.save! and edition.reload
     record_action edition, __method__, recipient: recipient
   end
+
+  private
+
+  def requester_different?(edition)
+    # To accommodate latest_status_action being nil, we'll always return true in
+    # those cases
+    # This is intended as a v.temporary fix until we can remedy the root cause
+    if edition.latest_status_action
+      edition.latest_status_action.requester_id != self.id
+    else
+      true
+    end
+  end
 end

data/lib/govuk_content_models/require_all.rb

@@ -3,13 +3,12 @@ require "active_model"
 require "mongoid"
 require "govuk_content_models"
 
-%w[ app/models app/validators app/repositories app/traits lib ].each do |path|
-  full_path = File.expand_path(
-    "#{File.dirname(__FILE__)}/../../#{path}", __FILE__)
+root_path = "#{File.dirname(__FILE__)}/../.."
+%w[ app/models app/validators app/traits lib ].each do |path|
+  full_path = File.expand_path("#{root_path}/#{path}")
   $LOAD_PATH.unshift full_path unless $LOAD_PATH.include?(full_path)
 end
 
-# Require everything under app
-Dir.glob("#{File.dirname(__FILE__)}/../../app/**/*.rb").each do |file|
-  require file
-end
+# Require validators first, then other files in app
+Dir.glob("#{root_path}/app/validators/*.rb").each {|f| require f }
+Dir.glob("#{root_path}/app/**/*.rb").each {|f| require f }

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -81,6 +81,11 @@ FactoryGirl.define do
     section "test:subsection test"
 
     association :assigned_to, factory: :user
+
+    trait :scheduled_for_publishing do
+      state 'scheduled_for_publishing'
+      publish_at 1.day.from_now
+    end
   end
   factory :answer_edition, parent: :edition do
   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 = "8.1.0"
+  VERSION = "8.2.0"
 end

data/test/models/edition_scheduled_for_publishing_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+
+class EditionScheduledForPublishingTest < ActiveSupport::TestCase
+  context "#schedule_for_publishing" do
+    context "when publish_at is not specified" do
+      setup do
+        @edition = FactoryGirl.create(:edition, state: 'ready')
+        @edition.schedule_for_publishing
+        @edition.reload
+      end
+
+      should "return an error" do
+        assert_includes @edition.errors[:publish_at], "can't be blank"
+      end
+
+      should "not complete the transition to scheduled_for_publishing" do
+        assert_equal 'ready', @edition.state
+      end
+    end
+
+    context "when publish_at is specified" do
+      setup do
+        @edition = FactoryGirl.create(:edition, state: 'ready')
+        @publish_when = 1.day.from_now
+        @edition.schedule_for_publishing(@publish_when)
+        @edition.reload
+      end
+
+      should "save publish_at against the edition" do
+        assert_equal @publish_when.to_i, @edition.publish_at.to_i
+      end
+
+      should "complete the transition to scheduled_for_publishing" do
+        assert_equal 'scheduled_for_publishing', @edition.state
+      end
+    end
+  end
+
+  context "when scheduled_for_publishing" do
+    should "not allow editing fields like title" do
+      edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+
+      edition.title = 'a new title'
+
+      refute edition.valid?
+      assert_includes edition.errors.full_messages, "Editions scheduled for publishing can't be edited"
+    end
+
+    should "allow editing fields like section" do
+      edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+
+      edition.section = 'new section'
+
+      assert edition.save
+      assert_equal edition.reload.section, 'new section'
+    end
+
+    should "return false for #can_destroy?" do
+      edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+      refute edition.can_destroy?
+    end
+
+    should "allow transition to published state" do
+      edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+      assert edition.can_publish?
+    end
+  end
+
+  context "#cancel_scheduled_publishing" do
+    setup do
+      @edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+      @edition.cancel_scheduled_publishing
+      @edition.reload
+    end
+
+    should "remove the publish_at stored against the edition" do
+      assert_nil @edition.publish_at
+    end
+
+    should "complete the transition back to ready" do
+      assert_equal 'ready', @edition.state
+    end
+  end
+end

data/test/models/edition_test.rb

@@ -46,6 +46,15 @@ class EditionTest < ActiveSupport::TestCase
     assert a.errors[:title].any?
   end
 
+  context "#publish_at" do
+    should "not be a time in the past" do
+      edition = FactoryGirl.build(:edition, publish_at: 1.minute.ago)
+
+      refute edition.valid?
+      assert_includes edition.errors[:publish_at], "can't be a time in the past"
+    end
+  end
+
   test "it should give a friendly (legacy supporting) description of its format" do
     a = LocalTransactionEdition.new
     assert_equal "LocalTransaction", a.format
@@ -629,6 +638,15 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal 2, GuideEdition.where(panopticon_id: edition.panopticon_id, state: "archived").count
   end
 
+  test "when an edition is published, publish_at is cleared" do
+    user = FactoryGirl.create(:user)
+    edition = FactoryGirl.create(:edition, :scheduled_for_publishing)
+
+    user.publish edition, comment: "First publication"
+
+    assert_nil edition.reload.publish_at
+  end
+
   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")

data/test/models/workflow_actor_test.rb

@@ -58,4 +58,32 @@ class WorkflowActorTest < ActiveSupport::TestCase
     end
   end
 
+  context "#schedule_for_publishing" do
+    setup do
+      @user = FactoryGirl.build(:user)
+      @publish_at = 1.day.from_now
+      @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 @user.schedule_for_publishing(edition, @activity_details)
+    end
+
+    should "schedule an edition for publishing if it is ready" do
+      edition = FactoryGirl.create(:edition, state: 'ready')
+
+      edition = @user.schedule_for_publishing(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')
+      @user.expects(:record_action).with(edition, :schedule_for_publishing, { comment: "Go schedule !" })
+
+      @user.schedule_for_publishing(edition, @activity_details)
+    end
+  end
 end

data/test/models/workflow_test.rb

@@ -56,6 +56,19 @@ class WorkflowTest < ActiveSupport::TestCase
     return user, transaction
   end
 
+  context "#status_text" do
+    should "return a capitalized text representation of the state" do
+      assert_equal 'Ready', FactoryGirl.build(:edition, state: 'ready').status_text
+    end
+
+    should "also return scheduled publishing time when the state is scheduled for publishing" do
+      edition = FactoryGirl.build(:edition, :scheduled_for_publishing)
+      expected_status_text = 'Scheduled for publishing on ' + edition.publish_at.strftime("%d/%m/%Y %H:%M")
+
+      assert_equal expected_status_text, edition.status_text
+    end
+  end
+
   test "permits the creation of new editions" do
     user, transaction = template_user_and_published_transaction
     assert transaction.persisted?
@@ -219,6 +232,7 @@ class WorkflowTest < ActiveSupport::TestCase
     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)
   end
 
   test "user should not be able to okay a guide they requested review for" do
@@ -347,4 +361,19 @@ class WorkflowTest < ActiveSupport::TestCase
     bs.valid?
     assert_equal "Published editions can't be edited", bs.errors[:base].first
   end
+
+  test "User can request amendments for an edition they just approved" do
+    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."})
+    assert edition.in_review?
+
+    user_2.approve_review(edition, {comment: "Looks good just now"})
+    assert edition.ready?
+
+    user_2.request_amendments(edition, {comment: "More work needed"})
+    assert edition.amends_needed?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -417,6 +417,7 @@ files:
 - test/models/business_support_edition_test.rb
 - test/models/campaign_edition_test.rb
 - test/models/curated_list_test.rb
+- test/models/edition_scheduled_for_publishing_test.rb
 - test/models/edition_test.rb
 - test/models/fact_check_address_test.rb
 - test/models/help_page_edition_test.rb
@@ -457,7 +458,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 484371821541707473
+      hash: 4108751101128219238
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -466,7 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 484371821541707473
+      hash: 4108751101128219238
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -490,6 +491,7 @@ test_files:
 - test/models/business_support_edition_test.rb
 - test/models/campaign_edition_test.rb
 - test/models/curated_list_test.rb
+- test/models/edition_scheduled_for_publishing_test.rb
 - test/models/edition_test.rb
 - test/models/fact_check_address_test.rb
 - test/models/help_page_edition_test.rb