[refactor] Migrate from Paperclip to ActiveStorage (#152)

sman591 · web-flow · commit 6a956aafb09e · 2019-05-21T15:12:05.000-04:00
* [refactor] Use ActiveStorage instead of Paperclip

* Reformat

* Add link to original source
diff --git a/Gemfile b/Gemfile
@@ -46,8 +46,8 @@ gem 'doorkeeper', '~> 5.0'
 gem 'devise-doorkeeper'
 
 # User uploads
-gem 'paperclip', '~> 6.0'
-gem 'aws-sdk-s3'
+gem "aws-sdk-s3", require: false
+gem "file_validators"
 
 # Templating utilities
 gem 'haml-rails', '~> 1.0'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -103,7 +103,6 @@ GEM
     chromedriver-helper (2.1.1)
       archive-zip (~> 0.10)
       nokogiri (~> 1.8)
-    climate_control (0.2.0)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.2)
@@ -152,6 +151,9 @@ GEM
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
+    file_validators (2.3.0)
+      activemodel (>= 3.2)
+      mime-types (>= 1.0)
     font-awesome-rails (4.7.0.5)
       railties (>= 3.2, < 6.1)
     formatador (0.2.5)
@@ -265,12 +267,6 @@ GEM
       oauth2 (~> 1.0)
       omniauth (~> 1.2)
     orm_adapter (0.5.0)
-    paperclip (6.1.0)
-      activemodel (>= 4.2.0)
-      activesupport (>= 4.2.0)
-      mime-types
-      mimemagic (~> 0.3.0)
-      terrapin (~> 0.6.0)
     popper_js (1.14.5)
     power_assert (1.1.4)
     pry (0.12.2)
@@ -413,8 +409,6 @@ GEM
     strip_attributes (1.9.0)
       activemodel (>= 3.0, < 7.0)
     temple (0.8.1)
-    terrapin (0.6.0)
-      climate_control (>= 0.0.3, < 1.0)
     test-unit (3.3.3)
       power_assert
     thor (0.20.3)
@@ -470,6 +464,7 @@ DEPENDENCIES
   doorkeeper (~> 5.0)
   dotenv-rails
   factory_bot_rails
+  file_validators
   font-awesome-rails (~> 4.0)
   groupdate
   guard
@@ -484,7 +479,6 @@ DEPENDENCIES
   mustache (~> 1.0)
   mysql2 (>= 0.4.4, < 0.6.0)
   omniauth-mlh (~> 0.1)
-  paperclip (~> 6.0)
   puma (~> 3.11)
   rails (~> 5.2.2)
   rails-controller-testing
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ HackathonManager makes use of a few different third-party services & Ruby gems:
 - [Devise](https://github.com/plataformatec/devise) + [MyMLH](https://my.mlh.io/) (authentication & attendee identity)
 - [Sidekiq](https://github.com/mperham/sidekiq) (background jobs)
 - [Sparkpost](https://www.sparkpost.com/) (email)
-- [Paperclip](https://github.com/thoughtbot/paperclip) + [Amazon S3](https://aws.amazon.com/s3/) (resume storage)
+- [Amazon S3](https://aws.amazon.com/s3/) (resume storage)
 - [Chartkick](http://chartkick.com/) (management UI charts)
 - [Blazer](https://github.com/ankane/blazer) (custom SQL queries, analytics, and charts)
 - [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) (authentication via OAuth for API usage)
diff --git a/app/controllers/manage/stats_controller.rb b/app/controllers/manage/stats_controller.rb
@@ -31,13 +31,13 @@ def dietary_special_needs
   def sponsor_info
     data = Rails.cache.fetch(cache_key_for_questionnaires("sponsor_info")) do
       select_attributes = [
+        :id,
         :first_name,
         :last_name,
         :vcs_url,
         :portfolio_url,
         :user_id,
-        :school_id,
-        :resume_file_name
+        :school_id
       ]
       json_attributes = [
         :first_name,
@@ -47,9 +47,9 @@ def sponsor_info
         :vcs_url,
         :portfolio_url
       ]
-      data = Questionnaire.where("can_share_info = '1' AND checked_in_at != 0").select(select_attributes)
+      data = Questionnaire.where("can_share_info = '1' AND checked_in_at != 0").joins(:resume_attachment).select(select_attributes)
       json = to_json_array(data, json_attributes)
-      json.map.with_index { |item, index| item.insert(5, data[index].resume? ? data[index].resume.url : '') }
+      json.map.with_index { |item, index| item.insert(6, data[index].resume.attached? ? url_for(data[index].resume) : '') }
     end
     render json: { data: data }
   end
diff --git a/app/inputs/deletable_attachment_input.rb b/app/inputs/deletable_attachment_input.rb
@@ -3,7 +3,7 @@ def input(wrapper_options)
     merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
     out = ''
     out << @builder.file_field(attribute_name, merged_input_options)
-    if object.send("#{attribute_name}?")
+    if object.send("#{attribute_name}").attached?
       out << @builder.input("delete_#{attribute_name}", as: :boolean, label: "Remove?", wrapper_html: { class: 'deletable_attachment_input' })
     end
     out.html_safe
diff --git a/app/models/deletable_attachment.rb b/app/models/deletable_attachment.rb
@@ -2,15 +2,14 @@
 module DeletableAttachment
   extend ActiveSupport::Concern
 
-  included do
-    attachment_definitions.keys.each do |name|
+  class_methods do
+    def deletable_attachment(name, dependent: :purge_later)
       attr_accessor :"delete_#{name}"
 
-      before_validation { send(name).destroy if send("delete_#{name}") == '1' }
+      before_validation { send(name)&.purge if send("delete_#{name}") == '1' }
 
       define_method :"delete_#{name}=" do |value|
         instance_variable_set :"@delete_#{name}", value
-        send("#{name}_file_name_will_change!")
       end
     end
   end
diff --git a/app/models/questionnaire.rb b/app/models/questionnaire.rb
@@ -1,5 +1,6 @@
 class Questionnaire < ApplicationRecord
   include ActiveModel::Dirty
+  include DeletableAttachment
 
   before_validation :consolidate_school_names
   before_validation :clean_for_non_rsvp
@@ -28,11 +29,11 @@ class Questionnaire < ApplicationRecord
   #   validates_presence_of :why_attend
   # end
 
-  has_attached_file :resume
-  validates_attachment_content_type :resume, content_type: %w[application/pdf], message: "Invalid file type"
-  validates_attachment_size :resume, in: 0..2.megabytes, message: "File size is too big"
-
-  include DeletableAttachment
+  has_one_attached :resume
+  deletable_attachment :resume
+  validates :resume, file_size: { less_than_or_equal_to: 2.megabytes },
+                     file_content_type: { allow: ['application/pdf'] },
+                     if: -> { resume.attached? }
 
   validates :portfolio_url, url: { allow_blank: true }
   validates :vcs_url, url: { allow_blank: true }
diff --git a/app/views/application/_questionnaire_summary.html.haml b/app/views/application/_questionnaire_summary.html.haml
@@ -13,7 +13,7 @@
   = @questionnaire.vcs_url? ? link_to(@questionnaire.vcs_url, @questionnaire.vcs_url, target: '_blank') : 'Not provided'
 %p
   %b Resume:
-  = @questionnaire.resume? ? link_to("Download &raquo;".html_safe, @questionnaire.resume.url) : 'Not provided'
+  = @questionnaire.resume.attached? ? link_to("Download &raquo;".html_safe, @questionnaire.resume) : 'Not provided'
 %p
   %b Traveling from:
   = @questionnaire.travel_not_from_school ? "Somewhere else (#{@questionnaire.travel_location})" : "My school (#{@questionnaire.school.full_name})"
diff --git a/app/views/manage/questionnaires/_overview.html.haml b/app/views/manage/questionnaires/_overview.html.haml
@@ -91,7 +91,7 @@
             = @questionnaire.vcs_url? ? link_to(@questionnaire.vcs_url, @questionnaire.vcs_url, target: '_blank') : not_provided
           %dt.col-md-4 Resume
           %dd.col-md-8
-            = @questionnaire.resume? ? link_to("Download &raquo;".html_safe, @questionnaire.resume.url) : not_provided
+            = @questionnaire.resume.attached? ? link_to("Download &raquo;".html_safe, @questionnaire.resume) : not_provided
 
     .card.mb-3
       .card-header Education
diff --git a/config/environments/production.rb b/config/environments/production.rb
@@ -39,7 +39,7 @@
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
   # Store uploaded files on the local file system (see config/storage.yml for options)
-  config.active_storage.service = :local
+  config.active_storage.service = :amazon
 
   # Mount Action Cable outside main process or domain
   # config.action_cable.mount_path = nil
@@ -102,15 +102,4 @@
   mailer_url_protocol = ENV["HM_PROTOCOL"].presence || 'https'
   config.action_mailer.default_url_options = { host: mailer_url_host, protocol: mailer_url_protocol }
   config.action_mailer.asset_host = "#{mailer_url_protocol}://#{mailer_url_host}"
-
-  # Paperclip
-  config.paperclip_defaults = {
-    storage: :s3,
-    bucket: ENV['AWS_BUCKET'],
-    s3_credentials: {
-      access_key_id: ENV['AWS_ACCESS_KEY_ID'],
-      secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
-    },
-    s3_region: ENV['AWS_REGION']
-  }
 end
diff --git a/config/storage.yml b/config/storage.yml
@@ -6,29 +6,9 @@ local:
   service: Disk
   root: <%= Rails.root.join("storage") %>
 
-# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
-# amazon:
-#   service: S3
-#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
-#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
-#   region: us-east-1
-#   bucket: your_own_bucket
-
-# Remember not to checkin your GCS keyfile to a repository
-# google:
-#   service: GCS
-#   project: your_project
-#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
-#   bucket: your_own_bucket
-
-# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
-# microsoft:
-#   service: AzureStorage
-#   storage_account_name: your_account_name
-#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
-#   container: your_container_name
-
-# mirror:
-#   service: Mirror
-#   primary: local
-#   mirrors: [ amazon, google, microsoft ]
+amazon:
+  service: S3
+  access_key_id: <%= ENV["AWS_ACCESS_KEY_ID"] %>
+  secret_access_key: <%= ENV["AWS_SECRET_ACCESS_KEY"] %>
+  region: <%= ENV["AWS_REGION"] %>
+  bucket: <%= ENV["AWS_BUCKET"] %>
diff --git a/db/migrate/20161208055809_add_attachment_resume_to_questionnaires.rb b/db/migrate/20161208055809_add_attachment_resume_to_questionnaires.rb
diff --git a/db/migrate/20190521010316_create_active_storage_tables.active_storage.rb b/db/migrate/20190521010316_create_active_storage_tables.active_storage.rb
@@ -0,0 +1,27 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+end
diff --git a/db/migrate/20190521011254_drop_paperclip_attachments_from_questionnaires.rb b/db/migrate/20190521011254_drop_paperclip_attachments_from_questionnaires.rb
@@ -0,0 +1,10 @@
+class DropPaperclipAttachmentsFromQuestionnaires < ActiveRecord::Migration[5.2]
+  def change
+    columns = [:resume_file_name, :resume_content_type, :resume_file_size, :resume_updated_at]
+    columns.each do |column|
+      if column_exists?(:questionnaires, column)
+        remove_column :questionnaires, column
+      end
+    end
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,28 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_02_16_203450) do
+ActiveRecord::Schema.define(version: 2019_05_21_171801) do
+
+  create_table "active_storage_attachments", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+    t.string "name", null: false
+    t.string "record_type", null: false
+    t.bigint "record_id", null: false
+    t.bigint "blob_id", null: false
+    t.datetime "created_at", null: false
+    t.index ["blob_id"], name: "index_active_storage_attachments_on_blob_id"
+    t.index ["record_type", "record_id", "name", "blob_id"], name: "index_active_storage_attachments_uniqueness", unique: true
+  end
+
+  create_table "active_storage_blobs", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+    t.string "key", null: false
+    t.string "filename", null: false
+    t.string "content_type"
+    t.text "metadata"
+    t.bigint "byte_size", null: false
+    t.string "checksum", null: false
+    t.datetime "created_at", null: false
+    t.index ["key"], name: "index_active_storage_blobs_on_key", unique: true
+  end
 
   create_table "blazer_audits", id: :integer, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
     t.integer "user_id"
@@ -174,10 +195,6 @@
     t.string "travel_location"
     t.boolean "data_sharing_accepted"
     t.string "level_of_study"
-    t.string "resume_file_name"
-    t.string "resume_content_type"
-    t.bigint "resume_file_size"
-    t.datetime "resume_updated_at"
     t.string "interest"
     t.text "why_attend"
     t.datetime "boarded_bus_at"
@@ -257,6 +274,7 @@
     t.index ["uid"], name: "index_users_on_uid"
   end
 
+  add_foreign_key "active_storage_attachments", "active_storage_blobs", column: "blob_id"
   add_foreign_key "oauth_access_grants", "oauth_applications", column: "application_id"
   add_foreign_key "oauth_access_tokens", "oauth_applications", column: "application_id"
   add_foreign_key "questionnaires", "bus_lists"
diff --git a/test/matchers.rb b/test/matchers.rb
@@ -0,0 +1,50 @@
+# Originally adapted from https://github.com/thoughtbot/paperclip/blob/master/lib/paperclip/matchers/have_attached_file_matcher.rb
+
+module HackathonManager
+  module Shoulda
+    module Matchers
+      # Ensures that the given instance or class has an attachment with the
+      # given name.
+      #
+      # Example:
+      #   describe User do
+      #     it { should have_attached_file(:avatar) }
+      #   end
+      def have_attached_file(name)
+        HaveAttachedFileMatcher.new(name)
+      end
+
+      class HaveAttachedFileMatcher
+        def initialize(attachment_name)
+          @attachment_name = attachment_name
+        end
+
+        def matches?(subject)
+          @subject = subject
+          responds?
+        end
+
+        def failure_message
+          "Should have an attachment named #{@attachment_name}"
+        end
+
+        def failure_message_when_negated
+          "Should not have an attachment named #{@attachment_name}"
+        end
+
+        alias negative_failure_message failure_message_when_negated
+
+        def description
+          "have an attachment named #{@attachment_name}"
+        end
+
+        protected
+
+        def responds?
+          file = @subject.send(@attachment_name)
+          file.respond_to?(:attached?) && file.respond_to?(:attach)
+        end
+      end
+    end
+  end
+end
diff --git a/test/models/questionnaire_test.rb b/test/models/questionnaire_test.rb
diff --git a/test/test_helper.rb b/test/test_helper.rb
diff --git a/vendor/cache/climate_control-0.2.0.gem b/vendor/cache/climate_control-0.2.0.gem
diff --git a/vendor/cache/file_validators-2.3.0.gem b/vendor/cache/file_validators-2.3.0.gem
diff --git a/vendor/cache/paperclip-6.1.0.gem b/vendor/cache/paperclip-6.1.0.gem
diff --git a/vendor/cache/terrapin-0.6.0.gem b/vendor/cache/terrapin-0.6.0.gem
