system_settings 0.6.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2436379d110a7e6416bce537892e89d29c0bf9ae6319abc843766010f9ed5e03
-  data.tar.gz: ee3c15960c0cde816a6078abd303fb892dddd28609990176ab427d35602e435d
+  metadata.gz: 321c73f1b71d88e67c98191025ac69b6fa58ea6dbbaa838cb5a6eaea6622337a
+  data.tar.gz: 17bd42a54230f37063f618fe2cfebc3875410d3879757e9ed38138990c6a952d
 SHA512:
-  metadata.gz: dc1d77aade5cdebcd53fd487d91a1a24c1cc0b4b444ce5b9ebab3fe0439f89df68e320497453a220c7b4c1b8c648515c56a4a7defb73cd379f71c6b04c702182
-  data.tar.gz: a85ef1e09a368464d980cda6a5ff180191d9bb5dda3bdb49a80701a1c5c80b72935a5e76b492a21a82654a730956a3618ee428ed1c03872ecc312dc1aebcd2f9
+  metadata.gz: 4231c986165f29d944aec79b4cc5239ccc9f7d614ef710ec77e452a238f8579ec3afcf20c09c0701ec49b3a89547ebbfcc3e4f395a71d024b1349fadb8df1cfc
+  data.tar.gz: bab2dd0fbf7b7f5f38ea38e4ebdcb1d732eb0254a2e3278925ac16408cca8d3c05c898137c92e7916c2b4f85c6105a9ad1e1ec5be0e51eb9d8a0fa617ff3fd47

data/README.md

@@ -42,10 +42,14 @@ string :default_locale, value: "en"
 integer :default_records_per_page, value: 25
 integer :remainder_interval_in_hours, value: 48
 
-# Array type strings and integers
+# Decimal values
+decimal :max_temp, value: 95.2
+
+# Array type strings, integers and decimals
 string_list :admin_emails, description: "Will receive alerts"
 string_list :upload_allowed_extensions, value: ["docx", "pdf", "txt"]
 integer_list :lucky_numbers, description: "Prime numbers are more effective", value: [2, 3, 5, 11]
+decimal_list :allowed_multipliers, value: [12.3, 99, BigDecimal("-87")]
 ```
 
 Load values from `config/system_settings.rb` into database:
@@ -93,19 +97,16 @@ If you would like to store your settings somewhere else than `config/system_sett
 
 ## Using System Settings in tests
 
-Your test suite probably clears database before/after every test example. Fortunately is very easy to load fresh settings from configuration file. It can be done by running `SystemSettings.load`.
+Your test suite probably clears database before/after every test example. Fortunately is very easy to load fresh settings from configuration file.
+It can be done by running `SystemSettings.load`. It will persist all loaded settings. But if you would like to persist only a subset of loaded settings run `SystemSettings.load(:one, :two, :three)`.
+
 And if you modify settings values in test example you can reset to defaults with `SystemSettings.reset_to_defaults`.
 
 
 ## Development
 
-Required development dependencies:
-* [Node.js](https://nodejs.org/) - JavaScript runtime
-* [Yarn](https://yarnpkg.com/) - package manager
-
 Optional development tools:
-* [overmind](https://github.com/DarthSim/overmind) - Process manager for Procfile-based applications and tmux
-* [direnv](https://direnv.net/) - Unclutter your .profile 
+* [direnv](https://direnv.net/) - Unclutter your .profile
 
 Required environment variables:
 * `RAILS_VERSION`
@@ -120,16 +121,13 @@ Getting started with development:
 1) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 bundle`
 2) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 ./bin/rails db:create db:migrate`
 3) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 ./bin/rails test`
-4) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 ./bin/rails frontend:install`
-4) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 ./bin/rails app:system_settings:load`
-4) `RAILS_VERSION=5.2.3 SQLITE3_VERSION=1.4.1 overmind start`
-
 
 ## Build status
 System Settings is being tested with Rails versions - `5.0`, `5.1`, `5.2`, `6.0`, `rails repo master branch`
 
 [![Build Status](https://dev.azure.com/kristsozols/System%20Settings/_apis/build/status/krists.system_settings?branchName=master)](https://dev.azure.com/kristsozols/System%20Settings/_build/latest?definitionId=1&branchName=master)
-
+[![Maintainability](https://api.codeclimate.com/v1/badges/3ad889ca36f62bad04dc/maintainability)](https://codeclimate.com/github/krists/system_settings/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3ad889ca36f62bad04dc/test_coverage)](https://codeclimate.com/github/krists/system_settings/test_coverage)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets .css

data/app/assets/stylesheets/system_settings/application.css

@@ -0,0 +1,227 @@
+html {
+    box-sizing: border-box;
+    font-size: 14px;
+    font-family: Arial, Helvetica, sans-serif;
+    overflow-y: scroll;
+}
+
+*, *:before, *:after {box-sizing: inherit;}
+
+body {
+    margin: 0;
+    padding: 0;
+    font-weight: normal;
+    min-height: 100vh;
+    position: relative;
+    display: flex;
+    flex-direction: column;
+    color: #233656;
+    background: white;
+    font-size: 1rem;
+    line-height: 1.5rem;
+}
+
+header {
+    border-bottom: 1px solid #e1e1e1;
+    height: 2rem;
+    padding: 0.5rem 0;
+    box-sizing: content-box;
+    background: white;
+    position: sticky;
+    top: 0;
+    width: 100%;
+}
+
+main {
+    padding: 3rem 0;
+}
+
+header .container,
+main .container {
+    max-width: 1020px;
+    margin: 0 auto;
+}
+
+a { color: #233656; text-decoration: none; }
+a:hover { text-decoration: underline; }
+
+.app-name, .app-name:hover, .app-name:active {
+    font-size: 1.5rem;
+    line-height: 2rem;
+    font-weight: bold;
+    user-select: none;
+    text-decoration: none;
+}
+
+.sys-name {
+    display: inline-block;
+    background: #f2f2f2;
+    border-radius: 3px;
+    padding: 0 0.5em;
+    font-family: "Courier New", Courier, monospace;
+    font-size: 0.75em;
+    max-width: 100%;
+}
+
+table th {
+    text-align: left;
+}
+
+.settings-table {
+    width: 100%;
+    table-layout: fixed;
+    white-space: nowrap;
+    user-select: none;
+}
+
+.settings-table td:empty:after {
+    content: "-";
+}
+
+.settings-table td {
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+
+.settings-table .description { width: 35% }
+.settings-table .value { width: 25% }
+
+.settings-table tbody td.no-entries {
+    color: #737373;
+    padding-top: 1rem;
+    margin-bottom: 1rem;
+}
+
+.settings-table tfoot td {
+    font-size: 0.8em;
+    padding-top: 1rem;
+    margin-bottom: 1rem;
+}
+
+.settings-table .value .value-part, .attribute .value .value-part {
+    max-width: 100%;
+    margin-right: 0.25em;
+}
+
+.settings-table .value .value-part:last-child, .attribute .value .value-part:last-child {
+    margin-right: 0;
+}
+
+.attribute {
+    display: flex;
+    flex-direction: column;
+    margin-bottom: 1rem;
+}
+
+.attribute .name {
+    font-size: 0.8em;
+    color: #737373;
+    user-select: none;
+}
+
+.attribute .value {
+    align-self: flex-start;
+}
+.attribute .value:empty:after {
+    content: "-";
+}
+
+.attribute .field_with_errors .name, .attribute .errors {
+    color: #d01d1d;
+}
+.attribute .hint {
+    font-size: 0.8em;
+    display: block;
+}
+
+.buttons {
+    border-top: 1px dotted #f2f2f2;
+    padding-top: 1rem;
+    margin-bottom: 1rem;
+}
+.buttons > * {
+    margin-right: 0.5rem;
+}
+
+button, input[type=submit], input[type=button], a.button {
+    display: inline-block;
+    cursor: pointer;
+    border: none;
+    border-radius: 3px;
+    padding: 0.375rem 0.75rem;
+    font-size: 1rem;
+    line-height: 1.5;
+    user-select: none;
+    white-space: nowrap;
+}
+
+button, input[type=submit], input[type=button] {
+    color: #4d4d4d;
+    background-color: #d9d9d9;
+    transition: background-color 0.1s ease-in-out;
+    outline: none;
+}
+
+button:focus, button:hover, input[type=submit]:focus, input[type=submit]:hover, input[type=button]:focus, input[type=button]:hover {
+    background-color: #b8b8b8;
+}
+
+button:active, input[type=submit]:active, input[type=button]:active {
+    background-color: #828282;
+}
+
+a.button {
+    color: #4d4d4d;
+    background-color: transparent;
+    transition: background-color 0.1s ease-in-out;
+    outline: none;
+    text-decoration: none;
+}
+
+a.button:focus, a.button:hover {
+    background-color: rgba(0, 0, 0, 0.15);
+}
+
+a.button:active {
+    background-color: rgba(0, 0, 0, 0.4);
+}
+
+button.primary, input[type=submit].primary, input[type=button].primary, a.button.primary {
+    color: #4d4d4d;
+    background-color: #a6a6a6;
+    transition: background-color 0.1s ease-in-out;
+    outline: none;
+}
+
+button.primary:focus, button.primary:hover, input[type=submit].primary:focus, input[type=submit].primary:hover, input[type=button].primary:focus, input[type=button].primary:hover, a.button.primary:focus, a.button.primary:hover {
+    background-color: #8d8d8d;
+}
+
+button.primary:active, input[type=submit].primary:active, input[type=button].primary:active, a.button.primary:active {
+    background-color: #646464;
+}
+
+input[type=text] {
+    border: none;
+    border-radius: 3px;
+    padding: 0.5em;
+    font-size: 1rem;
+    line-height: normal;
+    color: #4d4d4d;
+    background-color: #e6e6e6;
+    transition: background-color 0.1s ease-in-out;
+    outline: none;
+    box-sizing: content-box;
+    width: auto;
+    min-width: 12ch;
+    max-width: calc(100% - 2em);
+    will-change: width;
+}
+
+input[type=text]:focus {
+    background-color: #c4c4c4;
+}
+
+input[type=text]:active {
+    background-color: #bfbfbf;
+}

data/app/controllers/system_settings/application_controller.rb

@@ -1,11 +1,7 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
-
-    private
-
-    def add_authenticity_token
-      response.headers["Authenticity-Token"] = form_authenticity_token if protect_against_forgery?
-    end
   end
 end

data/app/controllers/system_settings/settings_controller.rb

@@ -1,29 +1,34 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class SettingsController < SystemSettings::ApplicationController
-    RETURN_ATTRIBUTES = ["id", "name", "type", "value", "description"].freeze
+    RETURN_ATTRIBUTES = %w[id name type value description].freeze
+    before_action :set_setting, only: [:edit, :show, :update]
 
     def index
-      @total_count = SystemSettings::Setting.count
-      @settings = SystemSettings::Setting.order(:name).extending(SystemSettings::Pagination).page(params[:page], per_page: params[:per])
-      render json: {
-          items: @settings.map { |s| s.as_json(only: RETURN_ATTRIBUTES) },
-          total_count: @total_count
-      }
+      @settings = SystemSettings::Setting.order(:name)
     end
 
-    def show
-      @setting = SystemSettings::Setting.find(params[:id])
-      add_authenticity_token
-      render json: @setting.as_json(only: RETURN_ATTRIBUTES)
-    end
+    def edit; end
+
+    def show; end
 
     def update
-      @setting = SystemSettings::Setting.find(params[:id])
-      if @setting.update(value: params[:value])
-        render json: @setting.as_json(only: RETURN_ATTRIBUTES)
+      if @setting.update(setting_params)
+        redirect_to setting_path(@setting)
       else
-        render json: {errors: @setting.errors.as_json}, status: :unprocessable_entity
+        render :edit
       end
     end
+
+    private
+
+    def set_setting
+      @setting = SystemSettings::Setting.find(params[:id])
+    end
+
+    def setting_params
+      params.require(:setting).permit(:value)
+    end
   end
 end

data/app/helpers/system_settings/application_helper.rb

@@ -0,0 +1,34 @@
+module SystemSettings::ApplicationHelper
+  SEPARATOR = ";".freeze
+
+  def format_value(value)
+    if value.respond_to?(:each)
+      capture do
+        value.each do |v|
+          concat content_tag(:span, v, class: "value-part")
+        end
+      end
+    else
+      value
+    end
+  end
+
+  def format_value_for_form(record)
+    case record
+    when SystemSettings::StringListSetting
+      record.value.map { |v| v.gsub(SEPARATOR, "\\#{SEPARATOR}") }.join(SEPARATOR)
+    when SystemSettings::IntegerListSetting, SystemSettings::DecimalListSetting
+      record.value.join(SEPARATOR)
+    else
+      record.value
+    end
+  end
+
+  def display_settings_file_path
+    if SystemSettings.settings_file_path.to_s.include?(Rails.root.to_s)
+      Pathname.new(SystemSettings.settings_file_path).relative_path_from(Rails.root)
+    else
+      SystemSettings.settings_file_path
+    end
+  end
+end

data/app/models/system_settings/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/models/system_settings/boolean_setting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class BooleanSetting < SystemSettings::Setting
     attribute :value, :boolean

data/app/models/system_settings/configurator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SystemSettings
   class Configurator
     class << self
@@ -53,20 +55,33 @@ module SystemSettings
       add(name, SystemSettings::BooleanSetting, value: value, description: description, &blk)
     end
 
-    def persist
+    def decimal(name, value: nil, description: nil, &blk)
+      add(name, SystemSettings::DecimalSetting, value: value, description: description, &blk)
+    end
+
+    def decimal_list(name, value: nil, description: nil, &blk)
+      add(name, SystemSettings::DecimalListSetting, value: value || [], description: description, &blk)
+    end
+
+    def persist(only: [])
       SystemSettings.instrument("system_settings.persist", items: @items) do |payload|
         if settings_table_exists?
           SystemSettings::Setting.transaction do
-            @items.each do |entry|
-              persisted_record = SystemSettings::Setting.find_by(name: entry[:name])
-              if persisted_record
-                if persisted_record.class == entry[:class]
-                  persisted_record.update!(description: entry[:description])
-                else
-                  warn "SystemSettings: Type mismatch detected! Previously #{entry[:name]} had type #{persisted_record.class.name} but you are loading #{entry[:class].name}"
+            if only.empty?
+              @items.each { |item| create_or_update_item(item) }
+            else
+              only.each do |wanted_name|
+                item = @items.find { |i| i[:name] == wanted_name } || begin
+                  loaded_names = @items.empty? ? "(none)" : @items.map{ |i| i[:name] }.join("\n")
+                  message = <<~MESSAGE.strip
+                    Couldn't persist system setting #{wanted_name}. There are no items by this name. Could it be a typo?
+
+                    Configurator has loaded following items:
+                    #{loaded_names}
+                  MESSAGE
+                  raise(SystemSettings::Errors::NotLoadedError, message)
                 end
-              else
-                entry[:class].create!(name: entry[:name], value: entry[:value], description: entry[:description])
+                create_or_update_item(item)
               end
             end
           end
@@ -104,5 +119,18 @@ module SystemSettings
       value = value.call if value.is_a?(Proc)
       @items.push(name: name, class: class_const, value: value, description: description)
     end
+
+    def create_or_update_item(item)
+      persisted_record = SystemSettings::Setting.find_by(name: item[:name])
+      if persisted_record
+        if persisted_record.class == item[:class]
+          persisted_record.update!(description: item[:description])
+        else
+          warn "SystemSettings: Type mismatch detected! Previously #{item[:name]} had type #{persisted_record.class.name} but you are loading #{item[:class].name}"
+        end
+      else
+        item[:class].create!(name: item[:name], value: item[:value], description: item[:description])
+      end
+    end
   end
 end