keystone_ui-preferences 0.6.0 → 0.8.0

data/lib/generators/keystone_ui/preferences/install/install_generator.rb

@@ -11,7 +11,7 @@ module KeystoneUi
 
         source_root File.expand_path("templates", __dir__)
 
-        desc "Installs KeystoneUi::Preferences: copies its migration."
+        desc "Installs KeystoneUi::Preferences: copies its migration and its template picker script."
 
         def copy_migration
           migration_template(
@@ -19,6 +19,11 @@ module KeystoneUi
             "db/migrate/create_keystone_ui_preferences_component_preferences.rb"
           )
         end
+
+        def copy_template_picker_script
+          script = File.expand_path("../../../../../app/javascript/keystone_ui/preferences/theme_settings_controller.js", __dir__)
+          create_file "app/javascript/controllers/keystone_ui/preferences/theme_settings_controller.js", File.read(script)
+        end
       end
     end
   end

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

@@ -0,0 +1,55 @@
+class CopyKeystoneUiColorsThemePreferences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  class ThemePreference < ActiveRecord::Base
+    self.table_name = "keystone_ui_colors_theme_preferences"
+  end
+
+  class ComponentPreference < ActiveRecord::Base
+    self.table_name = "keystone_ui_preferences_component_preferences"
+  end
+
+  def up
+    return unless table_exists?(:keystone_ui_colors_theme_preferences)
+
+    ThemePreference.find_in_batches do |theme_preferences|
+      rows = theme_preferences.flat_map { |theme_preference| [ colours(theme_preference), mode(theme_preference), look(theme_preference) ].compact }
+      saved = saved_keys(theme_preferences)
+      missing = rows.reject { |row| saved.include?(row.values_at(:owner_type, :owner_id, :component_key)) }
+      ComponentPreference.insert_all(missing) if missing.any?
+      missing.each { |row| Rails.cache.delete([ "keystone_ui_preferences", *row.values_at(:owner_type, :owner_id, :component_key) ].join("/")) }
+    end
+  end
+
+  private
+
+  def saved_keys(theme_preferences)
+    theme_preferences.group_by(&:owner_type).flat_map do |owner_type, owned|
+      ComponentPreference.where(owner_type: owner_type, owner_id: owned.map(&:owner_id), component_key: %w[colours mode look]).pluck(:owner_type, :owner_id, :component_key)
+    end.to_set
+  end
+
+  def colours(theme_preference)
+    row(theme_preference, "colours", colours_value(theme_preference), members_choose: theme_preference.members_choose)
+  end
+
+  def mode(theme_preference)
+    return nil if theme_preference.mode.blank?
+
+    row(theme_preference, "mode", { "mode" => theme_preference.mode })
+  end
+
+  def look(theme_preference)
+    return nil if theme_preference.look.blank? && theme_preference.members_choose_look
+
+    row(theme_preference, "look", { "look" => theme_preference.look.presence }.compact, members_choose: theme_preference.members_choose_look)
+  end
+
+  def colours_value(theme_preference)
+    return { "template_name" => theme_preference.template_name } if theme_preference.template_name.present?
+
+    { "accent" => theme_preference.accent, "surface" => theme_preference.surface, "text" => theme_preference.text }
+  end
+
+  def row(theme_preference, component_key, value, members_choose: true)
+    { owner_type: theme_preference.owner_type, owner_id: theme_preference.owner_id, component_key: component_key, value: value, members_choose: members_choose }
+  end
+end

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

@@ -11,7 +11,7 @@ module KeystoneUi
 
         source_root File.expand_path("templates", __dir__)
 
-        desc "Updates KeystoneUi::Preferences: copies migrations added since it was installed."
+        desc "Updates KeystoneUi::Preferences: copies migrations added since it was installed and the template picker script when the app has none."
 
         def copy_remove_extra_owner_index_migration
           migration_template(
@@ -19,6 +19,20 @@ module KeystoneUi
             "db/migrate/remove_extra_owner_index_from_keystone_ui_preferences_component_preferences.rb"
           )
         end
+
+        def copy_keystone_ui_colors_theme_preferences_migration
+          migration_template(
+            "copy_keystone_ui_colors_theme_preferences.rb.erb",
+            "db/migrate/copy_keystone_ui_colors_theme_preferences.rb"
+          )
+        end
+
+        def copy_template_picker_script
+          copy = "app/javascript/controllers/keystone_ui/preferences/theme_settings_controller.js"
+          return if File.exist?(File.join(destination_root, copy))
+
+          create_file copy, File.read(File.expand_path("../../../../../app/javascript/keystone_ui/preferences/theme_settings_controller.js", __dir__))
+        end
       end
     end
   end

data/lib/keystone_ui/preferences/colors_check.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Preferences
+    class ColorsCheck
+      class Error < StandardError; end
+
+      MESSAGE = "keystone_ui-preferences and keystone_ui-colors both save colours, modes and looks, so the app cannot load both. " \
+        "Remove keystone_ui-colors from the Gemfile and change every KeystoneUi::Colors name the app uses first, " \
+        "then run bin/rails generate keystone_ui:preferences:update, so the migration copying keystone_ui-colors' saved choices is in db/migrate, " \
+        "and then run bin/rails db:migrate."
+
+      def initialize(colors_loaded:)
+        @colors_loaded = colors_loaded
+      end
+
+      def call
+        raise Error, MESSAGE if @colors_loaded
+      end
+    end
+  end
+end

data/lib/keystone_ui/preferences/configuration.rb

@@ -3,13 +3,23 @@
 module KeystoneUi
   module Preferences
     class Configuration
-      attr_accessor :current_owner_method, :authentication_method, :current_account_method, :max_value_bytes
+      attr_accessor :current_owner_method, :authentication_method, :current_account_method, :max_value_bytes, :default_accent, :default_surface, :default_background, :default_text, :default_mode, :user_looks, :app_look_label, :account_colors, :account_looks, :theme_fonts
 
       def initialize
         @current_owner_method = :current_user
         @authentication_method = :authenticate_user!
         @component_names = {}
         @max_value_bytes = 10_000
+        @default_accent = "blue"
+        @default_surface = "zinc"
+        @default_background = "#ffffff"
+        @default_text = "#18181b"
+        @default_mode = "light"
+        @user_looks = true
+        @app_look_label = "Classic"
+        @account_colors = true
+        @account_looks = true
+        @theme_fonts = []
       end
 
       def name_component(component_key, name)

data/lib/keystone_ui/preferences/engine.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+require "keystone_ui/preferences/colors_check"
+
 module KeystoneUi
   module Preferences
     class Engine < ::Rails::Engine
       isolate_namespace KeystoneUi::Preferences
 
+      def self.check_colors
+        KeystoneUi::Preferences::ColorsCheck.new(colors_loaded: KeystoneUi.const_defined?(:Colors, false)).call
+      end
+
+      config.after_initialize do
+        KeystoneUi::Preferences::Engine.check_colors
+      end
+
       initializer "keystone_ui.preferences.supplier" do
         KeystoneUi.configure do |config|
           config.preference_supplier = lambda do |view, component_key|
@@ -12,6 +22,20 @@ module KeystoneUi
           end
         end
       end
+
+      initializer "keystone_ui.preferences.theme_mode" do
+        KeystoneUi.configure do |config|
+          config.theme_mode_supplier = lambda do |view|
+            view.respond_to?(:keystone_theme_mode) ? view.keystone_theme_mode : KeystoneUi::Preferences.configuration.default_mode
+          end
+        end
+      end
+
+      initializer "keystone_ui.preferences.look" do
+        KeystoneUi.configure do |config|
+          config.look_supplier = ->(view) { view.keystone_look if view.respond_to?(:keystone_look) }
+        end
+      end
     end
   end
 end

data/lib/keystone_ui/preferences/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Preferences
-    VERSION = "0.6.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/keystone_ui/preferences.rb

@@ -1,5 +1,6 @@
 require "keystone_ui"
 require "keystone_ui/navigation_order"
+require "keystone_ui/looks"
 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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -15,14 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.43.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: keystone_ui-looks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: keystone_ui-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -79,25 +107,42 @@ files:
 - 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/javascript/keystone_ui/preferences/theme_settings_controller.js
+- app/models/keystone_ui/preferences/appearance_choice.rb
 - app/models/keystone_ui/preferences/application_record.rb
+- app/models/keystone_ui/preferences/checked_theme.rb
+- app/models/keystone_ui/preferences/chosen_colours.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/navigation_arrangement.rb
+- app/models/keystone_ui/preferences/pick_account_appearance.rb
 - app/models/keystone_ui/preferences/pick_account_layouts.rb
+- app/models/keystone_ui/preferences/pick_appearance.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/models/keystone_ui/preferences/sent_theme.rb
+- app/models/keystone_ui/preferences/theme_css.rb
+- app/models/keystone_ui/preferences/theme_reader.rb
+- app/models/keystone_ui/preferences/theme_roles.rb
+- app/views/keystone_ui/preferences/settings/_account_appearance.html.erb
 - app/views/keystone_ui/preferences/settings/_account_layouts.html.erb
+- app/views/keystone_ui/preferences/settings/_appearance.html.erb
+- app/views/keystone_ui/preferences/settings/_colour_choices.html.erb
+- app/views/keystone_ui/preferences/settings/_look_choices.html.erb
 - app/views/keystone_ui/preferences/settings/_navigation_order.html.erb
 - app/views/keystone_ui/preferences/settings/_navigation_placement.html.erb
+- app/views/keystone_ui/preferences/settings/_theme_settings.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/copy_keystone_ui_colors_theme_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/colors_check.rb
 - lib/keystone_ui/preferences/configuration.rb
 - lib/keystone_ui/preferences/engine.rb
 - lib/keystone_ui/preferences/version.rb