rails-settings-ui 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d63b8dd2f8b21d13584e337a8fcecda9a8f4cdf8cb36fe43c8c820ff4135610
-  data.tar.gz: f5b9e70028d0b94d02f65a6c4d83c1099b0c7d77b1d26461277ab96fbed9070e
+  metadata.gz: 7cf201387248adc25655ab881e32b146940be2c850b604cc0057b4a7bf146183
+  data.tar.gz: 60e18da98e363ff116efa4d5584c10dfa58808d9fe41f5f8159ace32036e38d9
 SHA512:
-  metadata.gz: 898f2698cc54648e70d3f1c36a369779a9c75d49cbc98b442e8d6ee847d2378eeaac81a65b1e427c9ae8cc7837453210842d7ab07949b4b9e91354d5698ac172
-  data.tar.gz: 44dacf721a928326f0108f09be41cff3e1bc3a38c27b4b949024ff1d32656b65f60c2e0eaae94bbea8f6da64c4688649e96a38a69cc82e262eebf3cd99691dff
+  metadata.gz: 17dd3a8f8b71639e620ee06672595f34d99011fdde606f600887b45ac40107519c1e6c0988435d24bc5b78a2954e9ebe44e3c03d3b9ce71f361c2fb92a96f6ef
+  data.tar.gz: ffe3ca3182d6d6d0ea8339b0666df35c009c6b8da7b973080b77fb545411df82ab4a7b5005199e68854c6d74c52dde5a5790f5b59371db60c4024218bd17d4f8

data/Gemfile

@@ -1,8 +1,9 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec
 
 group :development, :test do
-  gem "sqlite3"
-  gem "rails-settings-cached", '0.5.4'
+  gem 'pry'
+  gem 'sqlite3'
+  gem 'rails-settings-cached', '2.8.2'
 end

data/README.md

@@ -1,20 +1,16 @@
 Rails settings UI
 ================================
 
-[![Gem Version](https://badge.fury.io/rb/rails-settings-ui.png)](http://badge.fury.io/rb/rails-settings-ui)
-[![Build Status](https://travis-ci.org/accessd/rails-settings-ui.svg?branch=master)](https://travis-ci.org/accessd/rails-settings-ui)
-[![Code Climate](https://codeclimate.com/github/accessd/rails-settings-ui/badges/gpa.svg)](https://codeclimate.com/github/accessd/rails-settings-ui)
-[![Test Coverage](https://codeclimate.com/github/accessd/rails-settings-ui/badges/coverage.svg)](https://codeclimate.com/github/accessd/rails-settings-ui/coverage)
+[![Gem Version](https://badge.fury.io/rb/rails-settings-ui.svg)](https://rubygems.org/gems/rails-settings-ui)
+[![build](https://github.com/accessd/rails-settings-ui/workflows/build/badge.svg)](https://github.com/accessd/rails-settings-cached/actions?query=workflow%3Abuild)
 
-A Rails Engine to manage your application settings. Includes validation. Compatible with Rails 5.
-It compatible with [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached) gem.
+A Rails Engine to manage your application settings. Includes validation. Compatible with Rails 8.
+It depends on [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached) gem.
 
 Preview:
 
 ![ScreenShot](https://raw.github.com/accessd/rails-settings-ui/master/doc/img/settings-page.png)
 
-Live example: http://rails-settings-ui.herokuapp.com/
-
 How to
 -----
 
@@ -22,16 +18,6 @@ Add to Gemfile
 
     gem 'rails-settings-ui'
 
-then add
-
-    gem 'rails-settings-cached'
-
-or
-
-    gem 'rails-settings'
-
-or your fork of rails-settings.
-
 If you want to use bootstrap interface you need also include bootstrap stylesheets to your app.
 You may use [bootstrap-sass](https://github.com/twbs/bootstrap-sass) gem for that.
 
@@ -115,55 +101,24 @@ if you don't specify labels in locale config, you'll get:
   settings:
     attributes:
       launch_mode:
-        help_block: 'Rocket launch mode'
+        help_block: 'launch mode'
 ```
 
 Validations
 -------------
 
-To validation work is required the default settings in the proper format, eg:
+Validations work based on default value for setting or by explicitly specify type for setting, eg:
 
-For rails-settings-cached up to 0.5.8:
+    class Settings < RailsSettings::Base
+      cache_prefix { "v1" }
 
-    class Settings < RailsSettings::CachedSettings
-      defaults[:company_name] = "Company name"
-      defaults[:head_name] = "Head name"
-      defaults[:manager_premium] = 19
-      defaults[:show_contract_fields] = true
-      defaults[:launch_mode] = [:auto, :manual]
+      field :company_name, type: :string, default: "Company name"
+      field :head_name, default: "Head name"
+      field :manager_premium, default: 19
+      field :show_contract_fields, default: true
+      field :launch_mode, default: [:auto, :manual]
     end
 
-For rails-settings-cached with version >= 0.6.0 default settings moved to YAML config file (config/app.yml), so
-defaults should looks like:
-
-```yaml
-  defaults: &defaults
-    rocket_name: "Foo"
-    limit: 123
-    launch_mode:
-      - auto
-      - manual
-    spaceports:
-      - plesetsk
-      - baikonur
-    style:
-      border_color: 'e0e0e0'
-      block_color: 'ffffff'
-      title:
-        font: "Tahoma"
-        size: "12"
-        color: '107821'
-
-  development:
-    <<: *defaults
-
-  test:
-    <<: *defaults
-
-  production:
-    <<: *defaults
-```
-
 Views
 -------------
 
@@ -192,10 +147,10 @@ Alternatively, to have custom rules just for rails-setting-ui you can:
 
     Rails.application.config.to_prepare do
       RailsSettingsUi::ApplicationController.module_eval do
-        before_filter :check_settings_permissions # for Rails 3
-        before_action :check_settings_permissions # starting from Rails 4
+        before_action :check_settings_permissions
 
         private
+
         def check_settings_permissions
           render status: 403 unless current_user && can_manage_settings?(current_user)
         end

data/app/controllers/rails_settings_ui/settings_controller.rb

@@ -1,16 +1,24 @@
 class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationController
   include RailsSettingsUi::SettingsHelper
   before_action :collection
-  before_action :validate_settings, only: :update_all
+  before_action :cast_settings_params, only: :update_all
 
   def index
   end
 
   def update_all
-    if @errors.any?
+    if @casted_settings[:errors].any?
+      @errors = @casted_settings[:errors]
       render :index
     else
-      coerced_values.each { |name, value| RailsSettingsUi.settings_klass[name] = value }
+      @casted_settings.map do |name, value|
+        next if name == 'errors'
+
+        sc = RailsSettingsUi.setting_config(name)
+        next if sc[:readonly] == true
+
+        RailsSettingsUi.settings_klass.public_send("#{name}=", value)
+      end
       flash[:success] = t('settings.index.settings_saved')
       redirect_to [:settings]
     end
@@ -19,23 +27,19 @@ class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationControll
   private
 
   def collection
-    all_settings_without_ignored = all_settings.reject{ |name, _description| RailsSettingsUi.ignored_settings.include?(name.to_sym) }
+    all_settings_without_ignored = all_settings.reject do |name, _description|
+      RailsSettingsUi.ignored_settings.include?(name.to_sym)
+    end
     @settings = Hash[all_settings_without_ignored]
     @errors = {}
   end
 
-  def validate_settings
-    # validation schema accepts hash (http://dry-rb.org/gems/dry-validation/forms/) so we're converting
-    # ActionController::Parameters => ActiveSupport::HashWithIndifferentAccess
-    @errors = RailsSettingsUi::SettingsFormValidator.new(default_settings, settings_from_params).errors
-  end
-
-  def coerced_values
-    RailsSettingsUi::SettingsFormCoercible.new(default_settings, settings_from_params).coerce!
+  def cast_settings_params
+    @casted_settings = RailsSettingsUi::TypeConverter.cast(settings_from_params)
   end
 
   def settings_from_params
-    settings_params = params['settings'].deep_dup
+    settings_params = params['settings'].deep_dup || {}
     if settings_params.respond_to?(:to_unsafe_h)
       settings_params.to_unsafe_h
     else

data/app/helpers/rails_settings_ui/settings_helper.rb

@@ -70,20 +70,15 @@ module RailsSettingsUi::SettingsHelper
     content_tag(:span, I18n.t("settings.errors.default_missing"), class: "label label-warning")
   end
 
-  def get_collection_method
-    case Rails::VERSION::STRING
-    when /4\.0\.\d+/ || /3\..*/
-      :all
-    else
-      :get_all
-    end
-  end
-
   def default_value_for_setting(setting_name)
     RailsSettingsUi.defaults_for_settings.with_indifferent_access[setting_name.to_sym]
   end
 
   def all_settings
-    RailsSettingsUi.settings_klass.public_send(get_collection_method)
+    stored_settings = RailsSettingsUi.settings_klass.public_send(:all).each_with_object({}) do |s, hsh|
+      hsh[s.var] = s.value
+    end.with_indifferent_access
+
+    stored_settings.merge(RailsSettingsUi.default_settings.merge(stored_settings))
   end
 end

data/config/locales/en.yml

@@ -1,8 +1,7 @@
 en:
   errors:
-    form_hash?: Invalid hash
-    int?: Invalid numeric
-    float?: Invalid numeric
+    invalid_hash: Invalid hash
+    invalid_numeric: Invalid numeric
   settings:
     index:
       title: Settings
@@ -10,6 +9,6 @@ en:
       value: Value
       save_all: Save all
       settings_include_errors: Settings include errors
-      settings_saved: Settings saved succesfully!
+      settings_saved: Settings saved successfully!
     errors:
       default_missing: Default value missing, but exists in db

data/lib/rails-settings-ui/engine.rb

@@ -4,7 +4,6 @@ module ::RailsSettingsUi
 
     config.generators do |g|
       g.test_framework      :rspec,        fixture: false
-      g.fixture_replacement :factory_girl, dir: 'spec/factories'
       g.assets false
       g.helper false
     end

data/lib/rails-settings-ui/settings_form_coercible.rb

@@ -42,10 +42,11 @@ module RailsSettingsUi
     attr_reader :settings, :default_settings
     attr_accessor :coerced_settings
 
+    integer_klass = defined?(Fixnum) ? Fixnum : Integer
     COERCIONS_MAP = {
         String => Types::Coercible::String,
         Symbol => Types::CustomCoercions::Symbol,
-        (1.class == Integer ? Integer : Fixnum) => Types::Params::Integer,
+        integer_klass => Types::Params::Integer,
         ActiveSupport::HashWithIndifferentAccess => Types::CustomCoercions::Hash,
         ActiveSupport::Duration => Types::Params::Integer,
         Float => Types::Params::Float,

data/lib/rails-settings-ui/settings_form_validator.rb

@@ -19,8 +19,9 @@ module RailsSettingsUi
   end
 
   class SettingsFormValidator
+    integer_klass = defined?(Fixnum) ? Fixnum : Integer
     VALIDATABLE_TYPES = {
-      (1.class == Integer ? Integer : Fixnum) => :int?,
+      integer_klass => :int?,
       Float => :float?,
       ActiveSupport::Duration => :int?,
       ActiveSupport::HashWithIndifferentAccess => :form_hash?

data/lib/rails-settings-ui/type_converter.rb

@@ -0,0 +1,79 @@
+require_relative "value_types/string"
+require_relative "value_types/symbol"
+require_relative "value_types/fixnum"
+require_relative "value_types/hash"
+require_relative "value_types/duration"
+require_relative "value_types/float"
+require_relative "value_types/array"
+require_relative "value_types/boolean"
+
+module RailsSettingsUi
+  class UnknownDefaultValueType < StandardError;end
+
+  class TypeConverter
+    integer_klass = defined?(Fixnum) ? Fixnum : Integer
+    VALUE_TYPES_MAP = {
+      String => RailsSettingsUi::ValueTypes::String,
+      Symbol => RailsSettingsUi::ValueTypes::Symbol,
+      integer_klass => RailsSettingsUi::ValueTypes::Fixnum,
+      # ActiveSupport::HashWithIndifferentAccess => RailsSettingsUi::ValueTypes::Hash,
+      ActiveSupport::Duration => RailsSettingsUi::ValueTypes::Float,
+      Float => RailsSettingsUi::ValueTypes::Float,
+      Array => RailsSettingsUi::ValueTypes::Array,
+      FalseClass => RailsSettingsUi::ValueTypes::Boolean,
+      TrueClass => RailsSettingsUi::ValueTypes::Boolean,
+      boolean: RailsSettingsUi::ValueTypes::Boolean,
+      string: RailsSettingsUi::ValueTypes::String,
+      integer: RailsSettingsUi::ValueTypes::Fixnum,
+      float: RailsSettingsUi::ValueTypes::Float,
+      array: RailsSettingsUi::ValueTypes::Array,
+      hash: RailsSettingsUi::ValueTypes::Hash
+    }
+
+    def self.cast(settings)
+      errors = {}
+      settings.each do |name, value|
+        sc = RailsSettingsUi.setting_config(name.to_s)
+        type = setting_value_type(name, value, sc)
+        settings[name] = type.cast
+        if type.errors.any?
+          errors[name.to_sym] = type.errors
+        end
+      end
+      settings = set_non_presented_settings(settings)
+
+      settings[:errors] = errors
+      settings
+    end
+
+    def self.setting_value_type(name, value, setting_config)
+      default_setting_value_type = if setting_config[:type].nil? || setting_config[:type] == :string
+                                     setting_config[:default].class
+                                   else
+                                     setting_config[:type]
+                                   end
+
+      unless VALUE_TYPES_MAP.keys.include?(default_setting_value_type)
+        raise RailsSettingsUi::UnknownDefaultValueType,
+          "Unknown default value type #{default_setting_value_type} for #{name}"
+      end
+
+      # puts "--- #{name}: #{default_setting_value_type} ---"
+      setting_value_type_class = VALUE_TYPES_MAP[default_setting_value_type]
+      setting_value_type_class.new(value)
+    end
+
+    def self.set_non_presented_settings(settings)
+      RailsSettingsUi.default_settings.each do |name, value|
+        if !settings[name.to_sym].present?
+          if [TrueClass, FalseClass].include?(value.class)
+            settings[name.to_sym] = false
+          elsif [Array].include?(value.class)
+            settings[name.to_sym] = []
+          end
+        end
+      end
+      settings
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/array.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Array < RailsSettingsUi::ValueTypes::Base
+      def cast
+        # Array presented in checkboxes
+        if ["Hash", "ActiveSupport::HashWithIndifferentAccess"].include?(value.class.name)
+          value.keys.map!(&:to_sym)
+        elsif value.class.name == 'ActionController::Parameters'
+          value.reject{|_,v| v!='on' }.keys.map!(&:to_sym)
+        # or in select tag
+        else
+          value.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/base.rb

@@ -0,0 +1,30 @@
+module RailsSettingsUi
+  module ValueTypes
+    class Base
+      attr_accessor :value, :errors
+
+      def initialize(value)
+        self.value = value
+        self.errors = []
+        validate
+      end
+
+      def cast
+        raise NotImplementedError
+      end
+
+      def valid?
+        !errors.any?
+      end
+
+      def value_numeric?
+        !value.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/).nil?
+      end
+
+      protected
+
+      def validate
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/boolean.rb

@@ -0,0 +1,16 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Boolean < RailsSettingsUi::ValueTypes::Base
+      def cast
+        case value
+        when 'off'
+          self.value = false
+        else
+          self.value = true
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/duration.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Duration < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_f.seconds
+      end
+
+      def validate
+        unless value_numeric?
+          self.errors << I18n.t('errors.invalid_numeric', default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/fixnum.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Fixnum < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_i
+      end
+
+      def validate
+        unless value_numeric?
+          self.errors << I18n.t('errors.invalid_numeric', default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/float.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Float < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_f
+      end
+
+      def validate
+        unless value_numeric?
+          self.errors << I18n.t('errors.invalid_numeric', default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/hash.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Hash < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value
+      end
+
+      def validate
+        begin
+          self.value = JSON.parse(value.gsub(/\=\>/, ':'))
+        rescue JSON::ParserError => e
+          self.errors << I18n.t('errors.invalid_hash', default: 'Invalid')
+        end
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/string.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class String < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_s
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/value_types/symbol.rb

@@ -0,0 +1,11 @@
+require_relative "base"
+
+module RailsSettingsUi
+  module ValueTypes
+    class Symbol < RailsSettingsUi::ValueTypes::Base
+      def cast
+        value.to_sym
+      end
+    end
+  end
+end

data/lib/rails-settings-ui/version.rb

@@ -1,3 +1,3 @@
 module RailsSettingsUi
-  VERSION = '1.3.5'
+  VERSION = '1.4.0'
 end

data/lib/rails-settings-ui.rb

@@ -3,8 +3,7 @@ require 'rails-settings-ui/engine'
 require 'rails-settings-ui/route_delegator'
 require 'rails-settings-ui/version'
 
-require "rails-settings-ui/settings_form_validator"
-require "rails-settings-ui/settings_form_coercible"
+require "rails-settings-ui/type_converter"
 
 module RailsSettingsUi
   mattr_accessor :parent_controller
@@ -45,12 +44,21 @@ module RailsSettingsUi
       settings_class.constantize
     end
 
+    def setting_config(name)
+      defined_fields = RailsSettingsUi.settings_klass.public_send(:all).defined_fields
+      defined_fields.find { |s| s[:key] == name }
+    end
+
     def default_settings
-      if Gem.loaded_specs['rails-settings-cached'].version.to_s >= '0.6.0'
-        settings = RailsSettings::Default.instance.with_indifferent_access
+      rsc_version = Gem.loaded_specs['rails-settings-cached'].version.to_s
+
+      if rsc_version >= '2.7.0'
+        defined_fields = RailsSettingsUi.settings_klass.public_send(:all).defined_fields
+        settings = defined_fields.each_with_object({}) { |s, hsh| hsh[s[:key]] = s[:default] }.with_indifferent_access
         settings.reject { |name, _description| ignored_settings.include?(name.to_sym) }
       else
-        RailsSettingsUi.settings_klass.defaults
+        settings = RailsSettings::Default.instance.with_indifferent_access
+        settings.reject { |name, _description| ignored_settings.include?(name.to_sym) }
       end
     end
   end

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link application.css
+//= link application.js

data/spec/dummy/app/models/settings.rb

@@ -1,8 +1,12 @@
-class Settings < RailsSettings::CachedSettings
-  defaults[:project_name] = "Dummy"
-  defaults[:limit] = 150
-  defaults[:angle] = 0.5
-  defaults[:style] = {
+class Settings < RailsSettings::Base
+  cache_prefix { "v1" }
+
+  field :project_name, type: :string, default: "Dummy"
+  scope :limits do
+    field :limit, type: :integer, default: 150
+  end
+  field :angle, type: :float, default: 0.5
+  field :style, type: :hash, default: {
     border_color: 'e0e0e0',
     block_color: 'ffffff',
     title: {
@@ -11,10 +15,12 @@ class Settings < RailsSettings::CachedSettings
       color: '107821'
     }
   }
-  defaults[:check_something] = true
-  defaults[:description] = "But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful."
-  defaults[:mode] = [:auto, :manual]
-  defaults[:timer] = 2.hours
-  defaults[:project_status] = :finished
-  defaults[:locale] = [:en, :ru]
+  field :check_something, type: :boolean, default: true
+  field :description, type: :string,
+    default: "But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful."
+  field :mode, type: :array, default: [:auto, :manual]
+  field :timer, default: 2.hours
+  field :project_status, default: :finished
+  field :locale, default: [:en, :ru]
+  field :readonly_item, type: :integer, default: 100, readonly: true
 end

data/spec/dummy/config/application.rb

@@ -1,10 +1,14 @@
 require File.expand_path('../boot', __FILE__)
 
 # Pick the frameworks you want:
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "sprockets/railtie"
+# require "active_record/railtie"
+# require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "sprockets/railtie"
+
+# Workaround for Rails 6 requiring Logger before ActiveSupport modules
+require 'logger'
+require 'rails/all'
 # require "rails/test_unit/railtie"
 
 Bundler.require(*Rails.groups)
@@ -25,4 +29,3 @@ module Dummy
     config.i18n.default_locale = :en
   end
 end
-

data/spec/dummy/config/environments/development.rb

@@ -25,5 +25,5 @@ Dummy::Application.configure do
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
-  config.assets.debug = true
+  # config.assets.debug = true
 end

data/spec/dummy/config/environments/test.rb

@@ -33,4 +33,9 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
+
+  # Allow unsafe YAML loading for tests with Rails >= 6
+  if defined?(ActiveRecord::Base) && ActiveRecord::Base.respond_to?(:use_yaml_unsafe_load=)
+    ActiveRecord::Base.use_yaml_unsafe_load = true
+  end
 end