govuk_content_models 24.2.0 → 25.0.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 25.0.0
+
+- Removes the `alternative_title` field from the `Edition` class.
+- Adds methods to return major updates for an `Edition`.
+
 ## 24.2.0
 
 - Adds the `public_timestamp` and `latest_change_note` fields to the `Artefact`

data/app/models/edition.rb

@@ -17,7 +17,6 @@ class Edition
   field :created_at,           type: DateTime, default: lambda { Time.zone.now }
   field :publish_at,           type: DateTime
   field :overview,             type: String
-  field :alternative_title,    type: String
   field :slug,                 type: String
   field :department,           type: String
   field :rejected_count,       type: Integer,  default: 0
@@ -49,6 +48,7 @@ class Edition
       where(:assigned_to_id.exists => false)
     end
   }
+  scope :major_updates, lambda { where(major_change: true) }
 
   validates :title, presence: true
   validates :version_number, presence: true, uniqueness: {scope: :panopticon_id}
@@ -110,6 +110,28 @@ class Edition
     !scheduled_for_publishing? && subsequent_siblings.in_progress.empty?
   end
 
+  def major_updates_in_series
+    history.published.major_updates
+  end
+
+  def latest_major_update
+    major_updates_in_series.first
+  end
+
+  def latest_change_note
+    if latest_major_update.present?
+      latest_major_update.change_note
+    end
+  end
+
+  def public_updated_at
+    if latest_major_update.present?
+      latest_major_update.updated_at
+    elsif (first_published_edition = series.published.order(version_number: "asc").first)
+      first_published_edition.updated_at
+    end
+  end
+
   def meta_data
     PublicationMetadata.new self
   end
@@ -125,9 +147,9 @@ class Edition
 
   def indexable_content_without_parts
     if respond_to?(:body)
-      "#{alternative_title} #{Govspeak::Document.new(body).to_text}".strip
+      "#{Govspeak::Document.new(body).to_text}".strip
     else
-      alternative_title
+      ""
     end
   end
 
@@ -162,7 +184,6 @@ class Edition
     real_fields_to_merge = fields_to_copy(edition_class) + [
       :panopticon_id,
       :overview,
-      :alternative_title,
       :slug,
       :department,
       :browse_pages,

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 = "24.2.0"
+  VERSION = "25.0.0"
 end

data/test/models/edition_test.rb

@@ -137,12 +137,10 @@ class EditionTest < ActiveSupport::TestCase
                                   panopticon_id: @artefact.id,
                                   version_number: 1,
                                   department: "Test dept",
-                                  overview: "I am a test overview",
-                                  alternative_title: "Alternative test title")
+                                  overview: "I am a test overview")
     clone_edition = edition.build_clone
     assert_equal clone_edition.department, "Test dept"
     assert_equal clone_edition.overview, "I am a test overview"
-    assert_equal clone_edition.alternative_title, "Alternative test title"
     assert_equal clone_edition.version_number, 2
   end
 
@@ -194,7 +192,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title",
         video_url: "http://www.youtube.com/watch?v=dQw4w9WgXcQ"
     )
     new_edition = edition.build_clone AnswerEdition
@@ -205,7 +202,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.whole_body, edition.whole_body
   end
 
@@ -216,8 +212,7 @@ class EditionTest < ActiveSupport::TestCase
         panopticon_id: @artefact.id,
         version_number: 1,
         department: "Test dept",
-        overview: "I am a test overview",
-        alternative_title: "Alternative test title"
+        overview: "I am a test overview"
     )
     new_edition = edition.build_clone AnswerEdition
 
@@ -227,7 +222,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.whole_body, edition.whole_body
   end
 
@@ -239,7 +233,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title",
         more_information: "More information",
         alternate_methods: "Alternate methods"
     )
@@ -251,7 +244,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.whole_body, edition.whole_body
   end
 
@@ -263,7 +255,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title",
         body: "Test body"
     )
     new_edition = edition.build_clone TransactionEdition
@@ -274,7 +265,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.more_information, "Test body"
   end
 
@@ -286,7 +276,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title",
         video_url: "http://www.youtube.com/watch?v=dQw4w9WgXcQ"
     )
     new_edition = edition.build_clone TransactionEdition
@@ -297,7 +286,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.more_information, edition.whole_body
   end
 
@@ -309,7 +297,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title"
     )
     new_edition = edition.build_clone TransactionEdition
 
@@ -319,7 +306,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
     assert_equal new_edition.more_information, edition.whole_body
   end
 
@@ -331,7 +317,6 @@ class EditionTest < ActiveSupport::TestCase
         version_number: 1,
         department: "Test dept",
         overview: "I am a test overview",
-        alternative_title: "Alternative test title"
     )
     new_edition = edition.build_clone GuideEdition
 
@@ -341,7 +326,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.state, "draft"
     assert_equal new_edition.department, "Test dept"
     assert_equal new_edition.overview, "I am a test overview"
-    assert_equal new_edition.alternative_title, "Alternative test title"
   end
 
   test "Cloning between types with parts" do
@@ -998,10 +982,10 @@ class EditionTest < ActiveSupport::TestCase
     end
 
     context "for a single part thing" do
-      should "have the normalised content of that part" do
-        edition = FactoryGirl.create(:guide_edition, :state => 'ready', :title => 'one part thing', :alternative_title => 'alternative one part thing', panopticon_id: FactoryGirl.create(:artefact).id)
+      should "have an empty string for an edition with no body" do
+        edition = FactoryGirl.create(:guide_edition, :state => 'ready', :title => 'one part thing', panopticon_id: FactoryGirl.create(:artefact).id)
         edition.publish
-        assert_equal "alternative one part thing", edition.indexable_content
+        assert_equal "", edition.indexable_content
       end
     end
 
@@ -1091,4 +1075,67 @@ class EditionTest < ActiveSupport::TestCase
       assert_equal edition.browse_pages, new_edition.browse_pages
     end
   end
+
+  context "#latest_major_update" do
+    should 'return the most recent published edition with a major change' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: true,
+                                                     change_note: 'published',
+                                                     state: 'published',
+                                                     version_number: 1)
+      edition2 = edition1.build_clone
+
+      edition2.update_attributes!(major_change: true, change_note: 'changed', state: 'published')
+      edition1.update_attributes!(state: 'archived')
+
+      edition3 = edition2.build_clone
+
+      assert_equal edition2.id, edition3.latest_major_update.id
+    end
+  end
+
+  context "#latest_change_note" do
+    should 'return the change note of the latest major update' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: true,
+                                                     change_note: 'a change note',
+                                                     state: 'published')
+      edition2 = edition1.build_clone
+
+      assert_equal 'a change note', edition2.latest_change_note
+    end
+
+    should 'return nil if there is no major update in the edition series' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: false,
+                                                     state: 'published')
+      assert_equal nil, edition1.latest_change_note
+    end
+  end
+
+  context '#public_updated_at' do
+    should 'return the updated_at timestamp of the latest major update' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: true,
+                                                     change_note: 'a change note',
+                                                     updated_at: 1.minute.ago,
+                                                     state: 'published')
+      edition2 = edition1.build_clone
+
+      assert_equal edition1.updated_at, edition2.public_updated_at
+    end
+
+    should 'return the timestamp of the first published edition when there are no major updates' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: false,
+                                                     updated_at: 1.minute.ago,
+                                                     state: 'published')
+      edition2 = edition1.build_clone
+
+      assert_equal edition1.updated_at, edition2.public_updated_at
+    end
+
+    should 'return nil if there are no major updates and no published editions' do
+      edition1 = FactoryGirl.create(:answer_edition, major_change: false,
+                                                     updated_at: 1.minute.ago,
+                                                     state: 'draft')
+
+      assert_equal nil, edition1.public_updated_at
+    end
+  end
 end

data/test/models/workflow_test.rb

@@ -27,7 +27,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user = User.create(name: "Ben")
     other_user = User.create(name: "James")
 
-    guide = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    guide = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title")
     edition = guide
 
     request_review(user, edition)
@@ -141,7 +141,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user = User.create(name: "Ben")
     other_user = User.create(name: "James")
 
-    edition = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    edition = user.create_edition(:guide, panopticon_id: @artefact.id, overview: "My Overview", title: "My Title", slug: "my-title")
 
     request_review(user, edition)
     approve_review(other_user, edition)
@@ -158,7 +158,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user = User.create(name: "Ben")
     other_user = User.create(name: "James")
 
-    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title")
     edition = guide
 
     request_review(user, edition)
@@ -173,7 +173,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user = User.create(name: "Ben")
     other_user = User.create(name: "James")
 
-    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title")
     edition = guide
 
     request_review(user, edition)
@@ -189,7 +189,7 @@ class WorkflowTest < ActiveSupport::TestCase
     user = User.create(name: "Ben")
     other_user = User.create(name: "James")
 
-    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title")
     edition = guide
 
     request_review(user, edition)
@@ -206,7 +206,7 @@ class WorkflowTest < ActiveSupport::TestCase
     other_user = User.create(name: "James")
     another_user = User.create(name: "Fiona")
 
-    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title", alternative_title: "My Other Title")
+    guide = user.create_edition(:guide, panopticon_id: FactoryGirl.create(:artefact).id, overview: "My Overview", title: "My Title", slug: "my-title")
     edition = guide
 
     request_review(user, edition)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 24.2.0
+  version: 25.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -476,7 +476,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 950024458355486311
+      hash: -823528571067115172
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -485,7 +485,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 950024458355486311
+      hash: -823528571067115172
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23