govuk_content_models 29.1.2 → 30.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab1abf4484762f870e3d8e538b706e5cd426a66d
-  data.tar.gz: b6545c3d24622aaf2b7d912bec0612063dc7efad
+  metadata.gz: ace1431a4755075f7fc7d6a9ec4ec9edf0db97cb
+  data.tar.gz: b4744764d54f9a8eff22384617d8c700b4e8caea
 SHA512:
-  metadata.gz: 7e6a87f32f108d5ad7fde9fbcd35a962ff99f15cc93fddb9bc72fb02e8ef3b10f7a803eb6d30c2be0da930b434a125e6313188a13509fc43041a2de2ca965be1
-  data.tar.gz: d264ff8d7bdca85773d58504fcd3e2e4dbafc09df865638bad3386e0715bea87e779ce8e227eca83c8b93443fd2f8d17262699afcc1ad2267b07ac8f9e237d87
+  metadata.gz: 1be2224113f915f7df753dd478728911cddd4439a008457b2d99d63da82d28999acae2e4420c6ceee4df3321cef3eb2dcafc29da8fd6887b45ab4c464c814b4a
+  data.tar.gz: a55c774b064aca486549a103d45111ac4a6d581148ec2c6ab30dc77f26129413c4d7b8b4fe7b0768eeac0557b765a2f8bce0a787afba817399edf363e36c2c88

data/CHANGELOG.md

@@ -1,8 +1,22 @@
 # CHANGELOG
 
+## 30.0.0
+
+- Add:
+  - `content_id` field to the `Artefact` model
+
+- Remove:
+  - `specialist_body` field from `Artefact` model
+  - specialist documents from the list of formats owned by `specialist-publisher`
+  - model for rendering `specialist documents`
+  - `specialist document validator` from `slug validator`, its factory and its fixture
+
+  - Include question/answer texts in change notes for SimpleSmartAnswer editions
+  - Stop discarding some fields when creating a new edition (see: https://github.com/alphagov/govuk_content_models/commit/de295d09ea9bdc7397ee2ce1249d12b9cd1d9d66)
+
 ## 29.1.2
 
-- Bugfix: revert removal of specialist publisher code since it breaks Panopticon integration
+- Bugfix: revert removal of specialist document code since it breaks Panopticon integration
 
 ## 29.1.1
 
@@ -11,6 +25,7 @@
 ## 29.1.0
 
 - Allow detailed guide slugs to start with /guidance
+- Remove code relating to specialist documents
 
 ## 29.0.1
 
@@ -42,6 +57,7 @@
 
 - Change the scheduled publishing timestamp to be London local time
   instead of UTC.
+
 ## 28.7.0
 
 - Add `vehicle_recalls_and_faults_alert` artefact format

data/app/models/answer_edition.rb

@@ -5,8 +5,6 @@ class AnswerEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [:body]
-
   def whole_body
     self.body
   end

data/app/models/artefact.rb

@@ -37,13 +37,18 @@ class Artefact
   field "publication_id",       type: String
   field "description",          type: String
   field "state",                type: String,  default: "draft"
-  field "specialist_body",      type: String
   field "language",             type: String,  default: "en"
   field "need_extended_font",   type: Boolean, default: false
   field "latest_change_note",   type: String
   field "public_timestamp",     type: DateTime
   field "redirect_url",         type: String
 
+  # content_id should be unique but we have existing artefacts without it.
+  # We should therefore enforce the uniqueness as soon as:
+  #  - every current artefact will have a content id assigned
+  #  - every future artefact will be created with a content id
+  field "content_id",           type: String
+
   index "slug", :unique => true
 
   # This index allows the `relatable_artefacts` method to use an index-covered
@@ -75,17 +80,7 @@ class Artefact
     "smartanswers"            => ["smart-answer"],
     "custom-application"      => ["custom-application"], # In this case the owning_app is overriden. eg calendars, licencefinder
     "travel-advice-publisher" => ["travel-advice"],
-    "specialist-publisher"    => ["aaib_report",
-                                  "cma_case",
-                                  "countryside_stewardship_grant",
-                                  "drug_safety_update",
-                                  "european_structural_investment_fund",
-                                  "international_development_fund",
-                                  "maib_report",
-                                  "manual",
-                                  "medical_safety_alert",
-                                  "raib_report",
-                                  "vehicle_recalls_and_faults_alert"],
+    "specialist-publisher"    => ["manual"],
     "finder-api"              => ["finder",
                                   "finder_email_signup"],
     "whitehall"               => ["announcement",

data/app/models/business_support_edition.rb

@@ -39,12 +39,6 @@ class BusinessSupportEdition < Edition
   # https://github.com/mongoid/mongoid/issues/1735 Really Mongoid‽
   validates :min_value, :max_value, :max_employees, :numericality => {:allow_nil => true, :only_integer => true}
 
-  @fields_to_clone = [:body, :min_value, :max_value, :max_employees, :organiser,
-      :eligibility, :evaluation, :additional_information, :continuation_link,
-      :will_continue_on, :contact_details, :short_description, :priority, :areas,
-      :business_sizes, :locations, :purposes, :sectors, :stages, :support_types,
-      :start_date, :end_date]
-
   scope :for_facets, lambda { |facets|
     where({ "$and" => facets_criteria(facets) }).order_by([:priority, :desc], [:title, :asc])
   }

data/app/models/campaign_edition.rb

@@ -14,11 +14,6 @@ class CampaignEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [
-    :body, :large_image_id, :medium_image_id, :small_image_id,
-    :organisation_formatted_name, :organisation_url, :organisation_brand_colour, :organisation_crest
-  ]
-
   BRAND_COLOURS = [
     "attorney-generals-office",
     "cabinet-office",

data/app/models/completed_transaction_edition.rb

@@ -7,10 +7,7 @@ class CompletedTransactionEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [:body]
-
   def whole_body
     self.body
   end
-
 end

data/app/models/edition.rb

@@ -66,9 +66,6 @@ class Edition
   index "created_at"
   index "updated_at"
 
-  class << self; attr_accessor :fields_to_clone end
-  @fields_to_clone = []
-
   alias_method :admin_list_title, :title
 
   def series
@@ -173,24 +170,9 @@ class Edition
   # If the new clone is of the same type, we can copy all its fields over; if
   # we are changing the type of the edition, any fields other than the base
   # fields will likely be meaningless.
-  def fields_to_copy(edition_class)
-    edition_class == self.class ? self.class.fields_to_clone : []
-  end
-
-  def build_clone(edition_class=nil)
-    unless state == "published"
-      raise "Cloning of non published edition not allowed"
-    end
-    unless can_create_new_edition?
-      raise "Cloning of a published edition when an in-progress edition exists
-             is not allowed"
-    end
-
-    edition_class = self.class unless edition_class
-    new_edition = edition_class.new(title: self.title,
-                                    version_number: get_next_version_number)
-
-    real_fields_to_merge = fields_to_copy(edition_class) + [
+  def fields_to_copy(target_class)
+    return_value = [
+      :title,
       :panopticon_id,
       :overview,
       :slug,
@@ -198,31 +180,45 @@ class Edition
       :primary_topic,
       :additional_topics
     ]
-
-    real_fields_to_merge.each do |attr|
-      new_edition[attr] = read_attribute(attr)
+    if target_class == self.class
+      type_specific_keys = self.fields.keys - Edition.fields.keys
+      return_value += type_specific_keys
     end
+    return_value
+  end
 
-    if edition_class == AnswerEdition and %w(GuideEdition ProgrammeEdition TransactionEdition).include?(self.class.name)
-      new_edition.body = whole_body
+  def build_clone(target_class=nil)
+    unless state == "published"
+      raise "Cloning of non published edition not allowed"
     end
-
-    if edition_class == AnswerEdition and self.is_a?(LicenceEdition)
-      new_edition.body = whole_body
-      new_edition.overview = licence_overview
+    unless can_create_new_edition?
+      raise "Cloning of a published edition when an in-progress edition exists
+             is not allowed"
     end
 
-    if edition_class == SimpleSmartAnswerEdition && %w(AnswerEdition GuideEdition ProgrammeEdition TransactionEdition).include?(self.class.name)
-      new_edition.body = whole_body
-    end
+    target_class = self.class unless target_class
+    new_edition = target_class.new(version_number: get_next_version_number)
 
-    if edition_class == TransactionEdition and %w(AnswerEdition GuideEdition ProgrammeEdition).include?(self.class.name)
-      new_edition.more_information = whole_body
+    fields_to_copy(target_class).each do |attr|
+      new_edition[attr] = read_attribute(attr)
     end
 
-    if edition_class == GuideEdition and self.is_a?(AnswerEdition)
-      new_edition.parts.build(title: "Part One", body: whole_body,
-                              slug: "part-one")
+    # If the type is changing, then take the combined body (whole_body) from
+    # the old and decide where to put it in the new.
+    #
+    # Where the type is not changing, the body will already have been copied
+    # above.
+    #
+    # We don't need to copy parts between Parted types here, because the Parted
+    # module does that.
+    if target_class != self.class
+      if new_edition.respond_to?(:parts) and !self.respond_to?(:parts)
+        new_edition.parts.build(title: "Part One", body: whole_body, slug: "part-one")
+      elsif new_edition.respond_to?(:more_information=)
+        new_edition.more_information = whole_body
+      elsif new_edition.respond_to?(:body=)
+        new_edition.body = whole_body
+      end
     end
 
     new_edition

data/app/models/guide_edition.rb

@@ -8,7 +8,6 @@ class GuideEdition < Edition
   field :video_summary, type: String
 
   GOVSPEAK_FIELDS = []
-  @fields_to_clone = [:video_url, :video_summary]
 
   def has_video?
     video_url.present?

data/app/models/help_page_edition.rb

@@ -5,8 +5,6 @@ class HelpPageEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [:body]
-
   def whole_body
     self.body
   end

data/app/models/licence_edition.rb

@@ -14,9 +14,6 @@ class LicenceEdition < Edition
   validate :licence_identifier_unique
   validates_format_of :continuation_link, :with => URI::regexp(%w(http https)), :allow_blank => true
 
-  @fields_to_clone = [:licence_identifier, :licence_short_description,
-                      :licence_overview, :will_continue_on, :continuation_link]
-
   def whole_body
     [licence_short_description, licence_overview].join("\n\n")
   end

data/app/models/local_transaction_edition.rb

@@ -10,10 +10,6 @@ class LocalTransactionEdition < Edition
 
   GOVSPEAK_FIELDS = [:introduction, :more_information, :need_to_know]
 
-  @fields_to_clone = [
-    :lgsl_code, :introduction, :more_information, :need_to_know
-  ]
-
   validate :valid_lgsl_code
 
   def valid_lgsl_code

data/app/models/parted.rb

@@ -8,12 +8,12 @@ module Parted
     klass.after_validation :merge_embedded_parts_errors
   end
 
-  def build_clone(edition_class=nil)
+  def build_clone(target_class=nil)
     new_edition = super
 
     # If the new edition is of the same type or another type that has parts,
     # copy over the parts from this edition
-    if edition_class.nil? or edition_class.include? Parted
+    if target_class.nil? or target_class.include? Parted
       new_edition.parts = self.parts.map {|p| p.dup }
     end
 

data/app/models/place_edition.rb

@@ -8,8 +8,6 @@ class PlaceEdition < Edition
 
   GOVSPEAK_FIELDS = [:introduction, :more_information, :need_to_know]
 
-  @fields_to_clone = [:introduction, :more_information, :place_type, :need_to_know]
-
   def whole_body
     self.introduction
   end

data/app/models/programme_edition.rb

@@ -7,7 +7,6 @@ class ProgrammeEdition < Edition
   before_save :setup_default_parts, on: :create
 
   GOVSPEAK_FIELDS = []
-  @fields_to_clone = []
 
   DEFAULT_PARTS = [
     {title: "Overview", slug: "overview"},

data/app/models/simple_smart_answer_edition.rb

@@ -13,15 +13,16 @@ class SimpleSmartAnswerEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [:body]
-
   def whole_body
-    body
+    parts = [body]
+    unless nodes.nil?
+      parts += nodes.map { |node| "#{node.kind}: #{node.title} \n\n #{node.body}" }
+    end
+    parts.join("\n\n\n")
   end
 
-  def build_clone(edition_class=nil)
-    new_edition = super(edition_class)
-    new_edition.body = self.body
+  def build_clone(target_class=nil)
+    new_edition = super(target_class)
 
     if new_edition.is_a?(SimpleSmartAnswerEdition)
       self.nodes.each {|n| new_edition.nodes << n.clone }

data/app/models/transaction_edition.rb

@@ -13,10 +13,6 @@ class TransactionEdition < Edition
 
   validates_format_of :department_analytics_profile, with: /UA-\d+-\d+/i, allow_blank: true
 
-  @fields_to_clone = [:introduction, :will_continue_on, :link,
-                      :more_information, :alternate_methods,
-                      :need_to_know, :department_analytics_profile]
-
   def indexable_content
     "#{super} #{Govspeak::Document.new(introduction).to_text} #{Govspeak::Document.new(more_information).to_text}".strip
   end

data/app/models/video_edition.rb

@@ -10,8 +10,6 @@ class VideoEdition < Edition
 
   GOVSPEAK_FIELDS = [:body]
 
-  @fields_to_clone = [:video_url, :video_summary, :body]
-
   attaches :caption_file
 
   def has_video?

data/app/validators/slug_validator.rb

@@ -8,7 +8,6 @@ class SlugValidator < ActiveModel::EachValidator
       FinderEmailSignupValidator,
       GovernmentPageValidator,
       ManualPageValidator,
-      SpecialistDocumentPageValidator,
       BrowsePageValidator,
       DetailedGuideValidator,
       DefaultValidator
@@ -148,32 +147,6 @@ protected
     end
   end
 
-  class SpecialistDocumentPageValidator < InstanceValidator
-    def applicable?
-      of_kind?(acceptable_formats)
-    end
-
-    def validate!
-      unless url_parts.size == 2
-        record.errors[attribute] << "must be of form <finder-slug>/<specialist-document-slug>"
-      end
-      unless url_parts.all? { |url_part| valid_slug?(url_part) }
-        record.errors[attribute] << "must be usable in a URL"
-      end
-    end
-
-  private
-    def acceptable_formats
-      Artefact::FORMATS_BY_DEFAULT_OWNING_APP["specialist-publisher"] - unacceptable_formats
-    end
-
-    def unacceptable_formats
-      [
-        "manual",
-      ]
-    end
-  end
-
   class BrowsePageValidator < InstanceValidator
     def applicable?
       of_kind?('specialist_sector')

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -252,19 +252,6 @@ FactoryGirl.define do
     end
   end
 
-  factory :rendered_specialist_document do
-    sequence(:slug) {|n| "test-rendered-specialist-document-#{n}" }
-    sequence(:title) {|n| "Test Rendered Specialist Document #{n}" }
-    summary "My summary"
-    body "<p>My body</p>"
-    details({
-      "opened_date" => "2013-04-20",
-      "market_sector" => "some-market-sector",
-      "case_type" => "a-case-type",
-      "case_state" => "open",
-    })
-  end
-
   factory :rendered_manual do
     sequence(:slug) {|n| "test-rendered-manual-#{n}" }
     sequence(:title) {|n| "Test Rendered Manual #{n}" }

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 = "29.1.2"
+  VERSION = "30.0.0"
 end

data/test/models/artefact_test.rb

@@ -424,15 +424,6 @@ class ArtefactTest < ActiveSupport::TestCase
     assert artefact.any_editions_published?
   end
 
-  test "should have a specialist_body field present for markdown content" do
-    artefact = Artefact.create!(slug: "parent", name: "Harry Potter", kind: "guide", owning_app: "x")
-    refute_includes artefact.attributes, "specialist_body"
-
-    artefact.specialist_body = "Something wicked this way comes"
-    assert_includes artefact.attributes, "specialist_body"
-    assert_equal "Something wicked this way comes", artefact.specialist_body
-  end
-
   test "should have 'video' as a supported FORMAT" do
     assert_includes Artefact::FORMATS, "video"
   end

data/test/models/edition_test.rb

@@ -235,7 +235,8 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal 2, new_edition.version_number
     assert_equal @artefact.id.to_s, new_edition.panopticon_id
     assert_equal "draft", new_edition.state
-    assert_equal "I am a test overview", new_edition.overview
+    assert_match /#{edition.licence_overview}/, new_edition.body
+    assert_match /#{edition.licence_short_description}/, new_edition.body
     assert_equal edition.whole_body, new_edition.body
   end
 
@@ -277,6 +278,24 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal edition.whole_body, new_edition.whole_body
   end
 
+  test "Cloning from SimpleSmartAnswerEdition into AnswerEdition" do
+    edition = FactoryGirl.create(
+        :simple_smart_answer_edition,
+        state: "published",
+        panopticon_id: @artefact.id,
+        version_number: 1,
+        overview: "I am a test overview",
+    )
+    new_edition = edition.build_clone AnswerEdition
+
+    assert_equal AnswerEdition, new_edition.class
+    assert_equal 2, new_edition.version_number
+    assert_equal @artefact.id.to_s, new_edition.panopticon_id
+    assert_equal "draft", new_edition.state
+    assert_equal "I am a test overview", new_edition.overview
+    assert_equal edition.whole_body, new_edition.whole_body
+  end
+
   test "Cloning from AnswerEdition into TransactionEdition" do
     edition = FactoryGirl.create(
         :answer_edition,

data/test/models/simple_smart_answer_edition_test.rb

@@ -56,7 +56,7 @@ class SimpleSmartAnswerEditionTest < ActiveSupport::TestCase
 
     new_edition = edition.build_clone(AnswerEdition)
 
-    assert_equal edition.body, new_edition.body
+    assert_equal "This smart answer is somewhat unique and calls for a different kind of introduction\n\n\nquestion: You approach two open doors. Which do you choose? \n\n ", new_edition.body
 
     assert new_edition.is_a?(AnswerEdition)
     assert ! new_edition.respond_to?(:nodes)

data/test/validators/slug_validator_test.rb

@@ -76,16 +76,6 @@ class SlugTest < ActiveSupport::TestCase
     end
   end
 
-  context "Specialist documents" do
-    should "all url nested one level deep" do
-      assert document_with_slug("some-finder/my-specialist-document", kind: "cma_case").valid?;
-    end
-
-    should "not allow deeper nesting" do
-      refute document_with_slug("some-finder/my-specialist-document/not-allowed", kind: "cma_case").valid?
-    end
-  end
-
   context "Specialist sector browse pages" do
     should "allow a single path part" do
       assert document_with_slug("oil-and-gas", kind: "specialist_sector").valid?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 29.1.2
+  version: 30.0.0
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -310,7 +310,6 @@ files:
 - app/models/prerendered_entity.rb
 - app/models/programme_edition.rb
 - app/models/rendered_manual.rb
-- app/models/rendered_specialist_document.rb
 - app/models/simple_smart_answer_edition.rb
 - app/models/simple_smart_answer_edition/node.rb
 - app/models/simple_smart_answer_edition/node/option.rb
@@ -360,7 +359,6 @@ files:
 - lib/govuk_content_models/version.rb
 - lib/mongoid/monkey_patches.rb
 - 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
@@ -390,7 +388,6 @@ files:
 - test/models/parted_test.rb
 - test/models/prerendered_entity_tests.rb
 - test/models/rendered_manual_test.rb
-- test/models/rendered_specialist_document_test.rb
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb
 - test/models/simple_smart_answer_option_test.rb
@@ -430,13 +427,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Shared models for Panopticon and Publisher, as a Rails Engine
 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
@@ -466,7 +462,6 @@ test_files:
 - test/models/parted_test.rb
 - test/models/prerendered_entity_tests.rb
 - test/models/rendered_manual_test.rb
-- test/models/rendered_specialist_document_test.rb
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb
 - test/models/simple_smart_answer_option_test.rb

data/app/models/rendered_specialist_document.rb

@@ -1,19 +0,0 @@
-require "prerendered_entity"
-
-class RenderedSpecialistDocument
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  extend PrerenderedEntity
-
-  field :slug,                   type: String
-  field :title,                  type: String
-  field :summary,                type: String
-  field :body,                   type: String
-  field :published_at,           type: DateTime
-
-  field :details,                type: Hash
-
-  index "slug", unique: true
-
-  validates :slug, uniqueness: true
-end

data/test/fixtures/specialist_document_fixtures.rb

@@ -1,16 +0,0 @@
-module SpecialistDocumentFixtures
-  def basic_specialist_document_fields
-    {
-      slug: 'cma-cases/merger-investigation-2014',
-      title: "Merger Investigation 2014",
-      summary: "This is the summary of stuff going on in the Merger Investigation 2014",
-      state: "published",
-      body: "A body",
-      opened_date: '2012-04-21',
-      document_id: 'a-document-id',
-      market_sector: 'oil-and-gas',
-      case_type: 'some-case-type',
-      case_state: 'open'
-    }
-  end
-end

data/test/models/rendered_specialist_document_test.rb

@@ -1,12 +0,0 @@
-require "test_helper"
-require "fixtures/specialist_document_fixtures"
-require "models/prerendered_entity_tests"
-
-class RenderedSpecialistDocumentTest < ActiveSupport::TestCase
-  include SpecialistDocumentFixtures
-  include PrerenderedEntityTests
-
-  def model_class
-    RenderedSpecialistDocument
-  end
-end