Merge pull request #3081 from LinkUpStudioUA/shrine_field

Add Shrine support

Author: mshibuya

Appraisals

@@ -27,6 +27,7 @@ appraise "rails-5.0" do
     gem 'mongoid-paperclip', '>= 0.0.8', require: 'mongoid_paperclip'
     gem 'carrierwave-mongoid', '>= 0.6.3', require: 'carrierwave/mongoid'
     gem 'cancancan-mongoid'
+    gem 'shrine-mongoid'
   end
 end
 
@@ -56,6 +57,7 @@ appraise "rails-5.1" do
     gem 'mongoid-paperclip', '>= 0.0.8', require: 'mongoid_paperclip'
     gem 'carrierwave-mongoid', '>= 0.6.3', require: 'carrierwave/mongoid'
     gem 'cancancan-mongoid'
+    gem 'shrine-mongoid'
   end
 end
 
@@ -85,6 +87,7 @@ appraise "rails-5.2" do
     gem 'mongoid-paperclip', '>= 0.0.8', require: 'mongoid_paperclip'
     gem 'carrierwave-mongoid', '>= 0.6.3', require: 'carrierwave/mongoid'
     gem 'cancancan-mongoid'
+    gem 'shrine-mongoid'
   end
 end
 

Gemfile

@@ -35,6 +35,8 @@ group :test do
   gem 'rspec-expectations', '!= 3.8.3'
   gem 'rubocop', '~> 0.41.2'
   gem 'simplecov', '>= 0.9', require: false
+  gem 'shrine', '~> 2.0'
+  gem 'shrine-memory'
   gem 'timecop', '>= 0.5'
 
   platforms :ruby_19 do

gemfiles/cancan.gemfile

@@ -38,6 +38,8 @@ group :test do
   gem "rspec-expectations", "!= 3.8.3"
   gem "rubocop", "~> 0.41.2"
   gem "simplecov", ">= 0.9", require: false
+  gem "shrine", "~> 2.0"
+  gem "shrine-memory"
   gem "timecop", ">= 0.5"
   gem "cancan", ">= 1.6"
 

gemfiles/rails_5.0.gemfile

@@ -44,6 +44,8 @@ group :test do
   gem "rspec-expectations", "!= 3.8.3"
   gem "rubocop", "~> 0.41.2"
   gem "simplecov", ">= 0.9", require: false
+  gem "shrine", "~> 2.0"
+  gem "shrine-memory"
   gem "timecop", ">= 0.5"
   gem "cancancan", "~> 2.0"
 
@@ -58,6 +60,7 @@ group :mongoid do
   gem "mongoid-paperclip", ">= 0.0.8", require: "mongoid_paperclip"
   gem "carrierwave-mongoid", ">= 0.6.3", require: "carrierwave/mongoid"
   gem "cancancan-mongoid"
+  gem "shrine-mongoid"
 end
 
 gemspec path: "../"

gemfiles/rails_5.1.gemfile

@@ -45,6 +45,8 @@ group :test do
   gem "rspec-expectations", "!= 3.8.3"
   gem "rubocop", "~> 0.41.2"
   gem "simplecov", ">= 0.9", require: false
+  gem "shrine", "~> 2.0"
+  gem "shrine-memory"
   gem "timecop", ">= 0.5"
   gem "cancancan", "~> 2.0"
 
@@ -59,6 +61,7 @@ group :mongoid do
   gem "mongoid-paperclip", ">= 0.0.8", require: "mongoid_paperclip"
   gem "carrierwave-mongoid", ">= 0.6.3", require: "carrierwave/mongoid"
   gem "cancancan-mongoid"
+  gem "shrine-mongoid"
 end
 
 gemspec path: "../"

gemfiles/rails_5.2.gemfile

@@ -45,6 +45,8 @@ group :test do
   gem "rspec-expectations", "!= 3.8.3"
   gem "rubocop", "~> 0.41.2"
   gem "simplecov", ">= 0.9", require: false
+  gem "shrine", "~> 2.0"
+  gem "shrine-memory"
   gem "timecop", ">= 0.5"
   gem "cancancan", "~> 2.0"
 
@@ -59,6 +61,7 @@ group :mongoid do
   gem "mongoid-paperclip", ">= 0.0.8", require: "mongoid_paperclip"
   gem "carrierwave-mongoid", ">= 0.6.3", require: "carrierwave/mongoid"
   gem "cancancan-mongoid"
+  gem "shrine-mongoid"
 end
 
 gemspec path: "../"

gemfiles/rails_6.0.gemfile

@@ -39,6 +39,8 @@ group :test do
   gem "rspec-expectations", "!= 3.8.3"
   gem "rubocop", "~> 0.41.2"
   gem "simplecov", ">= 0.9", require: false
+  gem "shrine", "~> 2.0"
+  gem "shrine-memory"
   gem "timecop", ">= 0.5"
   gem "cancancan", "~> 3.0"
 

lib/rails_admin/config/fields.rb

@@ -84,4 +84,5 @@ def self.register_factory(&block)
 require 'rails_admin/config/fields/factories/carrierwave'
 require 'rails_admin/config/fields/factories/refile'
 require 'rails_admin/config/fields/factories/active_storage'
+require 'rails_admin/config/fields/factories/shrine'
 require 'rails_admin/config/fields/factories/association'

lib/rails_admin/config/fields/factories/shrine.rb

@@ -0,0 +1,27 @@
+require 'rails_admin/config/fields'
+require 'rails_admin/config/fields/types'
+require 'rails_admin/config/fields/types/file_upload'
+
+RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
+  next false unless defined?(::Shrine)
+
+  attachment_names = parent.abstract_model.model.ancestors.select { |m| m.is_a?(Shrine::Attachment) }.map { |a| a.instance_variable_get("@name") }
+  next false if attachment_names.blank?
+
+  attachment_name = attachment_names.detect { |a| a == properties.name.to_s.chomp('_data').to_sym }
+  next false unless attachment_name
+
+  field = RailsAdmin::Config::Fields::Types.load(:shrine).new(parent, attachment_name, properties)
+  fields << field
+
+  data_field_name = "#{attachment_name}_data".to_sym
+  child_properties = parent.abstract_model.properties.detect { |p| p.name == data_field_name }
+  next true unless child_properties
+
+  children_field = fields.detect { |f| f.name == data_field_name } || RailsAdmin::Config::Fields.default_factory.call(parent, child_properties, fields)
+  children_field.hide unless field == children_field
+  children_field.filterable(false) unless field == children_field
+
+  field.children_fields([data_field_name])
+  true
+end

lib/rails_admin/config/fields/types/all.rb

@@ -26,6 +26,7 @@
 require 'rails_admin/config/fields/types/hidden'
 require 'rails_admin/config/fields/types/text'
 require 'rails_admin/config/fields/types/serialized'
+require 'rails_admin/config/fields/types/shrine'
 require 'rails_admin/config/fields/types/time'
 require 'rails_admin/config/fields/types/timestamp'
 require 'rails_admin/config/fields/types/color'

lib/rails_admin/config/fields/types/shrine.rb

@@ -0,0 +1,48 @@
+require 'rails_admin/config/fields/types/file_upload'
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class Shrine < RailsAdmin::Config::Fields::Types::FileUpload
+          RailsAdmin::Config::Fields::Types.register(self)
+
+          register_instance_option :thumb_method do
+            unless defined? @thumb_method
+              @thumb_method = begin
+                next nil unless value.is_a?(Hash)
+
+                if value.key?(:thumb)
+                  :thumb
+                elsif value.key?(:thumbnail)
+                  :thumbnail
+                else
+                  value.keys.first
+                end
+              end
+            end
+            @thumb_method
+          end
+
+          register_instance_option :delete_method do
+            "remove_#{name}" if bindings[:object].respond_to?("remove_#{name}")
+          end
+
+          register_instance_option :cache_method do
+            "cached_#{name}_data" if bindings[:object].respond_to?("cached_#{name}_data")
+          end
+
+          def resource_url(thumb = nil)
+            return nil unless value
+
+            if value.is_a?(Hash)
+              value[thumb || value.keys.first].url
+            else
+              value.url
+            end
+          end
+        end
+      end
+    end
+  end
+end

spec/controllers/rails_admin/main_controller_spec.rb

@@ -341,6 +341,9 @@ class TeamWithNumberedPlayers < Team
         field :active_storage_assets do
           delete_method :remove_active_storage_assets
         end if defined?(ActiveStorage)
+        field :shrine_asset do
+          delete_method :remove_shrine_asset
+        end if defined?(Shrine)
       end
       controller.params = HashWithIndifferentAccess.new(
         'field_test' => {
@@ -357,7 +360,8 @@ class TeamWithNumberedPlayers < Team
           'delete_paperclip_asset' => 'test',
           'should_not_be_here' => 'test',
         }.merge(defined?(Refile) ? {'refile_asset' => 'test', 'remove_refile_asset' => 'test'} : {}).
-          merge(defined?(ActiveStorage) ? {'active_storage_asset' => 'test', 'remove_active_storage_asset' => 'test', 'active_storage_assets' => 'test', 'remove_active_storage_assets' => 'test'} : {}),
+          merge(defined?(ActiveStorage) ? {'active_storage_asset' => 'test', 'remove_active_storage_asset' => 'test', 'active_storage_assets' => 'test', 'remove_active_storage_assets' => 'test'} : {}).
+          merge(defined?(Shrine) ? {'shrine_asset' => 'test', 'remove_shrine_asset' => 'test'} : {}),
       )
 
       controller.send(:sanitize_params_for!, :create, RailsAdmin.config(FieldTest), controller.params['field_test'])
@@ -374,7 +378,8 @@ class TeamWithNumberedPlayers < Team
         'paperclip_asset' => 'test',
         'delete_paperclip_asset' => 'test',
       }.merge(defined?(Refile) ? {'refile_asset' => 'test', 'remove_refile_asset' => 'test'} : {}).
-        merge(defined?(ActiveStorage) ? {'active_storage_asset' => 'test', 'remove_active_storage_asset' => 'test', 'active_storage_assets' => 'test', 'remove_active_storage_assets' => 'test'} : {}))
+        merge(defined?(ActiveStorage) ? {'active_storage_asset' => 'test', 'remove_active_storage_asset' => 'test', 'active_storage_assets' => 'test', 'remove_active_storage_assets' => 'test'} : {}).
+        merge(defined?(Shrine) ? {'shrine_asset' => 'test', 'remove_shrine_asset' => 'test'} : {}))
     end
 
     it 'allows for polymorphic associations parameters' do

spec/dummy_app/Gemfile

@@ -27,6 +27,7 @@ group :mongoid do
   gem 'mongoid-paperclip', '>= 0.0.8', require: 'mongoid_paperclip'
   gem 'carrierwave-mongoid', '>= 0.6.3', require: 'carrierwave/mongoid'
   # gem 'refile-mongoid', '>= 0.0.1', platforms: [:ruby_21, :ruby_22]
+  gem 'shrine-mongoid'
 end
 
 gem 'carrierwave', '>= 0.8'
@@ -36,6 +37,8 @@ gem 'mini_magick', '>= 3.4'
 gem 'mlb', '>= 0.7'
 gem 'paperclip', '>= 3.4'
 gem 'rails_admin', path: '../../'
+gem 'shrine', '~> 2.0'
+gem 'shrine-memory'
 
 platforms :mri do
   # gem 'refile', '>= 0.5', require: 'refile/rails'

spec/dummy_app/app/active_record/field_test.rb

@@ -49,6 +49,9 @@ def carrierwave_assets=(files)
     end
   end
 
+  include ShrineUploader.attachment(:shrine_asset)
+  include ShrineVersioningUploader.attachment(:shrine_versioning_asset)
+
   enum string_enum_field: {S: 's', M: 'm', L: 'l'}
   enum integer_enum_field: [:small, :medium, :large]
 end

spec/dummy_app/app/active_record/shrine_uploader.rb

@@ -0,0 +1,8 @@
+class ShrineUploader < Shrine
+  plugin :activerecord
+
+  plugin :cached_attachment_data
+  plugin :determine_mime_type
+  plugin :pretty_location
+  plugin :remove_attachment
+end

spec/dummy_app/app/active_record/shrine_versioning_uploader.rb

@@ -0,0 +1,18 @@
+class ShrineVersioningUploader < Shrine
+  plugin :activerecord
+
+  plugin :cached_attachment_data
+  plugin :delete_raw
+  plugin :determine_mime_type
+  plugin :pretty_location
+  plugin :processing
+  plugin :remove_attachment
+  plugin :versions
+
+  process(:store) do |io|
+    {
+      original: io,
+      thumb: FakeIO.another_version(io, :thumb),
+    }
+  end
+end

spec/dummy_app/app/mongoid/field_test.rb

@@ -33,6 +33,11 @@ class FieldTest
   field :protected_field, type: String
   has_mongoid_attached_file :paperclip_asset, styles: {thumb: '100x100>'}
 
+  field :shrine_asset_data, type: String
+  include ShrineUploader::Attachment.new(:shrine_asset)
+  field :shrine_versioning_asset_data, type: String
+  include ShrineVersioningUploader::Attachment.new(:shrine_versioning_asset)
+
   has_many :nested_field_tests, dependent: :destroy, inverse_of: :field_test, autosave: true
   accepts_nested_attributes_for :nested_field_tests, allow_destroy: true
 

spec/dummy_app/app/mongoid/shrine_uploader.rb

@@ -0,0 +1,8 @@
+class ShrineUploader < Shrine
+  plugin :mongoid
+
+  plugin :cached_attachment_data
+  plugin :determine_mime_type
+  plugin :pretty_location
+  plugin :remove_attachment
+end

spec/dummy_app/app/mongoid/shrine_versioning_uploader.rb

@@ -0,0 +1,18 @@
+class ShrineVersioningUploader < Shrine
+  plugin :mongoid
+
+  plugin :cached_attachment_data
+  plugin :delete_raw
+  plugin :determine_mime_type
+  plugin :pretty_location
+  plugin :processing
+  plugin :remove_attachment
+  plugin :versions
+
+  process(:store) do |io|
+    {
+      original: io,
+      thumb: FakeIO.another_version(io, :thumb),
+    }
+  end
+end

spec/dummy_app/config/initializers/shrine.rb

@@ -0,0 +1,7 @@
+require 'shrine'
+require 'shrine/storage/memory'
+
+Shrine.storages = {
+  cache: Shrine::Storage::Memory.new,
+  store: Shrine::Storage::Memory.new,
+}

spec/dummy_app/db/migrate/20181029101829_add_shrine_data_to_field_tests.rb

@@ -0,0 +1,6 @@
+class AddShrineDataToFieldTests < ActiveRecord::Migration[5.0]
+  def change
+    add_column :field_tests, :shrine_asset_data, :text
+    add_column :field_tests, :shrine_versioning_asset_data, :text
+  end
+end

spec/rails_admin/config/fields/base_spec.rb

@@ -132,6 +132,21 @@ class CommentReversed < Tableless
         end
       end
     end
+
+    if defined?(Shrine)
+      context 'of a Shrine installation' do
+        it 'is the parent field itself' do
+          expect(RailsAdmin.config(FieldTest).fields.detect { |f| f.name == :shrine_asset }.children_fields).to eq([:shrine_asset_data])
+          expect(RailsAdmin.config(FieldTest).fields.detect { |f| f.name == :shrine_asset }.hidden?).to be_falsey
+        end
+
+        it 'is not filterable' do
+          fields = RailsAdmin.config(FieldTest).fields.select { |f| [:shrine_asset_data].include?(f.name) }
+          expect(fields).to all(be_hidden)
+          expect(fields).not_to include(be_filterable)
+        end
+      end
+    end
   end
 
   describe '#form_default_value' do

spec/rails_admin/config/fields/types/file_upload_spec.rb

@@ -16,13 +16,18 @@
           field :active_storage_asset do
             delete_method :remove_active_storage_asset
           end if defined?(ActiveStorage)
+          field :shrine_asset do
+            delete_method :remove_shrine_asset
+            cache_method :cached_shrine_asset_data
+          end if defined?(Shrine)
         end
       end
       expect(RailsAdmin.config(FieldTest).field(:carrierwave_asset).allowed_methods.collect(&:to_s)).to eq %w(carrierwave_asset remove_carrierwave_asset carrierwave_asset_cache)
       expect(RailsAdmin.config(FieldTest).field(:dragonfly_asset).allowed_methods.collect(&:to_s)).to eq %w(dragonfly_asset remove_dragonfly_asset retained_dragonfly_asset)
       expect(RailsAdmin.config(FieldTest).field(:paperclip_asset).allowed_methods.collect(&:to_s)).to eq %w(paperclip_asset delete_paperclip_asset)
       expect(RailsAdmin.config(FieldTest).field(:refile_asset).allowed_methods.collect(&:to_s)).to eq %w(refile_asset remove_refile_asset) if defined?(Refile)
       expect(RailsAdmin.config(FieldTest).field(:active_storage_asset).allowed_methods.collect(&:to_s)).to eq %w(active_storage_asset remove_active_storage_asset) if defined?(ActiveStorage)
+      expect(RailsAdmin.config(FieldTest).field(:shrine_asset).allowed_methods.collect(&:to_s)).to eq %w(shrine_asset remove_shrine_asset cached_shrine_asset_data) if defined?(Shrine)
     end
   end