govuk_content_models 6.3.0 → 6.4.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 6.4.0
+
+Added SpecialistDocumentEdition
+
 ## 6.1.0
 
 makes this gem compatible with gds-sso (9.2.0)

data/app/models/artefact.rb

@@ -78,6 +78,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"    => ["specialist-document"],
     "whitehall"               => ["case_study",
                                   "consultation",
                                   "detailed_guide",

data/app/models/specialist_document_edition.rb

@@ -0,0 +1,16 @@
+class SpecialistDocumentEdition < Edition
+  field :summary, type: String
+  field :body, type: String
+  field :opened_date, type: Date
+  field :closed_date, type: Date
+  field :case_type, type: String
+  field :case_state, type: String
+  field :market_sector, type: String
+  field :outcome_type, type: String
+
+  GOVSPEAK_FIELDS = Edition::GOVSPEAK_FIELDS + [:body]
+
+  def whole_body
+    self.body
+  end
+end

data/app/validators/slug_validator.rb

@@ -1,53 +1,149 @@
 class SlugValidator < ActiveModel::EachValidator
   # implement the method called during validation
   def validate_each(record, attribute, value)
-    if value.to_s =~ /^done\/(.+)/
-      parts = [$1]
-    elsif value.to_s =~ /\Aforeign-travel-advice\/(.+)/ and record.kind == 'travel-advice'
-      parts = [$1]
-    elsif record.respond_to?(:kind) and record.kind == 'help_page'
-      if value.to_s =~ /\Ahelp\/(.+)\z/
-        parts = [$1]
-      else
-        record.errors[attribute] << "Help page slugs must have a help/ prefix"
-        return
+    validators = [
+      DonePageValidator,
+      ForeignTravelAdvicePageValidator,
+      HelpPageValidator,
+      DetailedGuidePageValidator,
+      GovernmentPageValidator,
+      SpecialistDocumentPageValidator,
+      DefaultValidator
+    ].map { |klass| klass.new(record, attribute, value) }
+
+    validators.find(&:applicable?).validate!
+  end
+
+protected
+  class InstanceValidator < Struct.new(:record, :attribute, :value)
+    def starts_with?(expected_prefix)
+      value.to_s[0...expected_prefix.size] == expected_prefix
+    end
+
+    def of_kind?(expected_kind)
+      record.respond_to?(:kind) && [*expected_kind].include?(record.kind)
+    end
+
+    def url_after_first_slash
+      value.to_s.split('/', 2)[1]
+    end
+
+    def url_after_first_slash_is_valid_slug!
+      if !valid_slug?(url_after_first_slash)
+        record.errors[attribute] << "must be usable in a url"
       end
-    elsif value.to_s =~ /\Agovernment\/(.+)/ and prefixed_inside_government_format_names.include?(record.kind)
-      parts = $1.split('/')
-    else
-      parts = [value.clone]
-    end
-
-    if record.respond_to?(:kind)
-      # Inside Government formats use friendly_id to disambiguate clashes, which
-      # potentially results in a trailing '--1' on the last path segment.
-      # Rather than overriding the fairly robust parameterize-based validation
-      # below, we can just fudge the friendly_id added bit
-      if inside_government_format_names.include?(record.kind) && parts.last.include?('--')
-        parts.last.sub!('--', '-')
+    end
+
+    def url_parts
+      value.to_s.split("/")
+    end
+
+    def valid_slug?(url_part)
+      ActiveSupport::Inflector.parameterize(url_part.to_s) == url_part.to_s
+    end
+  end
+
+  class DonePageValidator < InstanceValidator
+    def applicable?
+      starts_with?("done/")
+    end
+
+    def validate!
+      url_after_first_slash_is_valid_slug!
+    end
+  end
+
+  class ForeignTravelAdvicePageValidator < InstanceValidator
+    def applicable?
+      starts_with?("foreign-travel-advice/") && of_kind?('travel-advice')
+    end
+
+    def validate!
+      url_after_first_slash_is_valid_slug!
+    end
+  end
+
+  class HelpPageValidator < InstanceValidator
+    def applicable?
+      of_kind?('help_page')
+    end
+
+    def validate!
+      record.errors[attribute] << "Help page slugs must have a help/ prefix" unless starts_with?("help/")
+      url_after_first_slash_is_valid_slug!
+    end
+  end
+
+  class WhitehallFormatValidator < InstanceValidator
+    def url_parts
+      normalize_last_part_for_friendly_id(super)
+    end
+
+    def validate!
+      unless url_parts.all? { |url_part| valid_slug?(url_part) }
+        record.errors[attribute] << "must be usable in a URL"
       end
+    end
+
+  protected
 
-      if prefixed_inside_government_format_names.include?(record.kind)
-        unless value.to_s =~ /\Agovernment\/(.+)/
-          record.errors[attribute] << "Inside Government slugs must have a government/ prefix"
-        end
+    def normalize_last_part_for_friendly_id(url_parts)
+      url_parts[0...-1] + url_parts[-1..-1].map do |url_part|
+        normalize_for_friendly_id(url_part)
       end
     end
 
-    parts.each do |part|
-      unless ActiveSupport::Inflector.parameterize(part.to_s) == part.to_s
+    def normalize_for_friendly_id(url_part)
+      url_part.sub('--', '-')
+    end
+
+  end
+
+  class DetailedGuidePageValidator < WhitehallFormatValidator
+    def applicable?
+      of_kind?('detailed_guide')
+    end
+  end
+
+  class GovernmentPageValidator < WhitehallFormatValidator
+    def applicable?
+      record.respond_to?(:kind) && prefixed_whitehall_format_names.include?(record.kind)
+    end
+
+    def validate!
+      record.errors[attribute] << "Inside Government slugs must have a government/ prefix" unless starts_with?('government/')
+      super
+    end
+
+  protected
+    def prefixed_whitehall_format_names
+      Artefact::FORMATS_BY_DEFAULT_OWNING_APP["whitehall"] - ["detailed_guide"]
+    end
+  end
+
+  class SpecialistDocumentPageValidator < WhitehallFormatValidator
+    def applicable?
+      of_kind?('specialist-document')
+    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
   end
 
-  private
-    def inside_government_format_names
-      Artefact::FORMATS_BY_DEFAULT_OWNING_APP["whitehall"]
+  class DefaultValidator < InstanceValidator
+    def applicable?
+      true
     end
 
-    def prefixed_inside_government_format_names
-      inside_government_format_names - ["detailed_guide"]
+    def validate!
+      record.errors[attribute] << "must be usable in a url" unless valid_slug?(value)
     end
+  end
 
 end

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -213,6 +213,12 @@ FactoryGirl.define do
     end
   end
 
+  factory :specialist_document_edition do
+    sequence(:slug) {|n| "test-specialist-document-#{n}" }
+    sequence(:title) {|n| "Test Specialist Document #{n}" }
+    summary "My summary"
+  end
+
   factory :simple_smart_answer_edition do
     panopticon_id {
       a = create(:artefact)

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 = "6.3.0"
+  VERSION = "6.4.0"
 end

data/test/models/specialist_document_edition_test.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require "test_helper"
+
+class SpecialistDocumentEditionTest < ActiveSupport::TestCase
+  should "have correct fields" do
+    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"
+    }
+
+    edition = SpecialistDocumentEdition.new(fields)
+
+    assert_equal fields[:title], edition.title
+  end
+
+  should "be persistable" do
+    artefact = FactoryGirl.create(:artefact)
+    edition = SpecialistDocumentEdition.create!(
+      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",
+      panopticon_id: artefact.id
+    )
+
+    found = SpecialistDocumentEdition.where(slug: edition.slug).first
+    assert_equal found.attributes, edition.attributes
+  end
+end
+

data/test/validators/slug_validator_test.rb

@@ -12,31 +12,49 @@ class SlugTest < ActiveSupport::TestCase
     validates :slug, presence: true, uniqueness: true, slug: true
   end
 
-  context "Slugs are checked" do
-    should "validate slugs for normal documents" do
-      record = Dummy.new(name: "Test", slug: "test")
-      assert record.valid?
-    end
+  def document_with_slug(slug, override_options = {})
+    default_options = {
+      name: "Test",
+      slug: slug
+    }
+    Dummy.new(default_options.merge(override_options))
+  end
 
-    should "validate help pages as starting with /help" do
-      record = Dummy.new(name: "Help 1", slug: "test", kind: "help_page")
-      assert record.invalid?
+  context "default slugs" do
+    should "reject url paths" do
+      refute document_with_slug("path/not-allowed").valid?
+    end
 
-      record.slug = "help/test"
-      assert record.valid?
+    should "allow a normal slug" do
+      assert document_with_slug("normal-slug").valid?
     end
+  end
 
-    should "validate inside government slugs as containing /government" do
-      record = Dummy.new(name: "Test 2", slug: "test", kind: "policy")
-      assert record.invalid?
+  context "Help pages" do
+    should "must start with help/" do
+      refute document_with_slug("test", kind: "help_page").valid?
+      assert document_with_slug("help/test", kind: "help_page").valid?
+    end
+  end
 
-      record.slug = "government/test"
-      assert record.valid?
+  context "Inside government slugs" do
+    should "allow slug starting government/" do
+      refute document_with_slug("test", kind: "policy").valid?
+      assert document_with_slug("government/test", kind: "policy").valid?
     end
 
     should "allow friendly_id suffixes to pass" do
-      record = Dummy.new(name: "Test 3", slug: "government/policy/test--3", kind: "policy")
-      assert record.valid?
+      assert document_with_slug("government/policy/test--3", kind: "policy").valid?
+    end
+  end
+
+  context "Specialist documents" do
+    should "all url nested one level deep" do
+      assert document_with_slug("some-finder/my-specialist-document", kind: "specialist-document").valid?
+    end
+
+    should "not allow deeper nesting" do
+      refute document_with_slug("some-finder/my-specialist-document/not-allowed", kind: "specialist-document").valid?
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -377,6 +377,7 @@ files:
 - app/models/simple_smart_answer_edition.rb
 - app/models/simple_smart_answer_edition/node.rb
 - app/models/simple_smart_answer_edition/node/option.rb
+- app/models/specialist_document_edition.rb
 - app/models/tag.rb
 - app/models/transaction_edition.rb
 - app/models/travel_advice_edition.rb
@@ -426,6 +427,7 @@ files:
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb
 - test/models/simple_smart_answer_option_test.rb
+- test/models/specialist_document_edition_test.rb
 - test/models/tag_test.rb
 - test/models/time_zone_test.rb
 - test/models/transaction_edition_test.rb
@@ -454,7 +456,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1683068425110248072
+      hash: 2506025069756162727
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -463,7 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1683068425110248072
+      hash: 2506025069756162727
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -498,6 +500,7 @@ test_files:
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb
 - test/models/simple_smart_answer_option_test.rb
+- test/models/specialist_document_edition_test.rb
 - test/models/tag_test.rb
 - test/models/time_zone_test.rb
 - test/models/transaction_edition_test.rb