thecore_settings 1.1.15 → 2.0.2

data/lib/thecore_settings/storage/carrier_wave_uploader.rb

@@ -0,0 +1,9 @@
+module ThecoreSettings
+  module Uploads
+    class CarrierWaveUploader < 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/thecore_settings/storage/shrine_uploader.rb

@@ -0,0 +1,14 @@
+module ThecoreSettings
+  module Uploads
+    class ShrineUploader < Shrine
+        plugin :determine_mime_type
+        plugin :validation_helpers
+        plugin :mongoid if ThecoreSettings.mongoid?
+        Attacher.validate do
+          validate_mime_type_inclusion %w[image/jpeg image/gif image/png]
+          validate_max_size 2.megabytes
+        end
+      end
+
+    end
+  end

data/lib/thecore_settings/tasks.rb

@@ -0,0 +1,35 @@
+# 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; use rake settings:dump[production] to create env-specific template"
+  task :dump, [:as_env] => ['settings:require'] do |t, args|
+    if args.empty? || args[:as_env].blank?
+      path = Settings.root_file_path.join('config/settings.yml')
+    else
+      path = Settings.root_file_path.join("config/settings.#{args[:as_env]}.yml")
+    end
+    ThecoreSettings::Dumper.dump(path)
+    puts "dumped settings to #{path}"
+  end
+
+  desc "Load settings from config/settings.yml without overwriting current values"
+  task :load => ['settings:require'] do
+    Settings.apply_defaults!(Rails.root.join("config/settings.#{Rails.env.to_s}.yml"), true)
+    Settings.apply_defaults!(Rails.root.join('config/settings.yml'), true)
+  end
+
+  desc "Delete all settings"
+  task :delete => ['settings:require'] do
+    Settings.destroy_all!
+  end
+end

data/lib/thecore_settings/uploads.rb

@@ -0,0 +1,57 @@
+module ThecoreSettings
+  module Uploads
+    autoload :CarrierWaveUploader, "thecore_settings/storage/carrier_wave_uploader"
+    autoload :ShrineUploader, "thecore_settings/storage/shrine_uploader"
+
+    def self.paperclip_options
+      if defined?(Rails)
+        {}
+      else
+        {path: "#{File.dirname(__FILE__)}/../../uploads/:filename", url: '/uploads/:filename'}
+      end
+    end
+
+    def self.included(base)
+      # carrierwave
+      if base.respond_to?(:mount_uploader)
+        # puts "[thecore_settings] CarrierWave detected"
+        # base.field(:file, type: String)
+        base.mount_uploader(:file, ThecoreSettings::Uploads::CarrierWaveUploader)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :carrierwave
+      # mongoid-paperclip
+      elsif ThecoreSettings.mongoid? && ::Mongoid.const_defined?('Paperclip')
+        base.send(:include, ::Mongoid::Paperclip)
+        # puts "[thecore_settings] PaperClip detected"
+        base.field(:file, type: String)
+        base.has_mongoid_attached_file(:file, self.paperclip_options)
+        if base.respond_to?(:do_not_validate_attachment_file_type)
+          base.do_not_validate_attachment_file_type :file
+        end
+
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :paperclip
+      elsif ThecoreSettings.active_record? && defined?(Paperclip)
+        base.has_attached_file(:file, self.paperclip_options)
+        if base.respond_to?(:do_not_validate_attachment_file_type)
+          base.do_not_validate_attachment_file_type :file
+        end
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :paperclip
+      elsif ThecoreSettings.active_record? && defined?(Shrine)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :shrine
+        base.send(:include, ShrineUploader::Attachment(:file))
+      elsif ThecoreSettings.mongoid? && ::Mongoid.const_defined?('Shrine')
+        base.send(:include, ::Mongoid::Document)
+        base.send(:include, ShrineUploader::Attachment(:file))
+        base.field(:file_data, type: String)
+        Settings.file_uploads_supported = true
+        Settings.file_uploads_engine = :shrine
+      else
+        # puts "[thecore_settings] Uploads disabled"
+      end
+    end
+  end
+end
+

data/lib/thecore_settings/validation.rb

@@ -0,0 +1,126 @@
+module ThecoreSettings
+  module Validation
+    class << self
+      def included(base)
+        base.before_validation do
+          self.raw = default_serializable_value if raw.blank?
+        end
+        base.before_validation :preprocess_value, if: :preprocessed_kind?
+        base.validates_uniqueness_of :key, scope: :ns
+        base.validates_inclusion_of :kind, in: ThecoreSettings.kinds
+        base.validates_numericality_of :raw, if: :integer_kind?
+        base.validates_numericality_of :raw, if: :float_kind?
+
+        add_validators(base)
+      end
+
+      def add_validators(base)
+        add_color_validator(base)
+        add_file_validator(base)
+        add_email_validator(base)
+        add_url_validator(base)
+        add_phone_validator(base)
+        add_geo_validator(base)
+        add_yaml_validator(base)
+        add_json_validator(base)
+      end
+
+      def add_color_validator(base)
+        base.validates_with(ThecoreSettings::HexColorValidator, attributes: :raw, if: :color_kind?)
+      end
+
+      def add_file_validator(base)
+        base.validate if: :file_kind? do
+          unless Settings.file_uploads_supported
+            raise '[thecore_settings] File kind requires either CarrierWave or Paperclip or Shrine. Check that thecore_settings is below them in Gemfile'
+          end
+        end
+      end
+
+      def add_email_validator(base)
+        base.validate if: :email_kind? 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
+      end
+
+      def add_url_validator(base)
+        base.before_validation if: :url_kind? do
+          require_addressable do
+            self.raw = Addressable::URI.heuristic_parse(self.raw) unless self.raw.blank?
+          end
+        end
+
+        base.before_validation if: :domain_kind? do
+          require_addressable do
+            self.raw = Addressable::URI.heuristic_parse(self.raw).host unless self.raw.blank?
+          end
+        end
+      end
+
+      def add_phone_validator(base)
+        base.validate if: :phone_kind? 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: :phones_kind? do
+          require_russian_phone do
+            unless raw.blank?
+              invalid_phones = raw.gsub("\r", '').split("\n").inject([]) do |memo, value|
+                memo << value unless RussianPhone::Number.new(value).valid?
+                memo
+              end
+              errors.add(:raw, I18n.t('admin.settings.phones_invalid', phones: invalid_phones * ', ')) unless invalid_phones.empty?
+            end
+          end
+        end
+
+      end
+
+      def add_geo_validator(base)
+        base.validate if: :address_kind? do
+          require_geocoder do
+            # just raise error if we are trying to use address kind without geocoder
+          end
+        end
+        if Object.const_defined?('Geocoder')
+          if ThecoreSettings.mongoid?
+            base.field(:coordinates, type: Array)
+            base.send(:include, Geocoder::Model::Mongoid)
+          end
+          base.geocoded_by(:raw)
+          base.after_validation(:geocode, if: :address_kind?)
+        end
+      end
+
+      def add_yaml_validator(base)
+        base.validate if: :yaml_kind? 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
+
+      def add_json_validator(base)
+        base.validate if: :json_kind? do
+          unless raw.blank?
+            begin
+              JSON.load(raw)
+            rescue JSON::ParserError => e
+              errors.add(:raw, I18n.t('admin.settings.json_invalid'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thecore_settings/version.rb

@@ -1,3 +1,3 @@
 module ThecoreSettings
-  VERSION = '1.1.15'.freeze
+  VERSION = "#{`git describe --tags $(git rev-list --tags --max-count=1)`.chomp}"
 end

data/lib/thecore_settings.rb

@@ -1,127 +1,119 @@
-require "thecore_settings/engine"
-#require "rich"
-require "russian_phone"
-require "sanitize"
-require "safe_yaml"
-require "validates_email_format_of"
-require "geocoder"
-require "paperclip"
-require "addressable"
-require "rails_admin_settings"
+require "thecore_settings/version"
 
 module ThecoreSettings
-  # Your code goes here...
-  SafeYAML::OPTIONS[:default_mode] = :safe
-  SafeYAML::OPTIONS[:deserialize_symbols] = false
-  #
-  # if Object.const_defined?("Rich")
-  #   Rich.setup do |config|
-  #
-  #     # == CKEditor configuration
-  #     #
-  #     # Rich ships with what I hope are sensible defaults.
-  #     # You may want to override these.
-  #     #
-  #     # For example, the elements available in the formats
-  #     # dropdown are defined like this:
-  #     #   config.editor[:format_tags] = "h3;p;pre"
-  #     #
-  #     # By default, Rich visualizes what type of element
-  #     # you are editing. To disable this:
-  #     #   config.editor[:startupOutlineBlocks] = false
-  #
-  #
-  #     # == Image styles
-  #     #
-  #     # Rich uses paperclip for image processing. You can
-  #     # define the styles you would like to use here. You
-  #     # can use the standard syntax allowed by paperclip.
-  #     # See: https://github.com/thoughtbot/paperclip/wiki/Thumbnail-Generation
-  #     #
-  #     # When you change these after uploading some files,
-  #     # remember to re-generate your styles by running:
-  #     #   rake rich:refresh_assets
-  #     config.image_styles = {
-  #       :thumb => "100x100#"
-  #     }
-  #
-  #     # == Convert options
-  #     #
-  #     # You can pass additional commands to ImageMagick to set image quality,
-  #     # apply a blur, and other fancy tricks.
-  #     #
-  #     # Example (this will make your image look terrible):
-  #     # config.convert_options = {
-  #     #     :large => '-quality 1'
-  #     # }
-  #
-  #     # == Allowed styles (in file manager)
-  #     #
-  #     # Of the styles specified above, which should be user
-  #     # selectable in the file manager?
-  #     #
-  #     # Example:
-  #     #   config.allowed_styles = [ :large, :thumb ]
-  #     #
-  #     # Default:
-  #     # config.allowed_styles = :all
-  #
-  #     # == Default Style
-  #     #
-  #     # The style to insert by default. In addition to the
-  #     # styles defined above you can also use :original to get
-  #     # the unprocessed file. Make sure this style exists.
-  #     config.default_style = :thumb
-  #
-  # 	# == Upload non-image files
-  # 	#
-  # 	# Setting this option to true will add a second Rich filebrowser icon to
-  # 	# the editor toolbar. In this filebrowser you can upload non-image files.
-  # 	# Inserting these files into your editor will result in a direct (A) link.
-  # 	#
-  # 	# Default:
-  # 	# config.allow_document_uploads = false
-  #
-  # 	# == Set allowed filetypes for non-image files
-  # 	#
-  # 	# If you want, you can restrict the types of documents that users can upload.
-  # 	# Default behavior is to allow any kind of file to be uploaded. You can set
-  # 	# the accepted types by providing an array of mimetypes to check against.
-  # 	# Note that for this to have any effect, you first need to enable document
-  # 	# uploads using the setting above.
-  # 	#
-  # 	# Default, allow any file to be uploaded:
-  # 	# config.allowed_document_types = :all
-  # 	#
-  # 	# Example, only allow PDF uploads:
-  # 	# config.allowed_document_types = ['application/pdf']
-  #
-  # 	# == Asset insertion
-  # 	#
-  # 	# Set this to true to keep the filebrowser open after inserting an asset.
-  # 	# Also configurable per-use from within the filebrowser.
-  # 	#
-  # 	# Default:
-  # 	# config.insert_many = false
-  #
-  #     # == User Authentication
-  #     #
-  #     # When defined, Rich will automatically call this method
-  #     # in a before filter to ensure that the user is logged in.
-  #     #
-  #     # If you do not change this value from the default, anyone
-  #     # will be able to see your images, and upload files.
-  #     #
-  #     # Example for Devise with an AdminUser model:
-  #     #   config.authentication_method = :authenticate_admin_user!
-  #     #
-  #     # Default (NOT recommended in production environments):
-  #     # config.authentication_method = :none
-  #     config.authentication_method = :authenticate_user!
-  #
-  #   end
-  #
-  #   Rich.insert
-  # end
+  if defined?(Rails) && defined?(Rails::Html) && defined?(Rails::Html::WhiteListSanitizer)
+    @@scrubber = Rails::Html::WhiteListSanitizer.new
+  end
+  cattr_accessor :scrubber
 
+  class PersistenceException < Exception
+  end
+
+  autoload :Mongoid,           "thecore_settings/mongoid"
+  autoload :Fallback,          "thecore_settings/fallback"
+  autoload :Namespaced,        "thecore_settings/namespaced"
+  autoload :Processing,        "thecore_settings/processing"
+  autoload :Validation,        "thecore_settings/validation"
+  autoload :RequireHelpers,    "thecore_settings/require_helpers"
+  autoload :RailsAdminConfig,  "thecore_settings/rails_admin_config"
+  autoload :Uploads,           "thecore_settings/uploads"
+  autoload :HexColorValidator, "thecore_settings/hex_color_validator"
+  autoload :Dumper,            "thecore_settings/dumper"
+
+  class << self
+    def orm
+      if defined?(::Mongoid)
+        :mongoid
+      else
+        :active_record
+      end
+    end
+
+    def mongoid?
+      orm == :mongoid
+    end
+
+    def active_record?
+      orm == :active_record
+    end
+
+    def apply_defaults!(file, verbose = false)
+      if File.file?(file)
+        puts "[settings] Loading from #{file}" if verbose
+        if defined?(Psych) && Psych.respond_to?(:safe_load)
+          yaml = Psych.safe_load(File.read(file))
+        else
+          yaml = YAML.load(File.read(file), safe: true)
+        end
+        yaml.each_pair do |namespace, vals|
+          process_defaults(namespace, vals, verbose)
+        end
+      end
+    end
+
+    def process_defaults(namespace, vals, verbose = false)
+      vals.symbolize_keys!
+      n = Settings.ns(namespace)
+      vals.each_pair do |key, val|
+        val.symbolize_keys!
+        if !val[:kind].nil? && (val[:kind] == 'file' || val[:kind] == 'image')
+          unless Settings.file_uploads_supported
+            raise PersistenceException, "Fatal: setting #{key} is #{val[:type]} but file upload engine is not detected"
+          end
+          value = File.open(Settings.root_file_path.join(val.delete(:value)))
+        else
+          value = val.delete(:value)
+        end
+        puts "#{key} - default '#{value}' current '#{Settings.get(key).raw}'" if verbose
+        n.set(key, value, val.merge(overwrite: false))
+      end
+      n.unload!
+    end
+
+    def migrate!
+      if ThecoreSettings.mongoid?
+        ThecoreSettings::Setting.where(:ns.exists => false).update_all(ns: 'main')
+        ThecoreSettings::Setting.all.each do |s|
+          s.kind = s.read_attribute(:type) if !s.read_attribute(:type).blank? && s.kind != s.read_attribute(:type)
+          s.save! if s.changed?
+          s.unset(:type)
+        end
+      else
+        if Settings.table_exists?
+          ThecoreSettings::Setting.where("ns IS NULL").update_all(ns: 'main')
+        end
+      end
+    end
+
+    def track_history!
+      return false unless Settings.table_exists?
+
+      if mongoid?
+        if ::Mongoid.const_defined?('History')
+          ThecoreSettings::Setting.send(:include, ::Mongoid::History::Trackable)
+          ThecoreSettings::Setting.send(:track_history, {track_create: true, track_destroy: true})
+        else
+          puts "[thecore_settings] WARN unable to track_history: Mongoid::History not loaded!"
+        end
+        if ::Mongoid.const_defined?('Userstamp')
+          ThecoreSettings::Setting.send(:include, ::Mongoid::Userstamp)
+        else
+          puts "[thecore_settings] WARN unable to track_history: Mongoid::Userstamp not loaded!"
+        end
+      elsif active_record?
+        if defined?(PaperTrail) && PaperTrail::Version.table_exists?
+          ThecoreSettings::Setting.send(:has_paper_trail)
+        end
+      end
+    end
+  end
+end
+
+require "thecore_settings/kinds"
+require "thecore_settings/settings"
+
+if Object.const_defined?('Rails')
+  require "thecore_settings/engine"
+else
+  require File.dirname(__FILE__) + '/../app/models/thecore_settings/setting.rb'
 end