system_settings 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 856385bd0d4333e0d4044a3afaca3dfad12db9cd3ade70940ab588cc8162ac0e
+  data.tar.gz: 2ccd7b81d43f94bc33e473eef401ae2cdaa0b6ae212e64e8b0d4826717be16c1
+SHA512:
+  metadata.gz: 31b69d9e2d3663a773cc6539211a2a53644f33a2aec0a40c1c8da1791a9dd81941dfb38d3e0615a4fcd0090e5b45b080f5ed2891303fc05fb8bae7ed0b804fd4
+  data.tar.gz: 415a9d5a5968a4ed30be94b6ba4812d803be1c5a2d5ebbe15fbb8d716beacd9caa378669e471b3284ca31bcb42ab7ac90226fd3cd4ad8a639ce4f5dcf2c2f9f0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Krists Ozols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# SystemSettings
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'system_settings'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install system_settings
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/system_settings/application_controller.rb

@@ -0,0 +1,11 @@
+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/root_controller.rb

@@ -0,0 +1,13 @@
+require_relative "./application_controller"
+
+module SystemSettings
+  class RootController < ApplicationController
+    def index
+      if File.exists?(SystemSettings::Engine.frontend_build_index_html_path)
+        render file: SystemSettings::Engine.frontend_build_index_html_path
+      else
+        render plain: "Frontend application has not been compiled", status: :not_implemented
+      end
+    end
+  end
+end

data/app/controllers/system_settings/settings_controller.rb

@@ -0,0 +1,27 @@
+require_relative "./application_controller"
+
+module SystemSettings
+  class SettingsController < ApplicationController
+    RETURN_ATTRIBUTES = ["id", "name", "type", "value", "description"].freeze
+
+    def index
+      @settings = SystemSettings::Setting.order(:name)
+      render json: @settings.map { |s| s.as_json(only: RETURN_ATTRIBUTES) }
+    end
+
+    def show
+      @setting = SystemSettings::Setting.find(params[:id])
+      add_authenticity_token
+      render json: @setting.as_json(only: RETURN_ATTRIBUTES)
+    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
+    end
+  end
+end

data/app/models/system_settings/application_record.rb

@@ -0,0 +1,5 @@
+module SystemSettings
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/system_settings/configurator.rb

@@ -0,0 +1,81 @@
+module SystemSettings
+  class Configurator
+
+    class << self
+      def from_file(path)
+        file_content = File.read(path)
+        new.tap do |obj|
+          obj.instance_eval(file_content, path, 1)
+        end
+      end
+    end
+
+    attr_reader :items
+
+    def initialize(&block)
+      @items = []
+      if block_given?
+        if block.arity == 1
+          yield self
+        else
+          instance_exec(&block)
+        end
+      end
+    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 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 persist
+      if settings_table_exists?
+        SystemSettings::Setting.transaction do
+          @items.each do |entry|
+            persisted_record = entry[:class].find_by(name: entry[:name])
+            if persisted_record
+              persisted_record.update_attributes!(description: entry[:description])
+            else
+              entry[:class].create!(name: entry[:name], value: entry[:value], description: entry[:description])
+            end
+          end
+        end
+      else
+        $stderr.puts "SystemSettings: Settings table has not been created!"
+        false
+      end
+    end
+
+    def purge
+      if settings_table_exists?
+        SystemSettings::Setting.delete_all
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    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)
+    end
+  end
+end

data/app/models/system_settings/integer_list_setting.rb

@@ -0,0 +1,8 @@
+require_relative "./setting"
+
+module SystemSettings
+  class IntegerListSetting < Setting
+    attribute :value, SystemSettings::Type::IntegerList.new
+    validates :value, list_of_integers: { allow_blank: true }
+  end
+end

data/app/models/system_settings/integer_setting.rb

@@ -0,0 +1,8 @@
+require_relative "./setting"
+
+module SystemSettings
+  class IntegerSetting < Setting
+    attribute :value, :integer
+    validates :value, numericality: { only_integer: true }
+  end
+end

data/app/models/system_settings/list_of_integers_validator.rb

@@ -0,0 +1,42 @@
+module SystemSettings
+  class ListOfIntegersValidator < ActiveModel::EachValidator
+    LIST_REGEXP = /\A[+-]?\d+(?:; *[+-]?\d+)*\z/
+    SINGLE_REGEXP = /\A[+-]?\d+\z/
+
+    def validate_each(record, attr_name, value)
+      came_from_user = :"#{attr_name}_came_from_user?"
+
+      if record.respond_to?(came_from_user) && record.public_send(came_from_user)
+        raw_value = record.read_attribute_before_type_cast(attr_name)
+      end
+      raw_value ||= value
+
+      if record_attribute_changed_in_place?(record, attr_name)
+        raw_value = value
+      end
+
+      unless matches_list_of_integers_regexp?(raw_value)
+        record.errors.add(attr_name, :not_a_list_of_integers)
+        return
+      end
+    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_integers_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/setting.rb

@@ -0,0 +1,8 @@
+require_relative "./application_record"
+
+module SystemSettings
+  class Setting < ApplicationRecord
+    validates :type, presence: true
+    validates :name, presence: true, uniqueness: true
+  end
+end

data/app/models/system_settings/string_list_setting.rb

@@ -0,0 +1,7 @@
+require_relative "./setting"
+
+module SystemSettings
+  class StringListSetting < Setting
+    attribute :value, SystemSettings::Type::StringList.new
+  end
+end

data/app/models/system_settings/string_setting.rb

@@ -0,0 +1,7 @@
+require_relative "./setting"
+
+module SystemSettings
+  class StringSetting < Setting
+    attribute :value, :string
+  end
+end

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

@@ -0,0 +1,32 @@
+module SystemSettings
+  module Type
+    class IntegerList < ActiveModel::Type::Value
+      SEPARATOR = ";".freeze
+
+      def type
+        :integer_list
+      end
+
+      def deserialize(value)
+        value.presence && JSON.parse(value)
+      end
+
+      def serialize(value)
+        JSON.dump(value) unless value.nil?
+      end
+
+      private
+
+      def cast_value(value)
+        case value
+        when Array
+          value.map { |v| v.to_i rescue nil }
+        when String
+          value.split(SEPARATOR).map { |v| v.to_i rescue nil }
+        else
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module SystemSettings
+  module Type
+    class StringList < ActiveModel::Type::Value
+      def type
+        :string_list
+      end
+
+      def deserialize(value)
+        value.presence && JSON.parse(value)
+      end
+
+      def serialize(value)
+        JSON.dump(value) unless value.nil?
+      end
+
+      private
+
+      def cast_value(value)
+        case value
+        when Array
+          value.map { |v| String(v).strip }
+        when String
+          value.split(/(?<=[^\\]);/).map(&:strip)
+        end
+      end
+    end
+  end
+end

data/config/locales/system_settings.en.yml

@@ -0,0 +1,32 @@
+en:
+  activerecord:
+    models:
+      system_settings/setting:
+        one: "System Setting"
+        other: "System Settings"
+      system_settings/integer_list_setting:
+        one: "System Setting (Integer list)"
+        other: "System Settings (Integer list)"
+      system_settings/integer_setting:
+        one: "System Setting (Integer)"
+        other: "System Settings (Integer)"
+      system_settings/string_list_setting:
+        one: "System Setting (String list)"
+        other: "System Settings (String list)"
+      system_settings/string_setting:
+        one: "System Setting (String)"
+        other: "System Settings (String)"
+    attributes:
+      system_settings/setting:
+        id: "ID"
+        name: "Name"
+        type: "Type"
+        description: "Description"
+        created_at: "Created at"
+        uploaded_at: "Updated at"
+    errors:
+      models:
+        system_settings/setting:
+          attributes:
+            value:
+              not_a_list_of_integers: "not a list of integers"

data/config/routes.rb

@@ -0,0 +1,7 @@
+SystemSettings::Engine.routes.draw do
+  scope "api" do
+    resources "settings"
+  end
+  root to: "root#index"
+  get "*rest", to: "root#index", as: :catch_all
+end

data/db/migrate/20181007125347_create_system_settings_settings.rb

@@ -0,0 +1,11 @@
+class CreateSystemSettingsSettings < ActiveRecord::Migration[5.2]
+  def change
+    create_table :system_settings_settings do |t|
+      t.string :name, null: false, index: { unique: true }
+      t.string :type, null: false, index: true
+      t.text :value
+      t.text :description
+      t.timestamps
+    end
+  end
+end

data/frontend/build/asset-manifest.json

@@ -0,0 +1,11 @@
+{
+  "files": {
+    "main.css": "/system_settings/static/css/main.e262560e.chunk.css",
+    "main.js": "/system_settings/static/js/main.afaa2372.chunk.js",
+    "runtime~main.js": "/system_settings/static/js/runtime~main.a09e9b82.js",
+    "static/js/2.83a5f4da.chunk.js": "/system_settings/static/js/2.83a5f4da.chunk.js",
+    "index.html": "/system_settings/index.html",
+    "precache-manifest.130ca067521371497dba783c23aa7e16.js": "/system_settings/precache-manifest.130ca067521371497dba783c23aa7e16.js",
+    "service-worker.js": "/system_settings/service-worker.js"
+  }
+}

data/frontend/build/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"><link rel="shortcut icon" href="/system_settings/favicon.ico"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name="theme-color" content="#000000"><title>System Settings</title><link href="/system_settings/static/css/main.e262560e.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script src="/system_settings/static/js/runtime~main.a09e9b82.js"></script><script src="/system_settings/static/js/2.83a5f4da.chunk.js"></script><script src="/system_settings/static/js/main.afaa2372.chunk.js"></script></body></html>

data/frontend/build/precache-manifest.130ca067521371497dba783c23aa7e16.js

@@ -0,0 +1,22 @@
+self.__precacheManifest = (self.__precacheManifest || []).concat([
+  {
+    "revision": "e04ed1ed3403d21f675ed787109671dd",
+    "url": "/system_settings/index.html"
+  },
+  {
+    "revision": "b12967943154ae7a6202",
+    "url": "/system_settings/static/css/main.e262560e.chunk.css"
+  },
+  {
+    "revision": "fbb0a923d9fbb93afddb",
+    "url": "/system_settings/static/js/2.83a5f4da.chunk.js"
+  },
+  {
+    "revision": "b12967943154ae7a6202",
+    "url": "/system_settings/static/js/main.afaa2372.chunk.js"
+  },
+  {
+    "revision": "1b52e032205e59a9e84f",
+    "url": "/system_settings/static/js/runtime~main.a09e9b82.js"
+  }
+]);

data/frontend/build/service-worker.js

@@ -0,0 +1,39 @@
+/**
+ * Welcome to your Workbox-powered service worker!
+ *
+ * You'll need to register this file in your web app and you should
+ * disable HTTP caching for this file too.
+ * See https://goo.gl/nhQhGp
+ *
+ * The rest of the code is auto-generated. Please don't update this file
+ * directly; instead, make changes to your Workbox build configuration
+ * and re-run your build process.
+ * See https://goo.gl/2aRDsh
+ */
+
+importScripts("https://storage.googleapis.com/workbox-cdn/releases/4.3.0/workbox-sw.js");
+
+importScripts(
+  "/system_settings/precache-manifest.130ca067521371497dba783c23aa7e16.js"
+);
+
+self.addEventListener('message', (event) => {
+  if (event.data && event.data.type === 'SKIP_WAITING') {
+    self.skipWaiting();
+  }
+});
+
+workbox.core.clientsClaim();
+
+/**
+ * The workboxSW.precacheAndRoute() method efficiently caches and responds to
+ * requests for URLs in the manifest.
+ * See https://goo.gl/S9QRab
+ */
+self.__precacheManifest = [].concat(self.__precacheManifest || []);
+workbox.precaching.precacheAndRoute(self.__precacheManifest, {});
+
+workbox.routing.registerNavigationRoute(workbox.precaching.getCacheKeyForURL("/system_settings/index.html"), {
+  
+  blacklist: [/^\/_/,/\/[^\/]+\.[^\/]+$/],
+});

data/frontend/build/static/css/main.e262560e.chunk.css

@@ -0,0 +1 @@
+.App_container__BLGGc{min-height:100vh;display:flex;flex-direction:column;position:relative;z-index:auto}.App_header-wrap__3DnwX{position:fixed;width:100%;background:#fff;border-bottom:1px solid #e1e1e1;z-index:1}.App_header__1o2Y8{max-width:1020px;margin:0 auto;display:flex}.App_header-name__2XXxc{font-size:1.5rem;line-height:2rem;font-weight:700;padding:.5rem 0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;text-decoration:none}.App_header-name__2XXxc:active,.App_header-name__2XXxc:focus,.App_header-name__2XXxc:hover{text-decoration:none}.App_header-spacer__3F0KU{margin-top:calc(3rem + 1px);height:3rem}.App_content-wrap__1oPWs{flex-grow:5;box-sizing:border-box;display:flex}.App_content__3dh9P{max-width:1020px;min-width:0;margin:0 auto;display:flex;flex-grow:1;flex-direction:column}.NotFoundPage_container__35vs4{flex-grow:1;align-items:center;justify-content:center;display:flex}.ListPage_table__2qY_8{table-layout:fixed;white-space:nowrap;width:100%;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.ListPage_table__2qY_8 td:empty:after{content:"-"}.ListPage_empty-tr__2VxYl{color:#a6a6a6}.ListPage_empty-tr__2VxYl td{text-align:center}.ListPage_name__1-Gs-{width:20%;overflow:hidden;text-overflow:ellipsis}.ListPage_table__2qY_8 tbody .ListPage_description__1Sci0,.ListPage_table__2qY_8 tbody .ListPage_name__1-Gs-,.ListPage_table__2qY_8 tbody .ListPage_value__3X3Vq{-webkit-user-select:text;-moz-user-select:text;-ms-user-select:text;user-select:text}.ListPage_description__1Sci0{width:50%}.ListPage_description__1Sci0,.ListPage_value__3X3Vq{overflow:hidden;text-overflow:ellipsis}.ListPage_actions__2iqTu{width:50px;text-align:right}.PageLoadError_wrap__mpF75{display:flex;align-items:flex-start;justify-content:center}.PageLoadError_container__kcD9o{display:flex;flex-direction:column;background:#ffe5e5;padding:.25rem .5rem;border-radius:4px;color:#b94343;text-align:center}.PageLoadError_error-small__14Fex{font-size:.85em}#nprogress{pointer-events:none}#nprogress .bar{background:#ffc25b;position:fixed;z-index:1031;top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;box-shadow:0 0 10px #ffc25b,0 0 5px #ffc25b;opacity:1;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px)}#nprogress .spinner{display:block;position:fixed;z-index:1031;top:.9rem;right:.9rem}#nprogress .spinner-icon{width:1.2rem;height:1.2rem;box-sizing:border-box;border-color:#ffc25b transparent transparent #ffc25b;border-style:solid;border-width:2px;border-radius:50%;-webkit-animation:nprogress-spinner .4s linear infinite;animation:nprogress-spinner .4s linear infinite}.nprogress-custom-parent{overflow:hidden;position:relative}.nprogress-custom-parent #nprogress .bar,.nprogress-custom-parent #nprogress .spinner{position:absolute}@-webkit-keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg)}to{-webkit-transform:rotate(1turn)}}@keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}.Attribute_wrap__1Zy9J{display:flex;flex-direction:column;margin-bottom:1rem}.Attribute_name__3a-cD{font-size:.8em;color:#737373;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.Attribute_value__IxZCj:empty:after{content:"-"}.ButtonBar_container__21aEr{border-top:1px dotted #f2f2f2;padding-top:1rem;margin-bottom:1rem}.ButtonBar_container__21aEr>*{margin-right:.5rem}.LabeledInput_wrap__2KAyr{position:relative;margin-bottom:1em}.LabeledInput_label__1AyjZ{font-size:.8em;color:#737373;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;display:block}.LabeledInput_input-and-error-wrap__2iJKd{display:flex;align-items:baseline}.LabeledInput_error__2QBpW{flex-grow:0;display:block;color:#ff3656;margin-left:1rem;white-space:nowrap}.LabeledInput_hint__rAeG8{font-size:.8em;display:block}.SettingForm_error-wrap__3SdnI{display:flex;padding:.5rem 0}.SettingForm_error-message__uQK1Y{background:#ffe5e5;padding:.25rem .5rem;border-radius:4px;color:#b94343}.SettingForm_error-small__3owRp{font-size:.85em}.ClassicSpinner_wrap__1LF2_{display:block}html{box-sizing:border-box;overflow-y:scroll;font-size:14px}*,:after,:before{box-sizing:inherit}:root,body{background:#fff}body{color:#233656;font-family:Arial,Helvetica,sans-serif;font-weight:400;font-size:1rem;line-height:1.5rem;margin:0;padding:0;min-height:100vh;position:relative;display:flex;flex-direction:column}table{border-collapse:collapse;border-spacing:0}table td,table th{text-align:left}a{color:#233656;text-decoration:none}a:hover{text-decoration:underline}a.button,button,input[type=button],input[type=submit]{display:inline-block;cursor:pointer;border:none;border-radius:3px;padding:.375rem .75rem;font-size:1rem;line-height:1.5;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;white-space:nowrap}button,input[type=button],input[type=submit]{color:#4d4d4d;background-color:#d9d9d9;-webkit-transition:background-color .1s ease-in-out;transition:background-color .1s ease-in-out;outline:none}button:focus,button:hover,input[type=button]:focus,input[type=button]:hover,input[type=submit]:focus,input[type=submit]:hover{background-color:#b8b8b8}button:active,input[type=button]:active,input[type=submit]:active{background-color:#828282}a.button{color:#4d4d4d;background-color:initial;-webkit-transition:background-color .1s ease-in-out;transition:background-color .1s ease-in-out;outline:none;text-decoration:none}a.button:focus,a.button:hover{background-color:rgba(0,0,0,.15)}a.button:active{background-color:rgba(0,0,0,.4)}a.button.primary,button.primary,input[type=button].primary,input[type=submit].primary{color:#4d4d4d;background-color:#a6a6a6;-webkit-transition:background-color .1s ease-in-out;transition:background-color .1s ease-in-out;outline:none}a.button.primary:focus,a.button.primary:hover,button.primary:focus,button.primary:hover,input[type=button].primary:focus,input[type=button].primary:hover,input[type=submit].primary:focus,input[type=submit].primary:hover{background-color:#8d8d8d}a.button.primary:active,button.primary:active,input[type=button].primary:active,input[type=submit].primary:active{background-color:#646464}input[type=text]{border:none;border-radius:3px;padding:.5em;font-size:1rem;line-height:normal;color:#4d4d4d;background-color:#e6e6e6;-webkit-transition:background-color .1s ease-in-out;transition:background-color .1s ease-in-out;outline:none;box-sizing:initial;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}.button-wrap{display:flex;align-items:center}.svg-wrap{display:block}code{border-radius:2px;padding:0 .2rem}.sysname,code{background:#f2f2f2}.sysname{display:inline-block;border-radius:3px;padding:0 .5em;font-family:Courier New,Courier,monospace;font-size:.75em}#root{z-index:1;position:relative}