govuk_content_models 12.0.0 → 12.1.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 12.1.0
+
+* Add LinkValidator, which checks that links in Govspeak fields are properly
+  formed and do not contain title text or rel=external. Remove
+  GovspeakSmartQuotesFixer which is irrelevant now title text is no longer
+  allowed.
+
 ## 12.0.0
 
 * Remove `SpecialistDocumentEdition` model. It is only used by the

data/app/models/edition.rb

@@ -48,6 +48,7 @@ class Edition
   validates :version_number, presence: true, uniqueness: {scope: :panopticon_id}
   validates :panopticon_id, presence: true
   validates_with SafeHtml
+  validates_with LinkValidator
 
   before_save :check_for_archived_artefact
   before_destroy :destroy_artefact

data/app/models/part.rb

@@ -1,5 +1,4 @@
 require "safe_html"
-require 'govspeak_smart_quotes_fixer'
 
 class Part
   include Mongoid::Document
@@ -18,11 +17,10 @@ class Part
 
   GOVSPEAK_FIELDS = [:body]
 
-  include GovspeakSmartQuotesFixer
-
   validates_presence_of :title
   validates_presence_of :slug
   validates_exclusion_of :slug, in: ["video"], message: "Can not be video"
   validates_format_of :slug, with: /^[a-z0-9\-]+$/i
   validates_with SafeHtml
+  validates_with LinkValidator
 end

data/app/models/travel_advice_edition.rb

@@ -2,7 +2,6 @@ require 'attachable'
 require 'parted'
 require 'state_machine'
 require 'safe_html'
-require 'govspeak_smart_quotes_fixer'
 
 class TravelAdviceEdition
   include Mongoid::Document
@@ -38,7 +37,6 @@ class TravelAdviceEdition
     "avoid_all_travel_to_whole_country",
   ]
 
-  include GovspeakSmartQuotesFixer
   before_validation :populate_version_number, :on => :create
 
   validates_presence_of :country_slug, :title
@@ -47,6 +45,7 @@ class TravelAdviceEdition
   validate :alert_status_contains_valid_values
   validate :first_version_cant_be_minor_update
   validates_with SafeHtml
+  validates_with LinkValidator
 
   scope :published, where(:state => "published")
 

data/app/validators/link_validator.rb

@@ -0,0 +1,48 @@
+class LinkValidator < ActiveModel::Validator
+  def validate(record)
+    record.changes.each do |field_name, (_, new_value)|
+      if govspeak_fields(record).include?(field_name.to_sym)
+        messages = errors(new_value)
+        record.errors[field_name] << messages if messages
+      end
+    end
+  end
+
+  def errors(string)
+    link_regex = %r{
+      \[.*?\]           # link text in literal square brackets
+      \(                # literal opening parenthesis
+         (\S*?)           # containing URL
+         (\s+"[^"]+")?    # and optional space followed by title text in quotes
+      \)                # literal close paren
+      (\{:rel=["']external["']\})?  # optional :rel=external in literal curly brackets.
+    }x
+
+    errors = []
+
+    string.scan(link_regex) do |match|
+
+      error = if match[0] !~ %r{^(?:https?://|mailto:|/)}
+        'Internal links must start with a forward slash eg [link text](/link-destination). External links must start with http://, https://, or mailto: eg [external link text](https://www.google.co.uk)'
+      elsif match[1]
+        %q-Don't include hover text in links. Delete the text in quotation marks eg "This appears when you hover over the link."-
+      elsif match[2]
+        'Delete {:rel="external"} in links.'
+      end
+
+      errors << error if error
+    end
+    errors
+  end
+
+  protected
+
+  def govspeak_fields(record)
+    if record.class.const_defined?(:GOVSPEAK_FIELDS)
+      record.class.const_get(:GOVSPEAK_FIELDS)
+    else
+      []
+    end
+  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.0.0"
+  VERSION = "12.1.0"
 end

data/test/models/travel_advice_edition_test.rb

@@ -213,28 +213,6 @@ class TravelAdviceEditionTest < ActiveSupport::TestCase
     end
   end
 
-  context "fixing user input" do
-    setup do
-      @ed = FactoryGirl.build(:travel_advice_edition)
-    end
-
-    should "convert smart quotes in the summary field" do
-      @ed.summary = "This is a [link](https://www.gov.uk/ “link”)"
-      @ed.save!
-
-      @ed.reload
-      assert_equal 'This is a [link](https://www.gov.uk/ "link")', @ed.summary
-    end
-
-    should "convert smart quotes in part bodies" do
-      @ed.parts.build(:title => 'One', :slug => 'one', :body => "This is a [link](https://www.gov.uk/ “link”)")
-      @ed.save!
-
-      @ed.reload
-      assert_equal 'This is a [link](https://www.gov.uk/ "link")', @ed.parts.first.body
-    end
-  end
-
   should "have a published scope" do
     e1 = FactoryGirl.create(:draft_travel_advice_edition)
     e2 = FactoryGirl.create(:published_travel_advice_edition)

data/test/validators/link_validator_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class LinkValidatorTest < ActiveSupport::TestCase
+  class Dummy
+    include Mongoid::Document
+
+    field "body", type: String
+    GOVSPEAK_FIELDS = [:body]
+
+    validates_with LinkValidator
+  end
+
+  context "links" do
+    should "start with http[s]://, mailto: or /" do
+      doc = Dummy.new(body: "abc [external](external.com)")
+      assert doc.invalid?
+      assert_includes doc.errors.keys, :body
+
+      doc = Dummy.new(body: "abc [external](http://external.com)")
+      assert doc.valid?
+
+      doc = Dummy.new(body: "abc [internal](/internal)")
+      assert doc.valid?
+    end
+    should "start not contain hover text" do
+      doc = Dummy.new(body: 'abc [foobar](foobar.com "hover")')
+      assert doc.invalid?
+      assert_includes doc.errors.keys, :body
+    end
+    should "start not set rel=external" do
+      doc = Dummy.new(body: 'abc [foobar](foobar.com){:rel="external"}')
+      assert doc.invalid?
+      assert_includes doc.errors.keys, :body
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -389,8 +389,8 @@ files:
 - app/models/workflow.rb
 - app/models/workflow_actor.rb
 - app/traits/attachable.rb
-- app/traits/govspeak_smart_quotes_fixer.rb
 - app/traits/taggable.rb
+- app/validators/link_validator.rb
 - app/validators/safe_html.rb
 - app/validators/slug_validator.rb
 - app/validators/tag_id_validator.rb
@@ -447,6 +447,7 @@ files:
 - test/test_helper.rb
 - test/traits/attachable_test.rb
 - test/traits/taggable_test.rb
+- test/validators/link_validator_test.rb
 - test/validators/safe_html_validator_test.rb
 - test/validators/slug_validator_test.rb
 - test/validators/tag_id_validator_test.rb
@@ -465,7 +466,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3589363428373326753
+      hash: 4316099945977506650
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -474,7 +475,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3589363428373326753
+      hash: 4316099945977506650
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -525,6 +526,7 @@ test_files:
 - test/test_helper.rb
 - test/traits/attachable_test.rb
 - test/traits/taggable_test.rb
+- test/validators/link_validator_test.rb
 - test/validators/safe_html_validator_test.rb
 - test/validators/slug_validator_test.rb
 - test/validators/tag_id_validator_test.rb

data/app/traits/govspeak_smart_quotes_fixer.rb

@@ -1,19 +0,0 @@
-# encoding: UTF-8
-
-module GovspeakSmartQuotesFixer
-  def self.included(model)
-    model.class_eval do
-      before_validation :fix_smart_quotes_in_govspeak
-    end
-  end
-
-  private
-
-  def fix_smart_quotes_in_govspeak
-    self.class::GOVSPEAK_FIELDS.each do |field|
-      if self.send(field) =~ /[“”]/
-        self.send(field).gsub!(/[“”]/, '"')
-      end
-    end
-  end
-end