rails_admin_settings 0.5.0 → 0.5.2

data/lib/rails_admin_settings/settings.rb

@@ -1,176 +1,176 @@
-class Settings
-  cattr_accessor :file_uploads_supported, :file_uploads_engine, :settings
-  @@file_uploads_supported = false
-  @@file_uploads_engine = false
-
-  class << self
-    @@loaded = false
-    @@settings = {}
-
-    def load!
-      if @@loaded
-        false
-      else
-        @@settings = {}
-        RailsAdminSettings::Setting.all.each do |setting|
-          @@settings[setting.key] = setting
-        end
-        @@loaded = true
-        true
-      end
-    end
-
-    def unload!
-      if @@loaded
-        @@settings = {}
-        @@loaded = false
-        true
-      else
-        false
-      end
-    end
-
-    # returns processed setting value
-    def method_missing(key, *args)
-      key = key.to_s
-
-      if key[-1] == '='
-        key = key[0..-2]
-        options = args[1] || {}
-        value = args.first
-        set(key, value, options).val
-      else
-        get(key, args.first || {}).val
-      end
-    end
-
-    def set(key, value = nil, options = {})
-      load!
-      key = key.to_s
-      options.symbolize_keys!
-
-
-      if !options[:type].nil? && options[:type] == 'yaml' && !value.nil? && !valid_yaml?(value)
-        value = value.to_yaml
-      end
-
-      if @@settings[key].nil?
-        write_to_database(key, options.merge(key: key, raw: value))
-      else
-        @@settings[key].update_attributes!(options.merge(raw: value))
-        @@settings[key]
-      end
-    end
-
-    def valid_yaml?(value)
-      begin
-        YAML.safe_load(value)
-      rescue LoadError => e
-        e.message << " [rails_admin_settings] Please add gem 'safe_yaml' to your Gemfile to use yaml settings"
-        raise e
-      rescue Psych::SyntaxError => e
-        return false
-      end
-    end
-
-    def enabled?(key, options = {})
-      get(key, options).enabled?
-    end
-
-    # returns setting object
-    def get(key, options = {})
-      load!
-      key = key.to_s
-      if @@settings[key].nil?
-        create_setting(key, options)
-      else
-        @@settings[key]
-      end
-    end
-
-    def []=(key, value)
-      set(key, value)
-    end
-
-    def [](key)
-      get(key)
-    end
-
-    def save_default(key, value, options = {})
-      load!
-      key = key.to_s
-      options.merge!(default: value)
-      if @@settings[key].nil?
-        create_setting(key, options).val
-      else
-        if @@settings[key].blank?
-          set(key, value).val
-        else
-          @@settings[key].val
-        end
-      end
-    end
-
-    def create_setting(key, options = {})
-      load!
-      key = key.to_s
-      options.symbolize_keys!
-      options[:raw] = options.delete(:default)
-      if @@settings[key].nil?
-        write_to_database(key, options.merge(key: key))
-      else
-        @@settings[key]
-      end
-    end
-
-    # to satisfy rspec
-    def to_ary
-      ['Settings']
-    end
-
-    def destroy(key)
-      raise 'please call destroy! to delete setting'
-    end
-
-    def destroy_all
-      raise 'please call destroy_all! to delete all settings'
-    end
-
-    def destroy!(key)
-      load!
-      key = key.to_s
-      unless @@settings[key].nil?
-        @@settings[key].destroy
-        @@settings.delete(key)
-      end
-    end
-
-    def destroy_all!
-      RailsAdminSettings::Setting.destroy_all
-      unload!
-    end
-
-
-    def write_to_database(key, options)
-      key = key.to_s
-      @@settings[key] = RailsAdminSettings::Setting.create(options)
-      unless @@settings[key].persisted?
-        if @@settings[key].errors[:key].any?
-          @@settings[key] = RailsAdminSettings::Setting.where(key: key).first
-          if options[:raw].blank? && !@@settings[key].blank?
-            # do not update setting if it's not blank in DB and we want to make it blank
-          else
-            unless @@settings[key].update_attributes(options)
-              raise RailsAdminSettings::PersistenceException
-            end
-          end
-        end
-      end
-      @@settings[key]
-    end
-
-    def label key
-      get(key).label
-    end
-  end
-end
+class Settings
+  cattr_accessor :file_uploads_supported, :file_uploads_engine, :settings
+  @@file_uploads_supported = false
+  @@file_uploads_engine = false
+
+  class << self
+    @@loaded = false
+    @@settings = {}
+
+    def load!
+      if @@loaded
+        false
+      else
+        @@settings = {}
+        RailsAdminSettings::Setting.all.each do |setting|
+          @@settings[setting.key] = setting
+        end
+        @@loaded = true
+        true
+      end
+    end
+
+    def unload!
+      if @@loaded
+        @@settings = {}
+        @@loaded = false
+        true
+      else
+        false
+      end
+    end
+
+    # returns processed setting value
+    def method_missing(key, *args)
+      key = key.to_s
+
+      if key[-1] == '='
+        key = key[0..-2]
+        options = args[1] || {}
+        value = args.first
+        set(key, value, options).val
+      else
+        get(key, args.first || {}).val
+      end
+    end
+
+    def set(key, value = nil, options = {})
+      load!
+      key = key.to_s
+      options.symbolize_keys!
+
+
+      if !options[:type].nil? && options[:type] == 'yaml' && !value.nil? && !valid_yaml?(value)
+        value = value.to_yaml
+      end
+
+      if @@settings[key].nil?
+        write_to_database(key, options.merge(key: key, raw: value))
+      else
+        @@settings[key].update_attributes!(options.merge(raw: value))
+        @@settings[key]
+      end
+    end
+
+    def valid_yaml?(value)
+      begin
+        YAML.safe_load(value)
+      rescue LoadError => e
+        e.message << " [rails_admin_settings] Please add gem 'safe_yaml' to your Gemfile to use yaml settings"
+        raise e
+      rescue Psych::SyntaxError => e
+        return false
+      end
+    end
+
+    def enabled?(key, options = {})
+      get(key, options).enabled?
+    end
+
+    # returns setting object
+    def get(key, options = {})
+      load!
+      key = key.to_s
+      if @@settings[key].nil?
+        create_setting(key, options)
+      else
+        @@settings[key]
+      end
+    end
+
+    def []=(key, value)
+      set(key, value)
+    end
+
+    def [](key)
+      get(key)
+    end
+
+    def save_default(key, value, options = {})
+      load!
+      key = key.to_s
+      options.merge!(default: value)
+      if @@settings[key].nil?
+        create_setting(key, options).val
+      else
+        if @@settings[key].blank?
+          set(key, value).val
+        else
+          @@settings[key].val
+        end
+      end
+    end
+
+    def create_setting(key, options = {})
+      load!
+      key = key.to_s
+      options.symbolize_keys!
+      options[:raw] = options.delete(:default)
+      if @@settings[key].nil?
+        write_to_database(key, options.merge(key: key))
+      else
+        @@settings[key]
+      end
+    end
+
+    # to satisfy rspec
+    def to_ary
+      ['Settings']
+    end
+
+    def destroy(key)
+      raise 'please call destroy! to delete setting'
+    end
+
+    def destroy_all
+      raise 'please call destroy_all! to delete all settings'
+    end
+
+    def destroy!(key)
+      load!
+      key = key.to_s
+      unless @@settings[key].nil?
+        @@settings[key].destroy
+        @@settings.delete(key)
+      end
+    end
+
+    def destroy_all!
+      RailsAdminSettings::Setting.destroy_all
+      unload!
+    end
+
+
+    def write_to_database(key, options)
+      key = key.to_s
+      @@settings[key] = RailsAdminSettings::Setting.create(options)
+      unless @@settings[key].persisted?
+        if @@settings[key].errors[:key].any?
+          @@settings[key] = RailsAdminSettings::Setting.where(key: key).first
+          if options[:raw].blank? && !@@settings[key].blank?
+            # do not update setting if it's not blank in DB and we want to make it blank
+          else
+            unless @@settings[key].update_attributes(options)
+              raise RailsAdminSettings::PersistenceException
+            end
+          end
+        end
+      end
+      @@settings[key]
+    end
+
+    def label key
+      get(key).label
+    end
+  end
+end

data/lib/rails_admin_settings/storage/carrierwave.rb

@@ -1,9 +1,9 @@
-module RailsAdminSettings
-  module Uploads
-    class CarrierWave < CarrierWave::Uploader::Base
-      def extension_white_list
-        %w(jpg jpeg gif png tiff psd ai txt rtf doc docx xls xlsx ppt pptx odt odx zip rar 7z pdf)
-      end
-    end
-  end
+module RailsAdminSettings
+  module Uploads
+    class CarrierWave < CarrierWave::Uploader::Base
+      def extension_white_list
+        %w(jpg jpeg gif png tiff psd ai txt rtf doc docx xls xlsx ppt pptx odt odx zip rar 7z pdf)
+      end
+    end
+  end
 end

data/lib/rails_admin_settings/types.rb

@@ -1,5 +1,5 @@
-module RailsAdminSettings
-  def self.types
-    ['string', 'integer', 'html', 'sanitized', 'yaml', 'phone', 'email', 'address', 'file', 'url', 'domain', 'color']
-  end
+module RailsAdminSettings
+  def self.types
+    ['string', 'integer', 'html', 'sanitized', 'yaml', 'phone', 'email', 'address', 'file', 'url', 'domain', 'color']
+  end
 end

data/lib/rails_admin_settings/uploads.rb

@@ -1,29 +1,30 @@
-module RailsAdminSettings
-  module Uploads
-    autoload :CarrierWave, "rails_admin_settings/storage/carrierwave"
-
-    def self.included(base)
-      # carrierwave
-      if base.respond_to?(:mount_uploader)
-        # puts "[rails_admin_settings] CarrierWave detected"
-        base.field(:file, type: String)
-        base.mount_uploader(:file, RailsAdminSettings::Uploads::CarrierWave)
-        Settings.file_uploads_supported = true
-        Settings.file_uploads_engine = :carrierwave
-      # paperclip
-      elsif Mongoid.const_defined?('Paperclip')
-        base.send(:include, Mongoid::Paperclip)
-        # puts "[rails_admin_settings] PaperClip detected"
-        base.field(:file, type: String)
-        base.has_mongoid_attached_file(:file)
-        base.send(:attr_accessor, :delete_file)
-        base.before_validation { self.file.clear if self.delete_file == '1' }
-
-        Settings.file_uploads_supported = true
-        Settings.file_uploads_engine = :paperclip
-      else
-        # puts "[rails_admin_settings] Uploads disabled"
-      end
-    end
-  end
-end
+module RailsAdminSettings
+  module Uploads
+    autoload :CarrierWave, "rails_admin_settings/storage/carrierwave"
+
+    def self.included(base)
+      # carrierwave
+      if base.respond_to?(:mount_uploader)
+        # puts "[rails_admin_settings] CarrierWave detected"
+        # base.field(:file, type: String)
+        base.mount_uploader(:file, RailsAdminSettings::Uploads::CarrierWave)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :carrierwave
+      # paperclip
+      elsif Mongoid.const_defined?('Paperclip')
+        base.send(:include, Mongoid::Paperclip)
+        # puts "[rails_admin_settings] PaperClip detected"
+        base.field(:file, type: String)
+        base.has_mongoid_attached_file(:file)
+        base.send(:attr_accessor, :delete_file)
+        base.before_validation { self.file.clear if self.delete_file == '1' }
+
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :paperclip
+      else
+        # puts "[rails_admin_settings] Uploads disabled"
+      end
+    end
+  end
+end
+

data/lib/rails_admin_settings/validation.rb

@@ -1,72 +1,72 @@
-module RailsAdminSettings
-  module Validation
-    def self.included(base)
-      base.before_validation do
-        self.raw = default_value if raw.blank?
-      end
-      base.before_validation :sanitize_value, if: :sanitized_type?
-      base.validates_uniqueness_of :key
-      base.validates_inclusion_of :type, in: RailsAdminSettings.types
-      base.validates_numericality_of :raw, if: :integer_type?
-
-      base.validate if: :phone_type? do
-        require_russian_phone do
-          errors.add(:raw, I18n.t('admin.settings.phone_invalid')) unless raw.blank? || RussianPhone::Number.new(raw).valid?
-        end
-      end
-
-      base.validate if: :email_type? 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
-
-      base.validate if: :address_type? do
-        require_geocoder do
-          # just raise error if we are trying to use address type without geocoder
-        end
-      end
-
-      base.validate if: :file_type? do
-        unless Settings.file_uploads_supported
-          raise '[rails_admin_settings] File type requires either CarrierWave or Paperclip. Check that rails_admin_settings is below them in Gemfile'
-        end
-      end
-
-      base.before_validation if: :url_type? do
-        require_addressable do
-          self.raw = Addressable::URI.heuristic_parse(self.raw) unless self.raw.blank?
-        end
-      end
-
-      base.before_validation if: :domain_type? do
-        require_addressable do
-          self.raw = Addressable::URI.heuristic_parse(self.raw).host unless self.raw.blank?
-        end
-      end
-
-      if Object.const_defined?('Geocoder')
-        base.field(:coordinates, type: Array)
-        base.send(:include, Geocoder::Model::Mongoid)
-        base.geocoded_by(:raw)
-        base.after_validation(:geocode, if: :address_type?)
-      end
-
-      base.validate if: :color_type? do
-        base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw)
-      end
-
-      base.validate if: :yaml_type? 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
-  end
-end
+module RailsAdminSettings
+  module Validation
+    def self.included(base)
+      base.before_validation do
+        self.raw = default_value if raw.blank?
+      end
+      base.before_validation :sanitize_value, if: :sanitized_type?
+      base.validates_uniqueness_of :key
+      base.validates_inclusion_of :type, in: RailsAdminSettings.types
+      base.validates_numericality_of :raw, if: :integer_type?
+
+      base.validate if: :phone_type? do
+        require_russian_phone do
+          errors.add(:raw, I18n.t('admin.settings.phone_invalid')) unless raw.blank? || RussianPhone::Number.new(raw).valid?
+        end
+      end
+
+      base.validate if: :email_type? 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
+
+      base.validate if: :address_type? do
+        require_geocoder do
+          # just raise error if we are trying to use address type without geocoder
+        end
+      end
+
+      base.validate if: :file_type? do
+        unless Settings.file_uploads_supported
+          raise '[rails_admin_settings] File type requires either CarrierWave or Paperclip. Check that rails_admin_settings is below them in Gemfile'
+        end
+      end
+
+      base.before_validation if: :url_type? do
+        require_addressable do
+          self.raw = Addressable::URI.heuristic_parse(self.raw) unless self.raw.blank?
+        end
+      end
+
+      base.before_validation if: :domain_type? do
+        require_addressable do
+          self.raw = Addressable::URI.heuristic_parse(self.raw).host unless self.raw.blank?
+        end
+      end
+
+      if Object.const_defined?('Geocoder')
+        base.field(:coordinates, type: Array)
+        base.send(:include, Geocoder::Model::Mongoid)
+        base.geocoded_by(:raw)
+        base.after_validation(:geocode, if: :address_type?)
+      end
+
+      base.validate if: :color_type? do
+        base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw)
+      end
+
+      base.validate if: :yaml_type? 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
+  end
+end

data/lib/rails_admin_settings/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminSettings
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

data/spec/advanced_usage_spec.rb

@@ -1,11 +1,11 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe 'Settings advanced usage' do
-  it 'with defaults' do
-    s = Settings.email(default: 'test@example.com')
-    s.should eq 'test@example.com'
-    Settings.get(:email).to_s.should eq 'test@example.com'
-  end
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings advanced usage' do
+  it 'with defaults' do
+    s = Settings.email(default: 'test@example.com')
+    s.should eq 'test@example.com'
+    Settings.get(:email).to_s.should eq 'test@example.com'
+  end
 end