keystone_ui-preferences 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dffbd18d9f90fc3020e69bfbb093379b348a2acd0b8d12d805d751c40c59f1ca
-  data.tar.gz: 8ecb76a3a5fa72a67c7751e14c73a6af4b2e7fb5343b9582cc10a341de886542
+  metadata.gz: 01e15e5f655d70c8bfd4b7b0d1c976705de25a0f0c0d24645e5aa3afe5c9e8ee
+  data.tar.gz: ec05d21e7991ff5378e817f8f70be35fbae4f92f6a141467fc188447176b1850
 SHA512:
-  metadata.gz: ad669daede81eed26e2134742d0cb8ee84fb9f931e1777e26e49a9e9167dcce4731fc6bb8b607c0c742e9f1773146f98c07e8e29666f809c8d6ea5ffc84dae9f
-  data.tar.gz: cd87ce9b9ce0e390ca927d88a7f3b3e7b02a5bbc667147cf352dff22467c45e25c2e6a93fdc8b328b268fb4134c08f7f5cb0614920804bcc65404d45d3439eef
+  metadata.gz: b82309fb9a0f5881748b3de2152973e348076aa1ae474fceb55be7476929e771732a3f023f655e22e8f4e34b3725218ff15a2d8c092a64a46842b5f94b9943c3
+  data.tar.gz: d6617f9f3c90e2931f7ef5a29fcd6b103b4e32da8a2d4c5f1026828831d31609e8ac3af82fe390953c7e01c12c986c890ca988b760872aab22fcf8f37c8d4b53

data/README.md

@@ -40,6 +40,7 @@ The gem asks the host for the signed-in person and for its sign-in check. Both d
 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
 end
 ```
 
@@ -59,7 +60,28 @@ Give a table a key, and the hidden columns it shows a person with nothing saved:
 ) %>
 ```
 
-A signed-in person sees a Columns menu above the table. Ticking or unticking a column saves `{ "hidden_columns": [...] }` for that person and key, replacing what they saved before, and reloads the page. Another person viewing the same table sees only their own saved layout. With nobody signed in, the table renders from its own call and shows no menu.
+A signed-in person sees a Columns menu above the table. Their changes save `{ "hidden_columns": [...], "column_order": [...] }` for that person and key when the menu closes, replacing what they saved before, and reload the page. Another person viewing the same table sees only their own saved layout. With nobody signed in, the table renders from its own call and shows no menu.
+
+## Account layouts
+
+With `current_account_method` set, an account can keep its own layout for a key, and a members-choose switch saying whether its members may keep their own. A table shows, in this order:
+
+1. The person's own layout, when the account lets members choose.
+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.
+
+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:
+
+```ruby
+SettingsHub.section :account_layouts, area: :account, title: "Table layouts",
+  capability: :configure_site,
+  renders: "keystone_ui/preferences/settings/account_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.
 
 ## What is stored
 
@@ -67,7 +89,7 @@ One row per owner and component key, in `keystone_ui_preferences_component_prefe
 
 | Column | Holds |
 |--------|-------|
-| `owner` | the person the value belongs to (polymorphic) |
+| `owner` | the person or account the value belongs to (polymorphic) |
 | `component_key` | the key the page gave the component |
 | `value` | the JSON object last saved |
 | `members_choose` | whether an account's members may keep their own value, on by default |

data/app/controllers/concerns/keystone_ui/preferences/component_preferences.rb

@@ -15,11 +15,21 @@ module KeystoneUi
         owner = send(KeystoneUi::Preferences.configuration.current_owner_method)
         return unless owner
 
+        choice = keystone_layout_choice(component_key)
         {
-          value: ComponentPreference.find_by(owner: owner, component_key: component_key.to_s)&.value,
-          save_url: keystone_ui_preferences.component_preference_path(component_key: component_key)
+          value: choice.value,
+          save_url: (keystone_ui_preferences.component_preference_path(component_key: component_key) if choice.members_choose?)
         }
       end
+
+      def keystone_layout_choice(component_key)
+        LayoutChoice.new(person: send(KeystoneUi::Preferences.configuration.current_owner_method), account: keystone_preferences_account, component_key: component_key)
+      end
+
+      def keystone_preferences_account
+        method = KeystoneUi::Preferences.configuration.current_account_method
+        send(method) if method
+      end
     end
   end
 end

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

@@ -4,6 +4,8 @@ module KeystoneUi
   module Preferences
     class ComponentPreferencesController < ApplicationController
       def update
+        return head :forbidden unless keystone_layout_choice(params[:component_key]).members_choose?
+
         preference = ComponentPreference.find_or_initialize_by(owner: current_owner, component_key: params[:component_key])
         preference.update!(value: JSON.parse(request.raw_post))
         head :no_content

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

@@ -6,6 +6,10 @@ module KeystoneUi
       self.table_name = "keystone_ui_preferences_component_preferences"
 
       belongs_to :owner, polymorphic: true
+
+      def owned_by?(record)
+        owner_type == record.class.base_class.name && owner_id == record.id
+      end
     end
   end
 end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class Kept
+      def ok? = true
+
+      def message = nil
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class LayoutChoice
+      def initialize(person:, account:, component_key:)
+        @person = person
+        @account = account
+        @component_key = component_key.to_s
+      end
+
+      def value
+        return account_preference.value unless members_choose?
+
+        (own_preference || account_preference)&.value
+      end
+
+      def members_choose?
+        account_preference.nil? || account_preference.members_choose
+      end
+
+      private
+
+      def own_preference
+        preferences.find { |preference| preference.owned_by?(@person) }
+      end
+
+      def account_preference
+        return nil unless @account
+
+        preferences.find { |preference| preference.owned_by?(@account) }
+      end
+
+      def preferences
+        @preferences ||= ComponentPreference.where(owner: [ @person, @account ].compact, component_key: @component_key).to_a
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class PickAccountLayouts
+      def initialize(values:, person: nil, account: nil)
+        @person = person
+        @account = account
+        @values = values
+      end
+
+      def call
+        return Refusal.new("There is no account to save this layout on.") unless @account
+
+        @values[:use_mine] == "1" ? share_mine : set_members_choose
+      end
+
+      private
+
+      def share_mine
+        mine = ComponentPreference.find_by(owner: @person, component_key: component_key)
+        return Refusal.new("You have no saved layout for this table to share.") unless mine
+
+        account_preference.update!(value: mine.value)
+        Kept.new
+      end
+
+      def set_members_choose
+        account_preference.update!(members_choose: @values[:members_choose] == "1")
+        Kept.new
+      end
+
+      def account_preference
+        @account_preference ||= ComponentPreference.find_or_initialize_by(owner: @account, component_key: component_key)
+      end
+
+      def component_key
+        @values[:component_key]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class Refusal
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def ok? = false
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+<% preferences = KeystoneUi::Preferences::ComponentPreference.where(owner: [ person, account ]).to_a %>
+<% component_keys = preferences.map(&:component_key).uniq.sort %>
+
+<% 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 %>
+      <%= 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 %>
+        <%= ui_checkbox_row(name: "members_choose", value: "1", label: "Members choose their own layout", checked: account_preference.nil? || account_preference.members_choose) %>
+        <%= ui_button(label: "Save", type: :submit) %>
+      <% end %>
+      <% if preferences.any? { |preference| preference.component_key == component_key && preference.owned_by?(person) } %>
+        <%= form_with(url: submit_url, method: :patch, data: { turbo: false }) do %>
+          <%= hidden_field_tag "component_key", component_key, id: nil %>
+          <%= hidden_field_tag "use_mine", "1", id: nil %>
+          <%= ui_button(label: "Use my layout for everyone", type: :submit, variant: :secondary) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

data/lib/keystone_ui/preferences/configuration.rb

@@ -3,7 +3,7 @@
 module KeystoneUi
   module Preferences
     class Configuration
-      attr_accessor :current_owner_method, :authentication_method
+      attr_accessor :current_owner_method, :authentication_method, :current_account_method
 
       def initialize
         @current_owner_method = :current_user

data/lib/keystone_ui/preferences/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-preferences
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -81,6 +81,11 @@ files:
 - app/controllers/keystone_ui/preferences/component_preferences_controller.rb
 - app/models/keystone_ui/preferences/application_record.rb
 - app/models/keystone_ui/preferences/component_preference.rb
+- app/models/keystone_ui/preferences/kept.rb
+- app/models/keystone_ui/preferences/layout_choice.rb
+- app/models/keystone_ui/preferences/pick_account_layouts.rb
+- app/models/keystone_ui/preferences/refusal.rb
+- app/views/keystone_ui/preferences/settings/_account_layouts.html.erb
 - config/routes.rb
 - lib/generators/keystone_ui/preferences/install/install_generator.rb
 - lib/generators/keystone_ui/preferences/install/templates/create_keystone_ui_preferences_component_preferences.rb.erb