govuk_content_models 23.0.0 → 24.0.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 24.0.0
+
+* Major clean-up which replaced `WorkflowActor` with `ActionProcessors`.
+This is a breaking change, shouldn't break any existing functionality,
+but may break re-opened classes, and tests relying on workflow helper
+methods which were present in `WorkflowActor`.
+* Added Edition fields `major_change` and `change_note`
+* Improved the audit log for scheduled publishing to show scheduled time,
+which requires storing it in the `action`.
+
 ## 23.0.0
 
 * Remove important_notes field from Edition

data/app/models/action.rb

@@ -36,6 +36,7 @@ class Action
   field :comment,            type: String
   field :comment_sanitized,  type: Boolean, default: false
   field :request_type,       type: String
+  field :request_details,    type: Hash, default: {}
   field :email_addresses,    type: String
   field :customised_message, type: String
   field :created_at,         type: DateTime, default: lambda { Time.zone.now }
@@ -52,7 +53,13 @@ class Action
   end
 
   def to_s
-    request_type.humanize.capitalize
+    if request_type == SCHEDULE_FOR_PUBLISHING
+      string = "Scheduled for publishing"
+      string += " on #{request_details['scheduled_time'].strftime('%d/%m/%Y %H:%M %Z')}" if request_details['scheduled_time'].present?
+      string
+    else
+      request_type.humanize.capitalize
+    end
   end
 
   def is_fact_check_request?

data/app/models/edition.rb

@@ -1,9 +1,11 @@
+require "traits/recordable_actions"
 require "workflow"
 
 class Edition
   include Mongoid::Document
   include Mongoid::Timestamps
   include Workflow
+  include RecordableActions
 
   field :panopticon_id,        type: String
   field :version_number,       type: Integer,  default: 1
@@ -28,6 +30,8 @@ class Edition
   field :creator,              type: String
   field :publisher,            type: String
   field :archiver,             type: String
+  field :major_change,         type: Boolean, default: false
+  field :change_note,          type: String
 
   GOVSPEAK_FIELDS = []
 
@@ -52,6 +56,7 @@ class Edition
   validates_with SafeHtml
   validates_with LinkValidator, on: :update
   validates_with TopicValidator, BrowsePageValidator
+  validates_presence_of :change_note, if: :major_change
 
   before_save :check_for_archived_artefact
   before_destroy :destroy_artefact

data/app/models/user.rb

@@ -1,14 +1,12 @@
 require "digest/md5"
 require "cgi"
 require "gds-sso/user"
-require "workflow_actor"
 require "safe_html"
 
 class User
   include Mongoid::Document
   include Mongoid::Timestamps
   include GDS::SSO::User
-  include WorkflowActor
 
   # Let an app configure the collection name to use, e.g. set a constant in an
   # initializer
@@ -46,4 +44,32 @@ class User
       opts[:s] ? "?s=#{CGI.escape(opts[:s])}" : ""
     ]
   end
+
+  def progress(edition, action_attributes)
+    request_type = action_attributes.delete(:request_type)
+
+    processor = GovukContentModels::ActionProcessors::REQUEST_TYPE_TO_PROCESSOR[request_type.to_sym]
+    edition = GovukContentModels::ActionProcessors::const_get(processor).new(self, edition, action_attributes, {}).processed_edition
+    edition.save if edition
+  end
+
+  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 = {})
+    GovukContentModels::ActionProcessors::CreateEditionProcessor.new(self, nil, {}, { format: format, edition_attributes: attributes }).processed_edition
+  end
+
+  def new_version(edition, convert_to = nil)
+    GovukContentModels::ActionProcessors::NewVersionProcessor.new(self, edition, {}, { convert_to: convert_to }).processed_edition
+  end
+
+  def assign(edition, recipient)
+    GovukContentModels::ActionProcessors::AssignProcessor.new(self, edition, { recipient_id: recipient.id }).processed_edition
+  end
 end

data/app/models/workflow.rb

@@ -1,5 +1,4 @@
 require "state_machine"
-require "action"
 
 module Workflow
   class CannotDeletePublishedPublication < RuntimeError; end
@@ -15,7 +14,6 @@ module Workflow
 
     field :state, type: String, default: "draft"
     belongs_to :assigned_to, class_name: "User"
-    embeds_many :actions
 
     state_machine initial: :draft do
       after_transition on: :request_amendments do |edition, transition|
@@ -105,18 +103,6 @@ module Workflow
     text
   end
 
-  def update_user_action(property, statuses)
-    actions.where(:request_type.in => statuses).limit(1).each do |action|
-      # This can be invoked by Panopticon when it updates an artefact and associated
-      # editions. The problem is that Panopticon and Publisher users live in different
-      # collections, but share a model and relationships with eg actions.
-      # Therefore, Panopticon might not find a user for an action.
-      if action.requester
-        set(property, action.requester.name)
-      end
-    end
-  end
-
   def denormalise_users!
     set(:assignee, assigned_to.name) if assigned_to
     update_user_action("creator",   [Action::CREATE, Action::NEW_VERSION])
@@ -125,50 +111,6 @@ module Workflow
     self
   end
 
-  def created_by
-    creation = actions.detect do |a|
-      a.request_type == Action::CREATE || a.request_type == Action::NEW_VERSION
-    end
-    creation.requester if creation
-  end
-
-  def published_by
-    publication = actions.where(request_type: Action::PUBLISH).first
-    publication.requester if publication
-  end
-
-  def archived_by
-    publication = actions.where(request_type: Action::ARCHIVE).first
-    publication.requester if publication
-  end
-
-  def latest_status_action(type = nil)
-    if type
-      self.actions.where(request_type: type).last
-    else
-      most_recent_action(&:status_action?)
-    end
-  end
-
-  def last_fact_checked_at
-    last_fact_check = actions.reverse.find(&:is_fact_check_request?)
-    last_fact_check ? last_fact_check.created_at : NullTimestamp.new
-  end
-
-  def new_action(user, type, options={})
-    actions.create!(options.merge(requester_id: user.id, request_type: type))
-  end
-
-  def new_action_without_validation(user, type, options={})
-    action = actions.build(options.merge(requester_id: user.id, request_type: type))
-    save(validate: false)
-    action
-  end
-
-  def most_recent_action(&blk)
-    self.actions.sort_by(&:created_at).reverse.find(&blk)
-  end
-
   def can_destroy?
     ! scheduled_for_publishing? && ! published? && ! archived?
   end
@@ -189,14 +131,6 @@ module Workflow
     siblings.update_all(sibling_in_progress: self.version_number)
   end
 
-  def notify_siblings_of_published_edition
-    siblings.update_all(sibling_in_progress: nil)
-  end
-
-  def update_sibling_in_progress(version_number_or_nil)
-    update_attribute(:sibling_in_progress, version_number_or_nil)
-  end
-
   def in_progress?
     ! ["archived", "published"].include? self.state
   end
@@ -223,6 +157,26 @@ module Workflow
 
   private
 
+    def notify_siblings_of_published_edition
+      siblings.update_all(sibling_in_progress: nil)
+    end
+
+    def update_sibling_in_progress(version_number_or_nil)
+      update_attribute(:sibling_in_progress, version_number_or_nil)
+    end
+
+    def update_user_action(property, statuses)
+      actions.where(:request_type.in => statuses).limit(1).each do |action|
+        # This can be invoked by Panopticon when it updates an artefact and associated
+        # editions. The problem is that Panopticon and Publisher users live in different
+        # collections, but share a model and relationships with eg actions.
+        # Therefore, Panopticon might not find a user for an action.
+        if action.requester
+          set(property, action.requester.name)
+        end
+      end
+    end
+
     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

data/app/traits/recordable_actions.rb

@@ -0,0 +1,53 @@
+require "action"
+
+module RecordableActions
+  extend ActiveSupport::Concern
+
+  included do
+    embeds_many :actions
+
+    def latest_status_action(type = nil)
+      if type
+        self.actions.where(request_type: type).last
+      else
+        most_recent_action(&:status_action?)
+      end
+    end
+
+    def last_fact_checked_at
+      last_fact_check = actions.reverse.find(&:is_fact_check_request?)
+      last_fact_check ? last_fact_check.created_at : NullTimestamp.new
+    end
+
+    def new_action(user, type, options={})
+      actions.create!(options.merge(requester_id: user.id, request_type: type))
+    end
+
+    def new_action_without_validation(user, type, options={})
+      action = actions.build(options.merge(requester_id: user.id, request_type: type))
+      save(validate: false)
+      action
+    end
+
+    def most_recent_action(&blk)
+      self.actions.sort_by(&:created_at).reverse.find(&blk)
+    end
+
+    def created_by
+      creation = actions.detect do |a|
+        a.request_type == Action::CREATE || a.request_type == Action::NEW_VERSION
+      end
+      creation.requester if creation
+    end
+
+    def published_by
+      publication = actions.where(request_type: Action::PUBLISH).first
+      publication.requester if publication
+    end
+
+    def archived_by
+      publication = actions.where(request_type: Action::ARCHIVE).first
+      publication.requester if publication
+    end
+  end
+end

data/lib/govuk_content_models.rb

@@ -1,13 +1,12 @@
 require "govuk_content_models/version"
 require "mongoid"
 require "mongoid/monkey_patches"
+require "govuk_content_models/action_processors"
 
-begin
-  module GovukContentModels
+module GovukContentModels
+  if defined?(Rails)
     class Engine < Rails::Engine
+      config.autoload_paths << File.expand_path('govuk_content_models/action_processors', __FILE__)
     end
   end
-rescue NameError
-  module GovukContentModels
-  end
 end

data/lib/govuk_content_models/action_processors.rb

@@ -0,0 +1,23 @@
+require "govuk_content_models/action_processors/base_processor"
+Dir[File.join(File.dirname(__FILE__), 'action_processors', '*.rb')].each { |f| require f }
+
+module GovukContentModels
+  module ActionProcessors
+    REQUEST_TYPE_TO_PROCESSOR = {
+      assign: 'AssignProcessor',
+      create_edition: 'CreateEditionProcessor',
+      request_review: 'RequestReviewProcessor',
+      approve_review: 'ApproveReviewProcessor',
+      send_fact_check: 'SendFactCheckProcessor',
+      receive_fact_check: 'ReceiveFactCheckProcessor',
+      approve_fact_check: 'ApproveFactCheckProcessor',
+      skip_fact_check: 'SkipFactCheckProcessor',
+      request_amendments: 'RequestAmendmentsProcessor',
+      schedule_for_publishing: 'ScheduleForPublishingProcessor',
+      cancel_scheduled_publishing: 'CancelScheduledPublishingProcessor',
+      publish: 'PublishProcessor',
+      archive: 'ArchiveProcessor',
+      new_version: 'NewVersionProcessor',
+    }
+  end
+end

data/lib/govuk_content_models/action_processors/approve_fact_check_processor.rb

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

data/lib/govuk_content_models/action_processors/approve_review_processor.rb

@@ -0,0 +1,11 @@
+module GovukContentModels
+  module ActionProcessors
+    class ApproveReviewProcessor < BaseProcessor
+
+      def process?
+        requester_different?
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/archive_processor.rb

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

data/lib/govuk_content_models/action_processors/assign_processor.rb

@@ -0,0 +1,12 @@
+module GovukContentModels
+  module ActionProcessors
+    class AssignProcessor < BaseProcessor
+
+      def process
+        edition.set(:assigned_to_id, action_attributes[:recipient_id])
+        edition.reload
+      end
+
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/base_processor.rb

@@ -0,0 +1,59 @@
+module GovukContentModels
+  module ActionProcessors
+    class BaseProcessor
+      attr_accessor :actor, :edition, :action_attributes, :event_attributes
+
+      def initialize(actor, edition, action_attributes={}, event_attributes={})
+        @actor = actor
+        @edition = edition
+        @action_attributes = action_attributes
+        @event_attributes = event_attributes
+      end
+
+      def processed_edition
+        if process? && process
+          record_action if record_action?
+          edition
+        end
+      end
+
+      protected
+
+      def process?
+        true
+      end
+
+      def process
+        edition.send(action_name)
+      end
+
+      def record_action?
+        true
+      end
+
+      def action_name
+        REQUEST_TYPE_TO_PROCESSOR.invert[self.class.name.slice(/.*::(.*)/, 1)]
+      end
+
+      def record_action
+        new_action = edition.new_action(actor, action_name, action_attributes || {})
+        edition.denormalise_users!
+        new_action
+      end
+
+      def record_action_without_validation
+        new_action = edition.new_action_without_validation(actor, action_name, action_attributes || {})
+        edition.denormalise_users!
+        new_action
+      end
+
+      def requester_different?
+        if edition.latest_status_action
+          edition.latest_status_action.requester_id != actor.id
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/govuk_content_models/action_processors/cancel_scheduled_publishing_processor.rb

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