system_settings 0.6.1 → 0.9.0

data/app/models/system_settings/decimal_list_setting.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  class DecimalListSetting < SystemSettings::Setting
+    attribute :value, SystemSettings::Type::DecimalList.new(scale: 6)
+    validates :value, "system_settings/list_of_decimals": true
+  end
+end

data/app/models/system_settings/decimal_setting.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  class DecimalSetting < SystemSettings::Setting
+    attribute :value, :decimal, scale: 6
+    validates :value, numericality: true
+  end
+end

data/app/models/system_settings/errors/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   module Errors
     class Error < StandardError

data/app/models/system_settings/errors/not_found_error.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SystemSettings
   module Errors
     class NotFoundError < SystemSettings::Errors::Error
     end
   end
-end
+end

data/app/models/system_settings/errors/not_loaded_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  module Errors
+    class NotLoadedError < SystemSettings::Errors::Error
+    end
+  end
+end

data/app/models/system_settings/errors/settings_read_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   module Errors
     class SettingsReadError < SystemSettings::Errors::Error

data/app/models/system_settings/integer_list_setting.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class IntegerListSetting < SystemSettings::Setting
-    attribute :value, SystemSettings::Type::IntegerList.new
+    attribute :value, SystemSettings::Type::IntegerList.new(limit: 8)
     validates :value, "system_settings/list_of_integers": true
   end
 end

data/app/models/system_settings/integer_setting.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class IntegerSetting < SystemSettings::Setting
-    attribute :value, :integer
+    attribute :value, :integer, limit: 8
     validates :value, numericality: { only_integer: true }
   end
 end

data/app/models/system_settings/list_of_decimals_validator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  class ListOfDecimalsValidator < ActiveModel::EachValidator
+    LIST_REGEXP = /\A[+-]?\d+(?:\.\d+){0,1}(?:; *[+-]?\d+(?:\.\d+){0,1})*\z/.freeze
+    SINGLE_REGEXP = /\A[+-]?\d+(?:\.\d+){0,1}\z/.freeze
+
+    def validate_each(record, attr_name, value)
+      came_from_user = :"#{attr_name}_came_from_user?"
+
+      raw_value = record.read_attribute_before_type_cast(attr_name) if record.respond_to?(came_from_user) && record.public_send(came_from_user)
+      raw_value ||= value
+
+      raw_value = value if record_attribute_changed_in_place?(record, attr_name)
+
+      record.errors.add(attr_name, :not_a_list_of_decimals) unless matches_list_of_decimals_regexp?(raw_value)
+    end
+
+    private
+
+    def record_attribute_changed_in_place?(record, attr_name)
+      record.respond_to?(:attribute_changed_in_place?) &&
+        record.attribute_changed_in_place?(attr_name.to_s)
+    end
+
+    def matches_list_of_decimals_regexp?(raw_value)
+      case raw_value
+      when String
+        LIST_REGEXP.match?(raw_value)
+      when Array
+        raw_value.all? { |v| SINGLE_REGEXP.match?(v.to_s) }
+      else
+        false
+      end
+    end
+  end
+end

data/app/models/system_settings/list_of_integers_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class ListOfIntegersValidator < ActiveModel::EachValidator
     LIST_REGEXP = /\A[+-]?\d+(?:; *[+-]?\d+)*\z/.freeze

data/app/models/system_settings/list_of_strings_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class ListOfStringsValidator < ActiveModel::EachValidator
     NON_WHITESPACE_REGEXP = /[^[:space:]]/.freeze

data/app/models/system_settings/setting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class Setting < SystemSettings::ApplicationRecord
     validates :type, presence: true

data/app/models/system_settings/string_list_setting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class StringListSetting < SystemSettings::Setting
     attribute :value, SystemSettings::Type::StringList.new

data/app/models/system_settings/string_setting.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class StringSetting < SystemSettings::Setting
     attribute :value, :string
     validates :value, presence: true
+
+    def value=(original_value)
+      next_value = original_value.to_s.blank? ? nil : original_value.to_s.strip
+      super(next_value)
+    end
   end
 end

data/app/models/system_settings/type/decimal_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  module Type
+    class DecimalList < ActiveModel::Type::Value
+      SEPARATOR = ";"
+
+      def initialize(precision: nil, limit: nil, scale: nil)
+        super
+        @single_type = ActiveModel::Type::Decimal.new(precision: precision, limit: limit, scale: scale)
+      end
+
+      def type
+        :decimal_list
+      end
+
+      def deserialize(value)
+        result = value.presence && JSON.parse(value)
+        if result.is_a?(Array)
+          result.map { |v| @single_type.cast(v) }
+        else
+          result
+        end
+      end
+
+      def serialize(value)
+        JSON.dump(value) unless value.nil?
+      end
+
+      private
+
+      def cast_value(value)
+        case value
+        when Array
+          value.map { |v| @single_type.cast(v) }
+        when String
+          value.split(SEPARATOR).map { |v| @single_type.cast(v) }
+        end
+      end
+    end
+  end
+end

data/app/models/system_settings/type/integer_list.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 module SystemSettings
   module Type
     class IntegerList < ActiveModel::Type::Value
-      SEPARATOR = ";".freeze
+      SEPARATOR = ";"
+
+      def initialize(precision: nil, limit: nil, scale: nil)
+        super
+        @single_type = ActiveModel::Type::Integer.new(precision: precision, limit: limit, scale: scale)
+      end
 
       def type
         :integer_list
@@ -20,21 +27,9 @@ module SystemSettings
       def cast_value(value)
         case value
         when Array
-          value.map do |v|
-            begin
-              v.to_i
-            rescue StandardError
-              nil
-            end
-          end
+          value.map { |v| @single_type.cast(v) }
         when String
-          value.split(SEPARATOR).map do |v|
-            begin
-              v.to_i
-            rescue StandardError
-              nil
-            end
-          end
+          value.split(SEPARATOR).map { |v| @single_type.cast(v) }
         end
       end
     end

data/app/models/system_settings/type/string_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   module Type
     class StringList < ActiveModel::Type::Value

data/app/views/layouts/system_settings/application.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>System Settings - <%= SystemSettings::VERSION %></title>
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag 'system_settings/application', media: 'all' %>
+  </head>
+  <body>
+    <header>
+      <div class="container">
+        <%= link_to "System Settings", root_path, class: "app-name" %>
+      </div>
+    </header>
+    <main>
+      <div class="container">
+        <%= yield %>
+      </div>
+    </main>
+  </body>
+</html>

data/app/views/system_settings/settings/_common_attributes.html.erb

@@ -0,0 +1,14 @@
+<div class="attribute">
+  <div class="name"><%= setting.class.human_attribute_name(:name) %></div>
+  <div class="value">
+    <span class="sys-name"><%= setting.name %></span>
+  </div>
+</div>
+<div class="attribute">
+  <div class="name"><%= setting.class.human_attribute_name(:type) %></div>
+  <div class="value"><%= setting.model_name.human %></div>
+</div>
+<div class="attribute">
+  <div class="name"><%= setting.class.human_attribute_name(:description) %></div>
+  <div class="value"><%= setting.description %></div>
+</div>

data/app/views/system_settings/settings/_form.html.erb

@@ -0,0 +1,18 @@
+<%= form_for setting, as: :setting, url: setting_path(setting), method: "post" do |f| %>
+  <div class="attribute">
+    <%= f.label :value, class: "name" %>
+    <% if f.object.is_a?(SystemSettings::BooleanSetting) %>
+      <%= f.check_box :value, value: f.object.value %>
+    <% else %>
+      <%= f.text_field :value, value: format_value_for_form(f.object), class: "value" %>
+    <% end %>
+    <% if f.object.errors.messages[:value].any? %>
+      <div class="errors"><%= f.object.errors.messages[:value].join("; ") %></div>
+    <% end %>
+    <div class="hint"><%= t(f.object.type, scope: "system_settings.settings.form.hints_by_type", default: "").html_safe %></div>
+  </div>
+  <div class="buttons">
+  <%= f.submit t(".save"), class: "primary" %>
+  <%= link_to t(".back"), setting_path(setting), class: "button" %>
+  </div>
+<% end %>

data/app/views/system_settings/settings/edit.html.erb

@@ -0,0 +1,2 @@
+<%= render "common_attributes", setting: @setting %>
+<%= render "form", setting: @setting %>

data/app/views/system_settings/settings/index.html.erb

@@ -0,0 +1,29 @@
+<table class="settings-table">
+  <thead>
+    <tr>
+      <th class="name"><%= SystemSettings::Setting.human_attribute_name(:name) %></th>
+      <th class="description"><%= SystemSettings::Setting.human_attribute_name(:description) %></th>
+      <th class="value"><%= SystemSettings::Setting.human_attribute_name(:value) %></th>
+    </tr>
+  </thead>
+  <tbody>
+  <% if @settings.any? %>
+    <% @settings.each do |setting| %>
+      <tr>
+        <td class="name"><%= link_to setting.name, setting_path(setting), class: "sys-name" %></td>
+        <td class="description"><%= setting.description %></td>
+        <td class="value"><%= format_value setting.value %></td>
+      </tr>
+    <% end %>
+  <% else %>
+    <tr>
+      <td colspan="3" class="no-entries"><%= t(".no_settings").html_safe %></td>
+    </tr>
+  <% end %>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td colspan="3"><%= t(".add_new", path: display_settings_file_path).html_safe %></td>
+    </tr>
+  </tfoot>
+</table>

data/app/views/system_settings/settings/show.html.erb

@@ -0,0 +1,9 @@
+<%= render "common_attributes", setting: @setting %>
+<div class="attribute">
+  <div class="name"><%= @setting.class.human_attribute_name(:value) %></div>
+  <div class="value"><%= format_value @setting.value %></div>
+</div>
+<div class="buttons">
+  <%= link_to t(".edit"), edit_setting_path(@setting), class: "button primary" %>
+  <%= link_to t(".back"), root_path, class: "button" %>
+</div>

data/config/locales/system_settings.en.yml

@@ -16,11 +16,21 @@ en:
       system_settings/string_setting:
         one: "System Setting (String)"
         other: "System Settings (String)"
+      system_settings/decimal_setting:
+        one: "System Setting (Decimal)"
+        other: "System Settings (Decimal)"
+      system_settings/decimal_list_setting:
+        one: "System Setting (Decimal list)"
+        other: "System Settings (Decimal list)"
+      system_settings/boolean_setting:
+        one: "System Setting (Boolean)"
+        other: "System Settings (Boolean)"
     attributes:
       system_settings/setting:
         id: "ID"
         name: "Name"
         type: "Type"
+        value: "Value"
         description: "Description"
         created_at: "Created at"
         uploaded_at: "Updated at"
@@ -31,7 +41,23 @@ en:
             value:
               not_a_list_of_integers: "not a list of integers"
               not_a_list_of_strings: "not a list of strings"
+              not_a_list_of_decimals: "not a list of decimals"
         system_settings/boolean_setting:
           attributes:
             value:
-              inclusion: "must be set to true or false"
+              inclusion: "must be set to true or false"
+  system_settings:
+    settings:
+      index:
+        no_settings: "No settings"
+        add_new: "Add new entries in <code>%{path}</code>"
+      show:
+        edit: Edit
+        back: Back
+      form:
+        save: Save
+        back: Back
+        hints_by_type:
+          "SystemSettings::StringListSetting": "Separate values by <code>;</code> character."
+          "SystemSettings::IntegerListSetting": "Separate values by <code>;</code> character."
+          "SystemSettings::DecimalListSetting": "Decimal separator is the <code>.</code> character. Separate multiple values by <code>;</code> character."

data/config/routes.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 SystemSettings::Engine.routes.draw do
-  scope "api" do
-    resources "settings"
+  resources :settings, only: [:show, :edit] do
+    member do
+      post "/", to: "settings#update"
+    end
   end
-  root to: "root#index"
-  get "*rest", to: "root#index", as: :catch_all
+  root to: "settings#index"
 end

data/lib/system_settings.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require "system_settings/version"
 require "system_settings/engine"
 
 module SystemSettings
@@ -9,21 +12,24 @@ module SystemSettings
     instrument("system_settings.find", name: name) do |payload|
       record = Setting.find_by(name: name)
       unless record
-        message = "Couldn't find system setting #{name}\n\n"
-        message << "It might not be loaded from settings file(#{settings_file_path}).\n"
-        message << "To load missing settings with their initial values you "
-        message << "can call SystemSettings.load from your Rails environment or run Rails task:\n\n"
-        message << "    bin/rails system_settings:load RAILS_ENV=#{::Rails.env}"
+        message = <<~MESSAGE.strip
+          Couldn't find system setting #{name}
+
+          It might not be loaded from settings file(#{settings_file_path}).
+          To load missing settings with their initial values you can call SystemSettings.load from your Rails environment or run Rails task:
+
+              bin/rails system_settings:load RAILS_ENV=#{::Rails.env}
+        MESSAGE
         raise(Errors::NotFoundError, message)
       end
       payload[:value] = record.value
     end
   end
 
-  def self.load
+  def self.load(*names)
     instrument("system_settings.load", path: settings_file_path) do |payload|
       configurator = Configurator.from_file(settings_file_path)
-      payload[:success] = configurator.persist
+      payload[:success] = configurator.persist(only: names)
     end
   end