rails_admin_settings 0.1.0 → 0.2.0

data/README.md

@@ -12,6 +12,7 @@ Pull request with AR support will be welcome
 - Lazy loading - loads settings only if they are needed during request
 - Loads all settings at once and caches them for the duration of request
 - Supports lots of setting types - yaml, html with ckeditor, phone numbers etc
+- Each setting can be enabled and disabled within rails_admin, if it's disabled it returns default value for type
 
 ## Installation
 
@@ -27,6 +28,7 @@ Add this line to your application's Gemfile:
 - Put it after russian_phone to get built-in support
 - Put it after sanitized to get built-in support
 - Put it after safe_yaml to get built-in support
+- Put it after validates_email_format_of to get built-in support
 
 And then execute:
 
@@ -46,6 +48,7 @@ Or install it yourself as:
 
     Settings.content_block_1(mode: 'html', default: 'test')
     Settings.data(mode: 'yaml')
+    Settings.enabled?(:data, type: 'phone') # also creates setting if it doesn't exist
     Settings.data = [1, 2, 3]
 
 See more here: https://github.com/rs-pro/rails_admin_settings/blob/master/spec/advanced_usage_spec.rb
@@ -57,10 +60,12 @@ Supported types:
     string (input)
     text (textarea)
     html (supports Rich, glebtv-ckeditor, ckeditor, but does not require any of them)
+    sanitized (requires sanitize -- sanitizes HTML before saving to DB [Warning: uses RELAXED config!])
     integer (stored as string)
     yaml (requires safe_yaml)
     phone (requires russian_phone)
-    sanitized (requires sanitize)
+    email (requires validates_email_format_of)
+
 
 Strings and html support following replacement patterns:
 

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

@@ -1,4 +1,4 @@
-- if @object.type == 'string' || @object.type == 'integer'
+- if ['string', 'integer', 'phone', 'email', 'address'].include?(@object.type)
   = form.text_field :raw, :value => field.value
 - elsif @object.type == 'text' || @object.type == 'yaml'
   = form.text_area :raw, :value => field.value, :rows => 10, :cols => 80

data/config/locales/ru.rails_admin_settings.yml

@@ -4,6 +4,7 @@ ru:
       label: 'Настройки'
       no_ckeditor_detected: CKEditor не обнаружен — отображаю настройку как текстовое поле
       phone_invalid: Неверный телефонный номер
+      email_invalid: Неверный email
       yaml_invalid: Неверный синтаксис YAML
   mongoid:
     models:

data/lib/rails_admin_settings/processing.rb

@@ -1,7 +1,7 @@
 module RailsAdminSettings
   module Processing
     def text_type?
-      ['string', 'html', 'sanitized'].include? type
+      ['string', 'html', 'sanitized', 'email'].include? type
     end
 
     def html_type?
@@ -16,10 +16,18 @@ module RailsAdminSettings
       'yaml' == type
     end
 
+    def email_type?
+      'email' == type
+    end
+
     def phone_type?
       'phone' == type
     end
 
+    def address_type?
+      'address' == type
+    end
+
     def sanitized_type?
       'sanitized' == type
     end
@@ -59,7 +67,7 @@ module RailsAdminSettings
         nil
       elsif phone_type?
         require_russian_phone do
-          RussianPhone::Number.new('(000) 000-00-00')
+          RussianPhone::Number.new('')
         end
       else
         nil

data/lib/rails_admin_settings/rails_admin_config.rb

@@ -1,7 +1,7 @@
 module RailsAdminSettings
   module RailsAdminConfig
     def self.included(base)
-      rails_admin do
+      base.rails_admin do
         navigation_label t('admin.settings.label')
 
         object_label_method do

data/lib/rails_admin_settings/require_helpers.rb

@@ -27,7 +27,27 @@ module RailsAdminSettings
         require 'sanitize'
         yield
       rescue LoadError => e
-        e.message << " [rails_admin_settings] Please install sanitize to use sanitized settings"
+        e.message << " [rails_admin_settings] Please add gem 'sanitize' to your Gemfile to use sanitized settings"
+        raise e
+      end
+    end
+
+    def require_validates_email_format_of
+      begin
+        require 'validates_email_format_of'
+        yield
+      rescue LoadError => e
+        e.message << " [rails_admin_settings] Please add gem 'validates_email_format_of' to your Gemfile to use email type settings"
+        raise e
+      end
+    end
+
+    def require_geocoder
+      begin
+        require 'geocoder'
+        yield
+      rescue LoadError => e
+        e.message << " [rails_admin_settings] Please add gem 'geocoder' to your Gemfile to use address type settings"
         raise e
       end
     end

data/lib/rails_admin_settings/setting.rb

@@ -4,6 +4,8 @@ module RailsAdminSettings
     include ::Mongoid::Document
     include ::Mongoid::Timestamps::Short
 
+    store_in collection: "rails_admin_settings"
+
     if Object.const_defined?('Mongoid') && Mongoid.const_defined?('Audit')
       include ::Mongoid::Audit::Trackable
       track_history track_create: true, track_destroy: true

data/lib/rails_admin_settings/settings.rb

@@ -53,6 +53,10 @@ class Settings
       end
     end
 
+    def enabled?(key, options = {})
+      get(key, options).enabled?
+    end
+
     # returns setting object
     def get(key, options = {})
       load!

data/lib/rails_admin_settings/types.rb

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

data/lib/rails_admin_settings/validation.rb

@@ -11,16 +11,36 @@ module RailsAdminSettings
 
       base.validate if: :phone_type? do
         require_russian_phone do
-          errors.add(:raw, t('admin.settings.phone_invalid')) if RussianPhone::Number.new(:raw).valid?
+          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
+
+      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: :yaml_type? do
         require_safe_yaml do
           unless raw.blank?
             begin
               YAML.safe_load(raw)
             rescue Psych::SyntaxError => e
-              errors.add(:raw, t('admin.settings.yaml_invalid'))
+              errors.add(:raw, I18n.t('admin.settings.yaml_invalid'))
             end
           end
         end

data/lib/rails_admin_settings/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminSettings
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/advanced_usage_spec.rb

@@ -48,10 +48,12 @@ describe 'Settings advanced usage' do
 
     Settings.get(:tphone).val.city.should eq '906'
     Settings.get(:tphone).val.formatted_subscriber.should eq '111-11-11'
+  end
 
+  it 'should set defaults for phone type' do
     Settings.dphone(type: 'phone')
 
-    Settings.dphone.city.should eq '000'
-    Settings.dphone.formatted_subscriber.should eq '000-00-00'
+    Settings.dphone.formatted_area.should eq ''
+    Settings.dphone.formatted_subscriber.should eq ''
   end
 end

data/spec/settings_spec.rb

@@ -35,4 +35,9 @@ describe Settings do
     YAML.safe_load(Settings.get(:tdata).raw).should eq ['one', 'two', 'three']
     Settings.tdata.should eq ['one', 'two', 'three']
   end
+
+  it '#enabled? sets defaults' do
+    Settings.enabled?(:phone, type: 'phone').should eq true
+    Settings.get(:phone).type.should eq 'phone'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -239,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2035061184471093913
+      hash: 1852916835368037287
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -248,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2035061184471093913
+      hash: 1852916835368037287
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25