keystone_ui-preferences 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dffbd18d9f90fc3020e69bfbb093379b348a2acd0b8d12d805d751c40c59f1ca
+  data.tar.gz: 8ecb76a3a5fa72a67c7751e14c73a6af4b2e7fb5343b9582cc10a341de886542
+SHA512:
+  metadata.gz: ad669daede81eed26e2134742d0cb8ee84fb9f931e1777e26e49a9e9167dcce4731fc6bb8b607c0c742e9f1773146f98c07e8e29666f809c8d6ea5ffc84dae9f
+  data.tar.gz: cd87ce9b9ce0e390ca927d88a7f3b3e7b02a5bbc667147cf352dff22467c45e25c2e6a93fdc8b328b268fb4134c08f7f5cb0614920804bcc65404d45d3439eef

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2026 Tyler Schneider
+
+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,73 @@
+# keystone_ui-preferences
+
+Per-user saved choices for Keystone UI components, such as a data table's hidden columns.
+
+A page gives a `ui_data_table` a `key:`. This gem saves each signed-in person's layout for that key and hands it back to keystone_ui, so the table renders from it and shows a Columns menu that saves to it. A person with nothing saved sees the hidden columns the table's own call names.
+
+## Installation
+
+Add the gem and run its install generator, which copies a migration for its table:
+
+```ruby
+gem "keystone_ui-preferences"
+```
+
+```bash
+bundle install
+bin/rails generate keystone_ui:preferences:install
+bin/rails db:migrate
+```
+
+Mount the engine in `config/routes.rb`. A table's Columns menu saves to it:
+
+```ruby
+mount KeystoneUi::Preferences::Engine => "/keystone_ui_preferences"
+```
+
+Include the concern in `ApplicationController`. It gives views the lookup keystone_ui calls for a table's key:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include KeystoneUi::Preferences::ComponentPreferences
+end
+```
+
+## Configuration
+
+The gem asks the host for the signed-in person and for its sign-in check. Both default to Devise's names:
+
+```ruby
+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
+end
+```
+
+## Using it
+
+Give a table a key, and the hidden columns it shows a person with nothing saved:
+
+```erb
+<%= ui_data_table(
+  items: @months,
+  columns: [
+    Keystone::Ui::Column.new(:month, "Month"),
+    Keystone::Ui::Column.new(:pipeline, "Pipeline", hideable: true)
+  ],
+  key: :revenue_projection_months,
+  hidden_columns: [ :pipeline ]
+) %>
+```
+
+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.
+
+## What is stored
+
+One row per owner and component key, in `keystone_ui_preferences_component_preferences`:
+
+| Column | Holds |
+|--------|-------|
+| `owner` | the person 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/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module KeystoneUi
+  module Preferences
+    module ComponentPreferences
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :keystone_component_preference if respond_to?(:helper_method)
+      end
+
+      def keystone_component_preference(component_key)
+        owner = send(KeystoneUi::Preferences.configuration.current_owner_method)
+        return unless owner
+
+        {
+          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)
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class ApplicationController < ::ApplicationController
+      before_action { send(KeystoneUi::Preferences.configuration.authentication_method) }
+
+      private
+
+      def current_owner
+        send(KeystoneUi::Preferences.configuration.current_owner_method)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class ComponentPreferencesController < ApplicationController
+      def update
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class ComponentPreference < ApplicationRecord
+      self.table_name = "keystone_ui_preferences_component_preferences"
+
+      belongs_to :owner, polymorphic: true
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+KeystoneUi::Preferences::Engine.routes.draw do
+  patch "/:component_key", to: "component_preferences#update", as: :component_preference
+end

data/lib/generators/keystone_ui/preferences/install/install_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 InstallGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+
+        source_root File.expand_path("templates", __dir__)
+
+        desc "Installs KeystoneUi::Preferences: copies its migration."
+
+        def copy_migration
+          migration_template(
+            "create_keystone_ui_preferences_component_preferences.rb.erb",
+            "db/migrate/create_keystone_ui_preferences_component_preferences.rb"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+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.string :component_key, null: false
+      t.json :value, null: false, default: {}
+      t.boolean :members_choose, default: true, null: false
+      t.timestamps
+    end
+
+    add_index :keystone_ui_preferences_component_preferences, %i[owner_type owner_id component_key], unique: true,
+      name: "index_keystone_ui_prefs_on_owner_and_key"
+  end
+end

data/lib/keystone_ui/preferences/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class Configuration
+      attr_accessor :current_owner_method, :authentication_method
+
+      def initialize
+        @current_owner_method = :current_user
+        @authentication_method = :authenticate_user!
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/keystone_ui/preferences/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class Engine < ::Rails::Engine
+      isolate_namespace KeystoneUi::Preferences
+
+      initializer "keystone_ui.preferences.supplier" do
+        KeystoneUi.configure do |config|
+          config.preference_supplier = lambda do |view, component_key|
+            view.keystone_component_preference(component_key) if view.respond_to?(:keystone_component_preference)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone_ui/preferences/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    VERSION = "0.1.0"
+  end
+end

data/lib/keystone_ui/preferences.rb

@@ -0,0 +1,9 @@
+require "keystone_ui"
+require "keystone_ui/preferences/version"
+require "keystone_ui/preferences/configuration"
+require "keystone_ui/preferences/engine"
+
+module KeystoneUi
+  module Preferences
+  end
+end

data/lib/keystone_ui-preferences.rb

@@ -0,0 +1 @@
+require "keystone_ui/preferences"

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: keystone_ui-preferences
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Schneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: keystone_ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.33.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.33.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: A companion engine for keystone_ui that saves each person's choices for
+  a component, such as a data table's hidden columns, and supplies them back to keystone_ui.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/keystone_ui/preferences/component_preferences.rb
+- app/controllers/keystone_ui/preferences/application_controller.rb
+- 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
+- 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/keystone_ui-preferences.rb
+- lib/keystone_ui/preferences.rb
+- lib/keystone_ui/preferences/configuration.rb
+- lib/keystone_ui/preferences/engine.rb
+- lib/keystone_ui/preferences/version.rb
+homepage: https://github.com/DYB-Development/keystone_ui-preferences
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/keystone_ui-preferences
+  source_code_uri: https://github.com/DYB-Development/keystone_ui-preferences
+  changelog_uri: https://github.com/DYB-Development/keystone_ui-preferences/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/DYB-Development/keystone_ui-preferences/issues
+  documentation_uri: https://github.com/DYB-Development/keystone_ui-preferences#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Per-user saved choices for Keystone UI components.
+test_files: []