rails_admin_settings 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 252fba15948c22109d39fac9bcf01afc70ee01b200533d89c23ae53d562b8eb6
-  data.tar.gz: 38d7ed5cf17306baa0f6d2440405bcfbdc5f975639077067ef1d2935ed1d368b
+  metadata.gz: d138604a0c03f484ed60c6a4a3bf3df0c7936c4e28ff18b4914dee9b05276e5a
+  data.tar.gz: 3f37b53322fdd2dc6ae98500b84edb4d91b2ed8638d141226740b80e5a9b09f8
 SHA512:
-  metadata.gz: 1cce2abe1a0a361d1a5758b3108dcd2c8945cf27de29172e6314035763d97414bd5e7fc44ad8fabfbaac1e80b583f0f000cc9389e12d32106f61276315bc2c92
-  data.tar.gz: 03f3c25dc49ec84fd6371cb68c7063ce83b6df9b2f6dcc0f81ff8b7f9b8a4adbe74cbdde16fc1e6c960aecfa8eaab05fc3003da1546e57826c8aaee3574b3242
+  metadata.gz: 6d78b5b79ea3487bb14dd67c4ac2a9d6bc97c4027d42fe8ee548d1fefa1b858c7dafcd6df67f03bde8899641e2619ce62a86b95327bb7d688f75c527bb919dd9
+  data.tar.gz: 3aa78be3967ac7178f2389390c82ebb4f845ca1e5dd5e482e40d4c785643a4256e416722fdff2e11dab863b1515f6806e56d711cd149b0be5660aa61cf8c80a9

data/.gitignore

@@ -16,3 +16,4 @@ test/version_tmp
 tmp
 .idea
 /uploads
+/public/uploads

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.travis.yml

@@ -14,8 +14,10 @@ env:
   matrix:
     - "UPLOADS=paperclip"
     - "UPLOADS=carrierwave"
+    - "UPLOADS=shrine"
     - "RAILS=1 UPLOADS=paperclip"
     - "RAILS=1 UPLOADS=carrierwave"
+    - "RAILS=1 UPLOADS=shrine"
 
 gemfile:
   - gemfiles/mongoid-6.0.gemfile

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.6.0 (2020-06-11)
+
+Add shrine file uploads
+
 ## 1.5.0 (2018-06-09)
 
 Add float type

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_admin_settings (1.5.1)
+    rails_admin_settings (1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -63,18 +63,25 @@ GEM
       mongoid-grid_fs (>= 1.3, < 3.0)
     climate_control (0.2.0)
     concurrent-ruby (1.1.5)
+    content_disposition (1.0.0)
     crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     docile (1.3.2)
+    down (5.1.1)
+      addressable (~> 2.5)
     erubi (1.8.0)
     factory_bot (5.0.2)
       activesupport (>= 4.2.0)
+    ffi (1.13.0)
     geocoder (1.5.1)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    image_processing (1.11.0)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
     jaro_winkler (1.5.3)
     json (2.2.0)
     loofah (2.2.3)
@@ -89,6 +96,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0331)
     mimemagic (0.3.3)
+    mini_magick (4.10.1)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
@@ -178,12 +186,20 @@ GEM
     rubocop-rspec (1.30.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
+    ruby-vips (2.0.17)
+      ffi (~> 1.9)
     russian_phone (0.6.1)
     safe_yaml (1.0.5)
     sanitize (5.0.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.8.0)
       nokogumbo (~> 2.0)
+    shrine (3.2.1)
+      content_disposition (~> 1.0)
+      down (~> 5.1)
+    shrine-mongoid (1.0.0)
+      mongoid (>= 5.0)
+      shrine (>= 3.0.0.beta3, < 4)
     simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -219,6 +235,8 @@ DEPENDENCIES
   database_cleaner
   factory_bot
   geocoder
+  image_processing
+  mini_magick
   mongoid (~> 6.3)
   mongoid-paperclip
   mongoid-rspec
@@ -230,8 +248,10 @@ DEPENDENCIES
   russian_phone
   safe_yaml
   sanitize
+  shrine (~> 3.0)
+  shrine-mongoid (~> 1.0)
   simplecov
   validates_email_format_of
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/lib/generators/rails_admin_settings/templates/migration.rb

@@ -15,6 +15,9 @@ class CreateRailsAdminSettings < ActiveRecord::Migration[5.0]
         t.attachment :file
       elsif defined?(CarrierWave)
         t.string :file
+      elsif defined?(Shrine)
+        t.text :file_data
+
       end
       t.timestamps
     end

data/lib/rails_admin_settings/determine_mime_type.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+class Shrine
+  module Plugins
+    # Documentation can be found on https://shrinerb.com/docs/plugins/determine_mime_type
+    module DetermineMimeType
+      LOG_SUBSCRIBER = -> (event) do
+        Shrine.logger.info "MIME Type (#{event.duration}ms) – #{{
+            io:       event[:io].class,
+            uploader: event[:uploader],
+        }.inspect}"
+      end
+
+      def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
+        uploader.opts[:determine_mime_type] ||= { analyzer: :file, analyzer_options: {} }
+        uploader.opts[:determine_mime_type].merge!(opts)
+
+        # instrumentation plugin integration
+        uploader.subscribe(:mime_type, &log_subscriber) if uploader.respond_to?(:subscribe)
+      end
+
+      module ClassMethods
+        # Determines the MIME type of the IO object by calling the specified
+        # analyzer.
+        def determine_mime_type(io)
+          analyzer = opts[:determine_mime_type][:analyzer]
+
+          analyzer = mime_type_analyzer(analyzer) if analyzer.is_a?(Symbol)
+          args     = if analyzer.is_a?(Proc)
+                       [io, mime_type_analyzers].take(analyzer.arity.abs)
+                     else
+                       [io, opts[:determine_mime_type][:analyzer_options]]
+                     end
+
+          mime_type = instrument_mime_type(io) { analyzer.call(*args) }
+          io.rewind
+
+          mime_type
+        end
+        alias mime_type determine_mime_type
+
+        # Returns a hash of built-in MIME type analyzers, where keys are
+        # analyzer names and values are `#call`-able objects which accepts the
+        # IO object.
+        def mime_type_analyzers
+          @mime_type_analyzers ||= MimeTypeAnalyzer::SUPPORTED_TOOLS.inject({}) do |hash, tool|
+            hash.merge!(tool => mime_type_analyzer(tool))
+          end
+        end
+
+        # Returns callable mime type analyzer object.
+        def mime_type_analyzer(name)
+          MimeTypeAnalyzer.new(name)
+        end
+
+        private
+
+        # Sends a `mime_type.shrine` event for instrumentation plugin.
+        def instrument_mime_type(io, &block)
+          return yield unless respond_to?(:instrument)
+
+          instrument(:mime_type, io: io, &block)
+        end
+      end
+
+      module InstanceMethods
+        private
+
+        # Calls the configured MIME type analyzer.
+        def extract_mime_type(io)
+          self.class.determine_mime_type(io)
+        end
+      end
+
+      class MimeTypeAnalyzer
+        SUPPORTED_TOOLS = [:fastimage, :file, :filemagic, :mimemagic, :marcel, :mime_types, :mini_mime, :content_type]
+        MAGIC_NUMBER    = 256 * 1024
+
+        def initialize(tool)
+          raise Error, "unknown mime type analyzer #{tool.inspect}, supported analyzers are: #{SUPPORTED_TOOLS.join(",")}" unless SUPPORTED_TOOLS.include?(tool)
+
+          @tool = tool
+        end
+
+        def call(io, options = {})
+          mime_type = send(:"extract_with_#{@tool}", io, options)
+          io.rewind
+
+          mime_type
+        end
+
+        private
+
+        def extract_with_file(io, options)
+          require "open3"
+
+          return nil if io.eof? # file command returns "application/x-empty" for empty files
+
+          Open3.popen3(*%W[file --mime-type --brief -]) do |stdin, stdout, stderr, thread|
+            begin
+              IO.copy_stream(io, stdin.binmode)
+            rescue Errno::EPIPE
+            end
+            stdin.close
+
+            status = thread.value
+
+            raise Error, "file command failed to spawn: #{stderr.read}" if status.nil?
+            raise Error, "file command failed: #{stderr.read}" unless status.success?
+
+            $stderr.print(stderr.read)
+
+            output = stdout.read.strip
+
+            raise Error, "file command failed: #{output}" if output.include?("cannot open")
+
+            output
+          end
+        rescue Errno::ENOENT
+          raise Error, "file command-line tool is not installed"
+        end
+
+        def extract_with_fastimage(io, options)
+          require "fastimage"
+
+          type = FastImage.type(io)
+          "image/#{type}" if type
+        end
+
+        def extract_with_filemagic(io, options)
+          require "filemagic"
+
+          return nil if io.eof? # FileMagic returns "application/x-empty" for empty files
+
+          FileMagic.open(FileMagic::MAGIC_MIME_TYPE) do |filemagic|
+            filemagic.buffer(io.read(MAGIC_NUMBER))
+          end
+        end
+
+        def extract_with_mimemagic(io, options)
+          require "mimemagic"
+
+          mime = MimeMagic.by_magic(io)
+          mime&.type
+        end
+
+        def extract_with_marcel(io, options)
+          require "marcel"
+
+          return nil if io.eof? # marcel returns "application/octet-stream" for empty files
+
+          filename = (options[:filename_fallback] ? extract_filename(io) : nil)
+          Marcel::MimeType.for(io, name: filename)
+        end
+
+        def extract_with_mime_types(io, options)
+          require "mime/types"
+
+          if filename = extract_filename(io)
+            mime_type = MIME::Types.of(filename).first
+            mime_type&.content_type
+          end
+        end
+
+        def extract_with_mini_mime(io, options)
+          require "mini_mime"
+
+          if filename = extract_filename(io)
+            info = MiniMime.lookup_by_filename(filename)
+            info&.content_type
+          end
+        end
+
+        def extract_with_content_type(io, options)
+          if io.respond_to?(:content_type) && io.content_type
+            io.content_type.split(";").first
+          end
+        end
+
+        def extract_filename(io)
+          if io.respond_to?(:original_filename)
+            io.original_filename
+          elsif io.respond_to?(:path)
+            File.basename(io.path)
+          end
+        end
+      end
+
+    end
+
+    register_plugin(:determine_mime_type, DetermineMimeType)
+  end
+end

data/lib/rails_admin_settings/processing.rb

@@ -31,10 +31,14 @@ module RailsAdminSettings
 
     def value
       if upload_kind?
-        if file?
-          file.url
+        unless defined?(Shrine)
+          if file?
+            file.url
+          else
+            nil
+          end
         else
-          nil
+          file.url if file.present?
         end
       elsif raw.blank? || disabled?
         default_value

data/lib/rails_admin_settings/rails_admin_config.rb

@@ -4,7 +4,6 @@ module RailsAdminSettings
       if base.respond_to?(:rails_admin)
         base.rails_admin do
           navigation_label I18n.t('admin.settings.label')
-
           list do
             if Object.const_defined?('RailsAdminToggleable')
               field :enabled, :toggle
@@ -16,9 +15,9 @@ module RailsAdminSettings
             field :name
             field :raw do
               pretty_value do
-                if bindings[:object].file_kind?
+                if bindings[:object].file_kind? and !defined?(Shrine) and bindings[:object].to_path.present?
                   "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'>#{CGI::escapeHTML(bindings[:object].to_path)}</a>".html_safe
-                elsif bindings[:object].image_kind?
+                elsif bindings[:object].image_kind? and !defined?(Shrine) and !bindings[:object].file.nil?
                   "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'><img src='#{CGI::escapeHTML(bindings[:object].file.url)}' /></a>".html_safe
                 else
                   value

data/lib/rails_admin_settings/storage/shrine_uploader.rb

@@ -0,0 +1,14 @@
+module RailsAdminSettings
+  module Uploads
+    class ShrineUploader < Shrine
+        plugin :determine_mime_type
+        plugin :validation_helpers
+        plugin :mongoid if RailsAdminSettings.mongoid?
+        Attacher.validate do
+          validate_mime_type_inclusion %w[image/jpeg image/gif image/png]
+          validate_max_size 2.megabytes
+        end
+      end
+
+    end
+  end

data/lib/rails_admin_settings/uploads.rb

@@ -1,6 +1,7 @@
 module RailsAdminSettings
   module Uploads
     autoload :CarrierWaveUploader, "rails_admin_settings/storage/carrier_wave_uploader"
+    autoload :ShrineUploader, "rails_admin_settings/storage/shrine_uploader"
 
     def self.paperclip_options
       if defined?(Rails)
@@ -37,6 +38,16 @@ module RailsAdminSettings
         end
         Settings.file_uploads_supported = true
         Settings.file_uploads_engine = :paperclip
+      elsif RailsAdminSettings.active_record? && defined?(Shrine)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :shrine
+        base.send(:include, ShrineUploader::Attachment(:file))
+      elsif RailsAdminSettings.mongoid? && ::Mongoid.const_defined?('Shrine')
+        base.send(:include, ::Mongoid::Document)
+        base.send(:include, ShrineUploader::Attachment(:file))
+        base.field(:file_data, type: String)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :shrine
       else
         # puts "[rails_admin_settings] Uploads disabled"
       end

data/lib/rails_admin_settings/validation.rb

@@ -32,7 +32,7 @@ module RailsAdminSettings
       def add_file_validator(base)
         base.validate if: :file_kind? do
           unless Settings.file_uploads_supported
-            raise '[rails_admin_settings] File kind requires either CarrierWave or Paperclip. Check that rails_admin_settings is below them in Gemfile'
+            raise '[rails_admin_settings] File kind requires either CarrierWave or Paperclip or Shrine. Check that rails_admin_settings is below them in Gemfile'
           end
         end
       end

data/lib/rails_admin_settings/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminSettings
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/rails_admin_settings.gemspec

@@ -37,4 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "carrierwave-mongoid"
   spec.add_development_dependency "mongoid-paperclip"
   spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency 'image_processing'
+  spec.add_development_dependency "mini_magick"
+  spec.add_development_dependency "shrine", "~> 3.0"
+  spec.add_development_dependency "shrine-mongoid", "~> 1.0"
 end

data/spec/shrine_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+
+describe "Uploads" do
+  if Settings.file_uploads_engine != :shrine
+    pending "shrine not detected, skipped. To run use UPLOADS=shrine rspec"
+  else
+    before :each do
+      f = "#{File.dirname(__FILE__)}/../uploads/1024x768.gif"
+      if File.file?(f)
+        File.unlink(f)
+      end
+    end
+    it 'supports file kind' do
+      Settings.set('file', File.open("#{File.dirname(__FILE__)}/support/1024x768.gif"), kind: 'file')
+      expect(Settings.get(:file).file.metadata["filename"]).to eq '1024x768.gif'
+      expect(Settings.get(:file).file.metadata["size"]).to eq 4357
+      expect(Settings.get(:file).file.metadata["mime_type"]).to eq "image/gif"
+      expect(Settings.get(:file).file.id.split(".").last).to eq "gif"
+      expect(Settings.file.split("/").second + "/" + Settings.file.split("/").last.split(".").last).to eq "uploads/gif"
+      expect(File.exists?("public/uploads/#{Settings.get(:file).file.id}")).to be_truthy
+    end
+    it 'supports image kind' do
+      Settings.set('file', File.open("#{File.dirname(__FILE__)}/support/1024x768.gif"), kind: 'image')
+      expect(Settings.get(:file).file.metadata["filename"]).to eq '1024x768.gif'
+      expect(Settings.get(:file).file.metadata["size"]).to eq 4357
+      expect(Settings.get(:file).file.metadata["mime_type"]).to eq "image/gif"
+      expect(Settings.get(:file).file.id.split(".").last).to eq "gif"
+      expect(Settings.file.split("/").second + "/" + Settings.file.split("/").last.split(".").last).to eq "uploads/gif"
+      expect(File.exists?("public/uploads/#{Settings.get(:file).file.id}")).to be_truthy
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -28,6 +28,22 @@ if ENV['UPLOADS'] == 'carrierwave'
     end
   end
 end
+if ENV['UPLOADS'] == 'shrine'
+  require "shrine"
+  require "shrine/storage/file_system"
+  Shrine.storages = {
+      cache: Shrine::Storage::FileSystem.new("public", prefix: "uploads/cache"), # temporary
+      store: Shrine::Storage::FileSystem.new("public", prefix: "uploads"),       # permanent
+  }
+
+  if ENV['ACTIVERECORD']
+    Shrine.plugin :activerecord
+  end
+  Shrine.plugin :cached_attachment_data # for retaining the cached file across form redisplays
+  Shrine.plugin :restore_cached_data # re-extract metadata when attaching a cached file
+end
+
+
 
 I18n.enforce_available_locales = true
 I18n.load_path << File.join(File.dirname(__FILE__), "..", "config", "locales", "en.yml")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_settings
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Gleb Tv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -262,6 +262,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shrine-mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Mongoid / ActiveRecord + RailsAdmin App Settings management
 email:
 - glebtv@gmail.com
@@ -270,6 +326,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rakeTasks"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
@@ -288,6 +345,7 @@ files:
 - lib/generators/rails_admin_settings/migration_generator.rb
 - lib/generators/rails_admin_settings/templates/migration.rb
 - lib/rails_admin_settings.rb
+- lib/rails_admin_settings/determine_mime_type.rb
 - lib/rails_admin_settings/dumper.rb
 - lib/rails_admin_settings/engine.rb
 - lib/rails_admin_settings/fallback.rb
@@ -300,6 +358,7 @@ files:
 - lib/rails_admin_settings/require_helpers.rb
 - lib/rails_admin_settings/settings.rb
 - lib/rails_admin_settings/storage/carrier_wave_uploader.rb
+- lib/rails_admin_settings/storage/shrine_uploader.rb
 - lib/rails_admin_settings/tasks.rb
 - lib/rails_admin_settings/uploads.rb
 - lib/rails_admin_settings/validation.rb
@@ -318,6 +377,7 @@ files:
 - spec/namespaced_spec.rb
 - spec/paperclip_spec.rb
 - spec/settings_spec.rb
+- spec/shrine_spec.rb
 - spec/spec_helper.rb
 - spec/support/1024x768.gif
 - spec/support/database_cleaner.rb
@@ -345,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ''
@@ -362,6 +422,7 @@ test_files:
 - spec/namespaced_spec.rb
 - spec/paperclip_spec.rb
 - spec/settings_spec.rb
+- spec/shrine_spec.rb
 - spec/spec_helper.rb
 - spec/support/1024x768.gif
 - spec/support/database_cleaner.rb