govuk_content_models 9.0.1 → 10.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 10.0.0
+
+* Add validation for tag IDs
+
 ## 9.0.1
 
 * Bugfix: `whole_body` can return nil for CompletedTransactionEdition because the body field is no longer used.

data/app/models/tag.rb

@@ -1,4 +1,5 @@
 require "safe_html"
+require 'tag_id_validator'
 
 class Tag
   include Mongoid::Document
@@ -17,6 +18,8 @@ class Tag
   index :tag_type
 
   validates_presence_of :tag_id, :title, :tag_type
+  validates_uniqueness_of :tag_id, scope: :tag_type
+  validates_with TagIdValidator
   validates_with SafeHtml
 
   class MissingTags < RuntimeError

data/app/validators/tag_id_validator.rb

@@ -0,0 +1,17 @@
+class TagIdValidator < ActiveModel::Validator
+
+  def validate(record)
+    unless valid_tag_id?(record.tag_id)
+      record.errors[:tag_id] << "ID must be valid in a URL and have no more than one slash"
+    end
+  end
+
+  private
+
+  def valid_tag_id?(tag_id)
+    tag_id.to_s.match(/\A[a-z0-9\-\/]+\Z/) &&
+      tag_id.to_s.count('/') <= 1 &&
+      ! tag_id.to_s.end_with?('/')
+  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 = "9.0.1"
+  VERSION = "10.0.0"
 end

data/test/models/tag_test.rb

@@ -101,4 +101,18 @@ class TagTest < ActiveSupport::TestCase
 
     assert_equal %w{Business Chips Crime Pie}, tags.map(&:title).sort
   end
+
+  test "should be invalid when tag id already exists for the tag type" do
+    Tag.create!(tag_id: "cars", tag_type: "vehicles", title: "Cars")
+    Tag.create!(tag_id: "cars", tag_type: "gary-numan-songs", title: "Cars")
+
+    tag = Tag.new(tag_id: "cars", tag_type: "vehicles")
+
+    refute tag.valid?
+    assert tag.errors.has_key?(:tag_id)
+  end
+
+  test "should validate with TagIdValidator" do
+    assert_includes Tag.validators.map(&:class), TagIdValidator
+  end
 end

data/test/validators/tag_id_validator_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+require 'tag_id_validator'
+
+class TagIdValidatorTest < ActiveSupport::TestCase
+  class Dummy
+    include Mongoid::Document
+
+    field :tag_id, type: String
+    field :parent_id, type: String
+
+    validates_with TagIdValidator
+  end
+
+  should "permit a lower-case alphanumeric tag id" do
+    dummy = Dummy.new(tag_id: "a-good-tag-id")
+    assert dummy.valid?
+  end
+
+  should "not permit a tag id with spaces" do
+    dummy = Dummy.new(tag_id: "this tag has spaces")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+  should "not permit a tag id with uppercase characters" do
+    dummy = Dummy.new(tag_id: "CLEAN-ALL-THE-THINGS")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+  should "not permit a tag id with non-alphanumeric characters" do
+    dummy = Dummy.new(tag_id: "a-t@g-!d")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+  should "not permit a tag id with underscores" do
+    dummy = Dummy.new(tag_id: "tag_id_with_underscores")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+  should "permit a tag id containing a slash" do
+    dummy = Dummy.new(tag_id: "parent-tag-id/child-tag-id")
+    assert dummy.valid?
+  end
+
+  should "not permit more than one slash in a tag id" do
+    dummy = Dummy.new(tag_id: "parent-tag-id/more/than/one/slash")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+  should "not permit a slash at the end of a tag id" do
+    dummy = Dummy.new(tag_id: "parent-tag-id/")
+    refute dummy.valid?
+    assert dummy.errors.has_key?(:tag_id)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 10.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -392,6 +392,7 @@ files:
 - app/traits/taggable.rb
 - app/validators/safe_html.rb
 - app/validators/slug_validator.rb
+- app/validators/tag_id_validator.rb
 - config/mongoid.yml
 - govuk_content_models.gemspec
 - jenkins.sh
@@ -448,6 +449,7 @@ files:
 - test/traits/taggable_test.rb
 - test/validators/safe_html_validator_test.rb
 - test/validators/slug_validator_test.rb
+- test/validators/tag_id_validator_test.rb
 homepage: https://github.com/alphagov/govuk_content_models
 licenses: []
 post_install_message: 
@@ -463,7 +465,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2591551071857125687
+      hash: -283248144793344771
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -472,7 +474,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2591551071857125687
+      hash: -283248144793344771
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -525,3 +527,4 @@ test_files:
 - test/traits/taggable_test.rb
 - test/validators/safe_html_validator_test.rb
 - test/validators/slug_validator_test.rb
+- test/validators/tag_id_validator_test.rb