rails_admin_settings 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daf283cef242208c445d469dfa8b3608cbbef8a1
-  data.tar.gz: 7f8b0fa36cba674dddea4b6ab1e626701057bd28
+  metadata.gz: 7026b8ca9636dabaf5e279d2b2bfff9b6117c7bd
+  data.tar.gz: 22f40dc0852ea497da0826dfe612b5ccd721099d
 SHA512:
-  metadata.gz: 87550cd78de0107a324dcce90b8094ad8787eb1336ca76709ec703273432f4e5b968e2bc806adcaec7386dafeeb90152cb2acda84f5476d72ab2ebd019154cac
-  data.tar.gz: 1a28c1b482f2b65e56a98f089bb2c64643c55998047567a0e8ca5e1bfb36935aadb36045907a8375a581c9098dc75354bdfa3ad344c4f79bef3afc93e923e46a
+  metadata.gz: 98a6fe6a9ecb47a3cd5ebe3bb8b64014eb9bbe7e59e315a6dccd428d4d324d9e3bc42ef3e87d44532a693d72c697d8bf8f27fe67be59cb18f841c5cf381b148d
+  data.tar.gz: a0075c3be9b521493b03bf4b22767caf40761d13d4dab24a1f71f1ca1e50ed6dc2eb39b59a6d6fcc054b5468e188e0718715cc1a335b04cef6778900d718e327

data/.ruby-gemset

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

data/.ruby-version

@@ -1 +1,2 @@
-2.0.0-p247
+2.0.0-p353
+

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.6.0
+
+- Added namespaced settings
+- Added loading of default settings from config/settings.yml
+- Settings.label(key) is removed
+- Added Settings.apply_defaults! to load settings from yml file without
+  overwriting current settings.
+  *note*: If setting type is changed and old value does not pass validation for
+  new type, value will be reset to nil.
+- Added rake settings:save_defaults to dump current settings to
+  config/defaults.yml

data/app/models/rails_admin_settings/setting.rb

@@ -16,9 +16,14 @@ module RailsAdminSettings
 
     field :type, type: String, default: RailsAdminSettings.types.first
 
+    field :ns, type: String, default: 'main'
     field :key, type: String
-    field :raw, type: String, default: ''
-    field :label
+    index({ns: 1, key: 1}, {unique: true, sparse: true})
+
+    field :raw, type: String
+    field :label, type: String
+
+    scope :ns, ->(ns) { where(ns: ns) }
 
     include RailsAdminSettings::RequireHelpers
     include RailsAdminSettings::Processing
@@ -33,11 +38,28 @@ module RailsAdminSettings
       enabled
     end
 
-    before_save do
-      self.label = self.key  unless self.label.present?
+    def name
+      label.blank? ? key : label
     end
 
-    index(key: 1)
+    def to_path
+      if value.nil?
+        nil
+      else
+        URI.parse(value).path
+      end
+    end
+
+    def as_yaml(options = {})
+      v = {type: type, enabled: enabled, label: label}
+      if upload_type?
+        v[:value] = to_path
+      else
+        v[:value] = raw
+      end
+      v.stringify_keys!
+      v
+    end
 
     if Object.const_defined?('RailsAdmin')
       include RailsAdminSettings::RailsAdminConfig

data/app/views/rails_admin/main/_setting_value.html.haml

@@ -1,7 +1,7 @@
 - if ['string', 'integer', 'phone', 'email', 'address', 'url', 'domain'].include?(@object.type)
   = form.text_field :raw, :value => field.value
 - if @object.type == 'color'
-  = form.text_field :raw, :value => field.value, 'data-color' => true
+  = form.text_field :raw, :value => field.value, 'data-color' => true, style: "background-color: ##{field.value}"
 - elsif @object.type == 'text' || @object.type == 'yaml'
   = form.text_area :raw, :value => field.value, :rows => 10, :cols => 80
 - elsif @object.type == 'html'

data/config/locales/{ru.rails_admin_settings.yml → ru.yml}

@@ -1,20 +1,20 @@
-ru:
-  admin:
-    settings:
-      label: 'Настройки'
-      no_ckeditor_detected: CKEditor не обнаружен — отображаю настройку как текстовое поле
-      phone_invalid: Неверный телефонный номер
-      email_invalid: Неверный email
-      yaml_invalid: Неверный синтаксис YAML
-      color_invalid: Неверный цвет
-  mongoid:
-    models:
-      rails_admin_settings/setting: Настройки
-
-    attributes:
-      rails_admin_settings/setting:
-        label: Название
-        key: Ключ
-        raw: Значение
-        type: Тип
-
+ru:
+  admin:
+    settings:
+      label: 'Настройки'
+      no_ckeditor_detected: CKEditor не обнаружен — отображаю настройку как текстовое поле
+      phone_invalid: Неверный телефонный номер
+      email_invalid: Неверный email
+      yaml_invalid: Неверный синтаксис YAML
+      color_invalid: Неверный цвет
+  mongoid:
+    models:
+      rails_admin_settings/setting: Настройки
+
+    attributes:
+      rails_admin_settings/setting:
+        label: Название
+        key: Ключ
+        raw: Значение
+        type: Тип
+

data/lib/rails_admin_settings/dumper.rb

@@ -0,0 +1,12 @@
+module RailsAdminSettings
+  module Dumper
+    def self.dump(path)
+      ns = {}
+      RailsAdminSettings::Setting.each do |s|
+        ns[s.ns] = {} if ns[s.ns].nil?
+        ns[s.ns][s.key] = s.as_yaml
+      end
+      File.write(path, ns.to_yaml)
+    end
+  end
+end

data/lib/rails_admin_settings/engine.rb

@@ -8,6 +8,9 @@ module RailsAdminSettings
           after_filter { Settings.unload! }
         end
       end
+
+      RailsAdminSettings::Setting.where(:ns.exists => false).update_all(ns: 'main')
+      Settings.apply_defaults!(Rails.root.join('config/settings.yml'))
     end
   end
 end

data/lib/rails_admin_settings/fallback.rb

@@ -0,0 +1,19 @@
+module RailsAdminSettings
+  # we are inheriting from BasicObject so we don't get a bunch of methods from
+  # Kernel or Object
+  class Fallback < BasicObject
+    def initialize(ns, fb)
+      @ns = ns
+      @fb = fb
+    end
+
+    def inspect
+      "#<RailsAdminSettings::Fallback ns: #{@ns.inspect}, fb: #{@fb.inspect}>"
+    end
+
+    def method_missing(*args)
+      @ns.fallback = @fb
+      @ns.__send__(*args)
+    end
+  end
+end

data/lib/rails_admin_settings/hex_color_validator.rb

@@ -1,7 +1,7 @@
 module RailsAdminSettings
   class HexColorValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
-      record.errors[attribute] << (options[:message] || I18n.t('admin.settings.invalid_color')) unless value.blank? || self.class.matches?(value)
+      record.errors[attribute] << (options[:message] || I18n.t('admin.settings.color_invalid')) unless value.blank? || self.class.matches?(value)
     end
     def self.matches?(value)
       return false unless value

data/lib/rails_admin_settings/namespaced.rb

@@ -0,0 +1,201 @@
+module RailsAdminSettings
+  # we are inheriting from BasicObject so we don't get a bunch of methods from
+  # Kernel or Object
+  class Namespaced < BasicObject
+    attr_accessor :settings, :fallback
+    attr_reader :loaded, :mutex
+
+    def initialize(name)
+      self.settings = {}
+      @mutex = ::Mutex.new
+      @loaded = false
+      @locked = false
+      @name = name
+    end
+
+    def nil?
+      false
+    end
+    def inspect
+      "#<RailsAdminSettings::Namespaced name: #{@name.inspect}, fallback: #{@fallback.inspect}, loaded: #{@loaded}>"
+    end
+    def pretty_inspect
+      inspect
+    end
+
+    def load!
+      mutex.synchronize do
+        return if loaded
+        @loaded = true
+        @settings = {}
+        ::RailsAdminSettings::Setting.ns(@name).each do |setting|
+          @settings[setting.key] = setting
+        end
+      end
+    end
+
+    def unload!
+      mutex.synchronize do
+        @loaded = false
+        @settings = {}
+      end
+    end
+
+    # returns setting object
+    def get(key, options = {})
+      load!
+      key = key.to_s
+      mutex.synchronize do
+        @locked = true
+        v = @settings[key]
+        if v.nil?
+          unless @fallback.nil?
+            v = ::Settings.ns(@fallback).getnc(key)
+          end
+          if v.nil?
+            v = set(key, options[:default], options)
+          end
+        end
+        @locked = false
+        v
+      end
+    end
+
+    # returns setting object
+    def getnc(key)
+      load!
+      mutex.synchronize do
+        self.settings[key]
+      end
+    end
+
+    def set(key, value = nil, options = {})
+      load! unless @locked
+      key = key.to_s
+      options.symbolize_keys!
+
+      if !options[:type].nil? && options[:type] == 'yaml' && !value.nil?
+        if value.class.name != 'String'
+          value = value.to_yaml
+        end
+      end
+
+      options.merge!(value: value)
+      if @locked
+        write_to_database(key, options)
+      else
+        mutex.synchronize do
+          write_to_database(key, options)
+        end
+      end
+    end
+
+    def enabled?(key, options = {})
+      get(key, options).enabled?
+    end
+
+    def []=(key, value)
+      set(key, value)
+    end
+    def [](key)
+      get(key)
+    end
+
+    def destroy!(key)
+      load!
+      key = key.to_s
+      mutex.synchronize do
+        ::RailsAdminSettings::Setting.where(ns: @name, key: key).destroy_all
+        @settings.delete(key)
+      end
+    end
+
+    def destroy_all!
+      mutex.synchronize do
+        ::RailsAdminSettings::Setting.where(ns: @name).destroy_all
+        @loaded = false
+        @settings = {}
+      end
+    end
+
+    # returns processed setting value
+    def method_missing(key, *args)
+      key = key.to_s
+      if key.end_with?('_enabled?')
+        key = key[0..-10]
+        v = get(key)
+        if v.nil?
+          set(key, '').enabled
+        else
+          v.enabled
+        end
+      elsif key.end_with?('_enabled=')
+        key = key[0..-10]
+        v = get(key)
+        if ::Mongoid::VERSION >= "4.0.0"
+          v.set(enabled: args.first)
+        else
+          v.set("enabled", args.first)
+        end
+        v.enabled
+      elsif key.end_with?('=')
+        key = key[0..-2]
+        options = args[1] || {}
+        value = args.first
+        set(key, value, options).val
+      else
+        v = get(key, args.first || {})
+        if v.nil?
+          ''
+        else
+          v.val
+        end
+      end
+    end
+
+    def write_to_database(key, options)
+      is_file = !options[:type].nil? && (options[:type] == 'image' || options[:type] == 'file')
+      if is_file
+        options[:raw] = ''
+        file = options[:value]
+      else
+        options[:raw] = options[:value]
+      end
+
+      options.delete(:value)
+      options[:ns] = @name
+
+      if @settings[key].nil?
+        options.delete(:overwrite)
+        v = ::RailsAdminSettings::Setting.create(options.merge(key: key))
+        if !v.persisted?
+          if v.errors[:key].any?
+            v = ::RailsAdminSettings::Setting.where(key: key).first
+            if v.nil?
+              ::Kernel.raise ::RailsAdminSettings::PersistenceException, 'Fatal: error in key and not in DB'
+            end
+          else
+            ::Kernel.raise ::RailsAdminSettings::PersistenceException, v.errors.full_messages.join(',')
+          end
+        end
+        @settings[key] = v
+      else
+        opts = options.dup
+        if options[:overwrite] == false
+          opts.delete(:raw)
+          opts.delete(:value)
+          opts.delete(:enabled)
+        end
+        opts.delete(:overwrite)
+        @settings[key].update_attributes!(opts)
+      end
+      if is_file
+        if options[:overwrite] != false || !@settings[key].file?
+          @settings[key].file = file
+          @settings[key].save!
+        end
+      end
+      @settings[key]
+    end
+  end
+end

data/lib/rails_admin_settings/rails_admin_config.rb

@@ -5,19 +5,16 @@ module RailsAdminSettings
         base.rails_admin do
           navigation_label I18n.t('admin.settings.label')
 
-          object_label_method do
-            :label
-          end
-
           list do
             if Object.const_defined?('RailsAdminToggleable')
               field :enabled, :toggle
             else
               field :enabled
             end
-            field :label
-            field :raw
             field :type
+            field :ns
+            field :name
+            field :raw
           end
 
           edit do

data/lib/rails_admin_settings/railtie.rb

@@ -0,0 +1,7 @@
+module RailsAdminSettings
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require File.expand_path('../tasks', __FILE__)
+    end
+  end
+end