govuk_content_models 20.2.0 → 21.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 21.0.0
+
+* Remove diff-ing code from content models - diffs should now be calculated on the fly
+
 ## 20.2.0
 
 * Adds new `finder_email_signup` Artefact kind and validator for finder e-mail signups.

data/app/models/action.rb

@@ -33,7 +33,6 @@ class Action
   field :approved,           type: DateTime
   field :comment,            type: String
   field :comment_sanitized,  type: Boolean, default: false
-  field :diff,               type: String
   field :request_type,       type: String
   field :email_addresses,    type: String
   field :customised_message, type: String

data/app/models/edition.rb

@@ -275,15 +275,4 @@ class Edition
       Artefact.find(self.panopticon_id).destroy
     end
   end
-
-  def previous_edition_differences
-    return if version_number <= 1
-
-    if in_progress?
-      edition_changes.to_s # diff of current changes
-    else
-      actions.select { |a| a.request_type == 'publish' }.last.diff # diff with previous published version
-    end
-  end
-
 end

data/app/models/workflow.rb

@@ -1,4 +1,3 @@
-require "differ"
 require "state_machine"
 require "action"
 
@@ -186,17 +185,6 @@ module Workflow
     self.previous_published_edition || false
   end
 
-  def edition_changes
-    if self.whole_body.blank?
-      false
-    else
-      my_body, their_body = [self, self.published_edition].map do |edition|
-        edition.whole_body.gsub("\r\n", "\n")
-      end
-      Differ.diff_by_line(my_body, their_body)
-    end
-  end
-
   def notify_siblings_of_new_edition
     siblings.update_all(sibling_in_progress: self.version_number)
   end

data/app/models/workflow_actor.rb

@@ -118,10 +118,6 @@ module WorkflowActor
   end
 
   def publish(edition, details)
-    if edition.published_edition
-      details.merge!({ diff: edition.edition_changes })
-    end
-
     take_action(edition, __method__, details)
   end
 

data/govuk_content_models.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = GovukContentModels::VERSION
 
   gem.add_dependency "bson_ext"
-  gem.add_dependency "differ"
   gem.add_dependency "gds-api-adapters", ">= 10.9.0"
 
   gem.add_dependency "gds-sso",          ">= 7.0.0", "< 10.0.0"

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 = "20.2.0"
+  VERSION = "21.0.0"
 end

data/test/models/edition_test.rb

@@ -545,7 +545,6 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "given multiple editions, can return the most recent published edition" do
-    
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, slug: "hedgehog-topiary", state: "published")
 
     second_edition = edition.build_clone
@@ -569,31 +568,6 @@ class EditionTest < ActiveSupport::TestCase
     assert edition.new_action(user, "note", comment: "Something important")
   end
 
-  test "first edition has no previous edition diffrences" do
-    first_edition = template_published_answer
-
-    assert_nil first_edition.previous_edition_differences
-  end
-
-  test "can access the changes since the last version" do
-    second_edition = draft_second_edition_from(template_published_answer)
-
-    assert_equal("{\"Lots of info\" >> \"Test Body 2\"}",
-                 second_edition.previous_edition_differences)
-  end
-
-  test "can show the differences between published editions" do
-    second_edition = draft_second_edition_from(template_published_answer)
-    second_edition.update_attribute(:state, "ready")
-    second_edition.save!
-
-    user = User.create(name: "bob")
-    user.publish second_edition, comment: "Published comment"
-
-    assert_equal("{\"Lots of info\" >> \"Test Body 2\"}",
-                 second_edition.previous_edition_differences)
-  end
-
   test "status should not be affected by notes" do
     user = User.create(name: "bob")
     edition = FactoryGirl.create(:guide_edition, panopticon_id: @artefact.id, state: "ready")
@@ -770,30 +744,6 @@ class EditionTest < ActiveSupport::TestCase
     assert_equal new_edition.version_number, edition.sibling_in_progress
   end
 
-  test "a new guide edition with multiple parts creates a full diff when published" do
-    user = User.create name: "Roland"
-
-    edition_one = GuideEdition.new(title: "One", slug: "one", panopticon_id: @artefact.id)
-    edition_one.parts.build title: "Part One", body:"Never gonna give you up", slug: "part-one"
-    edition_one.parts.build title: "Part Two", body:"NYAN NYAN NYAN NYAN", slug: "part-two"
-    edition_one.save!
-
-    edition_one.state = :ready
-    user.publish edition_one, comment: "First edition"
-
-    edition_two = edition_one.build_clone
-    edition_two.save!
-    edition_two.parts.first.update_attribute :title, "Changed Title"
-    edition_two.parts.first.update_attribute :body, "Never gonna let you down"
-
-    edition_two.state = :ready
-    user.publish edition_two, comment: "Second edition"
-
-    publish_action = edition_two.actions.where(request_type: "publish").last
-
-    assert_equal "{\"# Part One\" >> \"# Changed Title\"}\n\n{\"Never gonna give you up\" >> \"Never gonna let you down\"}\n\n# Part Two\n\nNYAN NYAN NYAN NYAN", publish_action.diff
-  end
-
   test "a part's slug must be of the correct format" do
     edition_one = GuideEdition.new(title: "One", slug: "one", panopticon_id: @artefact.id)
     edition_one.parts.build title: "Part One", body:"Never gonna give you up", slug: "part-One-1"
@@ -825,28 +775,6 @@ class EditionTest < ActiveSupport::TestCase
     assert ! user.request_amendments(edition, {comment: "Well Done, but work harder"})
   end
 
-  test "a new programme edition with multiple parts creates a full diff when published" do
-    user = User.create name: "Mazz"
-
-    edition_one = ProgrammeEdition.new(title: "Childcare", slug: "childcare", panopticon_id: @artefact.id)
-    edition_one.parts.build title: "Part One", body:"Content for part one", slug: "part-one"
-    edition_one.parts.build title: "Part Two", body:"Content for part two", slug: "part-two"
-    edition_one.save!
-
-    edition_one.state = :ready
-    user.publish edition_one, comment: "First edition"
-
-    edition_two = edition_one.build_clone
-    edition_two.save!
-    edition_two.parts.first.update_attribute :body, "Some other content"
-    edition_two.state = :ready
-    user.publish edition_two, comment: "Second edition"
-
-    publish_action = edition_two.actions.where(request_type: "publish").last
-
-    assert_equal "# Part One\n\n{\"Content for part one\" >> \"Some other content\"}\n\n# Part Two\n\nContent for part two", publish_action.diff
-  end
-
   test "a published publication with a draft edition is in progress" do
     dummy_answer = template_published_answer
     assert !dummy_answer.has_sibling_in_progress?

data/test/models/local_transaction_edition_test.rb

@@ -52,27 +52,4 @@ class LocalTransactionEditionTest < ActiveSupport::TestCase
     assert lt.valid?
     assert lt.persisted?
   end
-
-  test "should create a diff between the versions when publishing a new version" do
-    make_service(149, %w{county unitary})
-    edition_one = LocalTransactionEdition.new(title: "Transaction", slug: "transaction", lgsl_code: "149", panopticon_id: @artefact.id)
-    user = User.create name: "Thomas"
-
-    edition_one.introduction = "Test"
-    edition_one.state = :ready
-    edition_one.save!
-
-    user.publish edition_one, comment: "First edition"
-
-    edition_two = edition_one.build_clone
-    edition_two.introduction = "Testing"
-    edition_two.state = :ready
-    edition_two.save!
-
-    user.publish edition_two, comment: "Second edition"
-
-    publish_action = edition_two.actions.where(request_type: "publish").last
-
-    assert_equal "{\"Test\" >> \"Testing\"}", publish_action.diff
-  end
 end

data/test/models/workflow_test.rb

@@ -307,51 +307,6 @@ class WorkflowTest < ActiveSupport::TestCase
     refute user.new_version(edition)
   end
 
-  test "a new edition of an answer creates a diff when published" do
-    without_metadata_denormalisation(AnswerEdition) do
-      edition_one = AnswerEdition.new(title: "Chucking wood", slug: "woodchuck", panopticon_id: @artefact.id)
-      edition_one.body = "A woodchuck would chuck all the wood he could chuck if a woodchuck could chuck wood."
-      edition_one.state = :ready
-      edition_one.save!
-
-      user = User.create name: "Michael"
-      user.publish edition_one, comment: "First edition"
-
-      edition_two = edition_one.build_clone
-      edition_two.body = "A woodchuck would chuck all the wood he could chuck if a woodchuck could chuck wood.\nAlthough no more than 361 cubic centimetres per day."
-      edition_two.state = :ready
-      edition_two.save!
-
-      user.publish edition_two, comment: "Second edition"
-
-      publish_action = edition_two.actions.where(request_type: "publish").last
-
-      assert_equal "A woodchuck would chuck all the wood he could chuck if a woodchuck could chuck wood.{+\"\\nAlthough no more than 361 cubic centimetres per day.\"}", publish_action.diff
-    end
-  end
-
-  test "handles inconsistent newlines" do
-    # Differ tries to be smart when calculating changes, by searching for a matching line
-    # later in the texts. When we have predominantly Windows-style new lines (\r\n) with
-    # a few Unix-style new lines (\n), a Unix-style new line later in one document will be
-    # matched to a Unix-style new line in the other, causing large swathes of spurious diff.
-
-    edition_one = AnswerEdition.new(title: "Chucking wood", slug: "woodchuck", panopticon_id: @artefact.id)
-    edition_one.body = "badger\n\nmushroom\r\n\r\nsnake\n\nend"
-
-    edition_two = AnswerEdition.new(title: "Chucking wood", slug: "woodchuck", panopticon_id: @artefact.id)
-    edition_two.body = "badger\r\n\r\nmushroom\r\n\r\nsnake\n\nend"
-    edition_two.stubs(:published_edition).returns(edition_one)
-
-    # Test that the diff output is simply the (normalised) string, with no diff markers
-    assert_equal "badger\n\nmushroom\n\nsnake\n\nend", edition_two.edition_changes.to_s
-  end
-
-  test "edition_changes should return false if the whole body is nil" do
-    edition = FactoryGirl.create(:completed_transaction_edition, body: nil)
-    refute edition.edition_changes
-  end
-
   test "an edition can be moved into archive state" do
     user, other_user = template_users
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 20.2.0
+  version: 21.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: differ
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
   requirement: !ruby/object:Gem::Requirement
@@ -460,7 +444,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4078975284747344059
+      hash: -3126132501408854274
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -469,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4078975284747344059
+      hash: -3126132501408854274
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23