govuk_content_models 6.0.2

data/test/models/tag_test.rb

@@ -0,0 +1,92 @@
+require "test_helper"
+
+class TagTest < ActiveSupport::TestCase
+  test "should return a hash of the fields" do
+    tag = Tag.new(
+      tag_id: "crime",
+      tag_type: "section",
+      title: "Crime"
+    )
+    expected_hash = {
+      id: "crime",
+      title: "Crime",
+      type: "section",
+      description: nil,
+      short_description: nil
+    }
+    assert_equal expected_hash, tag.as_json
+  end
+
+  setup do
+    %w(crime business housing).each do |section|
+      FactoryGirl.create(:tag, :tag_id => section, :title => section.capitalize)
+    end
+
+    %w(pie mash chips).each do |keyword|
+      FactoryGirl.create(
+        :tag,
+        :tag_id => keyword,
+        :title => keyword.capitalize,
+        :tag_type => "keyword"
+      )
+    end
+  end
+
+  test "should load by tag ID" do
+    assert_equal "Crime", Tag.by_tag_id("crime").title
+  end
+
+  test "should load by tag ID and type" do
+    assert_equal "Crime", Tag.by_tag_id("crime", "section").title
+  end
+
+  test "should not load an incorrectly-typed tag" do
+    assert_nil Tag.by_tag_id("crime", "keyword")
+  end
+
+  test "should return nil if tag does not exist" do
+    assert_nil Tag.by_tag_id("batman")
+  end
+
+  test "should return multiple tags" do
+    assert_equal(
+      %w(Crime Business),
+      Tag.by_tag_ids(%w(crime business)).map(&:title)
+    )
+  end
+
+  test "should return nil for missing tags" do
+    tag_ids = %w(crime business batman housing)
+    tags = Tag.by_tag_ids(tag_ids)
+    assert_nil tags[2]
+    [0, 1, 3].each do |i|
+      assert_equal tag_ids[i], tags[i].tag_id
+    end
+  end
+
+  test "should return nil for tags of the wrong type" do
+    tag_ids = %w(crime business pie batman)
+    tags = Tag.by_tag_ids(tag_ids, "section")
+    [2, 3].each do |i| assert_nil tags[i] end
+    [0, 1].each do |i| assert_equal tag_ids[i], tags[i].tag_id end
+  end
+
+  test "should return multiple tags from the bang method" do
+    assert_equal(
+      %w(Crime Business),
+      Tag.by_tag_ids!(%w(crime business)).map(&:title)
+    )
+  end
+
+  test "should raise an exception if any tags are missing" do
+    assert_raises Tag::MissingTags do
+      Tag.by_tag_ids!(%w(crime business batman))
+    end
+  end
+
+  test "should raise an exception with the wrong tag type" do
+    assert_raises Tag::MissingTags do
+      Tag.by_tag_ids!(%w(crime business pie chips), "section")
+    end
+  end
+end

data/test/models/time_zone_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class TimeZoneTest < ActiveSupport::TestCase
+  def first_day_of_summer_time
+    Time.zone.parse("2013-04-01")
+  end
+
+  def wintertime
+    Time.zone.parse("2013-01-01")
+  end
+
+  context "use_activesupport_time_zone is set to true, Time.zone is set to 'London'" do
+    setup do
+      # This context has already been set in the local mongoid.yml, and in test_helper.rb
+    end
+
+    should "still store the date in UTC" do
+      Timecop.freeze(wintertime) do
+        FactoryGirl.create(:artefact)
+        assert_equal 'UTC', Artefact.last[:created_at].zone
+        assert_equal 'GMT', Artefact.last.created_at.zone
+      end
+    end
+
+    should "use the Time.zone time zone for dot-methods" do
+      Timecop.freeze(wintertime) do
+        FactoryGirl.create(:artefact)
+        assert_equal 'GMT', Artefact.last.created_at.zone
+      end
+    end
+
+    context "it is currently British Summer Time" do
+      should "still store the date in UTC" do
+        Timecop.freeze(first_day_of_summer_time) do
+          FactoryGirl.create(:artefact)
+          assert_equal 'UTC', Artefact.last[:created_at].zone
+        end
+      end
+
+      should "use the time zone with offset for dot-methods" do
+        Timecop.freeze(first_day_of_summer_time) do
+          FactoryGirl.create(:artefact)
+          assert_equal 'BST', Artefact.last.created_at.zone
+        end
+      end
+    end
+  end
+end

data/test/models/transaction_edition_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class TransactionEditionTest < ActiveSupport::TestCase
+
+  setup do
+    @artefact = FactoryGirl.create(:artefact)
+  end
+
+  context "indexable_content" do
+    should "include the introduction without markup" do
+      transaction = FactoryGirl.create(:transaction_edition, introduction: "## introduction", more_information: "", panopticon_id: @artefact.id)
+      assert_equal "introduction", transaction.indexable_content
+    end
+
+    should "include the more_information without markup" do
+      transaction = FactoryGirl.create(:transaction_edition, more_information: "## more info", introduction: "", panopticon_id: @artefact.id)
+      assert_equal "more info", transaction.indexable_content
+    end
+  end
+end

data/test/models/travel_advice_edition_test.rb

@@ -0,0 +1,480 @@
+# encoding: UTF-8
+
+require "test_helper"
+
+class TravelAdviceEditionTest < ActiveSupport::TestCase
+
+  should "have correct fields" do
+    ed = TravelAdviceEdition.new
+    ed.title = "Travel advice for Aruba"
+    ed.overview = "This gives travel advice for Aruba"
+    ed.country_slug = 'aruba'
+    ed.alert_status = [ 'avoid_all_but_essential_travel_to_parts', 'avoid_all_travel_to_parts' ]
+    ed.summary = "This is the summary of stuff going on in Aruba"
+    ed.version_number = 4
+    ed.image_id = "id_from_the_asset_manager_for_an_image"
+    ed.document_id = "id_from_the_asset_manager_for_a_document"
+    ed.published_at = Time.zone.parse('2013-02-21T14:56:22Z')
+    ed.minor_update = true
+    ed.change_description = "Some things"
+    ed.synonyms = ["Foo", "Bar"]
+    ed.parts.build(:title => "Part One", :slug => "one")
+    ed.safely.save!
+
+    ed = TravelAdviceEdition.first
+    assert_equal "Travel advice for Aruba", ed.title
+    assert_equal "This gives travel advice for Aruba", ed.overview
+    assert_equal 'aruba', ed.country_slug
+    assert_equal [ 'avoid_all_but_essential_travel_to_parts', 'avoid_all_travel_to_parts' ], ed.alert_status
+    assert_equal "This is the summary of stuff going on in Aruba", ed.summary
+    assert_equal 4, ed.version_number
+    assert_equal "id_from_the_asset_manager_for_an_image", ed.image_id
+    assert_equal "id_from_the_asset_manager_for_a_document", ed.document_id
+    assert_equal Time.zone.parse('2013-02-21T14:56:22Z'), ed.published_at
+    assert_equal true, ed.minor_update
+    assert_equal ["Foo", "Bar"], ed.synonyms
+    assert_equal "Some things", ed.change_description
+    assert_equal "Part One", ed.parts.first.title
+  end
+
+  context "validations" do
+    setup do
+      @ta = FactoryGirl.build(:travel_advice_edition)
+    end
+
+    should "require a country slug" do
+      @ta.country_slug = ''
+      assert ! @ta.valid?
+      assert_includes @ta.errors.messages[:country_slug], "can't be blank"
+    end
+
+    should "require a title" do
+      @ta.title = ''
+      assert ! @ta.valid?
+      assert_includes @ta.errors.messages[:title], "can't be blank"
+    end
+
+    context "on state" do
+      should "only allow one edition in draft per slug" do
+        another_edition = FactoryGirl.create(:travel_advice_edition,
+                                             :country_slug => @ta.country_slug)
+        @ta.state = 'draft'
+        assert ! @ta.valid?
+        assert_includes @ta.errors.messages[:state], "is already taken"
+      end
+
+      should "only allow one edition in published per slug" do
+        another_edition = FactoryGirl.create(:published_travel_advice_edition,
+                                             :country_slug => @ta.country_slug)
+        @ta.state = 'published'
+        assert ! @ta.valid?
+        assert_includes @ta.errors.messages[:state], "is already taken"
+      end
+
+      should "allow multiple editions in archived per slug" do
+        another_edition = FactoryGirl.create(:archived_travel_advice_edition,
+                                             :country_slug => @ta.country_slug)
+        @ta.save!
+        @ta.state = 'archived'
+        assert @ta.valid?
+      end
+
+      should "not conflict with itself when validating uniqueness" do
+        @ta.state = 'draft'
+        @ta.save!
+        assert @ta.valid?
+      end
+    end
+
+    context "preventing editing of non-draft" do
+      should "not allow published editions to be edited" do
+        ta = FactoryGirl.create(:published_travel_advice_edition)
+        ta.title = "Fooey"
+        assert ! ta.valid?
+        assert_includes ta.errors.messages[:state], "must be draft to modify"
+      end
+
+      should "not allow archived editions to be edited" do
+        ta = FactoryGirl.create(:archived_travel_advice_edition)
+        ta.title = "Fooey"
+        assert ! ta.valid?
+        assert_includes ta.errors.messages[:state], "must be draft to modify"
+      end
+
+      should "allow publishing draft editions" do
+        ta = FactoryGirl.create(:travel_advice_edition)
+        assert ta.publish
+      end
+
+      should "allow 'save & publish'" do
+        ta = FactoryGirl.create(:travel_advice_edition)
+        ta.title = 'Foo'
+        assert ta.publish
+      end
+
+      should "allow archiving published editions" do
+        ta = FactoryGirl.create(:published_travel_advice_edition)
+        assert ta.archive
+      end
+
+      should "NOT allow 'save & archive'" do
+        ta = FactoryGirl.create(:published_travel_advice_edition)
+        ta.title = 'Foo'
+        assert ! ta.archive
+        assert_includes ta.errors.messages[:state], "must be draft to modify"
+      end
+    end
+
+    context "on alert status" do
+      should "not permit invalid values in the array" do
+        @ta.alert_status = [ 'avoid_all_but_essential_travel_to_parts', 'something_else', 'blah' ]
+        assert ! @ta.valid?
+        assert_includes @ta.errors.messages[:alert_status], "is not in the list"
+      end
+
+      should "permit an empty array" do
+        @ta.alert_status = [ ]
+        assert @ta.valid?
+      end
+    end
+
+    context "on version_number" do
+      should "require a version_number" do
+        @ta.save # version_number is automatically populated on create, so save it first.
+        @ta.version_number = ''
+        refute @ta.valid?
+        assert_includes @ta.errors.messages[:version_number], "can't be blank"
+      end
+
+      should "require a unique version_number per slug" do
+        another_edition = FactoryGirl.create(:archived_travel_advice_edition,
+                                             :country_slug => @ta.country_slug,
+                                             :version_number => 3)
+        @ta.version_number = 3
+        refute @ta.valid?
+        assert_includes @ta.errors.messages[:version_number], "is already taken"
+      end
+
+      should "allow matching version_numbers for different slugs" do
+        another_edition = FactoryGirl.create(:archived_travel_advice_edition,
+                                             :country_slug => 'wibble',
+                                             :version_number => 3)
+        @ta.version_number = 3
+        assert @ta.valid?
+      end
+    end
+
+    context "on minor update" do
+      should "not allow first version to be minor update" do
+        @ta.minor_update = true
+        refute @ta.valid?
+        assert_includes @ta.errors.messages[:minor_update], "can't be set for first version"
+      end
+
+      should "allow other versions to be minor updates" do
+        FactoryGirl.create(:published_travel_advice_edition, :country_slug => @ta.country_slug)
+        @ta.minor_update = true
+        assert @ta.valid?
+      end
+    end
+
+    context "on change_description" do
+      should "be required on publish" do
+        @ta.save! # Can't save directly as published, have to save as draft first
+        @ta.change_description = ""
+        @ta.state = "published"
+        refute @ta.valid?
+        assert_includes @ta.errors.messages[:change_description], "can't be blank on publish"
+      end
+
+      should "not be required on publish for a minor update" do
+        FactoryGirl.create(:archived_travel_advice_edition, :country_slug => @ta.country_slug)
+        @ta.version_number = 2 # version one can't be minor update
+        @ta.save! # Can't save directly as published, have to save as draft first
+        @ta.change_description = ""
+        @ta.minor_update = true
+        @ta.state = "published"
+        assert @ta.valid?
+      end
+
+      should "not be required when just saving a draft" do
+        @ta.change_description = ""
+        assert @ta.valid?
+      end
+    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)
+    e3 = FactoryGirl.create(:archived_travel_advice_edition)
+    e4 = FactoryGirl.create(:published_travel_advice_edition)
+
+    assert_equal [e2, e4].sort, TravelAdviceEdition.published.to_a.sort
+  end
+
+  context "fields on a new edition" do
+    should "be in draft state" do
+      assert TravelAdviceEdition.new.draft?
+    end
+
+    context "populating version_number" do
+      should "set version_number to 1 if there are no existing versions for the country" do
+        ed = TravelAdviceEdition.new(:country_slug => 'foo')
+        ed.valid?
+        assert_equal 1, ed.version_number
+      end
+
+      should "set version_number to the next available version" do
+        FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo', :version_number => 1)
+        FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo', :version_number => 2)
+        FactoryGirl.create(:published_travel_advice_edition, :country_slug => 'foo', :version_number => 4)
+
+        ed = TravelAdviceEdition.new(:country_slug => 'foo')
+        ed.valid?
+        assert_equal 5, ed.version_number
+      end
+
+      should "do nothing if version_number is already set" do
+        ed = TravelAdviceEdition.new(:country_slug => 'foo', :version_number => 42)
+        ed.valid?
+        assert_equal 42, ed.version_number
+      end
+
+      should "do nothing if country_slug is not set" do
+        ed = TravelAdviceEdition.new(:country_slug => '')
+        ed.valid?
+        assert_equal nil, ed.version_number
+      end
+    end
+
+    should "not be minor_update" do
+      assert_equal false, TravelAdviceEdition.new.minor_update
+    end
+  end
+
+  context "building a new version" do
+    setup do
+      @ed = FactoryGirl.create(:travel_advice_edition,
+                               :title => "Aruba",
+                               :overview => "Aruba is not near Wales",
+                               :country_slug => "aruba",
+                               :summary => "## The summary",
+                               :alert_status => ["avoid_all_but_essential_travel_to_whole_country", "avoid_all_travel_to_parts"],
+                               :image_id => "id_from_the_asset_manager_for_an_image",
+                               :document_id => "id_from_the_asset_manager_for_a_document")
+      @ed.parts.build(:title => "Fooey", :slug => 'fooey', :body => "It's all about Fooey")
+      @ed.parts.build(:title => "Gooey", :slug => 'gooey', :body => "It's all about Gooey")
+      @ed.save!
+      @ed.publish!
+    end
+
+    should "build a new instance with the same fields" do
+      new_ed = @ed.build_clone
+      assert new_ed.new_record?
+      assert new_ed.valid?
+      assert_equal @ed.title, new_ed.title
+      assert_equal @ed.country_slug, new_ed.country_slug
+      assert_equal @ed.overview, new_ed.overview
+      assert_equal @ed.summary, new_ed.summary
+      assert_equal @ed.image_id, new_ed.image_id
+      assert_equal @ed.document_id, new_ed.document_id
+      assert_equal @ed.alert_status, new_ed.alert_status
+    end
+
+    should "copy the edition's parts" do
+      new_ed = @ed.build_clone
+      assert_equal ['Fooey', 'Gooey'], new_ed.parts.map(&:title)
+    end
+  end
+
+  context "previous_version" do
+    setup do
+      @ed1 = FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo')
+      @ed2 = FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo')
+      @ed3 = FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo')
+    end
+
+    should "return the previous version" do
+      assert_equal @ed2, @ed3.previous_version
+      assert_equal @ed1, @ed2.previous_version
+    end
+
+    should "return nil if there is no previous version" do
+      assert_equal nil, @ed1.previous_version
+    end
+  end
+
+  context "publishing" do
+    setup do
+      @published = FactoryGirl.create(:published_travel_advice_edition, :country_slug => 'aruba',
+                                      :published_at => 3.days.ago, :change_description => 'Stuff changed')
+      @ed = FactoryGirl.create(:travel_advice_edition, :country_slug => 'aruba')
+    end
+
+    should "publish the edition and archive related editions" do
+      @ed.publish!
+      @published.reload
+      assert @ed.published?
+      assert @published.archived?
+    end
+
+    context "setting the published date" do
+      should "set the published_at to now for a normal update" do
+        Timecop.freeze(1.day.from_now) do
+          @ed.publish!
+          # The to_i is necessary to account for the difference in milliseconds
+          # Time from the db only has a resolution in seconds, whereas Time.zone.now is more accurate
+          assert_equal Time.zone.now.utc.to_i, @ed.published_at.to_i
+        end
+      end
+
+      should "set the published_at to the previous version's published_at for a minor update" do
+        @ed.minor_update = true
+        @ed.publish!
+        assert_equal @published.published_at, @ed.published_at
+      end
+    end
+
+    should "set the change_description to the previous version's change_description for a minor update" do
+      @ed.minor_update = true
+      @ed.publish!
+      assert_equal @published.change_description, @ed.change_description
+    end
+  end
+
+  context "setting the reviewed at date" do
+    setup do
+      @published = FactoryGirl.create(:published_travel_advice_edition, :country_slug => 'aruba',
+                                      :published_at => 3.days.ago, :change_description => 'Stuff changed')
+      @published.reviewed_at = 2.days.ago
+      @published.save!
+
+      Timecop.freeze(1.days.ago) do
+        # this is done to make sure there's a significant difference in time
+        # between creating the edition and it being published
+        @ed = FactoryGirl.create(:travel_advice_edition, :country_slug => 'aruba')
+      end
+    end
+
+    should "be updated to published time when edition is published" do
+      @ed.change_description = "Did some stuff"
+      @ed.publish!
+      assert_equal @ed.published_at, @ed.reviewed_at
+    end
+
+    should "be set to the previous version's reviewed_at when a minor update is published" do
+      @ed.minor_update = true
+      @ed.publish!
+      assert_equal @published.reviewed_at, @ed.reviewed_at
+    end
+
+    should "be able to be updated without affecting other dates" do
+      published_at = @ed.published_at
+      Timecop.freeze(1.day.from_now) do
+        @ed.reviewed_at = Time.zone.now
+        assert_equal published_at, @ed.published_at
+      end
+    end
+
+    should "be able to update reviewed_at on a published edition" do
+      @ed.minor_update = true
+      @ed.publish!
+      Timecop.freeze(1.day.from_now) do
+        new_time = Time.zone.now
+        @ed.reviewed_at = new_time
+        @ed.save!
+        assert_equal new_time.utc.to_i, @ed.reviewed_at.to_i
+      end
+    end
+  end
+
+  context "indexable content" do
+    setup do
+      @edition = FactoryGirl.build(:travel_advice_edition)
+    end
+
+    should "return summary and all part titles and bodies" do
+      @edition.summary = "The Summary"
+      @edition.parts << Part.new(:title => "Part One", :body => "Some text")
+      @edition.parts << Part.new(:title => "More info", :body => "Some more information")
+      assert_equal "The Summary Part One Some text More info Some more information", @edition.indexable_content
+    end
+
+    should "convert govspeak to plain text" do
+      @edition.summary = "## The Summary"
+      @edition.parts << Part.new(:title => "Part One", :body => "* Some text")
+      assert_equal "The Summary Part One Some text", @edition.indexable_content
+    end
+  end
+
+  context "actions" do
+    setup do
+      @user = FactoryGirl.create(:user)
+      @old = FactoryGirl.create(:archived_travel_advice_edition, :country_slug => 'foo')
+      @edition = FactoryGirl.create(:draft_travel_advice_edition, :country_slug => 'foo')
+    end
+
+    should "not have any actions by default" do
+      assert_equal 0, @edition.actions.size
+    end
+
+    should "add a 'create' action" do
+      @edition.build_action_as(@user, Action::CREATE)
+      assert_equal 1, @edition.actions.size
+      assert_equal Action::CREATE, @edition.actions.first.request_type
+      assert_equal @user, @edition.actions.first.requester
+    end
+
+    should "add a 'new' action with a comment" do
+      @edition.build_action_as(@user, Action::NEW_VERSION, "a comment for the new version")
+      assert_equal 1, @edition.actions.size
+      assert_equal "a comment for the new version", @edition.actions.first.comment
+    end
+
+    context "publish_as" do
+      should "add a 'publish' action with change_description as comment on publish" do
+        @edition.change_description = "## My hovercraft is full of eels!"
+        @edition.publish_as(@user)
+        @edition.reload
+        assert_equal 1, @edition.actions.size
+        action = @edition.actions.last
+        assert_equal Action::PUBLISH, action.request_type
+        assert_equal @user, action.requester
+        assert_equal "My hovercraft is full of eels!", action.comment
+      end
+
+      should "add a 'publish' action with 'Minor update' as comment on publish of a minor_update" do
+        @edition.minor_update = true
+        @edition.publish_as(@user)
+        @edition.reload
+        assert_equal 1, @edition.actions.size
+        action = @edition.actions.last
+        assert_equal Action::PUBLISH, action.request_type
+        assert_equal "Minor update", action.comment
+      end
+    end
+  end
+end