govuk_content_models 31.0.0 → 31.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f180214b4c41e4eeeca68831ad6ba2ca55f1ef7f
-  data.tar.gz: c3620788cedec2c668987ae8d8b563e527e080e3
+  metadata.gz: 3bb0e2f37d9ec79613e1e92088da6d20b8f221f4
+  data.tar.gz: 83b14b0586ef58599e8b466336d109aa54e25753
 SHA512:
-  metadata.gz: acf06907c1430d183ac52ae67cc858f67d68cab01f6963a406683fbcd8738c15595016aed443495e3310b0068f4eaea003214a4a2bfc48fc94950c7f0398eb54
-  data.tar.gz: 4b276c0907a6b77a0f0201c7e2e27d4e4c852a3e611f09f46d07e284a8f294270caab42e98745a54dd06159cc2ffc2d96b653f914cd926fc4136a9c37aa64349
+  metadata.gz: 720600bc3dadd0332f123af6b84cd9dfd65d4a3f1ac32a039e844fecb201e4a46d4b5710813205023fde049fcea3d3d5b31062dd4a87f6a71c3c14c464d02f70
+  data.tar.gz: 0b05a4bbf7acd75fdb9f947a1f8c8d1eb0f70d3c0dd5324745c004342738d198e1b7119ad47480cb3e98300c6781f43be5699b4cfcc92dd6f1c9aa3871aa193d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 31.1.0
+
+- `area_gss_codes` field for BusinessSupportEdition
+- Explicitly support conversion between any edition types
+
 ## 31.0.0
 
 - `Edition.find_or_create_from_panopticon_data` no longer takes a third

data/app/models/business_support_edition.rb

@@ -29,6 +29,7 @@ class BusinessSupportEdition < Edition
   field :start_date,      type: Date
   field :end_date,        type: Date
   field :areas,           type: Array, default: []
+  field :area_gss_codes,  type: Array, default: []
 
   GOVSPEAK_FIELDS = [:body, :eligibility, :evaluation, :additional_information]
 

data/app/models/edition.rb

@@ -171,20 +171,11 @@ class Edition
   # we are changing the type of the edition, any fields other than the base
   # fields will likely be meaningless.
   def fields_to_copy(target_class)
-    return_value = [
-      :title,
-      :panopticon_id,
-      :overview,
-      :slug,
-      :browse_pages,
-      :primary_topic,
-      :additional_topics
-    ]
     if target_class == self.class
-      type_specific_keys = self.fields.keys - Edition.fields.keys
-      return_value += type_specific_keys
+      base_field_keys + type_specific_field_keys
+    else
+      base_field_keys
     end
-    return_value
   end
 
   def build_clone(target_class=nil)
@@ -209,21 +200,33 @@ class Edition
     # Where the type is not changing, the body will already have been copied
     # above.
     #
-    # We don't need to copy parts between Parted types here, because the Parted
-    # module does that.
-    if target_class != self.class
-      if new_edition.respond_to?(:parts) and !self.respond_to?(:parts)
-        new_edition.parts.build(title: "Part One", body: whole_body, slug: "part-one")
-      elsif new_edition.respond_to?(:more_information=)
-        new_edition.more_information = whole_body
-      elsif new_edition.respond_to?(:body=)
-        new_edition.body = whole_body
-      end
+    # We don't need to copy parts between Parted types here, because the
+    # Parted module does that.
+    if target_class != self.class && !cloning_between_parted_types?(new_edition)
+      new_edition.clone_whole_body_from(self)
     end
 
     new_edition
   end
 
+  def clone_whole_body_from(origin_edition)
+    if self.respond_to?(:parts)
+      self.parts.build(title: "Part One", body: origin_edition.whole_body, slug: "part-one")
+    elsif self.respond_to?(:more_information=)
+      self.more_information = origin_edition.whole_body
+    elsif self.respond_to?(:body=)
+      self.body = origin_edition.whole_body
+    elsif self.respond_to?(:licence_overview=)
+      self.licence_overview = origin_edition.whole_body
+    else
+      raise "Nowhere to copy whole_body content for conversion from: #{origin_edition.class} to: #{self.class}"
+    end
+  end
+
+  def cloning_between_parted_types?(new_edition)
+    self.respond_to?(:parts) && new_edition.respond_to?(:parts)
+  end
+
   def self.find_or_create_from_panopticon_data(panopticon_id, importing_user)
     existing_publication = Edition.where(panopticon_id: panopticon_id)
                                   .order_by([:version_number, :desc]).first
@@ -321,4 +324,21 @@ class Edition
       Artefact.find(self.panopticon_id).destroy
     end
   end
+
+private
+  def base_field_keys
+    [
+      :title,
+      :panopticon_id,
+      :overview,
+      :slug,
+      :browse_pages,
+      :primary_topic,
+      :additional_topics,
+    ]
+  end
+
+  def type_specific_field_keys
+    (self.fields.keys - Edition.fields.keys).map(&:to_sym)
+  end
 end

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 = "31.0.0"
+  VERSION = "31.1.0"
 end

data/test/models/business_support_edition_test.rb

@@ -7,7 +7,10 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
   end
 
   should "have custom fields" do
-    support = FactoryGirl.create(:business_support_edition, panopticon_id: @artefact.id)
+    support = FactoryGirl.create(
+      :business_support_edition,
+      panopticon_id: @artefact.id,
+    )
     support.short_description = "The short description"
     support.body = "The body"
     support.eligibility = "The eligibility"
@@ -23,6 +26,7 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
 
     support.priority = 2
     support.areas = ["123","345","45","9"]
+    support.area_gss_codes = ["G123","G345","G45","G9"]
     support.business_sizes << "up-to-249"
     support.business_types << "charity"
     support.locations = ["scotland", "england"]
@@ -52,6 +56,7 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
     assert_equal 2, support.priority
 
     assert_equal ["123","345","45","9"], support.areas
+    assert_equal ["G123","G345","G45","G9"], support.area_gss_codes
     assert_equal ["up-to-249"], support.business_sizes
     assert_equal ["charity"], support.business_types
     assert_equal ["scotland", "england"], support.locations
@@ -64,7 +69,10 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
   end
 
   should "not allow max_value to be less than min_value" do
-    support = FactoryGirl.create(:business_support_edition, panopticon_id: @artefact.id)
+    support = FactoryGirl.create(
+      :business_support_edition,
+      panopticon_id: @artefact.id,
+    )
     support.min_value = 100
     support.max_value = 50
 
@@ -106,7 +114,10 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
   context "continuation_link validation" do
 
     setup do
-      @bs = FactoryGirl.create(:business_support_edition, panopticon_id: @artefact.id)
+      @bs = FactoryGirl.create(
+        :business_support_edition,
+        panopticon_id: @artefact.id,
+      )
     end
 
     should "not validate the continuation link when blank" do
@@ -125,31 +136,34 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
   end
 
   should "clone extra fields when cloning edition" do
-    support = FactoryGirl.create(:business_support_edition,
-                                 :panopticon_id => @artefact.id,
-                                 :state => "published",
-                                 :short_description => "Short description of support format",
-                                 :body => "Body to be cloned",
-                                 :min_value => 1,
-                                 :max_value => 2,
-                                 :max_employees => 3,
-                                 :organiser => "Organiser to be cloned",
-                                 :eligibility => "Eligibility to be cloned",
-                                 :evaluation => "Evaluation to be cloned",
-                                 :additional_information => "Additional info to be cloned",
-                                 :will_continue_on => "Continuation text to be cloned",
-                                 :continuation_link => "http://www.gov.uk",
-                                 :contact_details => "Contact details to be cloned",
-                                 :priority => 2,
-                                 :areas => ['123','9999'],
-                                 :business_sizes => ['up-to-249'],
-                                 :locations => ['london'],
-                                 :purposes => ['start-up'],
-                                 :sectors => ['agriculture','manufacturing'],
-                                 :stages => ['grow-and-sustain'],
-                                 :support_types => ['grant','loan'],
-                                 :start_date => 1.year.ago(Date.today),
-                                 :end_date => 1.year.since(Date.today))
+    support = FactoryGirl.create(
+      :business_support_edition,
+      :panopticon_id => @artefact.id,
+      :state => "published",
+      :short_description => "Short description of support format",
+      :body => "Body to be cloned",
+      :min_value => 1,
+      :max_value => 2,
+      :max_employees => 3,
+      :organiser => "Organiser to be cloned",
+      :eligibility => "Eligibility to be cloned",
+      :evaluation => "Evaluation to be cloned",
+      :additional_information => "Additional info to be cloned",
+      :will_continue_on => "Continuation text to be cloned",
+      :continuation_link => "http://www.gov.uk",
+      :contact_details => "Contact details to be cloned",
+      :priority => 2,
+      :areas => ['123','9999'],
+      :area_gss_codes => ['G123','G9999'],
+      :business_sizes => ['up-to-249'],
+      :locations => ['london'],
+      :purposes => ['start-up'],
+      :sectors => ['agriculture','manufacturing'],
+      :stages => ['grow-and-sustain'],
+      :support_types => ['grant','loan'],
+      :start_date => 1.year.ago(Date.today),
+      :end_date => 1.year.since(Date.today),
+    )
 
     new_support = support.build_clone
 
@@ -168,6 +182,7 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
 
     assert_equal support.priority, new_support.priority
     assert_equal support.areas, new_support.areas
+    assert_equal support.area_gss_codes, new_support.area_gss_codes
     assert_equal support.business_sizes, new_support.business_sizes
     assert_equal support.locations, new_support.locations
     assert_equal support.purposes, new_support.purposes
@@ -180,47 +195,82 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
 
   context "for facets" do
     setup do
-      @e1 = FactoryGirl.create(:business_support_edition,
-                              :areas => ['2345', '1234'],
-                              :business_sizes => ['1', 'up-to-1000000'],
-                              :locations => ['narnia'], :purposes => ['world-domination'],
-                              :sectors => ['agriculture', 'healthcare'],
-                              :stages => ['pivoting'], :support_types => ['award', 'grant', 'loan'])
-      @e2 = FactoryGirl.create(:business_support_edition,
-                              :areas => ['1212', '1234', '999'],
-                              :business_sizes => ['1', 'up-to-1000000'],
-                              :locations => ['hades', 'narnia'], :purposes => ['business-growth-and-expansion'],
-                              :sectors => ['education', 'healthcare'],
-                              :stages => ['start-up', 'pivoting'], :support_types => ['grant', 'loan', 'equity'])
-      @e3 = FactoryGirl.create(:business_support_edition,
-                              :areas => ['1234'],
-                              :business_sizes => ['up-to-249', 'up-to-1000000'],
-                              :locations => ['hades', 'chicken-town'], :purposes => ['making-the-most-of-the-internet'],
-                              :sectors => ['utilities'], :stages => ['start-up'], :support_types => ['grant'])
+      @e1 = FactoryGirl.create(
+        :business_support_edition,
+        :areas => ['2345', '1234'],
+        :area_gss_codes => ['G2345', 'G1234'],
+        :business_sizes => ['1', 'up-to-1000000'],
+        :locations => ['narnia'],
+        :purposes => ['world-domination'],
+        :sectors => ['agriculture', 'healthcare'],
+        :stages => ['pivoting'],
+        :support_types => ['award', 'grant', 'loan'],
+      )
+      @e2 = FactoryGirl.create(
+        :business_support_edition,
+        :areas => ['1212', '1234', '999'],
+        :area_gss_codes => ['G1212', 'G1234', 'G999'],
+        :business_sizes => ['1', 'up-to-1000000'],
+        :locations => ['hades', 'narnia'],
+        :purposes => ['business-growth-and-expansion'],
+        :sectors => ['education', 'healthcare'],
+        :stages => ['start-up', 'pivoting'],
+        :support_types => ['grant', 'loan', 'equity'],
+      )
+      @e3 = FactoryGirl.create(
+        :business_support_edition,
+        :areas => ['1234'],
+        :area_gss_codes => ['G1234'],
+        :business_sizes => ['up-to-249', 'up-to-1000000'],
+        :locations => ['hades', 'chicken-town'],
+        :purposes => ['making-the-most-of-the-internet'],
+        :sectors => ['utilities'],
+        :stages => ['start-up'],
+        :support_types => ['grant'],
+      )
     end
 
     should "only return editions matching the facet values provided" do
-      editions = BusinessSupportEdition.for_facets({:purposes => 'business-growth-and-expansion', :support_types => 'equity'})
+      editions = BusinessSupportEdition.for_facets({
+        :purposes => 'business-growth-and-expansion',
+        :support_types => 'equity',
+      })
       assert_equal [@e2], editions
-      editions = BusinessSupportEdition.for_facets({:business_sizes => '1,up-to-1000000', :locations => 'narnia'})
+      editions = BusinessSupportEdition.for_facets({
+        :business_sizes => '1,up-to-1000000',
+        :locations => 'narnia',
+      })
       assert_equal [@e1, @e2], editions
     end
     should "support searching with all the facet values" do
-      editions = BusinessSupportEdition.for_facets({:areas => '1234', :business_sizes => 'up-to-1000000', :locations => 'narnia,hades,chicken-town',
-                                                    :purposes => 'business-growth-and-expansion,making-the-most-of-the-internet,world-domination',
-                                                    :sectors => 'agriculture,healthcare,utilities', :stages => 'pivoting,start-up',
-                                                    :support_types => 'award,grant,loan'})
+      editions = BusinessSupportEdition.for_facets({
+        :areas => '1234',
+        :area_gss_codes => 'G1234',
+        :business_sizes => 'up-to-1000000',
+        :locations => 'narnia,hades,chicken-town',
+        :purposes => 'business-growth-and-expansion,making-the-most-of-the-internet,world-domination',
+        :sectors => 'agriculture,healthcare,utilities',
+        :stages => 'pivoting,start-up',
+        :support_types => 'award,grant,loan',
+      })
       assert_equal [@e1, @e2, @e3], editions
     end
     should "return nothing where no facet values match" do
-      editions = BusinessSupportEdition.for_facets({:business_sizes => 'up-to-a-bizillion', :locations => 'ecclefechan'})
+      editions = BusinessSupportEdition.for_facets({
+        :business_sizes => 'up-to-a-bizillion',
+        :locations => 'ecclefechan',
+      })
       assert_empty editions
     end
   end
 
   context "scheme dates" do
     should "should have year with 4 digits length" do
-      invalid_edition = FactoryGirl.build(:business_support_edition, start_date: Date.new(99, 12, 31), end_date: Date.new(99, 12, 31))
+      invalid_edition = FactoryGirl.build(
+        :business_support_edition,
+        start_date: Date.new(99, 12, 31),
+        end_date: Date.new(99, 12, 31),
+      )
 
       refute invalid_edition.valid?
 
@@ -230,7 +280,11 @@ class BusinessSupportEditionTest < ActiveSupport::TestCase
     end
 
     should "have start date earlier than end date" do
-      invalid_edition = FactoryGirl.build(:business_support_edition, start_date: 1.week.ago, end_date: 2.weeks.ago)
+      invalid_edition = FactoryGirl.build(
+        :business_support_edition,
+        start_date: 1.week.ago,
+        end_date: 2.weeks.ago,
+      )
 
       refute invalid_edition.valid?
       assert_includes invalid_edition.errors.full_messages, "Start date can't be later than end date"

data/test/models/edition_test.rb

@@ -198,6 +198,21 @@ class EditionTest < ActiveSupport::TestCase
   end
 
 # test cloning into different edition types
+  Edition.subclasses.permutation(2).each do |source_class, destination_class|
+    test "it should be possible to clone from a #{source_class} to a #{destination_class}" do
+      # Note that the new edition won't necessarily be valid - for example the
+      # new type might have required fields that the old just doesn't have.
+      # This is OK because when Publisher saves the clone, it already skips
+      # validations. The user will then be required to populate those values
+      # before they save the edition again.
+      source_edition = FactoryGirl.create(:edition, _type: source_class.to_s, state: "published")
+
+      assert_nothing_raised do
+        new_edition = source_edition.build_clone(destination_class)
+      end
+    end
+  end
+
   test "Cloning from GuideEdition into AnswerEdition" do
     edition = FactoryGirl.create(
         :guide_edition,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 31.0.0
+  version: 31.1.0
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext