keystone_ui-preferences 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497f7eeb505b63450d4e41595648c92f9acaba75494eb27c76ee901de7c60f9d
-  data.tar.gz: 80e5ffc7ecfa86e0ef011b14cd939e4c2d39c9c4d3e8e086d6efd22756d8542d
+  metadata.gz: 132478f987e0dbbf12eeda5ac9c9e9fe14a9ca1ec8b8ce60618b29e272f5db8f
+  data.tar.gz: eefd3cd44bce3d9aa5f3dab0c3ff4f5ad4a882e15ab9fbd836964e46e631724a
 SHA512:
-  metadata.gz: c79c4d859ae6f1aaa84cb608c626e69a13fb0aa908c8f373a6b11f07a49c8302d39bbcce5ac02228f94b5dd521a89225f000fd3c88277ef48b5e93053d840394
-  data.tar.gz: f89d730b80476e7c455cc8eba394adab7b3a9c39199395143236cad08dca89e9331032b8fea268be0ee2f506643b3cf9fbbc105a7fac1b24ddc27e150f1b19d8
+  metadata.gz: da15030c2de6a478df7106c48218dfe8bcd2197f592f68ea8147b5b6fa389b5c65b4e30699a1480df86f13ec1d8069a2da2058c38550e8ed539e74ccab8dfe74
+  data.tar.gz: be3c817d9c47d16df821adeb5cf7fbe2e6cb884ad48e3711e00f2d270619c25368a202d0364593fa15bea9f7eefc2651027a3f80fa225fd4fe4645b6c692d732

data/README.md

@@ -18,6 +18,13 @@ bin/rails generate keystone_ui:preferences:install
 bin/rails db:migrate
 ```
 
+After updating the gem, run its update generator to copy any migrations added since it was installed:
+
+```bash
+bin/rails generate keystone_ui:preferences:update
+bin/rails db:migrate
+```
+
 Mount the engine in `config/routes.rb`. A table's Columns menu saves to it:
 
 ```ruby
@@ -94,6 +101,36 @@ 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.
 
+## Navigation placement
+
+A person chooses where keystone_ui draws the desktop navigation, at the top or as a sidebar on the left or the right, in a settings_hub section the app registers:
+
+```ruby
+SettingsHub.section :navigation_placement, area: :user, title: "Navigation",
+  renders: "keystone_ui/preferences/settings/navigation_placement",
+  runs: "KeystoneUi::Preferences::PickNavigationPlacement"
+```
+
+The section offers Top, Left and Right, with the placement that applies to the person selected, or Top when nothing is saved. Saving keeps `"placement": "left"` for that person under the `navigation` key, leaving any saved tab order as it was, and keystone_ui's navigation reads it on the next page they open. A placement other than `top`, `left` or `right` is refused with a message, and nothing is saved.
+
+The `navigation` key follows the account layouts above, so an account that turns off members-choose for it draws its own placement and tab order for every member.
+
+While it is off, the placement and tab order sections say the account sets the navigation for everyone and offer no save. A placement, tab order or reset sent anyway is refused with a message, and nothing is saved.
+
+## Tab order
+
+A person sets the order of the navigation's groups, and of the tabs in each group, in a settings_hub section the app registers:
+
+```ruby
+SettingsHub.section :navigation_order, area: :user, title: "Tab order",
+  renders: "keystone_ui/preferences/settings/navigation_order",
+  runs: "KeystoneUi::Preferences::PickNavigationOrder"
+```
+
+The section lists the groups declared with keystone_ui's `navigation_group`, each with the tabs the person may see, in the order that applies to them. A group with no tab they may see is left out. Each group and tab has an Up and a Down button, and pressing one saves the order with it moved one place, so the page works in a Hotwire Native web view with no script and nothing to drag. At phone width each row's buttons sit under its name.
+
+Saving keeps `"order": [{ "group": "Admin" }, { "group": "Sales", "tabs": ["orders", "quotes"] }]` for that person under the `navigation` key, naming groups by label and tabs by key, and leaves their saved placement as it was. keystone_ui draws the navigation in that order on the next page they open, with anything the order does not name after it in its declared order. Reset removes the saved order, so the navigation goes back to the declared order. An order that is not a list of groups is refused with a message, and nothing is saved.
+
 ## What is stored
 
 One row per owner and component key, in `keystone_ui_preferences_component_preferences`:

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class NavigationArrangement
+      def initialize(arranged)
+        @arranged = arranged
+      end
+
+      def group_moved(index, step)
+        moved(order, index, step)
+      end
+
+      def tab_moved(group_index, tab_index, step)
+        order.tap { |groups| moved(groups[group_index]["tabs"], tab_index, step) }
+      end
+
+      def order
+        @arranged.map { |group, tabs| { "group" => group.label, "tabs" => tabs.map { |tab| tab.key.to_s } } }
+      end
+
+      private
+
+      def moved(items, index, step)
+        items.insert(index + step, items.delete_at(index))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "json"
+
+module KeystoneUi
+  module Preferences
+    class PickNavigationOrder
+      def initialize(values:, person: nil, account: nil)
+        @person = person
+        @account = account
+        @values = values
+      end
+
+      def call
+        return Refusal.new("Your account sets the navigation for everyone, so this was not saved.") unless members_choose?
+        return reset if @values[:reset] == "1"
+        return Refusal.new("That navigation order is too large to save.") if @values[:order].to_s.bytesize > KeystoneUi::Preferences.configuration.max_value_bytes
+
+        order = submitted_order
+        return Refusal.new("Choose an order for the navigation's groups and tabs.") unless order.is_a?(Array)
+
+        preference.update!(value: preference.value.to_h.merge("order" => order))
+        Kept.new
+      end
+
+      private
+
+      def members_choose?
+        LayoutChoice.new(person: @person, account: @account, component_key: "navigation").members_choose?
+      end
+
+      def reset
+        preference.update!(value: preference.value.to_h.except("order"))
+        Kept.new
+      end
+
+      def preference
+        @preference ||= ComponentPreference.find_or_initialize_by(owner: @person, component_key: "navigation")
+      end
+
+      def submitted_order
+        JSON.parse(@values[:order].to_s)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class PickNavigationPlacement
+      PLACEMENTS = %w[top left right].freeze
+
+      def initialize(values:, person: nil, account: nil)
+        @person = person
+        @account = account
+        @values = values
+      end
+
+      def call
+        return Refusal.new("Your account sets the navigation for everyone, so this was not saved.") unless members_choose?
+        return Refusal.new("Choose Top, Left or Right for the navigation.") unless PLACEMENTS.include?(@values[:placement])
+
+        preference = ComponentPreference.find_or_initialize_by(owner: @person, component_key: "navigation")
+        preference.update!(value: preference.value.to_h.merge("placement" => @values[:placement]))
+        Kept.new
+      end
+
+      private
+
+      def members_choose?
+        LayoutChoice.new(person: @person, account: @account, component_key: "navigation").members_choose?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+<% choice = KeystoneUi::Preferences::LayoutChoice.new(person: person, account: account, component_key: "navigation") %>
+<% saved_order = choice.value&.dig("order") || [] %>
+
+<% if choice.members_choose? %>
+  <% permitted = KeystoneUi.configuration.navigation_groups.map { |group| [ group, group.tabs_permitted_for(self) ] }.reject { |_group, tabs| tabs.empty? } %>
+  <% arranged = KeystoneUi::NavigationOrder.new(saved_order).arrange(permitted) %>
+  <% arrangement = KeystoneUi::Preferences::NavigationArrangement.new(arranged) %>
+
+  <% arranged.each_with_index do |(group, tabs), group_index| %>
+    <div data-navigation-group="<%= group.label %>">
+      <%= ui_grid(cols: { default: 1, sm: 2 }, gap: :sm) do %>
+        <p data-group-label><strong><%= group.label %></strong></p>
+        <%= ui_grid(cols: { default: 2 }, gap: :sm) do %>
+          <% if group_index.positive? %>
+            <%= form_with(url: submit_url, method: :patch, data: { turbo: false, group_move: "up" }) do %>
+              <%= hidden_field_tag "order", arrangement.group_moved(group_index, -1).to_json, id: nil %>
+              <%= ui_button(label: "Up", type: :submit, variant: :secondary, size: :sm) %>
+            <% end %>
+          <% end %>
+          <% if group_index < arranged.size - 1 %>
+            <%= form_with(url: submit_url, method: :patch, data: { turbo: false, group_move: "down" }) do %>
+              <%= hidden_field_tag "order", arrangement.group_moved(group_index, 1).to_json, id: nil %>
+              <%= ui_button(label: "Down", type: :submit, variant: :secondary, size: :sm) %>
+            <% end %>
+          <% end %>
+        <% end %>
+      <% end %>
+      <% tabs.each_with_index do |tab, tab_index| %>
+        <div data-navigation-tab="<%= tab.key %>">
+          <%= ui_grid(cols: { default: 1, sm: 2 }, gap: :sm) do %>
+            <span data-tab-label><%= tab.label %></span>
+            <%= ui_grid(cols: { default: 2 }, gap: :sm) do %>
+              <% if tab_index.positive? %>
+                <%= form_with(url: submit_url, method: :patch, data: { turbo: false, tab_move: "up" }) do %>
+                  <%= hidden_field_tag "order", arrangement.tab_moved(group_index, tab_index, -1).to_json, id: nil %>
+                  <%= ui_button(label: "Up", type: :submit, variant: :secondary, size: :sm) %>
+                <% end %>
+              <% end %>
+              <% if tab_index < tabs.size - 1 %>
+                <%= form_with(url: submit_url, method: :patch, data: { turbo: false, tab_move: "down" }) do %>
+                  <%= hidden_field_tag "order", arrangement.tab_moved(group_index, tab_index, 1).to_json, id: nil %>
+                  <%= ui_button(label: "Down", type: :submit, variant: :secondary, size: :sm) %>
+                <% end %>
+              <% end %>
+            <% end %>
+          <% end %>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+
+  <%= form_with(url: submit_url, method: :patch, data: { turbo: false }) do %>
+    <%= hidden_field_tag "reset", "1", id: nil %>
+    <%= ui_button(label: "Reset", type: :submit, variant: :secondary) %>
+  <% end %>
+<% else %>
+  <%= ui_alert(message: "Your account sets the navigation for everyone.") %>
+<% end %>

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

@@ -0,0 +1,15 @@
+<% choice = KeystoneUi::Preferences::LayoutChoice.new(person: person, account: account, component_key: "navigation") %>
+<% current = choice.value&.dig("placement") || "top" %>
+
+<% if choice.members_choose? %>
+  <%= form_with(url: submit_url, method: :patch, data: { turbo: false }) do %>
+    <%= ui_grid(cols: { default: 1, sm: 3 }, gap: :sm) do %>
+      <% { "top" => "Top", "left" => "Left", "right" => "Right" }.each do |placement, label| %>
+        <%= ui_radio_card(name: "placement", value: placement, label: label, checked: placement == current) %>
+      <% end %>
+    <% end %>
+    <%= ui_button(label: "Save", type: :submit) %>
+  <% end %>
+<% else %>
+  <%= ui_alert(message: "Your account sets the navigation for everyone.") %>
+<% end %>

data/lib/generators/keystone_ui/preferences/install/templates/create_keystone_ui_preferences_component_preferences.rb.erb

@@ -1,7 +1,7 @@
 class CreateKeystoneUiPreferencesComponentPreferences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :keystone_ui_preferences_component_preferences do |t|
-      t.references :owner, polymorphic: true, null: false
+      t.references :owner, polymorphic: true, null: false, index: false
       t.string :component_key, null: false
       t.json :value, null: false, default: {}
       t.boolean :members_choose, default: true, null: false

data/lib/generators/keystone_ui/preferences/update/templates/remove_extra_owner_index_from_keystone_ui_preferences_component_preferences.rb.erb

@@ -0,0 +1,5 @@
+class RemoveExtraOwnerIndexFromKeystoneUiPreferencesComponentPreferences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    remove_index :keystone_ui_preferences_component_preferences, %i[owner_type owner_id], name: "index_keystone_ui_preferences_component_preferences_on_owner", if_exists: true
+  end
+end

data/lib/generators/keystone_ui/preferences/update/update_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module KeystoneUi
+  module Preferences
+    module Generators
+      class UpdateGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+
+        source_root File.expand_path("templates", __dir__)
+
+        desc "Updates KeystoneUi::Preferences: copies migrations added since it was installed."
+
+        def copy_remove_extra_owner_index_migration
+          migration_template(
+            "remove_extra_owner_index_from_keystone_ui_preferences_component_preferences.rb.erb",
+            "db/migrate/remove_extra_owner_index_from_keystone_ui_preferences_component_preferences.rb"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/keystone_ui/preferences/version.rb

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

data/lib/keystone_ui/preferences.rb

@@ -1,4 +1,5 @@
 require "keystone_ui"
+require "keystone_ui/navigation_order"
 require "keystone_ui/preferences/version"
 require "keystone_ui/preferences/configuration"
 require "keystone_ui/preferences/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-preferences
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.33.1
+        version: 0.38.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.33.1
+        version: 0.38.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -83,12 +83,19 @@ files:
 - 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/navigation_arrangement.rb
 - app/models/keystone_ui/preferences/pick_account_layouts.rb
+- app/models/keystone_ui/preferences/pick_navigation_order.rb
+- app/models/keystone_ui/preferences/pick_navigation_placement.rb
 - app/models/keystone_ui/preferences/refusal.rb
 - app/views/keystone_ui/preferences/settings/_account_layouts.html.erb
+- app/views/keystone_ui/preferences/settings/_navigation_order.html.erb
+- app/views/keystone_ui/preferences/settings/_navigation_placement.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
+- lib/generators/keystone_ui/preferences/update/templates/remove_extra_owner_index_from_keystone_ui_preferences_component_preferences.rb.erb
+- lib/generators/keystone_ui/preferences/update/update_generator.rb
 - lib/keystone_ui-preferences.rb
 - lib/keystone_ui/preferences.rb
 - lib/keystone_ui/preferences/configuration.rb