govuk_content_models 10.1.0 → 10.1.1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 10.1.1
+
+* Allow an artefact to be associated with multiple needs
+
 ## 10.0.0
 
 * Add validation for tag IDs

data/app/models/artefact.rb

@@ -33,7 +33,12 @@ class Artefact
   field "owning_app",           type: String
   field "rendering_app",        type: String
   field "active",               type: Boolean, default: false
+
+  # will be removed once multiple need_ids
+  # gets deployed and tested.
   field "need_id",              type: String
+
+  field "need_ids",             type: Array, default: []
   field "fact_checkers",        type: String
   field "publication_id",       type: String
   field "description",          type: String
@@ -142,6 +147,7 @@ class Artefact
     reject_if: proc { |attrs| attrs["title"].blank? && attrs["url"].blank?  }
 
   before_validation :normalise, on: :create
+  before_validation :filter_out_empty_need_ids, if: :need_ids_changed?
   before_create :record_create_action
   before_update :record_update_action
   after_update :update_editions
@@ -154,6 +160,7 @@ class Artefact
   validates :language, inclusion: { in: ["en", "cy"] }
   validates_with CannotEditSlugIfEverPublished
   validate :validate_prefixes_and_paths
+  validate :format_of_new_need_ids, if: :need_ids_changed?
 
   def self.in_alphabetical_order
     order_by([[:name, :asc]])
@@ -347,6 +354,13 @@ class Artefact
     attributes.except "_id", "created_at", "updated_at", "actions"
   end
 
+  def need_id=(new_need_id)
+    super
+
+    need_ids << new_need_id if new_need_id.present? && ! need_ids.include?(new_need_id)
+    new_need_id
+  end
+
   private
 
   def validate_prefixes_and_paths
@@ -362,6 +376,16 @@ class Artefact
     end
   end
 
+  def filter_out_empty_need_ids
+    need_ids.reject!(&:blank?)
+  end
+
+  def format_of_new_need_ids
+    # http://api.rubyonrails.org/classes/ActiveModel/Dirty.html
+    new_need_ids = need_ids_was.blank? ? need_ids : need_ids - need_ids_was
+    errors.add(:need_ids, "must be six-digit integers") if new_need_ids.any? {|need_id| need_id !~ /^\d{6}$/ }
+  end
+
   def valid_url_path?(path)
     return false unless path.starts_with?("/")
     uri = URI.parse(path)

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 = "10.1.0"
+  VERSION = "10.1.1"
 end

data/test/models/artefact_action_test.rb

@@ -22,6 +22,7 @@ class ArtefactActionTest < ActiveSupport::TestCase
     "active" => false,
     "tag_ids" => [],
     "tags" => [],
+    "need_ids" => [],
     "state" => "draft",
     "related_artefact_ids" => [],
     "paths" => [],

data/test/models/artefact_test.rb

@@ -92,6 +92,76 @@ class ArtefactTest < ActiveSupport::TestCase
     end
   end
 
+  context "#need_ids" do
+    should "be empty by default" do
+      assert_empty FactoryGirl.build(:artefact).need_ids
+    end
+
+    should "filter out empty strings" do
+      artefact = FactoryGirl.create(:artefact, need_ids: ["", "100002"])
+      assert_equal ["100002"], artefact.reload.need_ids
+    end
+
+    should "store multiple needs related to an artefact" do
+      artefact = FactoryGirl.create(:artefact, need_ids: ["100001", "100002"])
+      assert_equal ["100001", "100002"], artefact.reload.need_ids
+    end
+
+    should "be six-digit integers" do
+      artefact = FactoryGirl.build(:artefact, need_ids: ["B1231"])
+
+      refute artefact.valid?
+      assert_includes artefact.errors[:need_ids], "must be six-digit integers"
+    end
+
+    should "not validate need ids that were migrated from the singular need_id field" do
+      artefact = FactoryGirl.create(:artefact)
+      # simulate what happened during migration
+      artefact.set(:need_ids, ['As an employer
+                                I need to know which type of DBS check an employee needs
+                                so that I can apply for the correct one'])
+
+      artefact.need_ids << "100045"
+
+      assert artefact.valid?
+    end
+
+    context "for backwards compatibility" do
+      setup do
+        @artefact = FactoryGirl.create(:artefact)
+      end
+
+      should "append to need_ids when need_id is assigned" do
+        @artefact.need_id = "100045"
+
+        assert_equal "100045", @artefact.need_id
+        assert_includes @artefact.need_ids, "100045"
+      end
+
+      should "append to existing need_ids when need_id is assigned" do
+        @artefact.set(:need_ids, ["100044"])
+        @artefact.set(:need_id, "100044")
+
+        @artefact.need_id = "100045"
+
+        assert_equal "100045", @artefact.need_id
+        assert_equal ["100044", "100045"], @artefact.need_ids
+      end
+
+      # this should only matter till the time we have both fields
+      # need_id and need_ids. can delete this test once we unset need_id.
+      should "keep need_ids unchanged when need_id is removed" do
+        @artefact.set(:need_ids, ["100044", "100045"])
+        @artefact.set(:need_id, "100044")
+
+        @artefact.need_id = nil
+
+        assert_equal nil, @artefact.need_id
+        assert_equal ["100044", "100045"], @artefact.need_ids
+      end
+    end
+  end
+
   context "validating paths and prefixes" do
     setup do
       @a = FactoryGirl.build(:artefact)
@@ -167,9 +237,9 @@ class ArtefactTest < ActiveSupport::TestCase
   end
 
   test "should store and return related artefacts in order" do
-    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_id: 1, owning_app: "x")
-    b = Artefact.create!(slug: "b", name: "b", kind: "place", need_id: 2, owning_app: "x")
-    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_id: 3, owning_app: "x")
+    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_ids: ["100001"], owning_app: "x")
+    b = Artefact.create!(slug: "b", name: "b", kind: "place", need_ids: ["100001"], owning_app: "x")
+    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_ids: ["100001"], owning_app: "x")
 
     a.related_artefacts = [b, c]
     a.save!
@@ -179,9 +249,9 @@ class ArtefactTest < ActiveSupport::TestCase
   end
 
   test "should store and return related artefacts in order, even when not in natural order" do
-    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_id: 1, owning_app: "x")
-    b = Artefact.create!(slug: "b", name: "b", kind: "place", need_id: 2, owning_app: "x")
-    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_id: 3, owning_app: "x")
+    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_ids: ["100001"], owning_app: "x")
+    b = Artefact.create!(slug: "b", name: "b", kind: "place", need_ids: ["100001"], owning_app: "x")
+    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_ids: ["100001"], owning_app: "x")
 
     a.related_artefacts = [c, b]
     a.save!
@@ -191,10 +261,10 @@ class ArtefactTest < ActiveSupport::TestCase
   end
 
   test "should store and return related artefacts in order, with a scope" do
-    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_id: 1, owning_app: "x")
-    b = Artefact.create!(state: "live", slug: "b", name: "b", kind: "place", need_id: 2, owning_app: "x")
-    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_id: 3, owning_app: "x")
-    d = Artefact.create!(state: "live", slug: "d", name: "d", kind: "place", need_id: 3, owning_app: "x")
+    a = Artefact.create!(slug: "a", name: "a", kind: "place", need_ids: ["100001"], owning_app: "x")
+    b = Artefact.create!(state: "live", slug: "b", name: "b", kind: "place", need_ids: ["100001"], owning_app: "x")
+    c = Artefact.create!(slug: "c", name: "c", kind: "place", need_ids: ["100001"], owning_app: "x")
+    d = Artefact.create!(state: "live", slug: "d", name: "d", kind: "place", need_ids: ["100001"], owning_app: "x")
 
     a.related_artefacts = [d, c, b]
     a.save!
@@ -509,7 +579,7 @@ class ArtefactTest < ActiveSupport::TestCase
       FactoryGirl.create(:tag, :tag_id => "fruit/aggregate", :tag_type => 'section', :title => "Aggregrate fruits", :parent_id => "fruit")
       FactoryGirl.create(:tag, :tag_id => "vegetables", :tag_type => 'section', :title => "Vegetables")
 
-      @artefact = Artefact.create!(slug: "apple", name: "Apple", sections: [], kind: "guide", need_id: 1, owning_app: "x")
+      @artefact = Artefact.create!(slug: "apple", name: "Apple", sections: [], kind: "guide", need_ids: ["100001"], owning_app: "x")
     end
 
     context "when related items are present in all groups" do
@@ -517,9 +587,9 @@ class ArtefactTest < ActiveSupport::TestCase
         @artefact.sections = ["fruit/simple"]
 
         @artefact.related_artefacts = [
-          Artefact.create!(slug: "pear", name: "Pear", kind: "guide", sections: ["fruit/simple"], need_id: 4, owning_app: "x"),
-          Artefact.create!(slug: "pineapple", name: "Pineapple", kind: "guide", sections: ["fruit/aggregate"], need_id: 2, owning_app: "x"),
-          Artefact.create!(slug: "broccoli", name: "Broccoli", kind: "guide", sections: ["vegetables"], need_id: 3, owning_app: "x")
+          Artefact.create!(slug: "pear", name: "Pear", kind: "guide", sections: ["fruit/simple"], need_ids: ["100001"], owning_app: "x"),
+          Artefact.create!(slug: "pineapple", name: "Pineapple", kind: "guide", sections: ["fruit/aggregate"], need_ids: ["100001"], owning_app: "x"),
+          Artefact.create!(slug: "broccoli", name: "Broccoli", kind: "guide", sections: ["vegetables"], need_ids: ["100001"], owning_app: "x")
         ]
         @artefact.save!
         @artefact.reload
@@ -541,9 +611,9 @@ class ArtefactTest < ActiveSupport::TestCase
       end
 
       should "return related artefacts in order, with a scope" do
-        a = Artefact.create!(state: "live", slug: "a", name: "a", kind: "place", need_id: 1, owning_app: "x")
-        b = Artefact.create!(slug: "b", name: "b", kind: "place", need_id: 2, owning_app: "x")
-        c = Artefact.create!(state: "live", slug: "c", name: "c", kind: "place", need_id: 3, owning_app: "x")
+        a = Artefact.create!(state: "live", slug: "a", name: "a", kind: "place", need_ids: ["100001"], owning_app: "x")
+        b = Artefact.create!(slug: "b", name: "b", kind: "place", need_ids: ["100001"], owning_app: "x")
+        c = Artefact.create!(state: "live", slug: "c", name: "c", kind: "place", need_ids: ["100001"], owning_app: "x")
 
         @artefact.related_artefacts = [c,b,a]
         @artefact.save!
@@ -563,8 +633,8 @@ class ArtefactTest < ActiveSupport::TestCase
 
     should "return all related artefacts in 'other' when an artefact has no sections" do
       @artefact.related_artefacts = [
-        Artefact.create!(slug: "pear", name: "Pear", kind: "guide", sections: ["fruit/simple"], need_id: 4, owning_app: "x"),
-        Artefact.create!(slug: "banana", name: "Banana", kind: "guide", sections: ["fruit/simple"], need_id: 6, owning_app: "x")
+        Artefact.create!(slug: "pear", name: "Pear", kind: "guide", sections: ["fruit/simple"], need_ids: ["100001"], owning_app: "x"),
+        Artefact.create!(slug: "banana", name: "Banana", kind: "guide", sections: ["fruit/simple"], need_ids: ["100001"], owning_app: "x")
       ]
 
       assert_equal [], @artefact.related_artefacts_grouped_by_distance["subsection"]
@@ -577,8 +647,8 @@ class ArtefactTest < ActiveSupport::TestCase
 
       @artefact.primary_section = "fruit/multiple"
       @artefact.related_artefacts = [
-        Artefact.create!(slug: "fig", name: "Fig", kind: "guide", sections: ["fruit/multiple"], need_id: 4, owning_app: "x"),
-        Artefact.create!(slug: "strawberry", name: "Strawberry", kind: "guide", sections: ["fruit/simple"], need_id: 6, owning_app: "x")
+        Artefact.create!(slug: "fig", name: "Fig", kind: "guide", sections: ["fruit/multiple"], need_ids: ["100001"], owning_app: "x"),
+        Artefact.create!(slug: "strawberry", name: "Strawberry", kind: "guide", sections: ["fruit/simple"], need_ids: ["100001"], owning_app: "x")
       ]
       @artefact.save!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 10.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -465,7 +465,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4548551299969788770
+      hash: -3442913868239428672
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -474,7 +474,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4548551299969788770
+      hash: -3442913868239428672
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23