RubyGems - super_settings - Versions diffs - 1.0.2 → 2.0.1 - Mend

super_settings 1.0.2 → 2.0.1

Files changed (53) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +28 -0
data/README.md +128 -26
data/VERSION +1 -1
data/app/helpers/super_settings/settings_helper.rb +13 -3
data/app/views/layouts/super_settings/settings.html.erb +1 -1
data/config/routes.rb +1 -1
data/db/migrate/20210414004553_create_super_settings.rb +1 -7
data/lib/super_settings/application/api.js +4 -1
data/lib/super_settings/application/helper.rb +56 -17
data/lib/super_settings/application/images/arrow-down-short.svg +3 -0
data/lib/super_settings/application/images/arrow-up-short.svg +3 -0
data/lib/super_settings/application/images/info-circle.svg +4 -0
data/lib/super_settings/application/images/pencil-square.svg +4 -0
data/lib/super_settings/application/images/plus.svg +3 -1
data/lib/super_settings/application/images/trash3.svg +3 -0
data/lib/super_settings/application/images/x-circle.svg +4 -0
data/lib/super_settings/application/index.html.erb +54 -37
data/lib/super_settings/application/layout.html.erb +5 -2
data/lib/super_settings/application/layout_styles.css +7 -151
data/lib/super_settings/application/layout_vars.css.erb +21 -0
data/lib/super_settings/application/scripts.js +162 -37
data/lib/super_settings/application/style_vars.css.erb +62 -0
data/lib/super_settings/application/styles.css +183 -14
data/lib/super_settings/application.rb +18 -11
data/lib/super_settings/attributes.rb +1 -8
data/lib/super_settings/configuration.rb +9 -0
data/lib/super_settings/controller_actions.rb +2 -2
data/lib/super_settings/engine.rb +1 -1
data/lib/super_settings/history_item.rb +1 -1
data/lib/super_settings/http_client.rb +165 -0
data/lib/super_settings/rack_application.rb +3 -3
data/lib/super_settings/rest_api.rb +5 -4
data/lib/super_settings/setting.rb +13 -2
data/lib/super_settings/storage/active_record_storage.rb +7 -0
data/lib/super_settings/storage/history_attributes.rb +31 -0
data/lib/super_settings/storage/http_storage.rb +60 -184
data/lib/super_settings/storage/json_storage.rb +201 -0
data/lib/super_settings/storage/mongodb_storage.rb +238 -0
data/lib/super_settings/storage/redis_storage.rb +49 -111
data/lib/super_settings/storage/s3_storage.rb +165 -0
data/lib/super_settings/storage/storage_attributes.rb +64 -0
data/lib/super_settings/storage/test_storage.rb +3 -5
data/lib/super_settings/storage/transaction.rb +67 -0
data/lib/super_settings/storage.rb +13 -6
data/lib/super_settings/time_precision.rb +36 -0
data/lib/super_settings.rb +11 -0
data/super_settings.gemspec +4 -2
metadata +22 -9
data/lib/super_settings/application/images/edit.svg +0 -1
data/lib/super_settings/application/images/info.svg +0 -1
data/lib/super_settings/application/images/slash.svg +0 -1
data/lib/super_settings/application/images/trash.svg +0 -1

data/lib/super_settings/application.rb CHANGED Viewed

@@ -10,31 +10,38 @@ module SuperSettings
     # @param layout [String, Symbol] path to an ERB template to use as the layout around the application UI. You can
     #                                pass the symbol +:default+ to use the default layout that ships with the gem.
     # @param add_to_head [String] HTML code to add to the <head> element on the page.
-    def initialize(layout = nil, add_to_head = nil)
+    # @param api_base_url [String] the base URL for the REST API.
+    # @param color_scheme [Symbol] whether to use dark mode for the application UI. If +nil+, the user's system
+    #                              preference will be used.
+    def initialize(layout: nil, add_to_head: nil, api_base_url: nil, color_scheme: nil)
       if layout
         layout = File.expand_path(File.join("application", "layout.html.erb"), __dir__) if layout == :default
-        @layout = ERB.new(File.read(layout))
+        @layout = ERB.new(File.read(layout)) if layout
         @add_to_head = add_to_head
+      else
+        @layout = nil
+        @add_to_head = nil
       end
+      @api_base_url = api_base_url
+      @color_scheme = color_scheme&.to_sym
     end
-    # Render the specified ERB file in the lib/application directory distributed with the gem.
+    # Render the web UI application HTML.
     #
     # @return [void]
-    def render(erb_file)
-      template = ERB.new(File.read(File.expand_path(File.join("application", erb_file), __dir__)))
+    def render
+      template = ERB.new(File.read(File.expand_path(File.join("application", "index.html.erb"), __dir__)))
       html = template.result(binding)
-      if @layout
-        render_layout { html }
-      else
-        html
-      end
+      html = render_layout { html } if @layout
+      html = html.html_safe if html.respond_to?(:html_safe)
+      html
     end
     private
     def render_layout
-      @layout.result(binding)
+      @layout&.result(binding)
     end
   end
 end

data/lib/super_settings/attributes.rb CHANGED Viewed

@@ -4,20 +4,13 @@ module SuperSettings
   # Interface to expose mass setting attributes on an object. Setting attributes with a
   # hash will simply call the attribute writers for each key in the hash.
   module Attributes
-    class UnknownAttributeError < StandardError
-    end
     def initialize(attributes = nil)
       self.attributes = attributes if attributes
     end
     def attributes=(values)
       values.each do |name, value|
-        if respond_to?(:"#{name}=", true)
-          send(:"#{name}=", value)
-        else
-          raise UnknownAttributeError.new("unknown attribute #{name.to_s.inspect} for #{self.class}")
-        end
+        send(:"#{name}=", value) if respond_to?(:"#{name}=", true)
       end
     end
   end

data/lib/super_settings/configuration.rb CHANGED Viewed

@@ -25,6 +25,7 @@ module SuperSettings
       def initialize
         @superclass = nil
         @web_ui_enabled = true
+        @color_scheme = false
         @changed_by_block = nil
       end
@@ -63,6 +64,14 @@ module SuperSettings
         !!@web_ui_enabled
       end
+      # Set dark mode for the web UI. Possible values are :light, :dark, or :system.
+      # The default value is :light.
+      attr_writer :color_scheme
+      def color_scheme
+        (@color_scheme ||= :light).to_sym
+      end
       # Enhance the controller. You can define methods or call controller class methods like
       # +before_action+, etc. in the block. These will be applied to the engine controller.
       # This is essentially the same a monkeypatching the controller class.

data/lib/super_settings/controller_actions.rb CHANGED Viewed

@@ -19,7 +19,7 @@ module SuperSettings
     # Render the HTML application for managing settings.
     def root
-      html = SuperSettings::Application.new.render("index.html.erb")
+      html = SuperSettings::Application.new.render
       render html: html.html_safe, layout: true
     end
@@ -40,7 +40,7 @@ module SuperSettings
     # API endpoint for updating settings. See SuperSettings::RestAPI for details.
     def update
-      changed_by = Configuration.instance.controller.changed_by(self)
+      changed_by = SuperSettings.configuration.controller.changed_by(self)
       result = SuperSettings::RestAPI.update(params[:settings], changed_by)
       if result[:success]
         render json: result

data/lib/super_settings/engine.rb CHANGED Viewed

@@ -27,7 +27,7 @@ module SuperSettings
     config.after_initialize do
       # Call the deferred initialization block.
-      configuration = Configuration.instance
+      configuration = SuperSettings.configuration
       configuration.call
       SuperSettings.refresh_interval = configuration.refresh_interval unless configuration.refresh_interval.nil?

data/lib/super_settings/history_item.rb CHANGED Viewed

@@ -27,7 +27,7 @@ module SuperSettings
     def changed_by_display
       return changed_by if changed_by.nil?
-      display_proc = Configuration.instance.model.changed_by_display
+      display_proc = SuperSettings.configuration.model.changed_by_display
       if display_proc && !changed_by.nil?
         display_proc.call(changed_by) || changed_by
       else

data/lib/super_settings/http_client.rb ADDED Viewed

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+require "net/http"
+require "uri"
+module SuperSettings
+  # This is a simple HTTP client that is used to communicate with the REST API. It
+  # will keep the connection alive and reuse it on subsequent requests.
+  class HttpClient
+    DEFAULT_HEADERS = {"Accept" => "application/json"}.freeze
+    DEFAULT_TIMEOUT = 5.0
+    KEEP_ALIVE_TIMEOUT = 60
+    class Error < StandardError
+    end
+    class NotFoundError < Error
+    end
+    class InvalidRecordError < Error
+      attr_reader :errors
+      def initialize(message, errors:)
+        super(message)
+        @errors = errors
+      end
+    end
+    def initialize(base_url, headers: nil, params: nil, timeout: nil, user: nil, password: nil)
+      base_url = "#{base_url}/" unless base_url.end_with?("/")
+      @base_uri = URI(base_url)
+      @base_uri.query = query_string(params) if params
+      @headers = headers ? DEFAULT_HEADERS.merge(headers) : DEFAULT_HEADERS
+      @timeout = timeout || DEFAULT_TIMEOUT
+      @user = user
+      @password = password
+      @mutex = Mutex.new
+      @connections = []
+    end
+    def get(path, params = nil)
+      request = Net::HTTP::Get.new(request_uri(path, params))
+      send_request(request)
+    end
+    def post(path, params = nil)
+      request = Net::HTTP::Post.new(request_uri(path))
+      request.body = JSON.dump(params) if params
+      send_request(request)
+    end
+    private
+    def send_request(request)
+      set_headers(request)
+      response_payload = nil
+      attempts = 0
+      with_connection do |http|
+        http.start unless http.started?
+        response = http.request(request)
+        begin
+          response.value # raises exception unless response is a success
+          response_payload = JSON.parse(response.body)
+        rescue Net::ProtocolError
+          if [404, 410].include?(response.code.to_i)
+            raise NotFoundError.new("#{response.code} #{response.message}")
+          elsif response.code.to_i == 422
+            raise InvalidRecordError.new("#{response.code} #{response.message}", errors: JSON.parse(response.body)["errors"])
+          else
+            raise Error.new("#{response.code} #{response.message}")
+          end
+        rescue JSON::JSONError => e
+          raise Error.new(e.message)
+        end
+      rescue IOError, Errno::ECONNRESET => connection_error
+        attempts += 1
+        retry if attempts <= 1
+        raise connection_error
+      end
+      response_payload
+    end
+    def with_connection(&block)
+      http = pop_connection
+      begin
+        response = yield(http)
+        return_connection(http)
+        response
+      rescue => e
+        begin
+          http.finish if http.started?
+        rescue IOError
+        end
+        raise e
+      end
+    end
+    def pop_connection
+      http = nil
+      @mutex.synchronize do
+        http = @connections.pop
+      end
+      http = nil unless http&.started?
+      http ||= new_connection
+      http
+    end
+    def return_connection(http)
+      @mutex.synchronize do
+        if @connections.empty?
+          @connections.push(http)
+          http = nil
+        end
+      end
+      if http
+        begin
+          http.finish if http.started?
+        rescue IOError
+        end
+      end
+    end
+    def new_connection
+      http = Net::HTTP.new(@base_uri.host, @base_uri.port || @base_uri.inferred_port)
+      http.use_ssl = @base_uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+      http.write_timeout = @timeout
+      http.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
+      http
+    end
+    def set_headers(request)
+      @headers.each do |name, value|
+        name = name.to_s
+        values = Array(value)
+        request[name] = values[0].to_s
+        values[1, values.length].each do |val|
+          request.add_field(name, val.to_s)
+        end
+      end
+    end
+    def request_uri(path, params = nil)
+      uri = URI.join(@base_uri, path.delete_prefix("/"))
+      if (params && !params.empty?) || (@base_uri.query && !@base_uri.query.empty?)
+        uri.query = [uri.query, query_string(params)].join("&")
+      end
+      uri
+    end
+    def query_string(params)
+      q = []
+      q << @base_uri.query unless @base_uri.query.to_s.empty?
+      params&.each do |name, value|
+        q << "#{URI.encode_www_form_component(name.to_s)}=#{URI.encode_www_form_component(value.to_s)}"
+      end
+      q.join("&")
+    end
+  end
+end

data/lib/super_settings/rack_application.rb CHANGED Viewed

@@ -122,7 +122,7 @@ module SuperSettings
     #
     # @return [Boolean]
     def web_ui_enabled?
-      true
+      SuperSettings.configuration.controller.web_ui_enabled?
     end
     private
@@ -159,7 +159,7 @@ module SuperSettings
     def handle_root_request(request)
       response = check_authorization(request, write_required: true) do |user|
-        [200, {"content-type" => "text/html; charset=utf-8", "cache-control" => "no-cache"}, [Application.new(:default, add_to_head(request)).render("index.html.erb")]]
+        [200, {"content-type" => "text/html; charset=utf-8", "cache-control" => "no-cache"}, [Application.new(layout: :default, add_to_head: add_to_head(request), color_scheme: SuperSettings.configuration.controller.color_scheme).render]]
       end
       if [401, 403].include?(response.first)
@@ -236,7 +236,7 @@ module SuperSettings
     def post_params(request)
       if request.content_type.to_s.match?(/\Aapplication\/json/i) && request.body
-        request.params.merge(JSON.parse(request.body.string))
+        request.params.merge(JSON.parse(request.body.read))
       else
         request.params
       end

data/lib/super_settings/rest_api.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module SuperSettings
       #     ...
       #   ]
       def index
-        settings = Setting.active.sort_by(&:key)
+        settings = Setting.active.reject(&:deleted?).sort_by(&:key)
         {settings: settings.collect(&:as_json)}
       end
@@ -46,7 +46,8 @@ module SuperSettings
       #     updated_at: iso8601 string
       #   }
       def show(key)
-        Setting.find_by_key(key)&.as_json
+        setting = Setting.find_by_key(key)
+        setting.as_json if setting && !setting.deleted?
       end
       # The update operation uses a transaction to atomically update all settings.
@@ -156,7 +157,7 @@ module SuperSettings
       #
       # @example
       #   GET /last_updated_at
-      #      #
+      #
       #   The response payload is:
       #   {
       #     last_updated_at: iso8601 string
@@ -188,7 +189,7 @@ module SuperSettings
       #   ]
       def updated_since(time)
         time = Coerce.time(time)
-        settings = Setting.updated_since(time)
+        settings = Setting.updated_since(time).reject(&:deleted?)
         {settings: settings.collect(&:as_json)}
       end
     end

data/lib/super_settings/setting.rb CHANGED Viewed

@@ -109,6 +109,7 @@ module SuperSettings
       # @param time [Time]
       # @return [Array<Setting>]
       def updated_since(time)
+        time = SuperSettings::Coerce.time(time)
         storage.with_connection do
           storage.updated_since(time).collect { |record| new(record) }
         end
@@ -219,6 +220,16 @@ module SuperSettings
           next if Coerce.blank?(setting_params["key"])
           next if ["value_type", "value", "description", "deleted"].all? { |name| Coerce.blank?(setting_params[name]) }
+          key_was = setting_params["key_was"]
+          if key_was && !changed.include?(key_was)
+            old_setting = Setting.find_by_key(key_was)
+            if old_setting
+              old_setting.deleted = true
+              old_setting.changed_by = changed_by
+              changed[old_setting.key] = old_setting
+            end
+          end
           key = setting_params["key"]
           setting = changed[key] || Setting.find_by_key(key)
           unless setting
@@ -372,7 +383,7 @@ module SuperSettings
     #
     # @param val [Time, DateTime]
     def created_at=(val)
-      val = Coerce.time(val)
+      val = TimePrecision.new(val).time
       will_change!(:created_at, val) unless created_at == val
       @record.created_at = val
     end
@@ -388,7 +399,7 @@ module SuperSettings
     #
     # @param val [Time, DateTime]
     def updated_at=(val)
-      val = Coerce.time(val)
+      val = TimePrecision.new(val).time
       will_change!(:updated_at, val) unless updated_at == val
       @record.updated_at = val
     end

data/lib/super_settings/storage/active_record_storage.rb CHANGED Viewed

@@ -60,6 +60,13 @@ module SuperSettings
           Model.transaction(&block)
         end
+        def destroy_all
+          ApplicationRecord.transaction do
+            Model.delete_all
+            HistoryModel.delete_all
+          end
+        end
         protected
         # Only load settings asynchronously if there is an extra database connection left in the

data/lib/super_settings/storage/history_attributes.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module SuperSettings
+  module Storage
+    # Generic class that can be extended to represent a history record for a setting in memory.
+    class HistoryAttributes
+      include SuperSettings::Attributes
+      attr_accessor :key, :value, :changed_by
+      attr_writer :deleted
+      attr_reader :created_at
+      def initialize(*)
+        @key = nil
+        @value = nil
+        @changed_by = nil
+        @created_at = nil
+        @deleted = false
+        super
+      end
+      def created_at=(val)
+        @created_at = TimePrecision.new(val).time
+      end
+      def deleted?
+        !!@deleted
+      end
+    end
+  end
+end