govuk_content_models 34.0.0 → 35.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e57d325ccc96b7ded00251c5fba3ab51e74d58d
-  data.tar.gz: 9bec9ac5c2b93270b66163442d8a771eb21e5398
+  metadata.gz: 92694115f4161b92997ef39dda8faf21ffe830fa
+  data.tar.gz: 16a4fc4c0c45804fe4d34ed799958f98e88d18ac
 SHA512:
-  metadata.gz: 9a34f277be32a2a43a9e6aee4579bf5c66f80614b836db8b3bfcc46a4b7251c01967af251e37cb140c4a77557741cc3bdd945fa22ba777eedb2f9ba352d95b90
-  data.tar.gz: 7cdf7ab729992789532203d469bacd8fd9bb53b66e298446406242067d8c506a55c2117310735961791b55ff3a0afe54f7f109cc5a0afd2f2e3c6493488d8766
+  metadata.gz: dfae23fecd0faa01072c0ba78e24206d747fa9a2d0823b6cdd5de88c42798d973242651058209d4cd903ecc31dfae8b356c037284349a8974516e11d7487902f
+  data.tar.gz: 304f70288d4261f7c5cd3ec21ecb2383c5dc6880b896df083df5e2df45a47bbb1286e8aa6d95c1e1c27445b6792d90a29d52bf0a0a17f77add414bb8ea88df09

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 35.0.0
+
+- Upgrade to Mongoid 5.1 and Rails 4.2
+- Add new done page promotion toggles
+
 ## 34.0.0
 
 - Removes `legacy_source` tag [#368](https://github.com/alphagov/govuk_content_models/pull/368)

data/app/models/artefact.rb

@@ -49,17 +49,17 @@ class Artefact
   #  - every future artefact will be created with a content id
   field "content_id",           type: String
 
-  index "slug", :unique => true
+  index({ slug: 1 }, unique: true)
 
   # This index allows the `relatable_artefacts` method to use an index-covered
   # query, so it doesn't have to load each of the artefacts.
-  index [[:name, Mongo::ASCENDING],
-         [:state, Mongo::ASCENDING],
-         [:kind, Mongo::ASCENDING],
-         [:_type, Mongo::ASCENDING],
-         [:_id, Mongo::ASCENDING]]
+  index name: 1,
+        state: 1,
+        kind: 1,
+        _type: 1,
+        _id: 1
 
-  scope :not_archived, where(:state.nin => ["archived"])
+  scope :not_archived, lambda { where(:state.nin => ["archived"]) }
 
   MAXIMUM_RELATED_ITEMS = 8
 
@@ -143,7 +143,7 @@ class Artefact
   }.tap { |h| h.default_proc = -> _, k { k } }.freeze
 
   has_and_belongs_to_many :related_artefacts, class_name: "Artefact"
-  embeds_many :actions, class_name: "ArtefactAction", order: :created_at
+  embeds_many :actions, class_name: "ArtefactAction", order: { created_at: :asc }
 
   embeds_many :external_links, class_name: "ArtefactExternalLink"
   accepts_nested_attributes_for :external_links, :allow_destroy => true,
@@ -168,11 +168,11 @@ class Artefact
 
   scope :relatable_items, proc {
     where(:kind.ne => "completed_transaction", :state.ne => "archived")
-      .order_by([[:name, :asc]])
+      .order_by(name: :asc)
   }
 
   def self.in_alphabetical_order
-    order_by([[:name, :asc]])
+    order_by(name: :asc)
   end
 
   def self.find_by_slug(s)
@@ -302,8 +302,6 @@ class Artefact
 
   def self.from_param(slug_or_id)
     find_by_slug(slug_or_id) || find(slug_or_id)
-  rescue BSON::InvalidObjectId
-    raise Mongoid::Errors::DocumentNotFound.new(self, slug_or_id)
   end
 
   def update_attributes_as(user, *args)
@@ -371,7 +369,11 @@ class Artefact
   end
 
   def snapshot
-    attributes.except "_id", "created_at", "updated_at", "actions"
+    attributes
+      .except("_id", "created_at", "updated_at", "actions")
+      .merge(
+        "related_artefact_ids" => self.related_artefact_ids
+      )
   end
 
   def need_id=(new_need_id)

data/app/models/business_support/business_size.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/business_type.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/location.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/purpose.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/sector.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/stage.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support/support_type.rb

@@ -4,7 +4,7 @@ module BusinessSupport
 
     field :name, type: String
     field :slug, type: String
-    index :slug, unique: true
+    index({ slug: 1 }, unique: true)
 
     validates_presence_of :name
     validates_uniqueness_of :name

data/app/models/business_support_edition.rb

@@ -2,9 +2,6 @@
 require "edition"
 
 class BusinessSupportEdition < Edition
-
-  include Mongoid::MultiParameterAttributes
-
   field :short_description, type: String
   field :body, type: String
   field :min_value, type: Integer
@@ -40,7 +37,7 @@ class BusinessSupportEdition < Edition
   validates :min_value, :max_value, :max_employees, :numericality => {:allow_nil => true, :only_integer => true}
 
   scope :for_facets, lambda { |facets|
-    where({ "$and" => facets_criteria(facets) }).order_by([:priority, :desc], [:title, :asc])
+    where("$and" => facets_criteria(facets)).order_by(priority: :desc, title: :asc)
   }
 
 

data/app/models/curated_list.rb

@@ -11,7 +11,7 @@ class CuratedList
   field "slug", type: String
   has_and_belongs_to_many :artefacts, class_name: "Artefact"
 
-  index "slug"
+  index slug: 1
 
   validates :slug, presence: true, uniqueness: true, slug: true
 

data/app/models/edition.rb

@@ -1,4 +1,3 @@
-require "traits/recordable_actions"
 require "workflow"
 
 class Edition
@@ -36,10 +35,10 @@ class Edition
 
   # state_machine comes from Workflow
   state_machine.states.map(&:name).each do |state|
-    scope state, where(state: state)
+    scope state, lambda { where(state: state) }
   end
-  scope :archived_or_published, where(:state.in => ["archived", "published"])
-  scope :in_progress, where(:state.nin => ["archived", "published"])
+  scope :archived_or_published, lambda { where(:state.in => %w(archived published)) }
+  scope :in_progress, lambda { where(:state.nin => %w(archived published)) }
   scope :assigned_to, lambda { |user|
     if user
       where(assigned_to_id: user.id)
@@ -50,7 +49,7 @@ class Edition
   scope :major_updates, lambda { where(major_change: true) }
 
   validates :title, presence: true
-  validates :version_number, presence: true, uniqueness: {scope: :panopticon_id}
+  validates :version_number, presence: true, uniqueness: { scope: :panopticon_id }
   validates :panopticon_id, presence: true
   validates_with SafeHtml
   validates_with LinkValidator, on: :update, unless: :archived?
@@ -60,11 +59,11 @@ class Edition
   before_save :check_for_archived_artefact
   before_destroy :destroy_artefact
 
-  index "assigned_to_id"
-  index [["panopticon_id", Mongo::ASCENDING], ["version_number", Mongo::ASCENDING]], :unique => true
-  index "state"
-  index "created_at"
-  index "updated_at"
+  index assigned_to_id: 1
+  index({ panopticon_id: 1, version_number: 1 }, unique: true)
+  index state: 1
+  index created_at: 1
+  index updated_at: 1
 
   alias_method :admin_list_title, :title
 
@@ -81,11 +80,11 @@ class Edition
   end
 
   def previous_siblings
-    siblings.where(:version_number.lt => version_number)
+    siblings.where(:version_number.lt => version_number).order(version_number: "asc")
   end
 
   def subsequent_siblings
-    siblings.where(:version_number.gt => version_number)
+    siblings.where(:version_number.gt => version_number).order(version_number: "asc")
   end
 
   def latest_edition?
@@ -230,7 +229,7 @@ class Edition
 
   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
+      .order_by(version_number: :desc).first
     return existing_publication if existing_publication
 
     raise "Artefact not found" unless metadata = Artefact.find(panopticon_id)
@@ -245,11 +244,11 @@ class Edition
     scope = where(slug: slug)
 
     if edition.present? and edition == "latest"
-      scope.order_by(:version_number).last
+      scope.order_by(version_number: :asc).last
     elsif edition.present?
       scope.where(version_number: edition).first
     else
-      scope.where(state: "published").order(version_number: "desc").first
+      scope.where(state: "published").order(version_number: :desc).first
     end
   end
 

data/app/models/licence_edition.rb

@@ -24,8 +24,11 @@ class LicenceEdition < Edition
 
   private
   def licence_identifier_unique
-    if self.class.without_state('archived').where(:licence_identifier => licence_identifier,
-                        :panopticon_id.ne => panopticon_id).any?
+    if self.class.where(
+      :state.ne => 'archived',
+      :licence_identifier => licence_identifier,
+      :panopticon_id.ne => panopticon_id
+    ).any?
       errors.add(:licence_identifier, :taken)
     end
   end

data/app/models/local_authority.rb

@@ -46,7 +46,7 @@ class LocalAuthority
     else
       interactions.excludes(
         lgil_code: LocalInteraction::LGIL_CODE_PROVIDING_INFORMATION
-      ).order_by([:lgil_code, :asc]).first ||
+      ).order_by(lgil_code: :asc).first ||
       interactions.where(
         lgil_code: LocalInteraction::LGIL_CODE_PROVIDING_INFORMATION
       ).first

data/app/models/overview_dashboard.rb

@@ -7,7 +7,7 @@ class OverviewDashboard
   UNASSIGNED_KEY = "**UNASSIGNED**"
 
   field :dashboard_type,      type: String
-  field :result_group,        type: Integer
+  field :result_group,        type: String
   field :count,               type: Integer
   field :draft,               type: Integer
   field :amends_needed,       type: Integer

data/app/models/part.rb

@@ -7,7 +7,7 @@ class Part
   embedded_in :programme_edition
   embedded_in :business_support_edition
 
-  scope :in_order, order_by(:order, :asc)
+  scope :in_order, lambda { order_by(order: :asc) }
 
   field :order,      type: Integer
   field :title,      type: String
@@ -20,7 +20,7 @@ class Part
   validates_presence_of :title
   validates_presence_of :slug
   validates_exclusion_of :slug, in: ["video"], message: "Can not be video"
-  validates_format_of :slug, with: /^[a-z0-9\-]+$/i
+  validates_format_of :slug, with: /\A[a-z0-9\-]+\Z/i
   validates_with SafeHtml
   validates_with LinkValidator
 end

data/app/models/parted.rb

@@ -28,7 +28,7 @@ module Parted
   end
 
   def whole_body
-    self.parts.map {|i| %Q{\# #{i.title}\n\n#{i.body}} }.join("\n\n")
+    self.parts.in_order.map { |i| %(\# #{i.title}\n\n#{i.body}) }.join("\n\n")
   end
 
   private

data/app/models/rendered_manual.rb

@@ -11,7 +11,7 @@ class RenderedManual
   field :summary, type: String
   field :section_groups, type: Array
 
-  index "slug", unique: true
+  index({ slug: 1 }, unique: true)
 
   validates_uniqueness_of :slug
 end

data/app/models/simple_smart_answer_edition/node/option.rb

@@ -12,7 +12,7 @@ class SimpleSmartAnswerEdition < Edition
       field :next_node, type: String
       field :order, type: Integer
 
-      default_scope order_by([:order, :asc])
+      default_scope lambda { order_by(order: :asc) }
 
       validates :label, :next_node, presence: true
       validates :slug, :format => {:with => /\A[a-z0-9-]+\z/}

data/app/models/simple_smart_answer_edition/node.rb

@@ -14,7 +14,7 @@ class SimpleSmartAnswerEdition < Edition
     field :order, type: Integer
     field :kind, type: String
 
-    default_scope order_by([:order, :asc])
+    default_scope lambda { order_by(order: :asc) }
 
     GOVSPEAK_FIELDS = [:body]
 

data/app/models/simple_smart_answer_edition.rb

@@ -33,7 +33,7 @@ class SimpleSmartAnswerEdition < Edition
 
 
   # Workaround mongoid conflicting mods error
-  # See https://github.com/mongoid/mongoid/issues/1219
+  # See https://jira.mongodb.org/browse/MONGOID-1220
   # Override update_attributes so that nested nodes are updated individually. 
   # This get around the problem of mongoid issuing a query with conflicting modifications 
   # to the same document. 
@@ -63,6 +63,6 @@ class SimpleSmartAnswerEdition < Edition
   end
 
   def destroy_in_attrs?(attrs)
-    attrs['_destroy'] == '1'
+    attrs.delete('_destroy') == '1'
   end
 end

data/app/models/tag.rb

@@ -1,6 +1,6 @@
 require "safe_html"
 require 'tag_id_validator'
-require 'state_machine'
+require 'state_machines-mongoid'
 
 class Tag
   include Mongoid::Document
@@ -16,16 +16,14 @@ class Tag
 
   STATES = ['draft', 'live']
 
-  index :tag_id
-  index [ [:tag_id, Mongo::ASCENDING], [:tag_type, Mongo::ASCENDING] ], unique: true
-  index :tag_type
+  index tag_id: 1
+  index({ tag_id: 1, tag_type: 1 }, unique: true)
+  index tag_type: 1
 
   validates_presence_of :tag_id, :title, :tag_type
   validates_uniqueness_of :tag_id, scope: :tag_type
   validates_with TagIdValidator
 
-  attr_protected :state
-
   validates :state, inclusion: { in: STATES }
 
   class MissingTags < RuntimeError

data/app/models/travel_advice_edition.rb

@@ -1,6 +1,6 @@
 require 'attachable'
 require 'parted'
-require 'state_machine'
+require 'state_machines-mongoid'
 require 'safe_html'
 
 class TravelAdviceEdition
@@ -25,7 +25,7 @@ class TravelAdviceEdition
 
   embeds_many :actions
 
-  index [[:country_slug, Mongo::ASCENDING], [:version_number, Mongo::DESCENDING]], :unique => true
+  index({ country_slug: 1, version_number: -1 }, unique: true)
 
   attaches :image, :document
 
@@ -37,23 +37,23 @@ class TravelAdviceEdition
     "avoid_all_travel_to_whole_country",
   ]
 
-  before_validation :populate_version_number, :on => :create
+  before_validation :populate_version_number, on: :create
 
   validates_presence_of :country_slug, :title
   validate :state_for_slug_unique
-  validates :version_number, :presence => true, :uniqueness => { :scope => :country_slug }
+  validates :version_number, presence: true, uniqueness: { scope: :country_slug }
   validate :alert_status_contains_valid_values
   validate :first_version_cant_be_minor_update
   validates_with SafeHtml
   validates_with LinkValidator
 
-  scope :published, where(:state => "published")
+  scope :published, lambda { where(state: "published") }
 
   class << self; attr_accessor :fields_to_clone end
   @fields_to_clone = [:title, :country_slug, :overview, :alert_status, :summary, :image_id, :document_id, :synonyms]
 
   state_machine initial: :draft do
-    before_transition :draft => :published do |edition, transition|
+    before_transition draft: :published do |edition, _|
       if edition.minor_update
         previous = edition.previous_version
         edition.published_at = previous.published_at
@@ -73,12 +73,12 @@ class TravelAdviceEdition
     end
 
     event :archive do
-      transition all => :archived, :unless => :archived?
+      transition all => :archived, unless: :archived?
     end
 
     state :published do
       validate :cannot_edit_published
-      validates_presence_of :change_description, :unless => :minor_update, :message => "can't be blank on publish"
+      validates_presence_of :change_description, unless: :minor_update, message: "can't be blank on publish"
     end
     state :archived do
       validate :cannot_edit_archived
@@ -104,7 +104,7 @@ class TravelAdviceEdition
   end
 
   def build_action_as(user, action_type, comment = nil)
-    actions.build(:requester => user, :request_type => action_type, :comment => comment)
+    actions.build(requester: user, request_type: action_type, comment: comment)
   end
 
   def publish_as(user)
@@ -113,7 +113,7 @@ class TravelAdviceEdition
   end
 
   def previous_version
-    self.class.where(:country_slug => self.country_slug, :version_number.lt => self.version_number).order_by([:version_number, :desc]).first
+    self.class.where(country_slug: self.country_slug, :version_number.lt => self.version_number).order_by(version_number: :desc).first
   end
 
   private
@@ -121,19 +121,20 @@ class TravelAdviceEdition
   def state_for_slug_unique
     if %w(published draft).include?(self.state) and
         self.class.where(:_id.ne => id,
-                         :country_slug => country_slug,
-                         :state => state).any?
+                         country_slug: country_slug,
+                         state: state).any?
       errors.add(:state, :taken)
     end
   end
 
   def populate_version_number
     if self.version_number.nil? and ! self.country_slug.nil? and ! self.country_slug.empty?
-      if latest_edition = self.class.where(:country_slug => self.country_slug).order_by([:version_number, :desc]).first
-        self.version_number = latest_edition.version_number + 1
-      else
-        self.version_number = 1
-      end
+      latest_edition = self.class.where(country_slug: self.country_slug).order_by(version_number: :desc).first
+      self.version_number = if latest_edition
+                              latest_edition.version_number + 1
+                            else
+                              1
+                            end
     end
   end
 

data/app/models/user.rb

@@ -24,16 +24,14 @@ class User
   field "disabled",                type: Boolean, default: false
   field "organisation_content_id", type: String
 
-  index "uid", unique: true
-  index "disabled"
-
-  # Setup accessible (or protected) attributes for your model
-  attr_accessible :email, :name, :uid
-  attr_accessible :email, :name, :uid, :permissions, as: :oauth
-
-  scope :alphabetized, order_by(name: :asc)
-  scope :enabled, any_of({ :disabled.exists => false },
-                         { :disabled.in => [false, nil] })
+  index({ uid: 1 }, unique: true)
+  index disabled: 1
+
+  scope :alphabetized, lambda { order_by(name: :asc) }
+  scope :enabled, lambda {
+    any_of({ :disabled.exists => false },
+           { :disabled.in => [false, nil] }) # rubocop:disable Style/BracesAroundHashParameters
+  }
 
   def to_s
     name || email || ""

data/app/models/workflow.rb

@@ -1,4 +1,4 @@
-require "state_machine"
+require "state_machines-mongoid"
 
 module Workflow
   class CannotDeletePublishedPublication < RuntimeError; end
@@ -117,7 +117,7 @@ module Workflow
 
   def denormalise_users!
     new_assignee = assigned_to.try(:name)
-    set(:assignee, new_assignee) unless new_assignee == assignee
+    set(assignee: new_assignee) unless new_assignee == assignee
     update_user_action("creator",   [Action::CREATE, Action::NEW_VERSION])
     update_user_action("publisher", [Action::PUBLISH])
     update_user_action("archiver",  [Action::ARCHIVE])
@@ -133,7 +133,7 @@ module Workflow
   end
 
   def mark_as_rejected
-    self.inc(:rejected_count, 1)
+    self.inc(rejected_count: 1)
   end
 
   def previous_edition
@@ -185,7 +185,7 @@ module Workflow
         # collections, but share a model and relationships with eg actions.
         # Therefore, Panopticon might not find a user for an action.
         if action.requester
-          set(property, action.requester.name)
+          set(property => action.requester.name)
         end
       end
     end

data/app/traits/taggable.rb

@@ -52,8 +52,7 @@ module Taggable
     klass.field          :tag_ids, type: Array, default: []
     klass.field          :tags, type: Array, default: []
 
-    klass.index          :tag_ids
-    klass.attr_protected :tags, :tag_ids
+    klass.index          tag_ids: 1
     klass.__send__       :private, :tag_ids=
   end
 

data/config/mongoid.yml

@@ -1,6 +1,9 @@
 test:
-  host: localhost
-  database: govuk_content_shared_test
-  logger: false
-  use_activesupport_time_zone: true
-  autocreate_indexes: true
+  clients:
+    default:
+      database: govuk_content_shared_test
+      hosts:
+        - localhost
+  options:
+    use_activesupport_time_zone: true
+    log_level: :error

data/govuk_content_models.gemspec

@@ -20,22 +20,24 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "gds-sso",          "~> 11.2"
   gem.add_dependency "govspeak",         "~> 3.1"
-  # Mongoid 2.5.0 supports the newer 1.7.x and 1.8.x Mongo drivers
-  gem.add_dependency "mongoid",          "~> 2.5"
+  gem.add_dependency "mongoid",          "~> 5.1"
+  gem.add_dependency "state_machines",   "~> 0.4"
+  gem.add_dependency "state_machines-mongoid", "~> 0.1"
   gem.add_dependency "plek"
-  gem.add_dependency "state_machine"
 
-  gem.add_development_dependency "database_cleaner", "0.7.2"
-  gem.add_development_dependency "factory_girl", "3.3.0"
+  gem.add_development_dependency "database_cleaner", "1.5.1"
+  gem.add_development_dependency "factory_girl", "4.5.0"
   gem.add_development_dependency "gem_publisher", "1.2.0"
-  gem.add_development_dependency "mocha", "0.13.3"
+  gem.add_development_dependency "mocha", "1.1.0"
   gem.add_development_dependency "multi_json"
   gem.add_development_dependency "rake", "0.9.2.2"
-  gem.add_development_dependency "webmock", "1.8.7"
-  gem.add_development_dependency "shoulda-context", "1.0.0"
+  gem.add_development_dependency "webmock", "1.22.6"
+  gem.add_development_dependency "shoulda-context", "1.2.1"
   gem.add_development_dependency "timecop", "0.5.9.2"
+  gem.add_development_dependency 'govuk-lint', '~> 0.5.1'
+  gem.add_development_dependency 'pry-byebug'
 
   # The following are added to help bundler resolve dependencies
-  gem.add_development_dependency "rack", "~> 1.4.4"
-  gem.add_development_dependency "rails", "= 3.2.17"
+  gem.add_development_dependency "rack", "~> 1.6.4"
+  gem.add_development_dependency "rails", "= 4.2.5.1"
 end

data/jenkins.sh

@@ -4,6 +4,9 @@ rm -f Gemfile.lock
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 export GOVUK_APP_DOMAIN=dev.gov.uk
 bundle exec rake
+
+bundle exec govuk-lint-ruby --diff --cached --format clang app config lib test
+
 if [[ -n "$PUBLISH_GEM" ]]; then
   bundle exec rake publish_gem
 fi