rails_admin_settings 1.4.0 → 1.6.0

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)
@@ -31,12 +32,22 @@ module RailsAdminSettings
         Settings.file_uploads_supported = true
         Settings.file_uploads_engine = :paperclip
       elsif RailsAdminSettings.active_record? && defined?(Paperclip)
-        base.has_mongoid_attached_file(:file, self.paperclip_options)
+        base.has_attached_file(:file, self.paperclip_options)
         if base.respond_to?(:do_not_validate_attachment_file_type)
           base.do_not_validate_attachment_file_type :file
         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

@@ -1,91 +1,123 @@
 module RailsAdminSettings
   module Validation
-    def self.included(base)
-      base.before_validation do
-        self.raw = default_serializable_value if raw.blank?
+    class << self
+      def included(base)
+        base.before_validation do
+          self.raw = default_serializable_value if raw.blank?
+        end
+        base.before_validation :preprocess_value, if: :preprocessed_kind?
+        base.validates_uniqueness_of :key, scope: :ns
+        base.validates_inclusion_of :kind, in: RailsAdminSettings.kinds
+        base.validates_numericality_of :raw, if: :integer_kind?
+        base.validates_numericality_of :raw, if: :float_kind?
+
+        add_validators(base)
       end
-      base.before_validation :preprocess_value, if: :preprocessed_kind?
-      base.validates_uniqueness_of :key, scope: :ns
-      base.validates_inclusion_of :kind, in: RailsAdminSettings.kinds
-      base.validates_numericality_of :raw, if: :integer_kind?
 
-      base.validate if: :phone_kind? do
-        require_russian_phone do
-          errors.add(:raw, I18n.t('admin.settings.phone_invalid')) unless raw.blank? || RussianPhone::Number.new(raw).valid?
-        end
+      def add_validators(base)
+        add_color_validator(base)
+        add_file_validator(base)
+        add_email_validator(base)
+        add_url_validator(base)
+        add_phone_validator(base)
+        add_geo_validator(base)
+        add_yaml_validator(base)
+        add_json_validator(base)
       end
 
-      base.validate if: :phones_kind? do
-        require_russian_phone do
-          unless raw.blank?
-            invalid_phones = raw.gsub("\r", '').split("\n").inject([]) do |memo, value|
-              memo << value unless RussianPhone::Number.new(value).valid?
-              memo
-            end
-            errors.add(:raw, I18n.t('admin.settings.phones_invalid', phones: invalid_phones * ', ')) unless invalid_phones.empty?
+      def add_color_validator(base)
+        base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw, if: :color_kind?)
+      end
+
+      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 or Shrine. Check that rails_admin_settings is below them in Gemfile'
           end
         end
       end
 
-      base.validate if: :email_kind? do
-        require_validates_email_format_of do
-          errors.add(:raw, I18n.t('admin.settings.email_invalid')) unless raw.blank? || ValidatesEmailFormatOf.validate_email_format(raw).nil?
+      def add_email_validator(base)
+        base.validate if: :email_kind? do
+          require_validates_email_format_of do
+            errors.add(:raw, I18n.t('admin.settings.email_invalid')) unless raw.blank? || ValidatesEmailFormatOf.validate_email_format(raw).nil?
+          end
         end
       end
 
-      base.validate if: :address_kind? do
-        require_geocoder do
-          # just raise error if we are trying to use address kind without geocoder
+      def add_url_validator(base)
+        base.before_validation if: :url_kind? do
+          require_addressable do
+            self.raw = Addressable::URI.heuristic_parse(self.raw) unless self.raw.blank?
+          end
         end
-      end
 
-      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'
+        base.before_validation if: :domain_kind? do
+          require_addressable do
+            self.raw = Addressable::URI.heuristic_parse(self.raw).host unless self.raw.blank?
+          end
         end
       end
 
-      base.before_validation if: :url_kind? do
-        require_addressable do
-          self.raw = Addressable::URI.heuristic_parse(self.raw) unless self.raw.blank?
+      def add_phone_validator(base)
+        base.validate if: :phone_kind? do
+          require_russian_phone do
+            errors.add(:raw, I18n.t('admin.settings.phone_invalid')) unless raw.blank? || RussianPhone::Number.new(raw).valid?
+          end
         end
-      end
 
-      base.before_validation if: :domain_kind? do
-        require_addressable do
-          self.raw = Addressable::URI.heuristic_parse(self.raw).host unless self.raw.blank?
+        base.validate if: :phones_kind? do
+          require_russian_phone do
+            unless raw.blank?
+              invalid_phones = raw.gsub("\r", '').split("\n").inject([]) do |memo, value|
+                memo << value unless RussianPhone::Number.new(value).valid?
+                memo
+              end
+              errors.add(:raw, I18n.t('admin.settings.phones_invalid', phones: invalid_phones * ', ')) unless invalid_phones.empty?
+            end
+          end
         end
+
       end
 
-      if Object.const_defined?('Geocoder')
-        if RailsAdminSettings.mongoid?
-          base.field(:coordinates, type: Array)
-          base.send(:include, Geocoder::Model::Mongoid)
+      def add_geo_validator(base)
+        base.validate if: :address_kind? do
+          require_geocoder do
+            # just raise error if we are trying to use address kind without geocoder
+          end
+        end
+        if Object.const_defined?('Geocoder')
+          if RailsAdminSettings.mongoid?
+            base.field(:coordinates, type: Array)
+            base.send(:include, Geocoder::Model::Mongoid)
+          end
+          base.geocoded_by(:raw)
+          base.after_validation(:geocode, if: :address_kind?)
         end
-        base.geocoded_by(:raw)
-        base.after_validation(:geocode, if: :address_kind?)
       end
 
-      base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw, if: :color_kind?)
-
-      base.validate if: :yaml_kind? do
-        require_safe_yaml do
-          unless raw.blank?
-            begin
-              YAML.safe_load(raw)
-            rescue Psych::SyntaxError => e
-              errors.add(:raw, I18n.t('admin.settings.yaml_invalid'))
+      def add_yaml_validator(base)
+        base.validate if: :yaml_kind? do
+          require_safe_yaml do
+            unless raw.blank?
+              begin
+                YAML.safe_load(raw)
+              rescue Psych::SyntaxError => e
+                errors.add(:raw, I18n.t('admin.settings.yaml_invalid'))
+              end
             end
           end
         end
       end
 
-      base.validate if: :json_kind? do
-        unless raw.blank?
-          begin
-            JSON.load(raw)
-          rescue JSON::ParserError => e
-            errors.add(:raw, I18n.t('admin.settings.json_invalid'))
+      def add_json_validator(base)
+        base.validate if: :json_kind? do
+          unless raw.blank?
+            begin
+              JSON.load(raw)
+            rescue JSON::ParserError => e
+              errors.add(:raw, I18n.t('admin.settings.json_invalid'))
+            end
           end
         end
       end

data/lib/rails_admin_settings/version.rb

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

data/rails_admin_settings.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["glebtv@gmail.com"]
   spec.description   = %q{Mongoid / ActiveRecord + RailsAdmin App Settings management}
   spec.summary       = %q{}
-  spec.homepage      = "https://github.com/rs-pro/rails_admin_settings"
+  spec.homepage      = "https://gitlab.com/rocket-science/rails_admin_settings"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -36,5 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "addressable"
   spec.add_development_dependency "carrierwave-mongoid"
   spec.add_development_dependency "mongoid-paperclip"
-  spec.add_development_dependency "pry"
+  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/factories/setting.rb

@@ -3,6 +3,6 @@
 FactoryBot.define do
   factory :setting, class: RailsAdminSettings::Setting do
     sequence(:key){|n| "setting_#{n}" }
-    raw "Контент 1"
+    raw { "Контент 1" }
   end
 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

@@ -5,7 +5,6 @@ require 'rubygems'
 require 'simplecov'
 SimpleCov.start
 
-require 'pry'
 require 'bundler/setup'
 require 'active_support'
 require 'active_support/core_ext'
@@ -18,7 +17,6 @@ require 'database_cleaner'
 require 'factory_bot'
 require 'mongoid-rspec'
 
-p ENV["UPLOADS"]
 if ENV['UPLOADS'] == 'paperclip'
   require "mongoid-paperclip"
 end
@@ -30,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")

data/spec/types_spec.rb

@@ -23,6 +23,13 @@ describe 'Settings kind' do
     expect(Settings.testint2).to eq 5
   end
 
+  it 'float' do
+    expect(Settings.get(:testfloat, kind: 'float').value).to eq 0
+    expect(Settings.get(:testfloat, default: 5.2, kind: 'float').value).to eq 0
+    expect(Settings.get(:testfloat2, default: 5.5, kind: 'float').value).to eq 5.5
+    expect(Settings.testfloat2).to eq 5.5
+  end
+
   it 'does yaml' do
     Settings.set(:data, '[one, two, three]', kind: 'yaml')
     expect(Settings.get(:data).raw).to eq '[one, two, three]'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_settings
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Gleb Tv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -249,7 +249,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -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,9 +326,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rakeTasks"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -290,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
@@ -302,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
@@ -320,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
@@ -328,7 +386,7 @@ files:
 - spec/support/mongoid.rb
 - spec/support/mongoid.yml
 - spec/types_spec.rb
-homepage: https://github.com/rs-pro/rails_admin_settings
+homepage: https://gitlab.com/rocket-science/rails_admin_settings
 licenses:
 - MIT
 metadata: {}
@@ -347,8 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ''
@@ -365,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