govuk_content_models 12.1.0 → 12.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 12.2.0
+
+* Add ManualChangeHistory model and artefact kind.
+
 ## 12.1.0
 
 * Add LinkValidator, which checks that links in Govspeak fields are properly

data/app/models/artefact.rb

@@ -83,6 +83,7 @@ class Artefact
     "custom-application"      => ["custom-application"], # In this case the owning_app is overriden. eg calendars, licencefinder
     "travel-advice-publisher" => ["travel-advice"],
     "specialist-publisher"    => ["manual",
+                                  "manual-change-history",
                                   "manual-section",
                                   "specialist-document"],
     "finder-api"              => ["finder"],

data/app/models/manual_change_history.rb

@@ -0,0 +1,18 @@
+require "prerendered_entity"
+
+class ManualChangeHistory
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  extend PrerenderedEntity
+
+  field :updates, type: Array
+  field :slug, type: String
+  field :manual_slug, type: String
+
+  index "slug", unique: true
+
+  validates :slug, uniqueness: true
+  validates_with SafeHtml
+
+  GOVSPEAK_FIELDS = []
+end

data/app/validators/slug_validator.rb

@@ -7,6 +7,7 @@ class SlugValidator < ActiveModel::EachValidator
       HelpPageValidator,
       GovernmentPageValidator,
       ManualPageValidator,
+      ManualChangeHistoryValidator,
       SpecialistDocumentPageValidator,
       BrowsePageValidator,
       DefaultValidator
@@ -18,7 +19,11 @@ class SlugValidator < ActiveModel::EachValidator
 protected
   class InstanceValidator < Struct.new(:record, :attribute, :value)
     def starts_with?(expected_prefix)
-      value.to_s[0...expected_prefix.size] == expected_prefix
+      value.to_s.start_with?(expected_prefix)
+    end
+
+    def ends_with?(expected_suffix)
+      value.to_s.end_with?(expected_suffix)
     end
 
     def of_kind?(expected_kind)
@@ -121,7 +126,45 @@ protected
 
     def validate_guidance_prefix!
       unless starts_with?('guidance/')
-        record.errors[attribute] << 'Manual slugs must have a guidance/ prefix'
+        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 ManualChangeHistoryValidator < InstanceValidator
+    def applicable?
+      of_kind?('manual-change-history')
+    end
+
+    def validate!
+      validate_number_of_parts!
+      validate_guidance_prefix!
+      validate_updates_suffix!
+      validate_parts_as_slugs!
+    end
+
+  private
+    def validate_number_of_parts!
+      unless url_parts.size == 3
+        record.errors[attribute] << 'must contain 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_updates_suffix!
+      unless ends_with?('/updates')
+        record.errors[attribute] << 'must have a /updates suffix'
       end
     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 = "12.1.0"
+  VERSION = "12.2.0"
 end

data/test/models/manual_change_history_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+require "models/prerendered_entity_tests"
+
+class ManualChangeHistoryTest < ActiveSupport::TestCase
+  include PrerenderedEntityTests
+
+  def model_class
+    ManualChangeHistory
+  end
+end

data/test/validators/slug_validator_test.rb

@@ -104,6 +104,38 @@ class SlugTest < ActiveSupport::TestCase
     end
   end
 
+  context "Manual change history" do
+    should "allow slugs of the form guidance/manual-slug/updates" do
+      assert document_with_slug("guidance/a-manual/updates",
+                                kind: "manual-change-history").valid?
+    end
+
+    should "refuse slugs that don't start with guidance/" do
+      refute document_with_slug("manuals/a-manual/updates",
+                                kind: "manual-change-history").valid?
+    end
+
+    should "refuse slugs that don't end with /updates" do
+      refute document_with_slug("guidance/a-manual/change-history",
+                                kind: "manual-change-history").valid?
+    end
+
+    should "refuse slugs that don't have a manual-slug" do
+      refute document_with_slug("guidance/change-history",
+                                kind: "manual-change-history").valid?
+    end
+
+    should "refuse slugs that have extra sections" do
+      refute document_with_slug("guidance/a-manual/a-section/updates",
+                                kind: "manual-change-history").valid?
+    end
+
+    should "not allow invalid path segments" do
+      refute document_with_slug("guidance/bad.manual.slug/updates",
+                                kind: "manual-change-history").valid?
+    end
+  end
+
   context "Manual pages" do
     should "allow slugs starting guidance/" do
       refute document_with_slug("manuals/a-manual", kind: "manual").valid?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 12.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -370,6 +370,7 @@ files:
 - app/models/local_interaction.rb
 - app/models/local_service.rb
 - app/models/local_transaction_edition.rb
+- app/models/manual_change_history.rb
 - app/models/overview_dashboard.rb
 - app/models/part.rb
 - app/models/parted.rb
@@ -429,6 +430,7 @@ files:
 - test/models/local_authority_test.rb
 - test/models/local_service_test.rb
 - test/models/local_transaction_edition_test.rb
+- test/models/manual_change_history_test.rb
 - test/models/overview_dashboard_test.rb
 - test/models/prerendered_entity_tests.rb
 - test/models/rendered_manual_test.rb
@@ -466,7 +468,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4316099945977506650
+      hash: -3252707521846681022
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -475,7 +477,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4316099945977506650
+      hash: -3252707521846681022
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -508,6 +510,7 @@ test_files:
 - test/models/local_authority_test.rb
 - test/models/local_service_test.rb
 - test/models/local_transaction_edition_test.rb
+- test/models/manual_change_history_test.rb
 - test/models/overview_dashboard_test.rb
 - test/models/prerendered_entity_tests.rb
 - test/models/rendered_manual_test.rb