Merge pull request #596 from alphagov/add-additional-columns-for-archived-petitions

Add migration task for legacy data

Author: pixeltrix

app/models/archived/debate_outcome.rb

@@ -0,0 +1,75 @@
+module Archived
+  class DebateOutcome < ActiveRecord::Base
+    # By default we want the user to upload a '2x' style image, and we can then
+    # resize it down with Imagemagick
+    COMMONS_IMAGE_SIZE = { w: 1260.0, h: 710.0 }
+
+    belongs_to :petition, touch: true
+
+    validates :petition, presence: true
+    validates :debated_on, presence: true, if: :debated?
+    validates :transcript_url, :video_url, length: { maximum: 500 }
+
+    has_attached_file :commons_image,
+      # default_url needs to be a lambda - this way the generated image url will
+      # include any asset-digest
+      default_url: ->(_) { ActionController::Base.helpers.image_url("graphics/graphic_house-of-commons.jpg") },
+      styles: {
+        "1x": "#{(COMMONS_IMAGE_SIZE[:w]/2).to_i}x#{(COMMONS_IMAGE_SIZE[:h]/2).to_i}",
+        "2x": "#{COMMONS_IMAGE_SIZE[:w]}x#{COMMONS_IMAGE_SIZE[:h]}"
+      }
+
+    validates_attachment_content_type :commons_image, content_type: /\Aimage\/.*\Z/
+    validate :validate_commons_image_dimensions, unless: :no_commons_image_queued
+
+    after_create do
+      petition.touch(:debate_outcome_at)
+    end
+
+    after_save do
+      petition.update_columns(debate_state: debate_state)
+    end
+
+    def date
+      debated_on
+    end
+
+    private
+
+    def debate_state
+      debated? ? 'debated' : 'not_debated'
+    end
+
+    def image_ratio(width, height)
+      (width.to_f / height.to_f).round(2)
+    end
+
+    def no_commons_image_queued
+      commons_image.blank? || !commons_image.queued_for_write[:original]
+    end
+
+    def validate_commons_image_dimensions
+      # This should be tuned if the images start looking badly scaled
+      max_ratio_delta = 0.1
+
+      dimensions = Paperclip::Geometry.from_file(commons_image.queued_for_write[:original].path)
+
+      if dimensions.width < COMMONS_IMAGE_SIZE[:w]
+        errors.add(:commons_image, :too_narrow, width: dimensions.width, min_width: COMMONS_IMAGE_SIZE[:w])
+      end
+
+      if dimensions.height < COMMONS_IMAGE_SIZE[:h]
+        errors.add(:commons_image, :too_short, height: dimensions.height, min_height: COMMONS_IMAGE_SIZE[:h])
+      end
+
+      expected_ratio = image_ratio(COMMONS_IMAGE_SIZE[:w], COMMONS_IMAGE_SIZE[:h])
+      actual_ratio = image_ratio(dimensions.width, dimensions.height)
+
+      min_ratio = (expected_ratio - max_ratio_delta).round(2)
+      max_ratio = (expected_ratio + max_ratio_delta).round(2)
+      unless (min_ratio..max_ratio).include? actual_ratio
+        errors.add(:commons_image, :incorrect_ratio, ratio: actual_ratio, min_ratio: min_ratio, max_ratio: max_ratio)
+      end
+    end
+  end
+end

app/models/archived/government_response.rb

@@ -0,0 +1,13 @@
+module Archived
+  class GovernmentResponse < ActiveRecord::Base
+    belongs_to :petition, touch: true
+
+    validates :petition, presence: true
+    validates :summary, length: { maximum: 200 }, allow_blank: true
+    validates :details, length: { maximum: 10000 }, allow_blank: true
+
+    after_create do
+      petition.touch(:government_response_at)
+    end
+  end
+end

app/models/archived/note.rb

@@ -0,0 +1,7 @@
+module Archived
+  class Note < ActiveRecord::Base
+    belongs_to :petition, touch: true
+
+    validates :petition, presence: true
+  end
+end

app/models/archived/petition.rb

@@ -4,14 +4,23 @@ module Archived
   class Petition < ActiveRecord::Base
     OPEN_STATE = 'open'
     CLOSED_STATE = 'closed'
+    HIDDEN_STATE = 'hidden'
     REJECTED_STATE = 'rejected'
-    STATES = [OPEN_STATE, CLOSED_STATE, REJECTED_STATE]
+    STATES = [OPEN_STATE, CLOSED_STATE, HIDDEN_STATE, REJECTED_STATE]
     PUBLISHED_STATES = [OPEN_STATE, CLOSED_STATE]
 
-    alias_attribute :action, :title
-
     belongs_to :parliament, inverse_of: :petitions, required: true
 
+    has_one :creator, -> { where(creator: true) }, class_name: "Signature"
+    has_one :debate_outcome, dependent: :destroy
+    has_one :government_response, dependent: :destroy
+    has_one :note, dependent: :destroy
+    has_one :rejection, dependent: :destroy
+
+    has_many :emails, :dependent => :destroy
+    has_many :signatures
+    has_many :sponsors, -> { where(sponsor: true) }, class_name: "Signature"
+
     validates :title, presence: true, length: { maximum: 150 }
     validates :description, presence: true, length: { maximum: 1000 }
     validates :state, presence: true, inclusion: STATES
@@ -48,6 +57,14 @@ def by_most_signatures
       end
     end
 
+    def action
+      super || title
+    end
+
+    def action?
+      super || title?
+    end
+
     def open?
       state == OPEN_STATE
     end

app/models/archived/petition/email.rb

@@ -0,0 +1,11 @@
+module Archived
+  class Petition < ActiveRecord::Base
+    class Email < ActiveRecord::Base
+      belongs_to :petition, touch: true
+
+      validates :petition, presence: true
+      validates :subject, presence: true, length: { maximum: 100 }
+      validates :body, presence: true, length: { maximum: 5000 }
+    end
+  end
+end

app/models/archived/rejection.rb

@@ -0,0 +1,24 @@
+module Archived
+  class Rejection < ActiveRecord::Base
+    CODES = %w[duplicate irrelevant no-action honours fake-name foi libellous offensive]
+    HIDDEN_CODES = %w[libellous offensive]
+
+    belongs_to :petition, touch: true
+
+    validates :petition, presence: true
+    validates :code, presence: true, inclusion: { in: CODES }
+    validates :details, length: { maximum: 4000 }, allow_blank: true
+
+    after_create do
+      petition.update!(state: state_for_petition, rejected_at: Time.current)
+    end
+
+    def hide_petition?
+      code.in?(HIDDEN_CODES)
+    end
+
+    def state_for_petition
+      hide_petition? ? Petition::HIDDEN_STATE : Petition::REJECTED_STATE
+    end
+  end
+end

app/models/archived/signature.rb

@@ -0,0 +1,72 @@
+module Archived
+  class Signature < ActiveRecord::Base
+    PENDING_STATE = 'pending'
+    FRAUDULENT_STATE = 'fraudulent'
+    VALIDATED_STATE = 'validated'
+    INVALIDATED_STATE = 'invalidated'
+
+    STATES = [
+      PENDING_STATE, FRAUDULENT_STATE,
+      VALIDATED_STATE, INVALIDATED_STATE
+    ]
+
+    TIMESTAMPS = {
+      'government_response' => :government_response_email_at,
+      'debate_scheduled'    => :debate_scheduled_email_at,
+      'debate_outcome'      => :debate_outcome_email_at,
+      'petition_email'      => :petition_email_at
+    }
+
+    belongs_to :petition
+    belongs_to :invalidation
+    belongs_to :constituency, primary_key: :external_id
+
+    validates :constituency_id, length: { maximum: 255 }
+    validates :email, presence: true
+    validates :location_code, presence: true
+    validates :name, presence: true, length: { maximum: 255 }
+    validates :state, presence: true, inclusion: { in: STATES }
+
+    def self.batch(id = 0, limit: 1000)
+      where(arel_table[:id].gteq(id)).order(id: :asc).limit(limit)
+    end
+
+    def pending?
+      state == PENDING_STATE
+    end
+
+    def fraudulent?
+      state == FRAUDULENT_STATE
+    end
+
+    def validated?
+      state == VALIDATED_STATE
+    end
+
+    def invalidated?
+      state == INVALIDATED_STATE
+    end
+
+    def unsubscribed?
+      notify_by_email == false
+    end
+
+    def unsubscribe!(token)
+      if unsubscribed?
+        errors.add(:base, "Already Unsubscribed")
+      elsif unsubscribe_token != token
+        errors.add(:base, "Invalid Unsubscribe Token")
+      else
+        update(notify_by_email: false)
+      end
+    end
+
+    def already_unsubscribed?
+      errors[:base].include?("Already Unsubscribed")
+    end
+
+    def invalid_unsubscribe_token?
+      errors[:base].include?("Invalid Unsubscribe Token")
+    end
+  end
+end

config/locales/activerecord.en-GB.yml

@@ -24,6 +24,13 @@ en-GB:
             role:
               inclusion: "Role '%{value}' is invalid"
 
+        archived/debate_outcome:
+          attributes:
+            commons_image:
+              too_narrow: "Width must be at least %{min_width}px (is %{width}px)"
+              too_short: "Height must be at least %{min_height}px (is %{height}px)"
+              incorrect_ratio: "Width and height ratio of uploaded image is %{ratio} - should be between %{min_ratio} and %{max_ratio}"
+
         petition:
           attributes:
             moderation:

db/migrate/20170612144648_replicate_petition_models_for_archive.rb

@@ -0,0 +1,126 @@
+class ReplicatePetitionModelsForArchive < ActiveRecord::Migration
+  def change
+    create_table :archived_debate_outcomes do |t|
+      t.integer  :petition_id, null: false
+      t.date     :debated_on
+      t.string   :transcript_url, limit: 500
+      t.string   :video_url, limit: 500
+      t.text     :overview
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+      t.boolean  :debated, default: true, null: false
+      t.string   :commons_image_file_name
+      t.string   :commons_image_content_type
+      t.integer  :commons_image_file_size
+      t.datetime :commons_image_updated_at
+    end
+
+    add_index :archived_debate_outcomes, [:petition_id, :debated_on]
+    add_index :archived_debate_outcomes, :petition_id, unique: true
+    add_index :archived_debate_outcomes, :updated_at
+    add_foreign_key :archived_debate_outcomes, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    create_table :archived_government_responses do |t|
+      t.integer  :petition_id
+      t.string   :summary, limit: 500, null: false
+      t.text     :details
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :archived_government_responses, :petition_id, unique: true
+    add_index :archived_government_responses, :updated_at
+    add_foreign_key :archived_government_responses, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    create_table :archived_notes do |t|
+      t.integer  :petition_id
+      t.text     :details
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :archived_notes, :petition_id, unique: true
+    add_foreign_key :archived_notes, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    create_table :archived_petition_emails, force: :cascade do |t|
+      t.integer  :petition_id
+      t.string   :subject, null: false
+      t.text     :body
+      t.string   :sent_by
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :archived_petition_emails, :petition_id
+    add_foreign_key :archived_petition_emails, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    create_table :archived_rejections, force: :cascade do |t|
+      t.integer  :petition_id
+      t.string   :code, limit: 50, null: false
+      t.text     :details
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :archived_rejections, :petition_id, unique: true
+    add_foreign_key :archived_rejections, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    create_table :archived_signatures do |t|
+      t.string   :name, limit: 255, null: false
+      t.string   :state, limit: 20, default: "pending", null: false
+      t.string   :perishable_token, limit: 255
+      t.string   :postcode, limit: 255
+      t.string   :ip_address, limit: 20
+      t.integer  :petition_id
+      t.datetime :created_at
+      t.datetime :updated_at
+      t.boolean  :notify_by_email, default: true
+      t.string   :email, limit: 255
+      t.string   :unsubscribe_token
+      t.string   :constituency_id
+      t.datetime :validated_at
+      t.integer  :number
+      t.boolean  :seen_signed_confirmation_page, default: false, null: false
+      t.string   :location_code, limit: 30
+      t.datetime :invalidated_at
+      t.integer  :invalidation_id
+      t.datetime :government_response_email_at
+      t.datetime :debate_scheduled_email_at
+      t.datetime :debate_outcome_email_at
+      t.datetime :petition_email_at
+      t.uuid     :uuid
+      t.boolean  :creator, default: false, null: false
+      t.boolean  :sponsor, default: false, null: false
+    end
+
+    add_index :archived_signatures, :constituency_id
+    add_index :archived_signatures, [:created_at, :ip_address, :petition_id], name: "index_archived_signatures_on_creation_ip_and_petition_id"
+    add_index :archived_signatures, [:email, :petition_id, :name], unique: true
+    add_index :archived_signatures, :invalidation_id
+    add_index :archived_signatures, [:ip_address, :petition_id]
+    add_index :archived_signatures, [:petition_id, :location_code]
+    add_index :archived_signatures, :petition_id
+    add_index :archived_signatures, [:state, :petition_id]
+    add_index :archived_signatures, :updated_at
+    add_index :archived_signatures, :uuid
+    add_index :archived_signatures, :validated_at
+    add_index :archived_signatures, [:creator, :petition_id]
+    add_index :archived_signatures, [:sponsor, :petition_id]
+    add_foreign_key :archived_signatures, :archived_petitions, column: :petition_id, on_delete: :cascade
+
+    add_column :archived_petitions, :action, :string, limit: 255
+    add_column :archived_petitions, :background, :string, limit: 300
+    add_column :archived_petitions, :additional_details, :text
+    add_column :archived_petitions, :government_response_at, :datetime
+    add_column :archived_petitions, :scheduled_debate_date, :date
+    add_column :archived_petitions, :last_signed_at, :datetime
+    add_column :archived_petitions, :response_threshold_reached_at, :datetime
+    add_column :archived_petitions, :debate_threshold_reached_at, :datetime
+    add_column :archived_petitions, :rejected_at, :datetime
+    add_column :archived_petitions, :debate_outcome_at, :datetime
+    add_column :archived_petitions, :moderation_threshold_reached_at, :datetime
+    add_column :archived_petitions, :debate_state, :string, limit: 30
+    add_column :archived_petitions, :stopped_at, :datetime
+    add_column :archived_petitions, :special_consideration, :boolean
+  end
+end