govuk_content_models 6.0.2

data/app/validators/safe_html.rb

@@ -0,0 +1,33 @@
+require "govspeak"
+
+class SafeHtml < ActiveModel::Validator
+  def validate(record)
+    record.changes.each do |field_name, (old_value, new_value)|
+      check_struct(record, field_name, new_value)
+    end
+  end
+
+  def check_struct(record, field_name, value)
+    if value.respond_to?(:values) # e.g. Hash
+      value.values.each { |entry| check_struct(record, field_name, entry) }
+    elsif value.respond_to?(:each) # e.g. Array
+      value.each { |entry| check_struct(record, field_name, entry) }
+    elsif value.is_a?(String)
+      check_string(record, field_name, value)
+    end
+  end
+
+  def check_string(record, field_name, string)
+    if record.class::GOVSPEAK_FIELDS.include?(field_name)
+      unless Govspeak::Document.new(string).valid?
+        error = "cannot include invalid Govspeak or JavaScript"
+        record.errors.add(field_name, error)
+      end
+    else
+      unless Govspeak::HtmlValidator.new(string).valid?
+        error = "cannot include invalid HTML or JavaScript"
+        record.errors.add(field_name, error)
+      end
+    end
+  end
+end

data/app/validators/slug_validator.rb

@@ -0,0 +1,53 @@
+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
+      end
+    elsif value.to_s =~ /\Agovernment\/(.+)/ and prefixed_inside_government_format_names.include?(record.kind)
+      parts = $1.split('/')
+    else
+      parts = [value]
+    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
+
+      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
+      end
+    end
+
+    parts.each do |part|
+      unless ActiveSupport::Inflector.parameterize(part.to_s) == part.to_s
+        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"]
+    end
+
+    def prefixed_inside_government_format_names
+      inside_government_format_names - ["detailed_guide"]
+    end
+
+end

data/config/mongoid.yml

@@ -0,0 +1,5 @@
+test:
+  host: localhost
+  database: govuk_content_shared_test
+  logger: false
+  use_activesupport_time_zone: true

data/govuk_content_models.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/govuk_content_models/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Battley"]
+  gem.email         = ["pbattley@gmail.com"]
+  gem.description   = %q{Shared models for Panopticon and Publisher}
+  gem.summary       = %q{Shared models for Panopticon and Publisher, as a Rails Engine}
+  gem.homepage      = "https://github.com/alphagov/govuk_content_models"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "govuk_content_models"
+  gem.require_paths = ["lib", "app"]
+  gem.version       = GovukContentModels::VERSION
+
+  gem.add_dependency "bson_ext"
+  gem.add_dependency "differ"
+  gem.add_dependency "gds-api-adapters"
+
+  gem.add_dependency "gds-sso",          ">= 3.0.0", "< 4.0.0"
+  gem.add_dependency "govspeak",         ">= 1.0.1", "< 2.0.0"
+  # Mongoid 2.5.0 supports the newer 1.7.x and 1.8.x Mongo drivers
+  gem.add_dependency "mongoid",          "~> 2.5"
+  gem.add_dependency "plek"
+  gem.add_dependency "state_machine"
+
+  gem.add_development_dependency "database_cleaner", "0.7.2"
+  gem.add_development_dependency "factory_girl", "3.3.0"
+  gem.add_development_dependency "gem_publisher", "1.2.0"
+  gem.add_development_dependency "mocha", "0.13.3"
+  gem.add_development_dependency "multi_json", "1.3.7" # Pinned to allow dependency resolution
+  gem.add_development_dependency "rake", "0.9.2.2"
+  gem.add_development_dependency "webmock", "1.8.7"
+  gem.add_development_dependency "shoulda-context", "1.0.0"
+  gem.add_development_dependency "timecop", "0.5.9.2"
+
+  # The following are added to help bundler resolve dependencies
+  gem.add_development_dependency "rack", "~> 1.4.4"
+  gem.add_development_dependency "rails", "= 3.2.13"
+end

data/jenkins.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+rm -f Gemfile.lock
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+export GOVUK_APP_DOMAIN=dev.gov.uk
+bundle exec rake
+bundle exec rake publish_gem

data/lib/fact_check_address.rb

@@ -0,0 +1,36 @@
+require "plek"
+
+class FactCheckAddress
+  DOMAIN = "alphagov.co.uk"
+
+  def for_edition(edition)
+    "#{prefix}#{edition.id}@#{DOMAIN}"
+  end
+
+  def valid_address?(address)
+    regexp.match(address)
+  end
+
+  def edition_id_from_address(address)
+    match = valid_address?(address)
+    match && match[1]
+  end
+
+  private
+  def regexp
+    /#{Regexp.escape(prefix)}(.+?)@#{DOMAIN}/
+  end
+
+  def prefix
+    "factcheck+#{environment}-"
+  end
+
+  # Fact check email addresses are environment dependent. This is
+  # a bad thing, but changing it would be very disruptive. Since
+  # Plek no longer gives us access to the environment we have to rely
+  # on the fact that the environment is included in the public domain
+  # name for an app.
+  def environment
+    Plek.current.find('publisher').split('.')[1]
+  end
+end

data/lib/govuk_content_models.rb

@@ -0,0 +1,12 @@
+require "govuk_content_models/version"
+require "mongoid"
+
+begin
+  module GovukContentModels
+    class Engine < Rails::Engine
+    end
+  end
+rescue NameError
+  module GovukContentModels
+  end
+end

data/lib/govuk_content_models/require_all.rb

@@ -0,0 +1,14 @@
+# Require this file in a non-Rails app to load all the things
+require "active_model"
+require "mongoid"
+
+%w[ app/models app/validators app/repositories app/traits lib ].each do |path|
+  full_path = File.expand_path(
+    "#{File.dirname(__FILE__)}/../../#{path}", __FILE__)
+  $LOAD_PATH.unshift full_path unless $LOAD_PATH.include?(full_path)
+end
+
+# Require everything under app
+Dir.glob("#{File.dirname(__FILE__)}/../../app/**/*.rb").each do |file|
+  require file
+end

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -0,0 +1,213 @@
+require "factory_girl"
+require "answer_edition"
+require "artefact"
+require "tag"
+require "user"
+
+FactoryGirl.define do
+  factory :user do
+    sequence(:uid) { |n| "uid-#{n}"}
+    sequence(:name) { |n| "Joe Bloggs #{n}" }
+    sequence(:email) { |n| "joe#{n}@bloggs.com" }
+    if defined?(GDS::SSO::Config)
+      # Grant permission to signin to the app using the gem
+      permissions { ["signin"] }
+    end
+  end
+
+  factory :tag do
+    sequence(:tag_id) { |n| "crime-and-justice/the-police-#{n}" }
+    sequence(:title) { |n| "The title #{n}" }
+    tag_type "section"
+  end
+
+  factory :artefact do
+    sequence(:name) { |n| "Artefact #{n}" }
+    sequence(:slug) { |n| "slug-#{n}" }
+    kind            Artefact::FORMATS.first
+    owning_app      'publisher'
+  end
+
+  factory :non_publisher_artefact, parent: :artefact do
+    kind            'smart-answer'
+    owning_app      'smart-answers'
+  end
+
+  factory :edition, class: AnswerEdition do
+    panopticon_id {
+        a = create(:artefact)
+        a.id
+      }
+
+    sequence(:slug) { |n| "slug-#{n}" }
+    sequence(:title) { |n| "A key answer to your question #{n}" }
+
+    section "test:subsection test"
+
+    association :assigned_to, factory: :user
+  end
+  factory :answer_edition, parent: :edition do
+  end
+
+  factory :help_page_edition, :parent => :edition, :class => 'HelpPageEdition' do
+  end
+
+  factory :campaign_edition, :parent => :edition, :class => 'CampaignEdition' do
+  end
+
+  factory :completed_transaction_edition, :parent => :edition, :class => 'CompletedTransactionEdition' do
+  end
+
+  factory :video_edition, parent: :edition, :class => 'VideoEdition' do
+  end
+
+  factory :business_support_edition, :parent => :edition, :class => "BusinessSupportEdition" do
+    sequence(:business_support_identifier) {|n| "identifier-#{n}" }
+  end
+
+  factory :guide_edition do |ge|
+    panopticon_id {
+        a = create(:artefact)
+        a.id
+      }
+    ge.sequence(:title)  { |n| "Test guide #{n}" }
+    ge.sequence(:slug) { |ns| "slug-#{ns}"}
+    section { "test:subsection test" }
+  end
+
+  factory :programme_edition do |edition|
+    panopticon_id {
+        a = create(:artefact)
+        a.id
+      }
+    edition.sequence(:title) { |n| "Test programme #{n}" }
+    edition.sequence(:slug) { |ns| "slug-#{ns}"}
+    section { "test:subsection test" }
+  end
+
+  factory :guide_edition_with_two_parts, parent: :guide_edition do
+    title "a title"
+    after :create do |getp|
+      getp.parts.build(title: "PART !", body: "This is some version text.",
+                       slug: "part-one")
+      getp.parts.build(title: "PART !!",
+                       body: "This is some more version text.",
+                       slug: "part-two")
+    end
+  end
+
+  factory :guide_edition_with_two_govspeak_parts, parent: :guide_edition do
+    title "A title for govspeak parts"
+    after :create do |getp|
+      getp.parts.build(title: "Some Part Title!",
+                       body: "This is some **version** text.", slug: "part-one")
+      getp.parts.build(title: "Another Part Title",
+                       body: "This is [link](http://example.net/) text.",
+                       slug: "part-two")
+    end
+  end
+
+  factory :local_transaction_edition do |lte|
+    panopticon_id {
+        a = create(:artefact)
+        a.id
+      }
+    title  { "Test title" }
+    version_number 1
+    lte.sequence(:slug) { |ns| "slug-#{ns}"}
+    lte.sequence(:lgsl_code) { |nlgsl| nlgsl }
+    introduction { "Test introduction" }
+    more_information { "This is more information" }
+  end
+
+  factory :transaction_edition do |te|
+    panopticon_id {
+        a = create(:artefact)
+        a.id
+      }
+    title  { "Test title" }
+    version_number 1
+    introduction { "Test introduction" }
+    more_information { "This is more information" }
+    link "http://continue.com"
+    will_continue_on "To be continued..."
+    alternate_methods "Method A or Method B"
+  end
+
+  factory :licence_edition, :parent => :edition, :class => "LicenceEdition" do
+    licence_identifier "AB1234"
+  end
+
+  factory :local_service do |ls|
+    ls.sequence(:lgsl_code)
+    providing_tier { %w{district unitary county} }
+  end
+
+  factory :local_authority do
+    name "Some Council"
+    sequence(:snac) {|n| "%02dAA" % n }
+    sequence(:local_directgov_id)
+    tier "county"
+  end
+
+  factory :local_authority_with_contact, parent: :local_authority do
+    contact_address ["line one", "line two", "line three"]
+    contact_url "http://www.magic.com/contact"
+    contact_phone "0206778654"
+    contact_email "contact@local.authority.gov.uk"
+  end
+
+  factory :local_interaction do
+    association :local_authority
+    url "http://some.council.gov/do.html"
+    sequence(:lgsl_code) {|n| 120 + n }
+    lgil_code 0
+  end
+
+  factory :expectation do
+    sequence(:text) {|n| "You will need #{n} of these."}
+  end
+
+  factory :place_edition do
+    title "Far far away"
+    introduction "Test introduction"
+    more_information "More information"
+    place_type "Location location location"
+  end
+
+  factory :curated_list do
+    sequence(:slug) { |n| "slug-#{n}" }
+  end
+
+  factory :travel_advice_edition do
+    sequence(:country_slug) {|n| "test-country-#{n}" }
+    sequence(:title) {|n| "Test Country #{n}" }
+    change_description "Stuff changed"
+  end
+
+  # These factories only work when used with FactoryGirl.create
+  factory :draft_travel_advice_edition, :parent => :travel_advice_edition do
+  end
+  factory :published_travel_advice_edition, :parent => :travel_advice_edition do
+    after :create do |tae|
+      tae.published_at ||= Time.zone.now.utc
+      tae.state = 'published'
+      tae.save!
+    end
+  end
+  factory :archived_travel_advice_edition, :parent => :travel_advice_edition do
+    after :create do |tae|
+      tae.state = 'archived'
+      tae.save!
+    end
+  end
+
+  factory :simple_smart_answer_edition do
+    panopticon_id {
+      a = create(:artefact)
+      a.id
+    }
+    title "Simple smart answer"
+    body "Introduction to the smart answer"
+  end
+end

data/lib/govuk_content_models/test_helpers/local_services.rb

@@ -0,0 +1,24 @@
+module LocalServicesHelper
+  def make_authority(tier, options)
+    authority = FactoryGirl.create(:local_authority_with_contact,
+                                   snac: options[:snac], tier: tier)
+    add_service_interaction(authority, options[:lgsl]) if options[:lgsl]
+    authority
+  end
+
+  def add_service_interaction(existing_authority, lgsl_code)
+    FactoryGirl.create(:local_interaction, local_authority: existing_authority,
+                       lgsl_code: lgsl_code)
+  end
+
+  def make_service(lgsl_code, providing_tier)
+    LocalService.create!(lgsl_code: lgsl_code, providing_tier: providing_tier)
+  end
+
+  def make_authority_providing(lgsl_code)
+    council = FactoryGirl.create(:local_authority, snac: "00AA", tier: "county")
+    FactoryGirl.create(:local_interaction, local_authority: council,
+                       lgsl_code: lgsl_code)
+    council
+  end
+end