rails_admin_settings 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c3a2cc5a5dd0c4e77f1e05ef1447698edde1ba25344fc2e5baea2dc7c686427
-  data.tar.gz: 753783ad33100ef2d26891da3ecb909768f2b4c9e86242d1fedd44b388ee02ec
+  metadata.gz: 29fd0a6b9da6e78369f829515f98217818eee87ca05f4dfc6223265f8f1f177d
+  data.tar.gz: bd6b04c0cdc0ba33004138e24d7ab082e020cffaa61b2efa4f28c1168ee8cd6b
 SHA512:
-  metadata.gz: b8b2f3ac4d7218bd0840aba1965f499f5b56d4a0bb0f30a1e36cdb3ac411ab19e620cfc7c769989d66eab63fd7efd06c1a7356e21e1a3bd96e5f441ebd492ad0
-  data.tar.gz: 306df770d677bee42028699ded628aed3339aad936837383aefa2257cfe79badbdcbcfde7c618f745dd692b2d4a1d78c2254c2622f5dcca2f3596194f98a2f78
+  metadata.gz: a46ecf577c6f31320bf286d48a280717ae2a199e71fbd379edd11b18eda0a364b806e247485d26660e54836254c46f4b22a44f59722d46c5fac8cdc26129f6dc
+  data.tar.gz: 1fc1c269cbfea981a88305204ed5b12ec9d00bd631b9687e1b42c516cddc5c5de63e91e9149bfe5c909b5965689cad12c05e5873a1206f6c7d41f17e7785bb18

data/.travis.yml

@@ -9,12 +9,21 @@ rvm:
   - 2.5.0
 
 env:
-  - "UPLOADS=paperclip"
-  - "UPLOADS=carrierwave"
-  - "RAILS=1 UPLOADS=paperclip"
-  - "RAILS=1 UPLOADS=carrierwave"
+  global:
+    - CC_TEST_REPORTER_ID=f23ba257d0a12c588551991b4377e3eb218c1ff80050bc48c6b18c49ca16cb62
+  matrix:
+    - "UPLOADS=paperclip"
+    - "UPLOADS=carrierwave"
+    - "RAILS=1 UPLOADS=paperclip"
+    - "RAILS=1 UPLOADS=carrierwave"
 
 gemfile:
   - gemfiles/mongoid-6.0.gemfile
   - gemfiles/mongoid-6.3.gemfile
 
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --debug --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.4.1 (2018-03-07)
+
+Fix activerecord + paperclip uploads
+Minor code cleanup
+
 ## 1.4.0
 
 Add new kinds

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_admin_settings (1.4.0)
+    rails_admin_settings (1.4.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,10 @@
 
 [![Build Status](https://secure.travis-ci.org/rs-pro/rails_admin_settings.png?branch=master)](http://travis-ci.org/rs-pro/rails_admin_settings)
 [![Dependency Status](https://gemnasium.com/rs-pro/rails_admin_settings.svg)](https://gemnasium.com/rs-pro/rails_admin_settings)
+[![Gem Version](https://badge.fury.io/rb/rails_admin_settings.svg)](https://badge.fury.io/rb/rails_admin_settings)
+[![security](https://hakiri.io/github/rs-pro/rails_admin_settings/master.svg)](https://hakiri.io/github/rs-pro/rails_admin_settings/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/de00cbec10559ebd2b4b/maintainability)](https://codeclimate.com/github/rs-pro/rails_admin_settings/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/de00cbec10559ebd2b4b/test_coverage)](https://codeclimate.com/github/rs-pro/rails_admin_settings/test_coverage)
 
 App settings editable via RailsAdmin with support for ActiveRecord and Mongoid.
 
@@ -134,6 +138,13 @@ Simple format types are stored in db as-is.
 
 Rails admin management for settings is supported out of the box
 
+It is recommended to disable new/create page (it is not supported by design, settings are defined in ruby code).
+Disable via cancan:
+
+```
+cannot :create, RailsAdminSettings::Setting
+```
+
 ## Contributing
 
 1. Fork it

data/lib/rails_admin_settings.rb

@@ -6,6 +6,20 @@ module RailsAdminSettings
   end
   cattr_accessor :scrubber
 
+  class PersistenceException < Exception
+  end
+
+  autoload :Mongoid,           "rails_admin_settings/mongoid"
+  autoload :Fallback,          "rails_admin_settings/fallback"
+  autoload :Namespaced,        "rails_admin_settings/namespaced"
+  autoload :Processing,        "rails_admin_settings/processing"
+  autoload :Validation,        "rails_admin_settings/validation"
+  autoload :RequireHelpers,    "rails_admin_settings/require_helpers"
+  autoload :RailsAdminConfig,  "rails_admin_settings/rails_admin_config"
+  autoload :Uploads,           "rails_admin_settings/uploads"
+  autoload :HexColorValidator, "rails_admin_settings/hex_color_validator"
+  autoload :Dumper,            "rails_admin_settings/dumper"
+
   class << self
     def orm
       if defined?(::Mongoid)
@@ -22,55 +36,74 @@ module RailsAdminSettings
     def active_record?
       orm == :active_record
     end
-  end
-
-  class PersistenceException < Exception
-  end
-
-  autoload :Mongoid,           "rails_admin_settings/mongoid"
-  autoload :Fallback,          "rails_admin_settings/fallback"
-  autoload :Namespaced,        "rails_admin_settings/namespaced"
-  autoload :Processing,        "rails_admin_settings/processing"
-  autoload :Validation,        "rails_admin_settings/validation"
-  autoload :RequireHelpers,    "rails_admin_settings/require_helpers"
-  autoload :RailsAdminConfig,  "rails_admin_settings/rails_admin_config"
-  autoload :Uploads,           "rails_admin_settings/uploads"
-  autoload :HexColorValidator, "rails_admin_settings/hex_color_validator"
-  autoload :Dumper,            "rails_admin_settings/dumper"
 
-  def self.migrate!
-    if RailsAdminSettings.mongoid?
-      RailsAdminSettings::Setting.where(:ns.exists => false).update_all(ns: 'main')
-      RailsAdminSettings::Setting.all.each do |s|
-        s.kind = s.read_attribute(:type) if !s.read_attribute(:type).blank? && s.kind != s.read_attribute(:type)
-        s.save! if s.changed?
-        s.unset(:type)
-      end
-    else
-      if Settings.table_exists?
-        RailsAdminSettings::Setting.where("ns IS NULL").update_all(ns: 'main')
+    def apply_defaults!(file, verbose = false)
+      if File.file?(file)
+        puts "[settings] Loading from #{file}" if verbose
+        if defined?(Psych) && Psych.respond_to?(:safe_load)
+          yaml = Psych.safe_load(File.read(file))
+        else
+          yaml = YAML.load(File.read(file), safe: true)
+        end
+        yaml.each_pair do |namespace, vals|
+          process_defaults(namespace, vals, verbose)
+        end
       end
     end
-  end
-
-  def self.track_history!
-    return false unless Settings.table_exists?
 
-    if mongoid?
-      if ::Mongoid.const_defined?('History')
-        RailsAdminSettings::Setting.send(:include, ::Mongoid::History::Trackable)
-        RailsAdminSettings::Setting.send(:track_history, {track_create: true, track_destroy: true})
-      else
-        puts "[rails_admin_settings] WARN unable to track_history: Mongoid::History not loaded!"
+    def process_defaults(namespace, vals, verbose = false)
+      vals.symbolize_keys!
+      n = Settings.ns(namespace)
+      vals.each_pair do |key, val|
+        val.symbolize_keys!
+        if !val[:kind].nil? && (val[:kind] == 'file' || val[:kind] == 'image')
+          unless Settings.file_uploads_supported
+            raise PersistenceException, "Fatal: setting #{key} is #{val[:type]} but file upload engine is not detected"
+          end
+          value = File.open(Settings.root_file_path.join(val.delete(:value)))
+        else
+          value = val.delete(:value)
+        end
+        puts "#{key} - default '#{value}' current '#{Settings.get(key).raw}'" if verbose
+        n.set(key, value, val.merge(overwrite: false))
       end
-      if ::Mongoid.const_defined?('Userstamp')
-        RailsAdminSettings::Setting.send(:include, ::Mongoid::Userstamp)
+      n.unload!
+    end
+
+    def migrate!
+      if RailsAdminSettings.mongoid?
+        RailsAdminSettings::Setting.where(:ns.exists => false).update_all(ns: 'main')
+        RailsAdminSettings::Setting.all.each do |s|
+          s.kind = s.read_attribute(:type) if !s.read_attribute(:type).blank? && s.kind != s.read_attribute(:type)
+          s.save! if s.changed?
+          s.unset(:type)
+        end
       else
-        puts "[rails_admin_settings] WARN unable to track_history: Mongoid::Userstamp not loaded!"
+        if Settings.table_exists?
+          RailsAdminSettings::Setting.where("ns IS NULL").update_all(ns: 'main')
+        end
       end
-    elsif active_record?
-      if defined?(PaperTrail) && PaperTrail::Version.table_exists?
-        RailsAdminSettings::Setting.send(:has_paper_trail)
+    end
+
+    def track_history!
+      return false unless Settings.table_exists?
+
+      if mongoid?
+        if ::Mongoid.const_defined?('History')
+          RailsAdminSettings::Setting.send(:include, ::Mongoid::History::Trackable)
+          RailsAdminSettings::Setting.send(:track_history, {track_create: true, track_destroy: true})
+        else
+          puts "[rails_admin_settings] WARN unable to track_history: Mongoid::History not loaded!"
+        end
+        if ::Mongoid.const_defined?('Userstamp')
+          RailsAdminSettings::Setting.send(:include, ::Mongoid::Userstamp)
+        else
+          puts "[rails_admin_settings] WARN unable to track_history: Mongoid::Userstamp not loaded!"
+        end
+      elsif active_record?
+        if defined?(PaperTrail) && PaperTrail::Version.table_exists?
+          RailsAdminSettings::Setting.send(:has_paper_trail)
+        end
       end
     end
   end

data/lib/rails_admin_settings/settings.rb

@@ -64,32 +64,7 @@ class Settings < BasicObject
     end
 
     def apply_defaults!(file, verbose = false)
-      if File.file?(file)
-        puts "[settings] Loading from #{file}" if verbose
-        if defined?(Psych) && Psych.respond_to?(:safe_load)
-          yaml = Psych.safe_load(File.read(file))
-        else
-          yaml = YAML.load(File.read(file), safe: true)
-        end
-        yaml.each_pair do |namespace, vals|
-          vals.symbolize_keys!
-          n = ns(namespace)
-          vals.each_pair do |key, val|
-            val.symbolize_keys!
-            if !val[:kind].nil? && (val[:kind] == 'file' || val[:kind] == 'image')
-              unless @@file_uploads_supported
-                ::Kernel.raise ::RailsAdminSettings::PersistenceException, "Fatal: setting #{key} is #{val[:type]} but file upload engine is not detected"
-              end
-              value = File.open(root_file_path.join(val.delete(:value)))
-            else
-              value = val.delete(:value)
-            end
-            puts "#{key} - default '#{value}' current '#{Settings.get(key).raw}'" if verbose
-            n.set(key, value, val.merge(overwrite: false))
-          end
-          n.unload!
-        end
-      end
+      RailsAdminSettings.apply_defaults!(file, verbose)
     end
 
     def get(key, options = {})

data/lib/rails_admin_settings/uploads.rb

@@ -31,7 +31,7 @@ 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

data/lib/rails_admin_settings/validation.rb

@@ -1,91 +1,122 @@
 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?
+
+        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. 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.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_settings
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Gleb Tv
@@ -271,8 +271,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile

data/.ruby-gemset

@@ -1,2 +0,0 @@
-rails_admin_settings
-

data/.ruby-version

@@ -1 +0,0 @@
-2.1.5