govuk_content_models 29.0.1 → 29.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e08e3144ef51eba2493c273fc127e383d80364
-  data.tar.gz: cc5c02fd3d0aef0b5219a6b4d0e38a911326f29a
+  metadata.gz: a121fff0d81773c3acfd3666904c3b81770213fa
+  data.tar.gz: 10b3f0778399eb518163df1cffd4b70e84572b61
 SHA512:
-  metadata.gz: ee74ac88cfbaa85dc1d9bf879998b7ee3f8a9320f9617427e2f0a119346d3ea257fddbd04c575b154e6a827bbc50eda7b3c51bf2d149ec7cec0580c83e33b51f
-  data.tar.gz: 5305758f70dfce47c17a97e04b2b58cdf2d13382eab4e4b090ebabebadff6d073994b7c77cf44c4ae70d8f3dce1239b1e75f4e2e643f2d77295ef6003bf7aed7
+  metadata.gz: c54a371b42da309fce13c72b3be6085b5e90005aa93d92b8c7d33d3d176cbc1fae047d4556a0b06bad938efe4fb6dfca5ce5b090e8489350b9a538de00efedb8
+  data.tar.gz: ac2f04839f067d3801fb17691df3293d9c1a2ddf6a3c0296571e2c30fe97b23b7a678bd9183eeb69c317549edda3f0355d1e82f2097d1a66fbd5b2beabf7d7f1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 29.1.0
+- Allow detailed guide slugs to start with /guidance
+
 ## 29.0.1
 
 - Bugfix: updated_at field on non-archive editions was being updated whenever an Artefact was saved. Now only do so when the slug has changed.

data/app/models/artefact.rb

@@ -37,7 +37,6 @@ 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
@@ -75,17 +74,6 @@ 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/validators/slug_validator.rb

@@ -7,9 +7,8 @@ class SlugValidator < ActiveModel::EachValidator
       HelpPageValidator,
       FinderEmailSignupValidator,
       GovernmentPageValidator,
-      ManualPageValidator,
-      SpecialistDocumentPageValidator,
       BrowsePageValidator,
+      DetailedGuideValidator,
       DefaultValidator
     ].map { |klass| klass.new(record, attribute, value) }
 
@@ -116,75 +115,28 @@ 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
+  class BrowsePageValidator < InstanceValidator
     def applicable?
-      of_kind?(acceptable_formats)
+      of_kind?('specialist_sector')
     end
 
     def validate!
-      unless url_parts.size == 2
-        record.errors[attribute] << "must be of form <finder-slug>/<specialist-document-slug>"
+      unless [1, 2].include?(url_parts.size)
+        record.errors[attribute] << "must contains one or two path parts"
       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
+  class DetailedGuideValidator < InstanceValidator
     def applicable?
-      of_kind?('specialist_sector')
+      of_kind?('detailed_guide')
     end
 
     def validate!
-      unless [1, 2].include?(url_parts.size)
-        record.errors[attribute] << "must contains one or two path parts"
-      end
-      unless url_parts.all? { |url_part| valid_slug?(url_part) }
-        record.errors[attribute] << "must be usable in a URL"
-      end
+      record.errors[attribute] << "must be a valid URL either at the root or under 'guidance/'" unless value.match(%r{^(guidance/)?[a-z0-9\-_]+$})
     end
   end
 

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -252,25 +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}" }
-    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.0.1"
+  VERSION = "29.1.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/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?
@@ -104,19 +94,18 @@ class SlugTest < ActiveSupport::TestCase
     end
   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?
+  context "Detailed guides slugs" do
+    should "allow a '/' in the slug" do
+      assert document_with_slug("guidance/british-forces-overseas-posting-cyprus", kind: "detailed_guide").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?
+    should "allow only one '/' in the slug" do
+      refute document_with_slug("guidance/british-forces-overseas-posting-cyprus/more-information", kind: "detailed_guide").valid?
     end
 
-    should "not allow invalid path segments" do
-      refute document_with_slug("guidance/bad.manual.slug", kind: "manual").valid?
+    should "ensure it allows slugs that start at the root" do
+      assert document_with_slug("british-forces-overseas-posting-cyprus", kind: "detailed_guide").valid?
     end
+    #TODO: disallow this once guidance migration has been complete
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 29.0.1
+  version: 29.1.0
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -307,10 +307,7 @@ 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
@@ -360,7 +357,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
@@ -388,9 +384,6 @@ 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
@@ -436,7 +429,6 @@ 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
@@ -464,9 +456,6 @@ 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

data/app/models/prerendered_entity.rb

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

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

@@ -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/prerendered_entity_tests.rb

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

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

@@ -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