keystone_ui-preferences 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e15e5f655d70c8bfd4b7b0d1c976705de25a0f0c0d24645e5aa3afe5c9e8ee
-  data.tar.gz: ec05d21e7991ff5378e817f8f70be35fbae4f92f6a141467fc188447176b1850
+  metadata.gz: 497f7eeb505b63450d4e41595648c92f9acaba75494eb27c76ee901de7c60f9d
+  data.tar.gz: 80e5ffc7ecfa86e0ef011b14cd939e4c2d39c9c4d3e8e086d6efd22756d8542d
 SHA512:
-  metadata.gz: b82309fb9a0f5881748b3de2152973e348076aa1ae474fceb55be7476929e771732a3f023f655e22e8f4e34b3725218ff15a2d8c092a64a46842b5f94b9943c3
-  data.tar.gz: d6617f9f3c90e2931f7ef5a29fcd6b103b4e32da8a2d4c5f1026828831d31609e8ac3af82fe390953c7e01c12c986c890ca988b760872aab22fcf8f37c8d4b53
+  metadata.gz: c79c4d859ae6f1aaa84cb608c626e69a13fb0aa908c8f373a6b11f07a49c8302d39bbcce5ac02228f94b5dd521a89225f000fd3c88277ef48b5e93053d840394
+  data.tar.gz: f89d730b80476e7c455cc8eba394adab7b3a9c39199395143236cad08dca89e9331032b8fea268be0ee2f506643b3cf9fbbc105a7fac1b24ddc27e150f1b19d8

data/README.md

@@ -41,9 +41,12 @@ KeystoneUi::Preferences.configure do |config|
   config.current_owner_method = :current_user        # returns the person a value is saved for
   config.authentication_method = :authenticate_user! # runs before every save
   config.current_account_method = :current_account   # returns the account; nil (the default) skips the account level
+  config.max_value_bytes = 10_000                    # the largest saved value accepted, in bytes
 end
 ```
 
+The save address refuses, with a 422 and nothing saved, a body that is not a JSON object, a body larger than `max_value_bytes`, and a component key that is not 1 to 64 letters, digits and underscores.
+
 ## Using it
 
 Give a table a key, and the hidden columns it shows a person with nothing saved:
@@ -70,7 +73,7 @@ With `current_account_method` set, an account can keep its own layout for a key,
 2. Otherwise the account's layout, when it has one.
 3. Otherwise the table's default layout, from its own call.
 
-A person whose account does not let members choose sees no Columns menu, and a save they send is refused. Reading the layout that applies makes one query.
+A person whose account does not let members choose sees no Columns menu, and a save they send is refused. Reading the layout that applies makes one query, and each owner's row for a key, or the fact that there is none, is then kept in `Rails.cache` until that row is saved through the gem, so a later view makes no query. A row changed outside the gem keeps its old cache entry until it expires. With no cache configured, every view reads the rows.
 
 An admin sets an account's layouts in a settings_hub section. Who may open it is the app's decision, so register it behind a capability of the app's choosing:
 
@@ -81,7 +84,15 @@ SettingsHub.section :account_layouts, area: :account, title: "Table layouts",
   runs: "KeystoneUi::Preferences::PickAccountLayouts"
 ```
 
-The section lists each component key the admin or the account has a saved layout for. Each key has the members-choose switch and, when the admin has a saved layout of their own, a button that makes it the account's layout.
+The section lists each component key the admin or the account has a saved layout for, by the name the app gives it, or by the key in words when it has none:
+
+```ruby
+KeystoneUi::Preferences.configure do |config|
+  config.name_component :revenue_projection_months, "Revenue projection – By month"
+end
+```
+
+Each key has the members-choose switch and, when the admin has a saved layout of their own, a button that makes it the account's layout.
 
 ## What is stored
 

data/app/controllers/keystone_ui/preferences/component_preferences_controller.rb

@@ -4,11 +4,19 @@ module KeystoneUi
   module Preferences
     class ComponentPreferencesController < ApplicationController
       def update
+        return head 422 unless params[:component_key].match?(/\A\w{1,64}\z/)
         return head :forbidden unless keystone_layout_choice(params[:component_key]).members_choose?
 
+        return head 422 if request.raw_post.bytesize > KeystoneUi::Preferences.configuration.max_value_bytes
+
+        value = JSON.parse(request.raw_post)
+        return head 422 unless value.is_a?(Hash)
+
         preference = ComponentPreference.find_or_initialize_by(owner: current_owner, component_key: params[:component_key])
-        preference.update!(value: JSON.parse(request.raw_post))
+        preference.update!(value: value)
         head :no_content
+      rescue ActionDispatch::Http::Parameters::ParseError
+        head 422
       end
     end
   end

data/app/models/keystone_ui/preferences/component_preference.rb

@@ -7,6 +7,12 @@ module KeystoneUi
 
       belongs_to :owner, polymorphic: true
 
+      after_commit { Rails.cache.delete(self.class.cache_key_for(owner_type, owner_id, component_key)) }
+
+      def self.cache_key_for(owner_type, owner_id, component_key)
+        [ "keystone_ui_preferences", owner_type, owner_id, component_key ].join("/")
+      end
+
       def owned_by?(record)
         owner_type == record.class.base_class.name && owner_id == record.id
       end

data/app/models/keystone_ui/preferences/layout_choice.rb

@@ -3,6 +3,8 @@
 module KeystoneUi
   module Preferences
     class LayoutChoice
+      NOTHING_SAVED = "nothing saved"
+
       def initialize(person:, account:, component_key:)
         @person = person
         @account = account
@@ -32,7 +34,26 @@ module KeystoneUi
       end
 
       def preferences
-        @preferences ||= ComponentPreference.where(owner: [ @person, @account ].compact, component_key: @component_key).to_a
+        @preferences ||= begin
+          owners = [ @person, @account ].compact
+          cached = owners.index_with { |owner| Rails.cache.read(cache_key(owner)) }
+          missing = cached.select { |_owner, entry| entry.nil? }.keys
+          cached.values.grep(ComponentPreference) + read_and_cache(missing)
+        end
+      end
+
+      def read_and_cache(owners)
+        return [] if owners.empty?
+
+        found = ComponentPreference.where(owner: owners, component_key: @component_key).to_a
+        owners.each do |owner|
+          Rails.cache.write(cache_key(owner), found.find { |preference| preference.owned_by?(owner) } || NOTHING_SAVED)
+        end
+        found
+      end
+
+      def cache_key(owner)
+        ComponentPreference.cache_key_for(owner.class.base_class.name, owner.id, @component_key)
       end
     end
   end

data/app/views/keystone_ui/preferences/settings/_account_layouts.html.erb

@@ -4,7 +4,7 @@
 <% component_keys.each do |component_key| %>
   <div data-component-key="<%= component_key %>">
     <% account_preference = preferences.find { |preference| preference.component_key == component_key && preference.owned_by?(account) } %>
-    <%= ui_section(title: component_key.humanize, spacing: :sm) do %>
+    <%= ui_section(title: KeystoneUi::Preferences.configuration.component_name(component_key), spacing: :sm) do %>
       <%= form_with(url: submit_url, method: :patch, data: { turbo: false }) do %>
         <%= hidden_field_tag "component_key", component_key, id: nil %>
         <%= hidden_field_tag "members_choose", "0", id: nil %>

data/lib/keystone_ui/preferences/configuration.rb

@@ -3,11 +3,21 @@
 module KeystoneUi
   module Preferences
     class Configuration
-      attr_accessor :current_owner_method, :authentication_method, :current_account_method
+      attr_accessor :current_owner_method, :authentication_method, :current_account_method, :max_value_bytes
 
       def initialize
         @current_owner_method = :current_user
         @authentication_method = :authenticate_user!
+        @component_names = {}
+        @max_value_bytes = 10_000
+      end
+
+      def name_component(component_key, name)
+        @component_names[component_key.to_s] = name
+      end
+
+      def component_name(component_key)
+        @component_names.fetch(component_key.to_s) { component_key.to_s.humanize }
       end
     end
 

data/lib/keystone_ui/preferences/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Preferences
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-preferences
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tyler Schneider