fe 1.0.0 → 2.0.0

data/spec/controllers/fe/answer_sheets_controller_spec.rb

@@ -16,7 +16,7 @@ describe Fe::AnswerSheetsController, type: :controller do
     it 'should work' do
       create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
 
-      post :create, question_sheet_id: question_sheet.id
+      post :create, params: {question_sheet_id: question_sheet.id}
       expect(assigns(:answer_sheet)).to_not be_nil
     end
   end
@@ -25,7 +25,7 @@ describe Fe::AnswerSheetsController, type: :controller do
       create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
       page = create(:page, question_sheet: question_sheet)
 
-      get :edit, id: answer_sheet.id
+      get :edit, params: {id: answer_sheet.id}
       expect(assigns(:elements)).to eq([])
       expect(assigns(:page)).to eq(page)
     end
@@ -35,7 +35,7 @@ describe Fe::AnswerSheetsController, type: :controller do
           create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
           request.env['HTTP_REFERER'] = '/referrer'
 
-          get :edit, id: answer_sheet.id
+          get :edit, params: {id: answer_sheet.id}
           expect(response).to redirect_to('http://test.host/referrer')
         end
       end
@@ -43,22 +43,63 @@ describe Fe::AnswerSheetsController, type: :controller do
         it 'should render an empty page with a flash message' do
           create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
 
-          get :edit, id: answer_sheet.id
+          get :edit, params: {id: answer_sheet.id}
           expect(response.body['Sorry, there are no questions for this form yet.']).to_not be_nil
         end
       end
     end
   end
   context '#show' do
+    let(:page) { create(:page, question_sheet: question_sheet) }
+    let(:el_confidential) { create(:text_field_element, is_confidential: true) }
+    let(:el_visible) { create(:text_field_element, is_confidential: false) }
+
+    before do
+      answer_sheet.question_sheets << question_sheet
+    end
+
     it 'should work' do
-      create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
-      page = create(:page, question_sheet: question_sheet)
       text_field = create(:text_field_element)
-      create(:page_element, element: text_field, page: page)
+      page.elements << text_field
 
-      get :show, id: answer_sheet.id
+      get :show, params: {id: answer_sheet.id}
       expect(assigns(:elements)).to eq(page => [text_field])
     end
+    context 'filtering' do
+      let(:el_confidential) { create(:text_field_element, is_confidential: true) }
+      let(:el_visible) { create(:text_field_element, is_confidential: false) }
+      let(:el_visible2) { create(:text_field_element, is_confidential: false) }
+
+      before do
+        page.elements << el_confidential << el_visible << el_visible2
+      end
+
+      it 'should filter out elements' do
+        allow_any_instance_of(Fe::AnswerSheetsController).to receive(:get_filter).and_return(filter_default: :show, filter: [ :is_confidential ])
+
+        get :show, params: {id: answer_sheet.id}
+        expect(assigns(:elements)).to eq(page => [el_visible, el_visible2])
+      end
+      it 'should filter in elements' do
+        allow_any_instance_of(Fe::AnswerSheetsController).to receive(:get_filter).and_return(filter_default: :hide, filter: [ :is_confidential ])
+
+        get :show, params: {id: answer_sheet.id}
+        expect(assigns(:elements)).to eq(page => [el_confidential])
+      end
+    end
+    context 'element on multiple pages' do
+      let!(:question_sheet2) { create(:question_sheet) }
+      let!(:page2) { create(:page, question_sheet: question_sheet2) }
+
+      it 'should pull the right page' do
+        text_field = create(:text_field_element)
+        page.elements << text_field
+        page2.elements << text_field
+
+        get :show, params: {id: answer_sheet.id}
+        expect(assigns(:elements)).to eq(page => [text_field])
+      end
+    end
   end
   context '#send_reference_invite' do
     it 'should work' do
@@ -70,7 +111,14 @@ describe Fe::AnswerSheetsController, type: :controller do
       create(:email_template, name: 'Reference Invite')
       create(:email_template, name: 'Reference Notification to Applicant')
 
-      xhr :post, :send_reference_invite, reference: { ref_sheet.id.to_s => { relationship: 'rel', title: 'title', first_name: 'first_name', last_name: 'last_name', phone: 'phone', email: 'email@email.com' } }, reference_id: ref_sheet.id, id: answer_sheet.id
+      post :send_reference_invite, params: {
+        reference: {
+           ref_sheet.id.to_s => {
+              relationship: 'rel', title: 'title', first_name: 'first_name',
+              last_name: 'last_name', phone: 'phone', email: 'email@email.com' }
+            },
+            reference_id: ref_sheet.id, id: answer_sheet.id
+        }, xhr: true
       ref_sheet.reload
       expect(ref_sheet.relationship).to eq('rel')
       expect(ref_sheet.title).to eq('title')
@@ -80,4 +128,12 @@ describe Fe::AnswerSheetsController, type: :controller do
       expect(ref_sheet.email).to eq('email@email.com')
     end
   end
+  context '#pages' do
+    it 'filters out hidden pages' do
+      create(:answer_sheet_question_sheet, question_sheet: question_sheet, answer_sheet: answer_sheet)
+      page = create(:page, question_sheet: question_sheet)
+      page2 = create(:page, question_sheet: question_sheet, hidden: true)
+      expect(answer_sheet.pages).to eq([page])
+    end
+  end
 end

data/spec/dummy/app/models/user.rb

@@ -1,3 +1,3 @@
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   has_one :person
 end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -2,8 +2,8 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/spec/dummy/config/application.rb

@@ -1,3 +1,4 @@
+require 'uri'
 require File.expand_path('../boot', __FILE__)
 
 # Pick the frameworks you want:

data/spec/dummy/config/environments/test.rb

@@ -13,8 +13,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
@@ -37,5 +37,5 @@ Rails.application.configure do
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 
-  config.action_mailer.default_url_options = { :host => 'test.com' }
+  config.action_mailer.default_url_options = { host: 'test.com' }
 end

data/spec/dummy/config/initializers/assets.rb

@@ -4,5 +4,8 @@
 Rails.application.config.assets.version = '1.0'
 
 # Precompile additional assets.
-# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-# Rails.application.config.assets.precompile += %w( search.js )
+
+# javascripts
+Rails.application.config.assets.precompile += %w(fe/fe.public.js)
+# images
+Rails.application.config.assets.precompile += %w(fe/ajax-loader.gif fe/status.gif fe/icons/question-balloon.png)

data/spec/dummy/config/initializers/fast_gettext.rb

@@ -1,4 +1,4 @@
-FastGettext.add_text_domain 'app', :path => 'locale', :type => :po
+FastGettext.add_text_domain 'app', path: 'locale', type: :po
 FastGettext.default_available_locales = ['en', 'fr'] #all you want to allow
 FastGettext.default_text_domain = 'app'
 FastGettext.locale = 'en'

data/spec/dummy/config/initializers/to_unsafe_h.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_unsafe_h
+    self
+  end
+end

data/spec/dummy/config/initializers/to_unsafe_h.rb.new

@@ -0,0 +1,5 @@
+class Hash
+  def to_unsafe_h
+    self
+  end
+end

data/spec/dummy/db/migrate/20141203214017_core.fe_engine.rb

@@ -1,9 +1,9 @@
 # This migration comes from fe_engine (originally 20131003041856)
-  class Core < ActiveRecord::Migration
+  class Core < ActiveRecord::Migration[4.2]
   def change
     create_table Fe::QuestionSheet.table_name do |t|
-      t.string  :label,    :limit => 100,       :null => false   # name used internally in admin
-      t.boolean :archived, :default => false,   :nil => false
+      t.string  :label,    limit: 100,       null: false   # name used internally in admin
+      t.boolean :archived, default: false,   nil: false
       t.timestamps
     end
 
@@ -17,33 +17,33 @@
     add_index Fe.answer_sheet_class.constantize.table_name, :applicant_id, name: 'question_sheet_id'
 
     create_table Fe::Page.table_name do |t|
-      t.integer :question_sheet_id,  :null => false
-      t.string  :label,     :limit => 60, :null => false    # page title
+      t.integer :question_sheet_id,  null: false
+      t.string  :label,     limit: 60, null: false    # page title
       t.integer :number                                     # page number (order)
-      t.boolean :no_cache,  :default => false
-      t.boolean :hidden,    :default => false
+      t.boolean :no_cache,  default: false
+      t.boolean :hidden,    default: false
       t.timestamps
     end
 
     create_table Fe::Element.table_name do |t|
-      t.integer :question_grid_id,   :null => true
-      t.string  :kind,               :limit => 40,   :null => false  # single table inheritance: class name
-      t.string  :style,              :limit => 40                    # render style
-      t.string  :label,              :limit => 255                   # question label, section heading
-      t.text    :content,              :null => true                 # for content/instructions, and for choices (one per line)
+      t.integer :question_grid_id,   null: true
+      t.string  :kind,               limit: 40,   null: false  # single table inheritance: class name
+      t.string  :style,              limit: 40                    # render style
+      t.string  :label,              limit: 255                   # question label, section heading
+      t.text    :content,              null: true                 # for content/instructions, and for choices (one per line)
       t.boolean :required                                            # question is required?
-      t.string  :slug,               :limit => 36                    # variable reference
+      t.string  :slug,               limit: 36                    # variable reference
       t.integer :position
       t.string  :object_name,        :attribute_name
       t.string  :source
       t.string  :value_xpath
       t.string  :text_xpath
       t.string  :cols
-      t.boolean :is_confidential, :default => false
+      t.boolean :is_confidential, default: false
       t.string  :total_cols
       t.string  :css_id
       t.string  :css_class
-      t.integer :question_sheet_id, :null => false
+      t.integer :question_sheet_id, null: false
       t.timestamps
     end
     add_index Fe::Element.table_name, :slug
@@ -59,10 +59,10 @@
 
 
     create_table Fe::Answer.table_name do |t|
-      t.integer  :answer_sheet_id,  :null => false
-      t.integer  :question_id,      :null => false
+      t.integer  :answer_sheet_id,  null: false
+      t.integer  :question_id,      null: false
       t.text     :value
-      t.string   :short_value,         :null => true, :limit => 255   # indexed copy of :value
+      t.string   :short_value,         null: true, limit: 255   # indexed copy of :value
       # paperclip columns
       t.integer  :attachment_file_size
       t.string   :attachment_content_type
@@ -75,11 +75,11 @@
     add_index Fe::Answer.table_name, [:answer_sheet_id, :question_id], name: 'answer_sheet_question'
 
     create_table Fe::Condition.table_name do |t|
-      t.integer :question_sheet_id,  :null => false
-      t.integer :trigger_id,            :null => false
-      t.string  :expression,            :null => false,  :limit  => 255
-      t.integer :toggle_page_id,        :null => false
-      t.integer :toggle_id,             :null => true    # null if toggles whole page
+      t.integer :question_sheet_id,  null: false
+      t.integer :trigger_id,            null: false
+      t.string  :expression,            null: false,  limit: 255
+      t.integer :toggle_page_id,        null: false
+      t.integer :toggle_id,             null: true    # null if toggles whole page
       t.timestamps
     end
 

data/spec/dummy/db/migrate/20141203214018_create_reference_sheets.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20131003044250)
-class CreateReferenceSheets < ActiveRecord::Migration
+class CreateReferenceSheets < ActiveRecord::Migration[4.2]
   def change
     create_table Fe::ReferenceSheet.table_name do |t|
       t.integer  :question_id

data/spec/dummy/db/migrate/20141203214019_add_element_and_answer_fields.fe_engine.rb

@@ -1,10 +1,10 @@
 # This migration comes from fe_engine (originally 20131003044436)
-class AddElementAndAnswerFields < ActiveRecord::Migration
+class AddElementAndAnswerFields < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Element.table_name, :conditional_id,     :integer
     add_column Fe::Element.table_name, :tooltip,            :text
-    add_column Fe::Element.table_name, :hide_label,         :boolean, :default => false, :nil => false
-    add_column Fe::Element.table_name, :hide_option_labels, :boolean, :default => false, :nil => false
+    add_column Fe::Element.table_name, :hide_label,         :boolean, default: false, nil: false
+    add_column Fe::Element.table_name, :hide_option_labels, :boolean, default: false, nil: false
 
     #add_index Fe::Element.table_name, :conditional_id
   end

data/spec/dummy/db/migrate/20141203214020_create_email_templates.fe_engine.rb

@@ -1,8 +1,8 @@
 # This migration comes from fe_engine (originally 20131003044518)
-class CreateEmailTemplates < ActiveRecord::Migration
+class CreateEmailTemplates < ActiveRecord::Migration[4.2]
   def up
     create_table Fe::EmailTemplate.table_name do |t|
-      t.string  :name, :limit => 1000, :null => false
+      t.string  :name, limit: 1000, null: false
       t.text    :content
       t.boolean :enabled
       t.string  :subject

data/spec/dummy/db/migrate/20141203214021_add_max_lengths.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20131003044621)
-class AddMaxLengths < ActiveRecord::Migration
+class AddMaxLengths < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Element.table_name, :max_length, :integer
     

data/spec/dummy/db/migrate/20141203214022_create_join_table.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20131003044714)
-class CreateJoinTable < ActiveRecord::Migration
+class CreateJoinTable < ActiveRecord::Migration[4.2]
   def change
     create_table Fe::AnswerSheetQuestionSheet.table_name do |t|
       t.integer :answer_sheet_id

data/spec/dummy/db/migrate/20141203214023_remove_question_id_from_element.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20131016162128)
-class RemoveQuestionIdFromElement < ActiveRecord::Migration
+class RemoveQuestionIdFromElement < ActiveRecord::Migration[4.2]
   def up
     remove_column Fe::Element.table_name, :question_sheet_id
   end

data/spec/dummy/db/migrate/20141203214024_create_fe_people.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140623153424)
-class CreateFePeople < ActiveRecord::Migration
+class CreateFePeople < ActiveRecord::Migration[4.2]
   def change
     create_table :fe_people do |t|
       t.string :first_name, limit: 50

data/spec/dummy/db/migrate/20141203214025_create_fe_addresses.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140624180246)
-class CreateFeAddresses < ActiveRecord::Migration
+class CreateFeAddresses < ActiveRecord::Migration[4.2]
   def change
     create_table :fe_addresses do |t|
       t.datetime :startdate

data/spec/dummy/db/migrate/20141203214027_create_fe_users.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140625160545)
-class CreateFeUsers < ActiveRecord::Migration
+class CreateFeUsers < ActiveRecord::Migration[4.2]
   def change
     create_table :fe_users do |t|
       t.integer :user_id

data/spec/dummy/db/migrate/20141203214028_add_conditional_type_to_elements.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140808202507)
-class AddConditionalTypeToElements < ActiveRecord::Migration
+class AddConditionalTypeToElements < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Element.table_name, :conditional_type, :string
   end

data/spec/dummy/db/migrate/20141203214029_add_conditional_answer_to_elements.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140808203609)
-class AddConditionalAnswerToElements < ActiveRecord::Migration
+class AddConditionalAnswerToElements < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Element.table_name, :conditional_answer, :text
   end

data/spec/dummy/db/migrate/20141203214030_remove_short_value_column.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20141103204704)
-class RemoveShortValueColumn < ActiveRecord::Migration
+class RemoveShortValueColumn < ActiveRecord::Migration[4.2]
   def change
     remove_column Fe::Answer.table_name, :short_value
   end

data/spec/dummy/db/migrate/20141203214031_move_conditional_ids_used_for_choice_field_to_their_own_column.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20141109154522)
-class MoveConditionalIdsUsedForChoiceFieldToTheirOwnColumn < ActiveRecord::Migration
+class MoveConditionalIdsUsedForChoiceFieldToTheirOwnColumn < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Element.table_name, :choice_field_id, :integer
     Fe::Element.reset_column_information

data/spec/dummy/db/migrate/20150123215803_create_users.rb

@@ -1,4 +1,4 @@
-class CreateUsers < ActiveRecord::Migration
+class CreateUsers < ActiveRecord::Migration[4.2]
   def change
     create_table :users do |t|
       t.string :username

data/spec/dummy/db/migrate/20150504222619_add_all_element_ids_to_pages.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20150504221439)
-class AddAllElementIdsToPages < ActiveRecord::Migration
+class AddAllElementIdsToPages < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::Page.table_name, :all_element_ids, :string
   end

data/spec/dummy/db/migrate/20150925192557_add_share_to_elements.fe_engine.rb

@@ -0,0 +1,6 @@
+# This migration comes from fe_engine (originally 20150925181652)
+class AddShareToElements < ActiveRecord::Migration[4.2]
+  def change
+    add_column Fe::Element.table_name, :share, :boolean, default: false
+  end
+end

data/spec/dummy/db/migrate/20150930190001_create_fe_phone_numbers.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20140624182216)
-class CreateFePhoneNumbers < ActiveRecord::Migration
+class CreateFePhoneNumbers < ActiveRecord::Migration[4.2]
   def change
     begin
       create_table Fe::PhoneNumber do |t|

data/spec/dummy/db/migrate/20150930190002_add_locale_columns.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20150713022326)
-class AddLocaleColumns < ActiveRecord::Migration
+class AddLocaleColumns < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::QuestionSheet.table_name, :languages, :text
     add_column Fe::Element.table_name, :label_translations, :text

data/spec/dummy/db/migrate/20150930190003_add_locale_to_answer_sheet.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20150714220730)
-class AddLocaleToAnswerSheet < ActiveRecord::Migration
+class AddLocaleToAnswerSheet < ActiveRecord::Migration[4.2]
   def change
     add_column Fe.answer_sheet_class.constantize.table_name, :locale, :string, default: 'en'
   end

data/spec/dummy/db/migrate/20150930190004_change_pages_all_element_ids_to_text.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20150928085325)
-class ChangePagesAllElementIdsToText < ActiveRecord::Migration
+class ChangePagesAllElementIdsToText < ActiveRecord::Migration[4.2]
   def change
     change_column Fe::Page.table_name, :all_element_ids, :text
   end

data/spec/dummy/db/migrate/20150930191756_add_locale_to_reference_sheets.fe_engine.rb

@@ -1,5 +1,5 @@
 # This migration comes from fe_engine (originally 20150930191538)
-class AddLocaleToReferenceSheets < ActiveRecord::Migration
+class AddLocaleToReferenceSheets < ActiveRecord::Migration[4.2]
   def change
     add_column Fe::ReferenceSheet.table_name, :locale, :string, default: 'en'
   end

data/spec/dummy/db/migrate/20151021190027_add_question_sheet_id_in_refs.fe_engine.rb

@@ -0,0 +1,13 @@
+# This migration comes from fe_engine (originally 20151021184250)
+class AddQuestionSheetIdInRefs < ActiveRecord::Migration[4.2]
+  def change
+    add_column Fe::ReferenceSheet.table_name, :question_sheet_id, :integer
+
+    # set initial question_sheet_id on all refs
+    # NOTE: doing an update on a join query is a pain to do in both mysql and postgres
+    # and since there's not that many reference questions, this should be fine
+    Fe::ReferenceQuestion.all.each do |rq|
+      Fe::ReferenceSheet.where(question_id: rq.id).update_all(question_sheet_id: rq.related_question_sheet_id)
+    end
+  end
+end

data/spec/dummy/db/migrate/20160204164612_switch_conditional_answer_separator_to_semicolon.fe_engine.rb

@@ -0,0 +1,8 @@
+# This migration comes from fe_engine (originally 20151021181928)
+class SwitchConditionalAnswerSeparatorToSemicolon < ActiveRecord::Migration[4.2]
+  def change
+    Fe::Element.where("conditional_answer IS NOT NULL AND conditional_answer != ''").each do |e|
+      e.update_column :conditional_answer, e.conditional_answer.gsub(',', ';')
+    end
+  end
+end

data/spec/dummy/db/migrate/20160204164613_add_visible_and_visibility_cache_key_to_reference_sheets.fe_engine.rb

@@ -0,0 +1,7 @@
+# This migration comes from fe_engine (originally 20160201185838)
+class AddVisibleAndVisibilityCacheKeyToReferenceSheets < ActiveRecord::Migration[4.2]
+  def change
+    add_column Fe::ReferenceSheet.table_name, :visible, :boolean
+    add_column Fe::ReferenceSheet.table_name, :visibility_cache_key, :string
+  end
+end

data/spec/dummy/db/migrate/20181108201746_create_versions.rb

@@ -0,0 +1,80 @@
+# This migration creates the `versions` table, the only schema PT requires.
+# All other migrations PT provides are optional.
+class CreateVersions < ActiveRecord::Migration[4.2]
+  # Class names of MySQL adapters.
+  # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+  # - `Mysql2Adapter` - Used by `mysql2` gem.
+  MYSQL_ADAPTERS = [
+    "ActiveRecord::ConnectionAdapters::MysqlAdapter",
+    "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
+  ].freeze
+
+  # The largest text column available in all supported RDBMS is
+  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
+  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
+  # when serializing very large objects, `text` might not be big enough.
+  TEXT_BYTES = 1_073_741_823
+
+  def change
+    create_table :versions, versions_table_options do |t|
+      t.string   :item_type, item_type_options
+      t.integer  :item_id,   null: false
+      t.string   :event,     null: false
+      t.string   :whodunnit
+      t.text     :object, limit: TEXT_BYTES
+
+      # Known issue in MySQL: fractional second precision
+      # -------------------------------------------------
+      #
+      # MySQL timestamp columns do not support fractional seconds unless
+      # defined with "fractional seconds precision". MySQL users should manually
+      # add fractional seconds precision to this migration, specifically, to
+      # the `created_at` column.
+      # (https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html)
+      #
+      # MySQL users should also upgrade to rails 4.2, which is the first
+      # version of ActiveRecord with support for fractional seconds in MySQL.
+      # (https://github.com/rails/rails/pull/14359)
+      #
+      t.datetime :created_at
+    end
+    add_index :versions, [:item_type, :item_id]
+  end
+
+  private
+
+  # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
+  # See https://github.com/airblade/paper_trail/issues/651
+  def item_type_options
+    opt = { null: false }
+    opt[:limit] = 191 if mysql?
+    opt
+  end
+
+  def mysql?
+    MYSQL_ADAPTERS.include?(connection.class.name)
+  end
+
+  # Even modern versions of MySQL still use `latin1` as the default character
+  # encoding. Many users are not aware of this, and run into trouble when they
+  # try to use PaperTrail in apps that otherwise tend to use UTF-8. Postgres, by
+  # comparison, uses UTF-8 except in the unusual case where the OS is configured
+  # with a custom locale.
+  #
+  # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
+  # - http://www.postgresql.org/docs/9.4/static/multibyte.html
+  #
+  # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
+  # to be fixed later by introducing a new charset, `utf8mb4`.
+  #
+  # - https://mathiasbynens.be/notes/mysql-utf8mb4
+  # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
+  #
+  def versions_table_options
+    if mysql?
+      { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }
+    else
+      {}
+    end
+  end
+end