govuk_content_models 29.1.1 → 29.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50dc520a74843e9a3ccd9b5a0427b966711f30b5
-  data.tar.gz: 8ba0639769f9c134d133ff996e9d2d41d4d0ed77
+  metadata.gz: ab1abf4484762f870e3d8e538b706e5cd426a66d
+  data.tar.gz: b6545c3d24622aaf2b7d912bec0612063dc7efad
 SHA512:
-  metadata.gz: 1360728473419a672030754f02164c27f17fb790ef0acf0a1abcac89bb659680e778c6c32ecd894d5e219c65a774fe33e322d499dafd337b39e5b08b96d51ca5
-  data.tar.gz: 7651c6ef9eef44d07dabe3ebe997179f1aa20b89d6e26b5d785a89d66e0343c1c22b8f2d699f4d57fd62740fad031cdd60c5f9f2aa7d4dccdb5184ada39f3c7c
+  metadata.gz: 7e6a87f32f108d5ad7fde9fbcd35a962ff99f15cc93fddb9bc72fb02e8ef3b10f7a803eb6d30c2be0da930b434a125e6313188a13509fc43041a2de2ca965be1
+  data.tar.gz: d264ff8d7bdca85773d58504fcd3e2e4dbafc09df865638bad3386e0715bea87e779ce8e227eca83c8b93443fd2f8d17262699afcc1ad2267b07ac8f9e237d87

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 29.1.2
+
+- Bugfix: revert removal of specialist publisher code since it breaks Panopticon integration
+
 ## 29.1.1
 
 - Bugfix: update question options slugs when their labels are updated

data/app/models/artefact.rb

@@ -37,6 +37,7 @@ 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
@@ -74,6 +75,17 @@ 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"],
     "finder-api"              => ["finder",
                                   "finder_email_signup"],
     "whitehall"               => ["announcement",

data/app/models/prerendered_entity.rb

@@ -0,0 +1,13 @@
+module PrerenderedEntity
+  def create_or_update_by_slug!(attributes)
+    find_or_initialize_by(
+      slug: attributes.fetch(:slug)
+    ).tap do |doc|
+      doc.update_attributes!(attributes)
+    end
+  end
+
+  def find_by_slug(slug)
+    where(slug: slug).first
+  end
+end

data/app/models/rendered_manual.rb

@@ -0,0 +1,17 @@
+require "prerendered_entity"
+
+class RenderedManual
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  extend PrerenderedEntity
+
+  field :manual_id, type: String
+  field :slug, type: String
+  field :title, type: String
+  field :summary, type: String
+  field :section_groups, type: Array
+
+  index "slug", unique: true
+
+  validates_uniqueness_of :slug
+end

data/app/models/rendered_specialist_document.rb

@@ -0,0 +1,19 @@
+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/app/validators/slug_validator.rb

@@ -7,6 +7,8 @@ class SlugValidator < ActiveModel::EachValidator
       HelpPageValidator,
       FinderEmailSignupValidator,
       GovernmentPageValidator,
+      ManualPageValidator,
+      SpecialistDocumentPageValidator,
       BrowsePageValidator,
       DetailedGuideValidator,
       DefaultValidator
@@ -115,6 +117,63 @@ protected
     end
   end
 
+  class ManualPageValidator < InstanceValidator
+    def applicable?
+      of_kind?('manual')
+    end
+
+    def validate!
+      validate_number_of_parts!
+      validate_guidance_prefix!
+      validate_parts_as_slugs!
+    end
+
+  private
+    def validate_number_of_parts!
+      unless [2, 3].include?(url_parts.size)
+        record.errors[attribute] << 'must contains two or three path parts'
+      end
+    end
+
+    def validate_guidance_prefix!
+      unless starts_with?('guidance/')
+        record.errors[attribute] << 'must have a guidance/ prefix'
+      end
+    end
+
+    def validate_parts_as_slugs!
+      unless url_parts.all? { |url_part| valid_slug?(url_part) }
+        record.errors[attribute] << 'must be usable in a URL'
+      end
+    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,6 +252,25 @@ 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}" }
+    summary "My summary"
+  end
+
   factory :simple_smart_answer_edition, :parent => :edition, :class => "SimpleSmartAnswerEdition" do
     title "Simple smart answer"
     body "Introduction to the smart answer"

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

data/test/fixtures/specialist_document_fixtures.rb

@@ -0,0 +1,16 @@
+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/artefact_test.rb

@@ -424,6 +424,15 @@ 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/prerendered_entity_tests.rb

@@ -0,0 +1,46 @@
+# include in a test class and define a #model_class instance method
+
+module PrerenderedEntityTests
+  def test_duplicate_slug_not_allowed
+    model_class.create(slug: "my-slug")
+    second = model_class.create(slug: "my-slug")
+
+    refute second.valid?
+    assert_equal 1, model_class.count
+  end
+
+  def test_has_no_govspeak_fields
+    refute model_class.const_defined?(:GOVSPEAK_FIELDS)
+  end
+
+  def test_create_or_update_by_slug
+    slug = "a-slug"
+    original_body = "Original body"
+
+    version1_attrs= {
+      slug: slug,
+      body: original_body,
+    }
+
+    created = model_class.create_or_update_by_slug!(version1_attrs)
+
+    assert created.is_a?(model_class)
+    assert created.persisted?
+
+    version2_attrs = version1_attrs.merge(
+      body: "Updated body",
+    )
+
+    version2 = model_class.create_or_update_by_slug!(version2_attrs)
+
+    assert version2.persisted?
+    assert_equal "Updated body", version2.body
+  end
+
+  def test_find_by_slug
+    created = model_class.create!(slug: "find-by-this-slug")
+    found = model_class.find_by_slug("find-by-this-slug")
+
+    assert_equal created, found
+  end
+end

data/test/models/rendered_manual_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+require_relative "prerendered_entity_tests"
+
+class RenderedManualTest < ActiveSupport::TestCase
+  include PrerenderedEntityTests
+
+  def model_class
+    RenderedManual
+  end
+end

data/test/models/rendered_specialist_document_test.rb

@@ -0,0 +1,12 @@
+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

data/test/validators/slug_validator_test.rb

@@ -76,6 +76,16 @@ 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?
@@ -108,4 +118,20 @@ class SlugTest < ActiveSupport::TestCase
     end
     #TODO: disallow this once guidance migration has been complete
   end
+
+  context "Manual pages" do
+    should "allow slugs starting guidance/" do
+      refute document_with_slug("manuals/a-manual", kind: "manual").valid?
+      assert document_with_slug("guidance/a-manual", kind: "manual").valid?
+    end
+
+    should "allow two or three path parts" do
+      refute document_with_slug("guidance", kind: "manual").valid?
+      assert document_with_slug("guidance/a-manual", kind: "manual").valid?
+    end
+
+    should "not allow invalid path segments" do
+      refute document_with_slug("guidance/bad.manual.slug", kind: "manual").valid?
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 29.1.1
+  version: 29.1.2
 platform: ruby
 authors:
 - Paul Battley
@@ -307,7 +307,10 @@ files:
 - app/models/part.rb
 - app/models/parted.rb
 - app/models/place_edition.rb
+- 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
@@ -357,6 +360,7 @@ 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
@@ -384,6 +388,9 @@ files:
 - test/models/local_transaction_edition_test.rb
 - test/models/overview_dashboard_test.rb
 - 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
@@ -429,6 +436,7 @@ 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
@@ -456,6 +464,9 @@ test_files:
 - test/models/local_transaction_edition_test.rb
 - test/models/overview_dashboard_test.rb
 - 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