keystone_ui-colors 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e06b73e93b9e73587971d465b75f6aa1724bebdb9fe5c0da29335e502931b625
-  data.tar.gz: a6644a883ec9b73249c3738cd38b9342d29c5485d29c7f6218ea4657c5fd81ff
+  metadata.gz: 7e19d4ac1360f6f858edb7466444b610d3aa41f27c41c770f9d2b1674e51d04b
+  data.tar.gz: 53bc07b0653b12cd9b36f9b94908a6aebdb8cc79370618c0ba70f22a27fdf21a
 SHA512:
-  metadata.gz: cbc58ef7595fddbe715b833b3292a40e6559a6a589f71cfd90ccf20f57275aea508b7a98347100f7607d346d6a9d4a062a17a73b6be3da5d66c91ee13d8ed2b3
-  data.tar.gz: d66910b5ecd31bc3582bed2df71296fe0b3b614dc7e0e7dcf6a849e52febcae94c694acfc481fbde11dac0442b81e0b04de47f2c8fa634bfd8a31a728d354a1f
+  metadata.gz: e9e76f7316025de47b02b16e490c674dbacc7fd2eb43d0122c9a84b1d60c0350bda35a4514993a550ffa28e4b624ef7961cb72aee95bc7aeb62f576e5a3675cb
+  data.tar.gz: b2f238d93c3fd4384d99e94891ef4afff962dded85eb3809f6fd8ac111eb17c9513e9cda2d61f102da557deef1f9093a1f4d46598c9e3058cbd81d8d9365db79

data/README.md

@@ -8,7 +8,7 @@ Users pick from preset themes or custom hex colors. The gem generates CSS custom
 
 - Ruby >= 3.1
 - Rails >= 7.0
-- [keystone_ui](https://github.com/DYB-Development/keystone_ui) >= 0.4.1
+- [keystone_ui](https://github.com/DYB-Development/keystone_ui) >= 0.18.0
 
 ## Installation
 
@@ -172,6 +172,48 @@ end
 A choice made with keystone_ui's `ui_theme_toggle` in that browser still sets
 light or dark on these pages.
 
+Such a page also shows the host's default look, over any look a user or account chose, for the same actions.
+
+## Looks
+
+When the host registers looks with keystone_ui, a signed-in user's preference can
+hold one in its `look` column, and every page they see carries it as
+`data-look` on the `html` tag. A user with no saved look, and a visitor who is
+not signed in, see the host's `default_look`. A saved look the host no longer registers is passed over for the account's look,
+or for the host's default when the account's look is not registered either. The
+settings page then shows no look selected and still saves. While an account's colours apply, the
+page still shows the user's own look.
+
+The colours settings page lists every registered look, with the user's current
+look chosen, and saves the one they pick. A name the host does not register is
+refused with a message and nothing is stored. With no looks registered the page
+shows no look choice.
+
+A host that wants every user on one look sets `user_looks` to false:
+
+```ruby
+KeystoneUi::Colors.configure do |config|
+  config.user_looks = false
+end
+```
+
+The settings page then shows no look choice, a save ignores any look sent with
+it and keeps the rest, and every page shows the host's default look, even for a
+user who saved one earlier. `user_looks` is true by default.
+
+An account admin picks the account's look on the account picker, which lists
+every registered look with the account's current one chosen. A member with no
+look of their own sees the account's look, and a member who chose one keeps it.
+A host that keeps accounts off looks sets `account_looks` to false, and the
+account picker then shows no look choice and a saved account look is not
+applied. `account_looks` is true by default.
+
+The account picker also has a switch for whether members choose their own
+look, on by default and separate from the switch for colours. With it off, every
+member sees the account's look whatever they saved, and a member's picker shows
+no look choice. Run the update generator to add its column to an app that
+installed an earlier version.
+
 ## Preset Themes
 
 | Name     | Accent  | Surface | Custom background | Custom text | Description                    |
@@ -257,7 +299,7 @@ Accepts named colors (`"blue"`) or hex values (`"#3b82f6"`) for `accent` and `su
 
 ## Updating
 
-Run the update generator to get the latest Stimulus controller and any new migrations (such as the text colour column), then migrate:
+Run the update generator to get the latest Stimulus controller and any new migrations (such as the text colour and look columns), then migrate:
 
 ```bash
 bin/rails generate keystone_ui:colors:update

data/app/controllers/concerns/keystone_ui/colors/current_palette.rb

@@ -8,7 +8,7 @@ module KeystoneUi
       extend ActiveSupport::Concern
 
       included do
-        helper_method :keystone_palette_css, :keystone_theme_mode if respond_to?(:helper_method)
+        helper_method :keystone_palette_css, :keystone_theme_mode, :keystone_look if respond_to?(:helper_method)
       end
 
       class_methods do
@@ -28,6 +28,7 @@ module KeystoneUi
 
         if cached && !stale_cache?(owner, cached)
           @keystone_theme_mode = cached[:mode] || KeystoneUi::Colors.configuration.default_mode
+          @keystone_look = own_look(cached[:look])
           build_palette_css(
             cached[:accent],
             cached[:surface],
@@ -38,6 +39,7 @@ module KeystoneUi
 
         preference = KeystoneUi::Colors::ThemePreference.find_by(owner: owner)
         @keystone_theme_mode = preference&.mode || KeystoneUi::Colors.configuration.default_mode
+        @keystone_look = own_look(preference&.look)
         accent = preference&.accent || KeystoneUi::Colors.configuration.default_accent
         surface = preference&.surface || KeystoneUi::Colors.configuration.default_surface
 
@@ -51,6 +53,7 @@ module KeystoneUi
             mode: preference.mode,
             template_name: preference.template_name,
             text: preference.text,
+            look: preference.look,
             updated_at: preference.updated_at.to_i
           }
         end
@@ -59,11 +62,13 @@ module KeystoneUi
       def apply_chosen_palette(owner, account)
         choice = KeystoneUi::Colors::ColourChoice.new(person: owner, account: account)
         @keystone_theme_mode = choice.mode
+        @keystone_look = choice.look
         write_palette(choice.applying_preference)
       end
 
       def apply_host_palette
         @keystone_theme_mode = KeystoneUi::Colors.configuration.default_mode
+        @keystone_look = nil
         build_palette_css(
           KeystoneUi::Colors.configuration.default_accent,
           KeystoneUi::Colors.configuration.default_surface,
@@ -79,8 +84,16 @@ module KeystoneUi
         @keystone_theme_mode
       end
 
+      def keystone_look
+        @keystone_look
+      end
+
       private
 
+      def own_look(look)
+        look if KeystoneUi::Colors.configuration.user_looks
+      end
+
       def keystone_account
         method = KeystoneUi::Colors.configuration.current_account_method
         send(method) if method
@@ -117,7 +130,7 @@ module KeystoneUi
       end
 
       def stale_cache?(owner, cached)
-        return true unless cached.key?(:text)
+        return true unless cached.key?(:text) && cached.key?(:look)
 
         updated_at = KeystoneUi::Colors::ThemePreference
           .where(owner: owner)

data/app/controllers/keystone_ui/colors/settings_controller.rb

@@ -14,7 +14,10 @@ module KeystoneUi
       def update
         result = PickColours.new(person: current_owner, account: nil, values: preference_params).call
 
-        return render :show, status: :unprocessable_entity unless result.ok?
+        unless result.ok?
+          flash.now[:alert] = result.message
+          return render :show, status: :unprocessable_entity
+        end
 
         ForgetTheThemeChoice.new(controller: self).call
         redirect_to keystone_ui_colors.settings_path, notice: "Color settings updated."
@@ -29,7 +32,7 @@ module KeystoneUi
       end
 
       def preference_params
-        params.permit(:accent, :surface, :text, :template_name, :mode).to_h.symbolize_keys
+        params.permit(:accent, :surface, :text, :template_name, :mode, :look).to_h.symbolize_keys
       end
     end
   end

data/app/models/keystone_ui/colors/colour_choice.rb

@@ -27,6 +27,16 @@ module KeystoneUi
         own_preference&.mode || KeystoneUi::Colors.configuration.default_mode
       end
 
+      def look
+        [ (own_preference&.look if person_chooses_look?), (account_preference&.look if KeystoneUi::Colors.configuration.account_looks) ].find { |look| KeystoneUi.configuration.looks.key?(look) }
+      end
+
+      def person_chooses_look?
+        return false unless KeystoneUi::Colors.configuration.user_looks
+
+        account_preference.nil? || account_preference.members_choose_look
+      end
+
       def custom_offered?
         preference = applying_preference
         background = CustomColours.new(template_name: preference&.template_name, surface: preference&.surface, text: preference&.text).background

data/app/models/keystone_ui/colors/pick_account_colours.rb

@@ -11,10 +11,11 @@ module KeystoneUi
       def call
         return Refusal.new("This app does not let accounts choose their colours.") unless KeystoneUi::Colors.configuration.account_colors
 
-        result = PickColours.new(owner: @account, values: @values.except(:members_choose, :mode)).call
-        return result unless result.ok? && @values.key?(:members_choose)
+        result = PickColours.new(owner: @account, values: @values.except(:members_choose, :members_choose_look, :mode), look_allowed: KeystoneUi::Colors.configuration.account_looks).call
+        return result unless result.ok?
 
-        ThemePreference.find_by(owner: @account).update!(members_choose: @values[:members_choose] == "1")
+        switches = @values.slice(:members_choose, :members_choose_look).transform_values { |value| value == "1" }
+        ThemePreference.find_by(owner: @account).update!(switches) if switches.any?
         result
       end
     end

data/app/models/keystone_ui/colors/pick_colours.rb

@@ -3,14 +3,16 @@
 module KeystoneUi
   module Colors
     class PickColours
-      def initialize(values:, person: nil, account: nil, owner: nil)
+      def initialize(values:, person: nil, account: nil, owner: nil, look_allowed: KeystoneUi::Colors.configuration.user_looks)
         @owner = person || owner
+        @look_allowed = look_allowed
         @account = account
         @values = values
       end
 
       def call
         preference.assign_attributes(chosen_colours)
+        preference.look = @values[:look] if @values.key?(:look) && @look_allowed
 
         return Refusal.new(preference.errors.full_messages.first) unless preference.save
 

data/app/models/keystone_ui/colors/theme_preference.rb

@@ -20,6 +20,7 @@ module KeystoneUi
       validates :template_name, inclusion: { in: Templates.names.map(&:to_s) }, allow_blank: true
       validates :mode, inclusion: { in: MODES }, allow_nil: true
       validates :text, format: { with: HEX_COLOR }, allow_blank: true
+      validate :look_is_registered, if: :will_save_change_to_look?
 
       def apply_template!(name)
         template = Templates[name]
@@ -32,6 +33,12 @@ module KeystoneUi
 
       private
 
+      def look_is_registered
+        return if look.nil? || KeystoneUi.configuration.looks.key?(look)
+
+        errors.add(:look, "is not a look this app offers")
+      end
+
       def accent_is_valid
         return if SUPPORTED_ACCENTS.include?(accent) || accent&.match?(HEX_COLOR)
 

data/app/views/keystone_ui/colors/settings/_account_picker.html.erb

@@ -9,9 +9,17 @@
     <div style="display: flex; flex-direction: column; gap: 2rem;">
       <%= render partial: "keystone_ui/colors/settings/colours", locals: { preference: preference } %>
 
+      <% if KeystoneUi.configuration.looks.any? && KeystoneUi::Colors.configuration.account_looks %>
+        <%= render partial: "keystone_ui/colors/settings/looks", locals: { preference: preference } %>
+      <% end %>
+
       <%= ui_section(title: "Members", spacing: :sm) do %>
         <%= hidden_field_tag "members_choose", "0", id: nil %>
         <%= ui_checkbox_row(name: "members_choose", value: "1", label: "Members choose their own colours", checked: preference.members_choose) %>
+        <% if KeystoneUi.configuration.looks.any? && KeystoneUi::Colors.configuration.account_looks %>
+          <%= hidden_field_tag "members_choose_look", "0", id: nil %>
+          <%= ui_checkbox_row(name: "members_choose_look", value: "1", label: "Members choose their own look", checked: preference.members_choose_look) %>
+        <% end %>
       <% end %>
 
       <div>

data/app/views/keystone_ui/colors/settings/_looks.html.erb

@@ -0,0 +1,7 @@
+<%= ui_section(title: "Look", spacing: :sm) do %>
+  <div style="display: flex; flex-wrap: wrap; gap: 0.5rem;">
+    <% KeystoneUi.configuration.looks.each_key do |look| %>
+      <%= ui_radio_card(name: "look", value: look, label: look.humanize, checked: (preference.look || KeystoneUi.configuration.default_look) == look) %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/keystone_ui/colors/settings/_picker.html.erb

@@ -16,6 +16,10 @@
         <%= render partial: "keystone_ui/colors/settings/colours", locals: { preference: preference } %>
       <% end %>
 
+      <% if KeystoneUi.configuration.looks.any? && choice.person_chooses_look? %>
+        <%= render partial: "keystone_ui/colors/settings/looks", locals: { preference: preference } %>
+      <% end %>
+
       <%= ui_section(title: "Mode", spacing: :sm) do %>
         <div style="display: flex; flex-wrap: wrap; gap: 0.5rem;">
           <% KeystoneUi::Colors::ThemePreference::MODES.each do |mode| %>

data/app/views/keystone_ui/colors/settings/show.html.erb

@@ -1,5 +1,9 @@
 <%= ui_page_header(title: "Color Settings") %>
 
+<% if flash[:alert] %>
+  <%= ui_alert(message: flash[:alert], type: :error) %>
+<% end %>
+
 <% if flash[:notice] %>
   <%= ui_alert(message: flash[:notice], type: :success) %>
 <% end %>

data/lib/generators/keystone_ui/colors/install/templates/create_keystone_ui_colors_theme_preferences.rb.erb

@@ -6,7 +6,9 @@ class CreateKeystoneUiColorsThemePreferences < ActiveRecord::Migration[<%= Activ
       t.string :template_name
       t.string :mode
       t.string :text
+      t.string :look
       t.boolean :members_choose, default: true, null: false
+      t.boolean :members_choose_look, default: true, null: false
       t.references :owner, polymorphic: true, null: false
       t.timestamps
     end

data/lib/generators/keystone_ui/colors/update/templates/add_look_to_keystone_ui_colors_theme_preferences.rb.erb

@@ -0,0 +1,5 @@
+class AddLookToKeystoneUiColorsThemePreferences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :keystone_ui_colors_theme_preferences, :look, :string
+  end
+end

data/lib/generators/keystone_ui/colors/update/templates/add_members_choose_look_to_keystone_ui_colors_theme_preferences.rb.erb

@@ -0,0 +1,5 @@
+class AddMembersChooseLookToKeystoneUiColorsThemePreferences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :keystone_ui_colors_theme_preferences, :members_choose_look, :boolean, default: true, null: false
+  end
+end

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

@@ -40,6 +40,24 @@ module KeystoneUi
           )
         end
 
+        def add_look_migration
+          return if column_migrated?(:look)
+
+          migration_template(
+            File.expand_path("templates/add_look_to_keystone_ui_colors_theme_preferences.rb.erb", __dir__),
+            "db/migrate/add_look_to_keystone_ui_colors_theme_preferences.rb"
+          )
+        end
+
+        def add_members_choose_look_migration
+          return if column_migrated?(:members_choose_look)
+
+          migration_template(
+            File.expand_path("templates/add_members_choose_look_to_keystone_ui_colors_theme_preferences.rb.erb", __dir__),
+            "db/migrate/add_members_choose_look_to_keystone_ui_colors_theme_preferences.rb"
+          )
+        end
+
         def copy_stimulus_controller
           copy_file "theme_settings_controller.js",
             "app/javascript/controllers/keystone_ui/colors/theme_settings_controller.js"

data/lib/keystone_ui/colors/configuration.rb

@@ -3,7 +3,7 @@
 module KeystoneUi
   module Colors
     class Configuration
-      attr_accessor :current_owner_method, :authentication_method, :default_template, :default_accent, :default_surface, :default_mode, :default_background, :default_text, :account_colors, :current_account_method, :layout
+      attr_accessor :current_owner_method, :authentication_method, :default_template, :default_accent, :default_surface, :default_mode, :default_background, :default_text, :account_colors, :current_account_method, :layout, :user_looks, :account_looks
 
       def initialize
         @current_owner_method = :current_user
@@ -17,6 +17,8 @@ module KeystoneUi
         @account_colors = true
         @current_account_method = nil
         @layout = "application"
+        @user_looks = true
+        @account_looks = true
       end
     end
 

data/lib/keystone_ui/colors/engine.rb

@@ -13,6 +13,12 @@ module KeystoneUi
         end
       end
 
+      initializer "keystone_ui.colors.look" do
+        KeystoneUi.configure do |config|
+          config.look_supplier = ->(view) { view.keystone_look if view.respond_to?(:keystone_look) }
+        end
+      end
+
       initializer "keystone_ui.colors.tailwind" do
         KeystoneUi.configuration.tailwind_sources << root.join("app/views/**/*.erb").to_s
       end

data/lib/keystone_ui/colors/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Colors
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-colors
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -92,11 +92,14 @@ files:
 - app/models/keystone_ui/colors/theme_preference.rb
 - app/views/keystone_ui/colors/settings/_account_picker.html.erb
 - app/views/keystone_ui/colors/settings/_colours.html.erb
+- app/views/keystone_ui/colors/settings/_looks.html.erb
 - app/views/keystone_ui/colors/settings/_picker.html.erb
 - app/views/keystone_ui/colors/settings/show.html.erb
 - config/routes.rb
 - lib/generators/keystone_ui/colors/install/install_generator.rb
 - lib/generators/keystone_ui/colors/install/templates/create_keystone_ui_colors_theme_preferences.rb.erb
+- lib/generators/keystone_ui/colors/update/templates/add_look_to_keystone_ui_colors_theme_preferences.rb.erb
+- lib/generators/keystone_ui/colors/update/templates/add_members_choose_look_to_keystone_ui_colors_theme_preferences.rb.erb
 - lib/generators/keystone_ui/colors/update/templates/add_members_choose_to_keystone_ui_colors_theme_preferences.rb.erb
 - lib/generators/keystone_ui/colors/update/templates/add_mode_to_keystone_ui_colors_theme_preferences.rb.erb
 - lib/generators/keystone_ui/colors/update/templates/add_text_to_keystone_ui_colors_theme_preferences.rb.erb