RubyGems - rails-settings-ui - Versions diffs - 0.5.0 → 1.0.0 - Mend

rails-settings-ui 0.5.0 → 1.0.0

Files changed (95) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc72755cf22a10415d58b3854758ea9b01af316e
-  data.tar.gz: 77a112f4085d266714e08ddcb1348998db01d11e
+  metadata.gz: bab5e19fe5e850b631020ca8ccfc9ff8cba996ec
+  data.tar.gz: 9e384e854a1b3c4c629e0e87a7f9aa762d63faae
 SHA512:
-  metadata.gz: 987c8bafcca25d32509aec2de3f6f57b18ef12f35038bab3d0e8fde4c9d0e29447db29735196de32f3f6cda5f9ee33bd4909f59079121fde9b2291a9115c64ae
-  data.tar.gz: 2cec2721aed657dd43a150adc1087e9cdbb34d5b5c90b2371ee9c998a74e0e0810d8d74a9ddab979326900c7f76b19aced1c9e13248bd9b9504b82b4dd0381fa
+  metadata.gz: ece5120593fd281428c267140d2d5bd3cd41e2bc98662d578b6b05e97e6da1e47afe4e7c38b17885e96b7aa53faf7f9e26375d6f35e5fcc1a437afd3198b15e9
+  data.tar.gz: c9d3fb1f08061341d93975810b5a327f28591159d468be439c71721d3213f28b07f9a260a13c9a9551f0aa2460aa671a4d67747674eafa4de14e152bbda4241d

data/Gemfile CHANGED Viewed

@@ -5,5 +5,4 @@ gemspec
 group :development, :test do
   gem "sqlite3"
   gem "rails-settings-cached"
-  gem "haml-rails"
 end

data/app/controllers/rails_settings_ui/settings_controller.rb CHANGED Viewed

@@ -1,16 +1,16 @@
 class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationController
   include RailsSettingsUi::SettingsHelper
   before_filter :collection
-  before_filter :cast_settings_params, only: :update_all
+  before_filter :validate_settings, only: :update_all
   def index
   end
   def update_all
-    if @casted_settings[:errors].any?
+    if @errors.any?
       render :index
     else
-      @casted_settings.map { |setting| RailsSettingsUi.settings_klass[setting[0]] = setting[1] if setting[0] != "errors" }
+      coerced_values.each { |name, value| RailsSettingsUi.settings_klass[name] = value }
       redirect_to [:settings]
     end
   end
@@ -18,12 +18,21 @@ class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationControll
   private
   def collection
-    all_settings = RailsSettingsUi.settings_klass.defaults.merge(RailsSettingsUi.settings_klass.public_send(get_collection_method))
+    all_settings = default_settings.merge(RailsSettingsUi.settings_klass.public_send(get_collection_method))
     all_settings_without_ignored = all_settings.reject{ |name, description| RailsSettingsUi.ignored_settings.include?(name.to_sym) }
     @settings = Hash[all_settings_without_ignored]
+    @errors = {}
   end
-  def cast_settings_params
-    @casted_settings = RailsSettingsUi::TypeConverter.cast(params["settings"])
+  def validate_settings
+    @errors = RailsSettingsUi::SettingsFormValidator.new(default_settings, params['settings'].deep_dup).errors
+  end
+  def coerced_values
+    RailsSettingsUi::SettingsFormCoercible.new(default_settings, params['settings'].deep_dup).coerce!
+  end
+  def default_settings
+    RailsSettingsUi.settings_klass.defaults
   end
 end

data/app/helpers/rails_settings_ui/settings_helper.rb CHANGED Viewed

@@ -14,7 +14,7 @@ module RailsSettingsUi::SettingsHelper
   end
   def select_tag_field(setting_name, setting_value)
-    default_setting_values = I18n.t("settings.attributes.#{setting_name}.labels", default: {}).map do |label, value|
+    default_setting_values = I18n.t("settings.attributes.#{setting_name}.labels", default: {}).map do |value, label|
       [label, value]
     end
     select_tag("settings[#{setting_name.to_s}]", options_for_select(default_setting_values, setting_value), class: 'form-control')

data/app/views/layouts/rails_settings_ui/application.html.erb ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <title>Rails settings</title>
+    <meta charset="utf-8"/>
+    <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"/>
+    <meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport"/>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div class="container">
+      <div class="navbar navbar-default">
+        <div class="container-fluid">
+          <div class="navbar-header">
+            <a class="navbar-brand" href="/">Rails settings ui</a>
+          </div>
+        </div>
+      </div>
+      <div class="row">
+        <%= yield %>
+      </div>
+      <footer></footer>
+    </div>
+  </body>
+</html>

data/app/views/rails_settings_ui/settings/index.html.erb ADDED Viewed

@@ -0,0 +1,45 @@
+<ol class="breadcrumb">
+  <li class="active">
+    <%= t('settings.index.title') %>
+  </li>
+</ol>
+<% if @casted_settings && @casted_settings[:errors].any? %>
+  <div class="alert alert-danger">
+    <%= t('settings.index.settings_include_errors') %>
+  </div>
+<% end %>
+<%= form_tag [:update_all], method: :put, class: 'form' do %>
+  <table class="table table-striped">
+    <thead>
+      <tr>
+        <th>
+          <%= t('settings.index.description') %>
+        </th>
+        <th>
+          <%= t('settings.index.value') %>
+        </th>
+      </tr>
+    </thead>
+    <tbody>
+    <% @settings.each do |name, value| %>
+      <% errors = @errors.has_key?(name.to_sym) ? @errors[name.to_sym].join(', ') : nil %>
+      <tr data-name="<%= name %>">
+        <td>
+          <%= I18n.t("settings.attributes.#{name}.name") %>
+        </td>
+        <td class="setting-value">
+          <% setting_with_error = @casted_settings && @casted_settings[:errors].include?(name) %>
+          <div class="form-group <%= errors ? 'has-error' : '' %>">
+            <%= setting_field(name, value, @settings) %>
+            <span class="help-block">
+              <%= errors %>
+            </span>
+          </div>
+        </td>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+  <%= submit_tag t('settings.index.save_all'), class: 'btn btn-primary btn-lg' %>
+<% end %>

data/config/locales/en.yml CHANGED Viewed

@@ -1,4 +1,8 @@
 en:
+  errors:
+    form_hash?: Invalid hash
+    int?: Invalid numeric
+    float?: Invalid numeric
   settings:
     index:
       title: Settings
@@ -7,6 +11,4 @@ en:
       save_all: Save all
       settings_include_errors: Settings include errors
     errors:
-      invalid_numeric: Invalid numeric
-      invalid_hash: Invalid hash
       default_missing: Default value missing, but exists in db

data/config/locales/ru.yml CHANGED Viewed

@@ -1,4 +1,8 @@
 ru:
+  errors:
+    form_hash?: Невалидный хэш
+    int?: Невалидный формат числа
+    float?: Невалидный формат числа
   settings:
     index:
       title: Настройки

data/config/locales/zh-CN.yml CHANGED Viewed

@@ -1,4 +1,8 @@
 zh-CN:
+  errors:
+    form_hash?: 无效的 hash
+    int?: 无效的数字
+    float?: 无效的数字
   settings:
     index:
       title: 设置
@@ -7,6 +11,4 @@ zh-CN:
       save_all: 全部保存
       settings_include_errors: 设置含有错误
     errors:
-      invalid_numeric: 无效的数字
-      invalid_hash: 无效的 hash
       default_missing: 数据库中包含此项，但没找到默认值設定

data/config/locales/zh-TW.yml CHANGED Viewed

@@ -1,4 +1,8 @@
 zh-TW:
+  errors:
+    form_hash?: 無效的 hash
+    int?: 無效的數字
+    float?: 無效的數字
   settings:
     index:
       title: 設置
@@ -7,6 +11,4 @@ zh-TW:
       save_all: 全部保存
       settings_include_errors: 設置包含錯誤
     errors:
-      invalid_numeric: 無效的數字
-      invalid_hash: 無效的 hash
       default_missing: 數據庫中包含此項，但沒有找到默認值設定

data/lib/rails-settings-ui.rb CHANGED Viewed

@@ -3,7 +3,8 @@ require 'rails-settings-ui/engine'
 require 'rails-settings-ui/main_app_route_delegator'
 require 'rails-settings-ui/version'
-require "rails-settings-ui/type_converter"
+require "rails-settings-ui/settings_form_validator"
+require "rails-settings-ui/settings_form_coercible"
 module RailsSettingsUi
   mattr_accessor :parent_controller

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

@@ -1,5 +1,3 @@
-require 'haml-rails'
 module ::RailsSettingsUi
   class Engine < Rails::Engine
     isolate_namespace RailsSettingsUi

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

@@ -0,0 +1,91 @@
+require 'dry-types'
+module RailsSettingsUi
+  module Types
+    include Dry::Types.module
+    module CustomCoercions
+      class Symbol
+        def self.[](value)
+          value.to_sym
+        end
+      end
+      class Hash
+        def self.[](value)
+          JSON.parse(value.gsub(/\=\>/, ':'))
+        end
+      end
+      class Array
+        def self.[](value)
+          # array presented in checkboxes
+          case value.class.name
+          when 'Hash', 'ActiveSupport::HashWithIndifferentAccess'
+            value.keys.map!(&:to_sym)
+          when 'ActionController::Parameters'
+            value.select{ |_,v| v == 'on' }.keys.map!(&:to_sym)
+          else
+            # or in select tag
+            value.to_sym
+          end
+        end
+      end
+    end
+  end
+  class NotCoercibleError < StandardError;end
+  class SettingsFormCoercible
+    attr_reader :settings, :default_settings
+    attr_accessor :coerced_settings
+    COERCIONS_MAP = {
+        String => Types::Coercible::String,
+        Symbol => Types::CustomCoercions::Symbol,
+        Fixnum => Types::Form::Int,
+        ActiveSupport::HashWithIndifferentAccess => Types::CustomCoercions::Hash,
+        ActiveSupport::Duration => Types::Form::Int,
+        Float => Types::Form::Float,
+        Array => Types::CustomCoercions::Array,
+        FalseClass => Types::Form::Bool,
+        TrueClass => Types::Form::Bool
+    }.freeze
+    def initialize(default_settings, settings)
+      @default_settings = default_settings
+      @settings = settings
+      @coerced_settings = {}
+    end
+    def coerce!
+      settings.symbolize_keys.each do |name, value|
+        default_value_class = default_settings[name].class
+        coercible_type = COERCIONS_MAP[default_value_class]
+        raise NotCoercibleError, "can't coerce #{default_value_class}" unless coercible_type
+        coerced_settings[name] = coercible_type[value]
+      end
+      set_default_boolean_value!(coerced_settings)
+      coerced_settings
+    end
+    private
+    def set_default_boolean_value!(settings)
+      default_settings.each do |name, value|
+        setting_value = settings[name.to_sym]
+        next if setting_value.present?
+        settings[name.to_sym] = case value.class.name
+                                when 'TrueClass', 'FalseClass'
+                                  false
+                                when 'Array'
+                                  []
+                                end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'i18n'
+require 'dry-validation'
+module RailsSettingsUi
+  class SettingsSchema < Dry::Validation::Schema::Form
+  end
+  module CustomPredicates
+    include Dry::Logic::Predicates
+    predicate(:form_hash?) do |value|
+      begin
+        JSON.parse(value.gsub(/\=\>/, ':'))
+      rescue JSON::ParserError => e
+        false
+      end
+    end
+  end
+  class SettingsFormValidator
+    VALIDATABLE_TYPES = {
+      Fixnum => :int?,
+      Float => :float?,
+      ActiveSupport::Duration => :int?,
+      ActiveSupport::HashWithIndifferentAccess => :form_hash?
+    }.freeze
+    def initialize(default_settings, settings)
+      @default_settings = default_settings
+      @settings = settings
+      build_validation_schema
+    end
+    def errors
+      @schema.call(@settings).messages
+    end
+    private
+    def build_validation_schema
+      v = Dry::Validation::Schema::Value.new
+      validatable_settings.each do |name, value|
+        predicate = VALIDATABLE_TYPES[value.class]
+        v.key(name.to_sym).required(predicate) if predicate
+      end
+      SettingsSchema.configure do |config|
+        config.rules = v.rules
+        config.messages = :i18n
+        config.predicates = CustomPredicates
+      end
+      @schema = SettingsSchema.new
+    end
+    def validatable_settings
+      @default_settings.select { |_, value| value.class.in?(VALIDATABLE_TYPES.keys) }
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module RailsSettingsUi
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

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

@@ -1,6 +1,7 @@
 class Settings < RailsSettings::CachedSettings
   defaults[:project_name] = "Dummy"
   defaults[:limit] = 150
+  defaults[:angle] = 0.5
   defaults[:style] = {
     border_color: 'e0e0e0',
     block_color: 'ffffff',
@@ -13,4 +14,6 @@ class Settings < RailsSettings::CachedSettings
   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
 end

data/spec/dummy/config/application.rb CHANGED Viewed

@@ -22,7 +22,7 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
+    config.i18n.default_locale = :en
   end
 end

data/spec/dummy/config/environments/production.rb CHANGED Viewed

@@ -20,7 +20,7 @@ Dummy::Application.configure do
   # config.action_dispatch.rack_cache = true
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_assets = false
+  config.serve_static_files = false
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

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

@@ -13,9 +13,11 @@ Dummy::Application.configure do
   config.eager_load = false
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = "public, max-age=3600"
+  config.active_record.raise_in_transactional_callbacks = true
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false

data/spec/dummy/config/locales/en.yml CHANGED Viewed

@@ -25,4 +25,9 @@ en:
     attributes:
       check_something:
         name: Check This Out!
-        help_block: You really should check it out!
+        help_block: You really should check it out!
+      mode:
+        name: 'Mode'
+        labels:
+          auto: 'Auto'
+          manual: 'Manual'