system_settings 0.6.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19edc85867dc8e77f5c478253810138cfa2e1d3de4bb32543a7d18adbb5e9732
-  data.tar.gz: '00488e7c29d499bc5c1f48ba7ac59b0fcde7cd70c413706ccd99ac119e9ad01e'
+  metadata.gz: 213bb372d94ea27ce951f424559b1e19812248cca9df0f66136d4776d9848fb8
+  data.tar.gz: 0530b07ab886e8e2515d957c839b37c1eb7817d90deb2e1e2996d10457c08efa
 SHA512:
-  metadata.gz: 9cbacb36e4b9b5272da2f7756843fe232bf16b878a77467e8b464e88f909d545d6c6f55725345a4b8e3513bc05a3d4f493f9127ab01e676518d6396b337d5134
-  data.tar.gz: cb1ab8e4b6183a1fdf3670a1785b77f3c57f2a9bfa53b95feb42392fab65effb7a9ce9862958ed4f05b1635ef79c32ce7fc0b2f9ec8e142a829b1f7106b187d2
+  metadata.gz: 5d4ea1661ba9b875628ae3ac32e26cb593607ce8e470bc651287d105e23889b6794a1db594dff754dc1fcf89f0118995b4dc544c1d4d9a8fbfc3391d20e532a6
+  data.tar.gz: 397e5ade494169a4ff92c6bab9abada406c4d5ae9b2e3725a1ac282ec2d7cb7a066f8f7c69a724826d1e20bd3dc97f4decf48a80c08c61c54ad8a80193bdfcea

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,13 +1,7 @@
 # frozen_string_literal: true
 
-module SystemSettings
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
+class SystemSettings::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
+  ActiveSupport.run_load_hooks(:system_settings_application_controller, self)
 end

data/app/controllers/system_settings/settings_controller.rb

@@ -1,28 +1,32 @@
 # frozen_string_literal: true
 
-module SystemSettings
-  class SettingsController < SystemSettings::ApplicationController
-    RETURN_ATTRIBUTES = ["id", "name", "type", "value", "description"].freeze
-
-    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}
-    end
+class SystemSettings::SettingsController < SystemSettings::ApplicationController
+  RETURN_ATTRIBUTES = %w[id name type value description].freeze
+  before_action :set_setting, only: [:edit, :show, :update]
 
-    def show
-      @setting = SystemSettings::Setting.find(params[:id])
-      add_authenticity_token
-      render json: @setting.as_json(only: RETURN_ATTRIBUTES)
-    end
+  def index
+    @settings = SystemSettings::Setting.order(:name)
+  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)
-      else
-        render json: {errors: @setting.errors.as_json}, status: :unprocessable_entity
-      end
+  def update
+    if @setting.update(setting_params)
+      redirect_to setting_path(@setting)
+    else
+      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

data/app/helpers/system_settings/application_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SystemSettings::ApplicationHelper
+  SEPARATOR = ";"
+
+  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,7 +1,5 @@
 # frozen_string_literal: true
 
-module SystemSettings
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
+class SystemSettings::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
 end

data/app/models/system_settings/boolean_setting.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-module SystemSettings
-  class BooleanSetting < SystemSettings::Setting
-    attribute :value, :boolean
-    validates :value, inclusion: [true, false]
-  end
+class SystemSettings::BooleanSetting < SystemSettings::Setting
+  attribute :value, :boolean
+  validates :value, inclusion: [true, false]
 end

data/app/models/system_settings/configurator.rb

@@ -1,110 +1,134 @@
 # frozen_string_literal: true
 
-module SystemSettings
-  class Configurator
-    class << self
-      def from_file(file_name, kernel_class: Kernel)
-        file_name = file_name.to_path if file_name.respond_to?(:to_path)
-        raise SystemSettings::Errors::SettingsReadError, "The file name must either be a String or implement #to_path" unless file_name.is_a?(String)
-        raise SystemSettings::Errors::SettingsReadError, "#{file_name} file does not exist" unless File.exist?(file_name)
-        raise SystemSettings::Errors::SettingsReadError, "#{file_name} file not readable" unless File.readable?(file_name)
-        SystemSettings.instrument("system_settings.from_file", path: file_name) do |payload|
-          file_content = File.read(file_name)
-          new(kernel_class: kernel_class).tap do |obj|
-            obj.instance_eval(file_content, file_name, 1)
-            payload[:items] = obj.items
-          end
+class SystemSettings::Configurator
+  class << self
+    def from_file(file_name, kernel_class: Kernel)
+      file_name = file_name.to_path if file_name.respond_to?(:to_path)
+      raise SystemSettings::Errors::SettingsReadError, "The file name must either be a String or implement #to_path" unless file_name.is_a?(String)
+      raise SystemSettings::Errors::SettingsReadError, "#{file_name} file does not exist" unless File.exist?(file_name)
+      raise SystemSettings::Errors::SettingsReadError, "#{file_name} file not readable" unless File.readable?(file_name)
+      SystemSettings.instrument("system_settings.from_file", path: file_name) do |payload|
+        file_content = File.read(file_name)
+        new(kernel_class: kernel_class).tap do |obj|
+          obj.instance_eval(file_content, file_name, 1)
+          payload[:items] = obj.items
         end
       end
+    end
 
-      def purge
-        new.purge
-      end
+    def purge
+      new.purge
     end
+  end
 
-    attr_reader :items
+  attr_reader :items
 
-    def initialize(kernel_class: Kernel, &block)
-      @items = []
-      @kernel_class = kernel_class
-      return unless block_given?
-      if block.arity == 1
-        yield self
-      else
-        instance_exec(&block)
-      end
+  def initialize(kernel_class: Kernel, &block)
+    @items = []
+    @kernel_class = kernel_class
+    return unless block_given?
+    if block.arity == 1
+      yield self
+    else
+      instance_exec(&block)
     end
+  end
 
-    def string(name, value: nil, description: nil, &blk)
-      add(name, SystemSettings::StringSetting, value: value, description: description, &blk)
-    end
+  def string(name, value: nil, description: nil, &blk)
+    add(name, SystemSettings::StringSetting, value: value, description: description, &blk)
+  end
 
-    def string_list(name, value: nil, description: nil, &blk)
-      add(name, SystemSettings::StringListSetting, value: value || [], description: description, &blk)
-    end
+  def string_list(name, value: nil, description: nil, &blk)
+    add(name, SystemSettings::StringListSetting, value: value || [], description: description, &blk)
+  end
 
-    def integer(name, value: nil, description: nil, &blk)
-      add(name, SystemSettings::IntegerSetting, value: value, description: description, &blk)
-    end
+  def integer(name, value: nil, description: nil, &blk)
+    add(name, SystemSettings::IntegerSetting, value: value, description: description, &blk)
+  end
 
-    def integer_list(name, value: nil, description: nil, &blk)
-      add(name, SystemSettings::IntegerListSetting, value: value || [], description: description, &blk)
-    end
+  def integer_list(name, value: nil, description: nil, &blk)
+    add(name, SystemSettings::IntegerListSetting, value: value || [], description: description, &blk)
+  end
 
-    def boolean(name, value: nil, description: nil, &blk)
-      add(name, SystemSettings::BooleanSetting, value: value, description: description, &blk)
-    end
+  def boolean(name, value: nil, description: nil, &blk)
+    add(name, SystemSettings::BooleanSetting, value: value, description: description, &blk)
+  end
 
-    def persist
-      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}"
-                end
-              else
-                entry[:class].create!(name: entry[:name], value: entry[:value], description: entry[:description])
+  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
+          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
+              create_or_update_item(item)
             end
           end
-          payload[:success] = true
-        else
-          warn "SystemSettings: Settings table has not been created!"
-          payload[:success] = false
         end
+        payload[:success] = true
+      else
+        warn "SystemSettings: Settings table has not been created!"
+        payload[:success] = false
       end
     end
+  end
 
-    def purge
-      SystemSettings.instrument("system_settings.purge") do |payload|
-        if settings_table_exists?
-          SystemSettings::Setting.delete_all
-          payload[:success] = true
-        else
-          payload[:success] = false
-        end
+  def purge
+    SystemSettings.instrument("system_settings.purge") do |payload|
+      if settings_table_exists?
+        SystemSettings::Setting.delete_all
+        payload[:success] = true
+      else
+        payload[:success] = false
       end
     end
+  end
 
-    private
+  private
 
-    def warn(*args)
-      @kernel_class.warn(*args)
-    end
+  def warn(*args)
+    @kernel_class.warn(*args)
+  end
 
-    def settings_table_exists?
-      SystemSettings::Setting.table_exists?
-    end
+  def settings_table_exists?
+    SystemSettings::Setting.table_exists?
+  end
 
-    def add(name, class_const, value:, description:)
-      value = yield(value) if block_given?
-      value = value.call if value.is_a?(Proc)
-      @items.push(name: name, class: class_const, value: value, description: description)
+  def add(name, class_const, value:, description:)
+    value = yield(value) if block_given?
+    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