thecore_settings 1.1.15 → 2.0.2

data/lib/thecore_settings/processing.rb

@@ -0,0 +1,217 @@
+module ThecoreSettings
+  module Processing
+    ThecoreSettings.kinds.each do |dkind|
+      define_method "#{dkind}_kind?" do
+        dkind == kind
+      end
+      define_method "#{dkind}_type?" do
+        dkind == kind
+      end
+    end
+
+    def text_kind?
+      (ThecoreSettings.kinds - ['phone', 'phones', 'integer', 'float', 'yaml', 'json', 'boolean']).include? kind
+    end
+
+    def upload_kind?
+      ['file', 'image'].include? kind
+    end
+
+    def html_kind?
+      ['html', 'code', 'sanitize', 'sanitize_code', 'strip_tags', 'simple_format', 'simple_format_raw', 'sanitized'].include? kind
+    end
+
+    def preprocessed_kind?
+      ['sanitize', 'sanitize_code', 'strip_tags', 'simple_format', 'simple_format_raw', 'sanitized'].include? kind
+    end
+
+    alias_method :text_type?, :text_kind?
+    alias_method :upload_type?, :upload_kind?
+    alias_method :html_type?, :html_kind?
+
+    def value
+      if upload_kind?
+        unless defined?(Shrine)
+          if file?
+            file.url
+          else
+            nil
+          end
+        else
+          file.url if file.present?
+        end
+      elsif raw.blank? || disabled?
+        default_value
+      else
+        processed_value
+      end
+    end
+
+    def blank?
+      if file_kind?
+        file.url.nil?
+      elsif raw.blank? || disabled?
+        true
+      else
+        false
+      end
+    end
+
+    def to_s
+      if yaml_kind? || json_kind? || phone_kind? || integer_kind? || float_kind?
+
+        raw
+      else
+        value
+      end
+    end
+
+    private
+
+    def preprocess_value
+      case kind
+        # just to raise error if not in rails
+        when 'simple_format'
+          require_rails do
+          end
+        when 'simple_format_raw'
+          require_rails do
+          end
+        when 'strip_tags'
+          require_rails do
+            self.raw = ActionController::Base.helpers.strip_tags(raw)
+          end
+        when 'sanitize', 'sanitize_code'
+          require_rails do
+            self.raw = ThecoreSettings.scrubber.sanitize(raw)
+          end
+        when 'sanitized'
+          require_sanitize do
+            self.raw = Sanitize.clean(value, Sanitize::Config::RELAXED)
+          end
+      end
+    end
+
+    def default_value
+      if html_kind?
+        ''.html_safe
+      elsif text_kind?
+        ''
+      elsif integer_kind?
+        0
+      elsif float_kind?
+        0
+      elsif yaml_kind?
+        nil
+      elsif json_kind?
+        nil
+      elsif boolean_kind?
+        false
+      elsif phone_kind?
+        require_russian_phone do
+          RussianPhone::Number.new('')
+        end
+      elsif phones_kind?
+        []
+      else
+        nil
+      end
+    end
+
+    def default_serializable_value
+      if phones_kind?
+        ''
+      elsif boolean_type?
+        'false'
+      else
+        default_value
+      end
+    end
+
+    def process_html_types(text)
+      case kind
+        when 'simple_format'
+          require_rails do
+            text = ActionController::Base.helpers.simple_format(text)
+          end
+        when 'simple_format_raw'
+          require_rails do
+            text = ActionController::Base.helpers.simple_format(text, {}, sanitize: false)
+          end
+      end
+      text
+    end
+
+    def process_text
+      text = raw.dup
+      text.gsub!('{{year}}', Time.now.strftime('%Y'))
+      text.gsub! /\{\{year\|([\d]{4})\}\}/ do
+        if Time.now.strftime('%Y') == $1
+          $1
+        else
+          "#{$1}-#{Time.now.strftime('%Y')}"
+        end
+      end
+      text = process_html_types(text)
+      text = text.html_safe if html_kind?
+      text
+    end
+
+    def load_phone
+      require_russian_phone do
+        RussianPhone::Number.new(raw)
+      end
+    end
+
+    def load_phones
+      require_russian_phone do
+        raw.gsub("\r", '').split("\n").map{|i| RussianPhone::Number.new(i)}
+      end
+    end
+
+    def load_yaml
+      if defined?(Psych) && Psych.respond_to?(:safe_load)
+        Psych.safe_load(raw)
+      else
+        require_safe_yaml do
+          YAML.safe_load(raw)
+        end
+      end
+    end
+
+    def load_json
+      JSON.load(raw)
+    end
+
+    def processed_value
+      if text_kind?
+        process_text
+      elsif integer_kind?
+        raw.to_i
+      elsif float_kind?
+        raw.to_f
+      elsif yaml_kind?
+        load_yaml
+      elsif json_kind?
+        load_json
+      elsif boolean_kind?
+        raw == 'true'
+      elsif phone_kind?
+        load_phone
+      elsif phones_kind?
+        load_phones
+      elsif file_kind?
+        file.url
+      else
+        puts "[thecore_settings] Unknown field kind: #{kind}"
+        nil
+      end
+    end
+
+    def self.included(base)
+      base.class_eval do
+        alias_method :val, :value
+      end
+    end
+  end
+end

data/lib/thecore_settings/rails_admin_config.rb

@@ -0,0 +1,71 @@
+module ThecoreSettings
+  module RailsAdminConfig
+    def self.included(base)
+      if base.respond_to?(:rails_admin)
+        base.rails_admin do
+          navigation_label I18n.t('admin.settings.label')
+          list do
+            if Object.const_defined?('RailsAdminToggleable')
+              field :enabled, :toggle
+            else
+              field :enabled
+            end
+            field :kind
+            field :ns
+            field :name
+            field :raw do
+              pretty_value do
+                if bindings[:object].file_kind? and !defined?(Shrine) and bindings[:object].to_path.present?
+                  if bindings[:object].file.url.blank?
+                    "-"
+                  else
+                    "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'>#{CGI::escapeHTML(bindings[:object].to_path)}</a>".html_safe
+                  end
+                elsif bindings[:object].image_kind? and !defined?(Shrine) and !bindings[:object].file.nil?
+                  if bindings[:object].file.url.blank?
+                    "-"
+                  else
+                    "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'><img src='#{CGI::escapeHTML(bindings[:object].file.url)}' /></a>".html_safe
+                  end
+                else
+                  value
+                end
+              end
+            end
+            if ::Settings.table_exists?
+              nss = ::ThecoreSettings::Setting.pluck(:ns).uniq.map { |c| "ns_#{c.gsub('-', '_')}".to_sym }
+              scopes([nil] + nss)
+            end
+          end
+
+          edit do
+            field :enabled
+            field :label do
+              read_only true
+              help false
+            end
+            field :kind do
+              read_only true
+              help false
+            end
+            field :raw do
+              partial "setting_value"
+              visible do
+                !bindings[:object].upload_kind?
+              end
+            end
+            if Settings.file_uploads_supported
+              field :file, Settings.file_uploads_engine do
+                visible do
+                  bindings[:object].upload_kind?
+                end
+              end
+            end
+          end
+        end
+      else
+        puts "[thecore_settings] Problem: model does not respond to rails_admin: this should not happen"
+      end
+    end
+  end
+end

data/lib/thecore_settings/require_helpers.rb

@@ -0,0 +1,86 @@
+module ThecoreSettings
+  class NoRailsError  < StandardError
+    def initialize(message)
+      @message = message
+    end
+    def to_s
+      @message
+    end
+  end
+
+  module RequireHelpers
+    private
+
+    def require_russian_phone
+      begin
+        require 'russian_phone'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'russian_phone' to use phone settings"
+        raise e
+      end
+    end
+
+    def require_safe_yaml
+      begin
+        require 'safe_yaml'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'safe_yaml' to your Gemfile to use yaml settings"
+        raise e
+      end
+    end
+
+    def require_sanitize
+      begin
+        require 'sanitize'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'sanitize' to your Gemfile to use sanitized settings"
+        raise e
+      end
+    end
+
+    def require_rails
+      if defined?(Rails) &&
+          defined?(ActionController) &&
+          defined?(ActionController::Base) &&
+          !ThecoreSettings.scrubber.nil?
+        yield
+      else
+        raise NoRailsError.new("[thecore_settings] sanitize, simple_format and strip_tags types require Rails, please add this gem after Rails in your Gemfile")
+      end
+    end
+
+    def require_validates_email_format_of
+      begin
+        require 'validates_email_format_of'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'validates_email_format_of' to your Gemfile to use email kind settings"
+        raise e
+      end
+    end
+
+    def require_geocoder
+      begin
+        require 'geocoder'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'validates_email_format_of' to your Gemfile to use email kind settings"
+        raise e
+      end
+    end
+
+    def require_addressable
+      begin
+        require 'addressable/uri'
+        yield
+      rescue LoadError => e
+        e.message << " [thecore_settings] Please add gem 'addressable' to your Gemfile to use url/domain kind settings"
+        raise e
+      end
+    end
+  end
+end
+

data/lib/thecore_settings/settings.rb

@@ -0,0 +1,95 @@
+require 'thread'
+
+# 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
+  @@namespaces = {}
+  @@mutex = ::Mutex.new
+
+  @@ns_default = 'main'
+  @@ns_fallback = nil
+  cattr_accessor :ns_default, :ns_fallback, :namespaces
+
+  cattr_reader :mutex
+
+  class << self
+    def ns(name, options = {})
+      options.symbolize_keys!
+      if name.nil? || name == @@ns_default
+        name = @@ns_default.to_s
+      else
+        name = name.to_s
+      end
+      if options.key?(:type)
+        options[:kind] = options.delete(:type)
+      end
+      @@mutex.synchronize do
+        @@namespaces[name] ||= ::ThecoreSettings::Namespaced.new(name.to_s)
+      end
+      fallback = options.key?(:fallback) ? options[:fallback] : @@ns_fallback
+      ::ThecoreSettings::Fallback.new(@@namespaces[name], fallback)
+    end
+
+    def get_default_ns
+      ns(nil, fallback: @@ns_fallback)
+    end
+
+    def table_exists?
+      ThecoreSettings.mongoid? || ThecoreSettings::Setting.table_exists?
+    rescue ActiveRecord::NoDatabaseError
+      false
+    end
+
+    def unload!
+      @@mutex.synchronize do
+        @@namespaces.values.map(&:unload!)
+        @@namespaces = {}
+        @@ns_default = 'main'
+        @@ns_fallback = nil
+      end
+    end
+
+    def destroy_all!
+      ThecoreSettings::Setting.destroy_all
+      unload!
+    end
+
+    def root_file_path
+      if defined?(Rails)
+        Rails.root
+      else
+        Pathname.new(File.dirname(__FILE__)).join('../..')
+      end
+    end
+
+    def apply_defaults!(file, verbose = false)
+      ThecoreSettings.apply_defaults!(file, verbose)
+    end
+
+    def get(key, options = {})
+      options.symbolize_keys!
+      ns(options[:ns], options).get(key, options)
+    end
+
+    def set(key, value = nil, options = {})
+      options.symbolize_keys!
+      ns(options[:ns], options).set(key, value, options)
+    end
+
+    def save_default(key, value, options = {})
+      set(key, value, options.merge(overwrite: false))
+    end
+
+    def create_setting(key, value, options = {})
+      set(key, nil, options.merge(overwrite: false))
+    end
+
+    def method_missing(*args)
+      get_default_ns.__send__(*args)
+    end
+  end
+end
+