rails_admin_settings 0.5.5 → 0.6.0

data/lib/rails_admin_settings/settings.rb

@@ -1,208 +1,106 @@
 require 'thread'
 
-class Settings
-  cattr_accessor :file_uploads_supported, :file_uploads_engine, :settings
+# we are inheriting from BasicObject so we don't get a bunch of methods from
+# Kernel or Object
+class Settings < BasicObject
+  cattr_accessor :file_uploads_supported, :file_uploads_engine
   @@file_uploads_supported = false
   @@file_uploads_engine = false
-  @@mutex = Mutex.new
+  @@namespaces = {}
+  @@mutex = ::Mutex.new
 
   class << self
-    @@loaded = false
-    @@settings = {}
-
-    def load!
-      @@mutex.synchronize do
-        if @@loaded
-          false
-        else
-          @@settings = {}
-          RailsAdminSettings::Setting.all.each do |setting|
-            @@settings[setting.key] = setting
-          end
-          @@loaded = true
-          true
-        end
-      end
-    end
-
-    def unload!
-      @@mutex.synchronize do
-        if @@loaded
-          @@settings = {}
-          @@loaded = false
-          true
-        else
-          false
-        end
-      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
+    def ns(name, options = {})
       options.symbolize_keys!
-
-
-      if !options[:type].nil? && options[:type] == 'yaml' && !value.nil? && !valid_yaml?(value)
-        value = value.to_yaml
-      end
-
-      is_file = !options[:type].nil? && (options[:type] == 'image' || options[:type] == 'file')
-      if is_file
-        options[:raw] = ''
+      if name.nil?
+        name = 'main'
       else
-        options[:raw] = value
+        name = name.to_s
       end
-
-      if @@settings[key].nil?
-        write_to_database(key, options.merge(key: key))
-      else
-        @@mutex.synchronize do
-          @@settings[key].update_attributes!(options)
-        end
+      @@mutex.synchronize do
+        @@namespaces[name] ||= ::RailsAdminSettings::Namespaced.new(name.to_s)
       end
-
-      if is_file
-        @@mutex.synchronize do
-          @@settings[key].file = value
-          @@settings[key].save!
-        end
+      if options[:fallback].nil?
+        @@namespaces[name]
+      else
+        ::RailsAdminSettings::Fallback.new(@@namespaces[name], options[:fallback])
       end
-
-      @@settings[key]
     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
+    def unload!
+      @@mutex.synchronize do
+        @@namespaces.values.map(&:unload!)
+        @@namespaces = {}
       end
     end
 
-    def enabled?(key, options = {})
-      get(key, options).enabled?
+    def destroy_all!
+      RailsAdminSettings::Setting.destroy_all
+      unload!
     end
 
-    # returns setting object
-    def get(key, options = {})
-      load!
-      key = key.to_s
-      if @@settings[key].nil?
-        create_setting(key, options)
+    def root_file_path
+      if Object.const_defined?('Rails')
+        Rails.root
       else
-        @@settings[key]
+        Pathname.new(File.dirname(__FILE__)).join('../..')
       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
+    def apply_defaults!(file)
+      if File.file?(file)
+        yaml = YAML.load(File.read(file), safe: true)
+        yaml.each_pair do |namespace, vals|
+          vals.symbolize_keys!
+          n = ns(namespace)
+          vals.each_pair do |key, val|
+            val.symbolize_keys!
+            if !val[:type].nil? && (val[:type] == 'file' || val[:type] == '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
+            n.set(key, value, val.merge(overwrite: false))
+          end
+          n.unload!
         end
       end
     end
 
-    def create_setting(key, options = {})
-      load!
-      key = key.to_s
+    def get(key, options = {})
       options.symbolize_keys!
-      options[:raw] = options.delete(:default)
 
-      if @@settings[key].nil?
-        write_to_database(key, options.merge(key: key))
+      if options[:ns].nil? || options[:ns].to_s == 'main'
+        ns('main').get(key, options)
       else
-        @@settings[key]
+        ns(options[:ns]).get(key, options)
       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
+    def set(key, value = nil, options = {})
+      options.symbolize_keys!
 
-      @@mutex.synchronize do
-        unless @@settings[key].nil?
-          @@settings[key].destroy
-          @@settings.delete(key)
-        end
+      if options[:ns].nil? || options[:ns].to_s == 'main'
+        ns('main').set(key, value, options)
+      else
+        ns(options[:ns]).set(key, value, options)
       end
     end
 
-    def destroy_all!
-      RailsAdminSettings::Setting.destroy_all
-      unload!
+    def save_default(key, value, options = {})
+      set(key, value, options.merge(overwrite: false))
     end
 
-
-    def write_to_database(key, options)
-      key = key.to_s
-
-      @@mutex.synchronize do
-        @@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 create_setting(key, value, options = {})
+      set(key, nil, options.merge(overwrite: false))
     end
 
-    def label key
-      get(key).label
+    def method_missing(*args)
+      ns('main').__send__(*args)
     end
   end
 end
+

data/lib/rails_admin_settings/tasks.rb

@@ -0,0 +1,25 @@
+# require this file to load the tasks
+require 'rake'
+
+# Require sitemap_generator at runtime. If we don't do this the ActionView helpers are included
+# before the Rails environment can be loaded by other Rake tasks, which causes problems
+# for those tasks when rendering using ActionView.
+namespace :settings do
+  # Require sitemap_generator only. When installed as a plugin the require will fail, so in
+  # that case, load the environment first.
+  task :require do
+    Rake::Task['environment'].invoke
+  end
+
+  desc "Dump settings to config/settings.yml"
+  task :dump => ['settings:require'] do
+    path = Settings.root_file_path.join('config/settings.yml')
+    RailsAdminSettings::Dumper.dump(path)
+    puts "dumped settings to #{path}"
+  end
+
+  desc "Delete all settings"
+  task :delete => ['settings:require'] do
+    Settings.destroy_all!
+  end
+end

data/lib/rails_admin_settings/types.rb

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

data/lib/rails_admin_settings/validation.rb

@@ -5,7 +5,7 @@ module RailsAdminSettings
         self.raw = default_value if raw.blank?
       end
       base.before_validation :sanitize_value, if: :sanitized_type?
-      base.validates_uniqueness_of :key
+      base.validates_uniqueness_of :key, scope: :ns
       base.validates_inclusion_of :type, in: RailsAdminSettings.types
       base.validates_numericality_of :raw, if: :integer_type?
 
@@ -52,9 +52,7 @@ module RailsAdminSettings
         base.after_validation(:geocode, if: :address_type?)
       end
 
-      base.validate if: :color_type? do
-        base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw)
-      end
+      base.validates_with(RailsAdminSettings::HexColorValidator, attributes: :raw, if: :color_type?)
 
       base.validate if: :yaml_type? do
         require_safe_yaml do

data/lib/rails_admin_settings/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminSettings
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 end

data/lib/rails_admin_settings.rb

@@ -4,18 +4,22 @@ module RailsAdminSettings
   class PersistenceException < Exception
   end
 
+  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"
 end
 
 require "rails_admin_settings/types"
 require "rails_admin_settings/settings"
 
 if Object.const_defined?('Rails')
+  require "rails_admin_settings/railtie"
   require "rails_admin_settings/engine"
 else
   require File.dirname(__FILE__) + '/../app/models/rails_admin_settings/setting.rb'

data/rails_admin_settings.gemspec

@@ -21,14 +21,14 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "mongoid", ">= 3.1"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0.3"
-  spec.add_development_dependency "rspec", "~> 2.13.0"
-  spec.add_development_dependency "mongoid-rspec", "~> 1.7.0"
-  spec.add_development_dependency "simplecov", "~> 0.7.1"
-  spec.add_development_dependency "database_cleaner", "~> 0.9.1"
-  spec.add_development_dependency "factory_girl", "~> 4.2.0"
+  spec.add_development_dependency "rake", "~> 10.1.1"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "mongoid-rspec", "~> 1.10.0"
+  spec.add_development_dependency "simplecov", "~> 0.8.2"
+  spec.add_development_dependency "database_cleaner", "~> 1.2.0"
+  spec.add_development_dependency "factory_girl", "~> 4.3.0"
 
-  spec.add_development_dependency "safe_yaml", "~> 0.8.6"
+  spec.add_development_dependency "safe_yaml", "~> 1.0.0"
   spec.add_development_dependency "russian_phone", "~> 0.3.2"
   spec.add_development_dependency "sanitize", "~> 2.0.3"
   spec.add_development_dependency "validates_email_format_of", "~> 1.5.3"
@@ -37,4 +37,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "glebtv-carrierwave-mongoid"
   spec.add_development_dependency "glebtv-mongoid-paperclip"
+  spec.add_development_dependency "pry"
 end

data/spec/carrierwave_spec.rb

@@ -18,7 +18,7 @@ describe "Uploads" do
 
       Settings.get(:file).file.file.file.should eq "#{File.dirname(__FILE__).gsub('/spec', '/')}uploads/1024x768.gif"
 
-      File.exists?("#{File.dirname(__FILE__)}/../uploads/1024x768.gif").should be_true
+      File.exists?(Settings.root_file_path.join("uploads/1024x768.gif")).should be_true
     end
 
     it 'supports image type' do
@@ -29,7 +29,12 @@ describe "Uploads" do
 
       Settings.get(:file).file.file.file.should eq "#{File.dirname(__FILE__).gsub('/spec', '/')}uploads/1024x768.gif"
 
-      File.exists?("#{File.dirname(__FILE__)}/../uploads/1024x768.gif").should be_true
+      File.exists?(Settings.root_file_path.join("uploads/1024x768.gif")).should be_true
+    end
+
+    it 'supports defaults' do
+      Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults_w_file.yml'))
+      File.exists?(Settings.root_file_path.join("uploads/1024x768.gif")).should be_true
     end
   end
 end

data/spec/database_trickery_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 # this tests check how well rails_admin_settings handles settings disappearing from DB during execution
 # real usage: app specs with database_cleaner enabled
-describe Settings do
+describe 'Database trickery' do
 
   it "should handle settings disappearing from DB" do
     email = "my@mail.ru"
@@ -19,30 +19,28 @@ describe Settings do
     Settings.email.should == email2
   end
 
-  it "should handle settings appearing from DB" do
+  it "should handle settings appearing in DB when settings are loaded" do
     Settings.tst2.should == ''
-    RailsAdminSettings::Setting.create(key: 'tst', raw: 'tst')
+    RailsAdminSettings::Setting.create!(key: 'tst', raw: 'tst')
     # settings are still cached, but when we try to create a setting it sees updated value in DB
     Settings.tst.should == 'tst'
   end
 
-  it "should handle settings appearing in DB" do
+  it "should handle settings appearing in DB when settings are not loaded" do
     RailsAdminSettings::Setting.create(key: 'tst', raw: 'tst')
-
     Settings.tst = 'str'
     Settings.tst.should == 'str'
   end
 
   it "#destroy_all!" do
     Settings.tst = 'str'
-    expect { Settings.destroy_all }.to raise_exception
     Settings.destroy_all!
     Settings.tst.should == ''
   end
+
   it "#destroy!" do
     Settings.tst = 'str'
     Settings.tst2 = 'str2'
-    expect { Settings.destroy(:tst) }.to raise_exception
     Settings.destroy!(:tst)
     Settings.tst.should == ''
     Settings.tst2.should == 'str2'

data/spec/defaults_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings loading defaults' do
+  before :each do
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+  end
+
+  it 'loads twice ok' do
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+  end
+
+  it 'sets value' do
+    Settings.footer.should eq 'test <b></b>'
+    Settings.get(:footer).type.should eq 'html'
+  end
+
+  it 'sets type' do
+    Settings.get(:phone).phone_type?.should be_true
+    Settings.get(:phone).val.city.should eq '906'
+    Settings.get(:phone).val.formatted_subscriber.should eq '111-11-11'
+  end
+
+  it 'sets enabled' do
+    Settings.phone_enabled?.should eq true
+    Settings.disabled_enabled?.should eq false
+    Settings.enabled?(:disabled).should eq false
+  end
+
+  it 'works with namespace' do
+    Settings.ns(:main).phone.should eq '906 1111111'
+    Settings.ns(:other).footer.should eq 'zzz'
+    Settings.footer.should eq 'test <b></b>'
+    Settings.ns(:main).footer.should eq 'test <b></b>'
+  end
+
+  it 'works with fallback' do
+    Settings.ns(:etc, fallback: :main).phone.should eq '906 1111111'
+    Settings.ns(:etc, fallback: :main).footer.should eq 'test <b></b>'
+    Settings.ns(:other, fallback: :main).footer.should eq 'zzz'
+    Settings.ns(:etc, fallback: :other).footer.should eq 'zzz'
+  end
+
+  it "doesn't overwrite" do
+    Settings.ns(:main).phone = '906 2222222'
+    Settings.ns(:other).footer = 'xxx'
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+    Settings.ns(:main).phone.should eq '906 2222222'
+    Settings.ns(:other).footer.should eq 'xxx'
+  end
+end

data/spec/enabling_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings enabling and disabling' do
+  it 'works for name_enabled? and name_enabled =' do
+    Settings.zzz = '123'
+    Settings.zzz.should eq '123'
+    Settings.get(:zzz).enabled.should eq true
+    Settings.enabled?(:zzz).should eq true
+    Settings.zzz_enabled?.should eq true
+
+    Settings.zzz.should eq '123'
+    Settings.zzz_enabled = false
+    Settings.zzz_enabled?.should eq false
+    Settings.get(:zzz).enabled.should eq false
+    Settings.enabled?(:zzz).should eq false
+    Settings.zzz.should eq ''
+    Settings.unload!
+    Settings.zzz.should eq ''
+    Settings.get(:zzz).raw.should eq '123'
+
+    Settings.zzz_enabled = true
+    Settings.zzz.should eq '123'
+    Settings.zzz_enabled?.should eq true
+    Settings.get(:zzz).enabled.should eq true
+    Settings.enabled?(:zzz).should eq true
+  end
+end

data/spec/label_spec.rb

@@ -7,12 +7,12 @@ describe 'Settings label' do
   it "should have label" do
     label = "E-Mail"
     Settings.email(label: label, default: "my@mail.ru")
-    Settings.label(:email).should == label
+    Settings.get(:email).name.should == label
   end
 
   it "should properly set label as key if blank" do
     Settings.email(default: "my@mail.ru")
-    Settings.label(:email).should == 'email'
+    Settings.get(:email).name.should == 'email'
   end
 
 end

data/spec/namespaced_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Namespaced settings' do
+  it 'sets namespaced' do
+    Settings.ns(:other).test = 'test'
+  end
+
+  it 'reads namespaced from cache' do
+    ns = Settings.ns(:other)
+    ns.test = 'test'
+    ns.test.should eq 'test'
+  end
+
+  it 'reads namespaced from db' do
+    Settings.ns(:other).test = 'test'
+    Settings.ns(:other).test.should eq 'test'
+  end
+
+  it 'destroys' do
+    Settings.ns(:other).test = 'test'
+    Settings.ns(:other).destroy_all!
+    Settings.ns(:other).test.should eq ''
+  end
+
+  it 'sets type' do
+    expect {
+      Settings.ns(:other).set(:phone, 'test', type: 'phone')
+    }.to raise_error
+    Settings.ns(:other).set(:phone, '906 111 11 11', type: 'phone')
+    Settings.get(:phone, ns: 'other').phone_type?.should be_true
+    Settings.get(:phone, ns: 'other').val.city.should eq '906'
+    Settings.get(:phone, ns: 'other').val.formatted_subscriber.should eq '111-11-11'
+
+    ns = Settings.ns(:other)
+    ns.get(:phone).phone_type?.should be_true
+    ns.get(:phone).val.city.should eq '906'
+    ns.get(:phone).val.formatted_subscriber.should eq '111-11-11'
+  end
+end

data/spec/paperclip_spec.rb

@@ -29,6 +29,11 @@ describe "Uploads" do
 
       File.exists?("#{File.dirname(__FILE__)}/../uploads/1024x768.gif").should be_true
     end
+
+    it 'supports defaults' do
+      Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults_w_file.yml'))
+      File.exists?(Settings.root_file_path.join("uploads/1024x768.gif")).should be_true
+    end
   end
 end
 

data/spec/settings_spec.rb

@@ -2,8 +2,7 @@
 
 require 'spec_helper'
 
-describe Settings do
-
+describe 'Settings' do
   it "should works as RailsSettings" do
     Settings.destroy_all!
 
@@ -12,6 +11,18 @@ describe Settings do
     Settings.email.should == email
   end
 
+  it '#get should return new setting when setting does not exist' do
+    t = Settings.get(:test)
+    t.class.name.should eq 'RailsAdminSettings::Setting'
+    t.persisted?.should eq true
+    t.value.should eq ''
+  end
+
+  it '#name should return empty string when setting does not exist' do
+    Settings.test.should eq ''
+    Settings['test'].value.should eq ''
+  end
+
   it "should save default" do
     Settings.destroy_all!
 
@@ -26,7 +37,6 @@ describe Settings do
   end
 
   it 'should properly unload' do
-    Settings.class_eval { cattr_accessor :loaded }
     Settings.load!
     Settings.loaded.should eq true
     Settings.unload!
@@ -34,7 +44,6 @@ describe Settings do
   end
 
   it 'should properly store settings to DB' do
-    Settings.class_eval { cattr_accessor :loaded }
     Settings.unload!
     Settings.loaded.should eq false
     Settings.temp = '123'