MIGRATION: Rename color_scales as color_schemes

Migration drops old table (no records in production yet) and adds new
table. Change also replaces all the file and class names with color
scheme.

Author: rossta

app/controllers/application_controller.rb

@@ -5,17 +5,17 @@ class ApplicationController < ActionController::Base
   before_action :set_color_theme
 
   def set_color_theme
-    @color_scale = find_color_theme
+    @color_scheme = find_color_theme
   end
 
   def find_color_theme
-    if session[:color_scale_id]
+    if session[:color_scheme_id]
       begin
-        return ColorScale.find(session[:color_scale_id])
+        return ColorScheme.find(session[:color_scheme_id])
       rescue ActiveRecord::RecordNotFound
       end
     end
 
-    ColorScale.cached_default
+    ColorScheme.cached_default
   end
 end

app/controllers/settings/color_schemes_controller.rb

@@ -1,38 +1,38 @@
 class Settings::ColorSchemesController < ApplicationController
   def show
-    @color_scale = selected_color_scale || session_color_scale || ColorScale.cached_default
-    @settings = Settings.new(color_scale: @color_scale)
+    @color_scheme = selected_color_scheme || session_color_scheme || ColorScheme.cached_default
+    @settings = Settings.new(color_scheme: @color_scheme)
 
     render ColorSchemes::ShowView.new(
       settings: @settings,
-      fallback_color_scale: session_color_scale || ColorScale.cached_default,
-      curated_color_scales: ColorScale.cached_curated,
-      selected: selected_color_scale_id.present?,
-      saved: session[:color_scale_id].presence == @color_scale.id
+      fallback_color_scheme: session_color_scheme || ColorScheme.cached_default,
+      curated_color_schemes: ColorScheme.cached_curated,
+      selected: selected_color_scheme_id.present?,
+      saved: session[:color_scheme_id].presence == @color_scheme.id
     )
   end
 
   def update
-    update_params = params[:settings] ? params.require(:settings).permit(:color_scale_id) : {}
-    color_scale_id = update_params[:color_scale_id]
-    @color_scale = ColorScale.find(color_scale_id)
+    update_params = params[:settings] ? params.require(:settings).permit(:color_scheme_id) : {}
+    color_scheme_id = update_params[:color_scheme_id]
+    @color_scheme = ColorScheme.find(color_scheme_id)
 
-    redirect_to settings_color_scheme_path unless @color_scale.present?
+    redirect_to settings_color_scheme_path unless @color_scheme.present?
 
-    if @color_scale == ColorScale.cached_default
-      session.delete(:color_scale_id)
+    if @color_scheme == ColorScheme.cached_default
+      session.delete(:color_scheme_id)
     else
-      session[:color_scale_id] = @color_scale.id
+      session[:color_scheme_id] = @color_scheme.id
     end
 
     redirect_to settings_color_scheme_path, status: :see_other
   end
 
   private
 
-  def selected_color_scale_id = params.dig(:settings, :color_scale_id) || session[:color_scale_id]
+  def selected_color_scheme_id = params.dig(:settings, :color_scheme_id) || session[:color_scheme_id]
 
-  def session_color_scale = session[:color_scale_id] && ColorScale.find(session[:color_scale_id])
+  def session_color_scheme = session[:color_scheme_id] && ColorScheme.find(session[:color_scheme_id])
 
-  def selected_color_scale = selected_color_scale_id && ColorScale.find(selected_color_scale_id)
+  def selected_color_scheme = selected_color_scheme_id && ColorScheme.find(selected_color_scheme_id)
 end

app/models/color_scale.rb renamed to app/models/color_scheme.rb

@@ -2,7 +2,7 @@
 
 require "color_conversion"
 
-class ColorScale < ApplicationRecord
+class ColorScheme < ApplicationRecord
   APP_DEFAULT = {
     name: "Custom Cerulean Blue",
     weights: {
@@ -28,7 +28,7 @@ def self.curated
   end
 
   def self.cached_curated
-    cache_key = "curated_color_scale_ids"
+    cache_key = "curated_color_scheme_ids"
     cached_ids = Rails.cache.read(cache_key)
 
     return where(id: cached_ids) if cached_ids
@@ -47,7 +47,7 @@ def self.find_or_create_default
   end
 
   def self.cached_default
-    cache_key = "default_color_scale_id"
+    cache_key = "default_color_scheme_id"
     cached_id = Rails.cache.read(cache_key)
 
     return where(id: cached_id).first if cached_id

app/models/settings.rb

@@ -1,11 +1,11 @@
 class Settings
   include ActiveModel::Model
 
-  attr_accessor :color_scale
+  attr_accessor :color_scheme
 
-  def initialize(color_scale:)
-    @color_scale = color_scale
+  def initialize(color_scheme:)
+    @color_scheme = color_scheme
   end
 
-  def color_scale_id = color_scale.id
+  def color_scheme_id = color_scheme.id
 end

app/views/application/theme/_color.html.erb

@@ -1,5 +1,5 @@
 <style>
   :root {
-    <%= render ColorScales::Css.new(color_scale: @color_scale || ColorScale.find_or_create_default) %>
+    <%= render ColorSchemes::Css.new(color_scheme: @color_scheme || ColorScheme.find_or_create_default) %>
   }
 </style>

app/views/color_schemes/show_view.rb

@@ -6,11 +6,11 @@ class ColorSchemes::ShowView < ApplicationView
   include Phlex::Rails::Helpers::ButtonTo
   include Phlex::Rails::Helpers::ContentFor
 
-  def initialize(settings:, fallback_color_scale: nil, curated_color_scales: [], selected: false, saved: false)
+  def initialize(settings:, fallback_color_scheme: nil, curated_color_schemes: [], selected: false, saved: false)
     @settings = settings
-    @color_scale = settings.color_scale
-    @fallback_color_scale = fallback_color_scale
-    @curated_color_scales = curated_color_scales
+    @color_scheme = settings.color_scheme
+    @fallback_color_scheme = fallback_color_scheme
+    @curated_color_schemes = curated_color_schemes
     @selected = selected
     @saved = saved
   end
@@ -19,13 +19,13 @@ def view_template
     content_for :head do
       render("application/theme/color")
     end
-    render Pages::Header.new(title: "Theme")
+    render Pages::Header.new(title: "Theme: Color")
     div(class: "section-content container py-gap") do
       if @saved || @selected
         h3 do
           plain "You are now #{@saved ? "using" : "previewing"} the"
           whitespace
-          span(class: "emphasis") { @color_scale.display_name }
+          span(class: "emphasis") { @color_scheme.display_name }
           whitespace
           plain "color scheme"
         end
@@ -41,11 +41,11 @@ def view_template
         form_with(model: @settings, url: url_for, method: :get) do |f|
           fieldset do
             f.select(
-              :color_scale_id,
-              @curated_color_scales.map { |cs| [cs.display_name, cs.id] },
+              :color_scheme_id,
+              @curated_color_schemes.map { |cs| [cs.display_name, cs.id] },
               {
                 prompt: "Pick one!",
-                selected: @selected && @color_scale.id
+                selected: @selected && @color_scheme.id
               },
               # requestSubmit and Turbo
               # https://stackoverflow.com/questions/68624668/how-can-i-submit-a-form-on-input-change-with-turbo-streams
@@ -58,14 +58,14 @@ def view_template
         span(class: "mr-2 text-small") { "OR" }
 
         link_to "I feel lucky!",
-          settings_color_scheme_path(settings: {color_scale_id: @curated_color_scales.sample.id}),
+          settings_color_scheme_path(settings: {color_scheme_id: @curated_color_schemes.sample.id}),
           class: "button secondary mr-2"
 
-        if @selected && @color_scale != @fallback_color_scale
+        if @selected && @color_scheme != @fallback_color_scheme
           span(class: "mr-2 text-small") { "OR" }
 
           button_to "Reset preview",
-            settings_color_scheme_path(settings: {color_scale_id: @fallback_color_scale.id}),
+            settings_color_scheme_path(settings: {color_scheme_id: @fallback_color_scheme.id}),
             method: :patch,
             class: "button tertiary mr-2"
         end
@@ -76,23 +76,23 @@ def view_template
           span(class: "mr-2 text-small") { plain "Save" }
 
           button_to "Save this color scheme",
-            settings_color_scheme_path(settings: {color_scale_id: @color_scale.id}),
+            settings_color_scheme_path(settings: {color_scheme_id: @color_scheme.id}),
             method: :patch,
             class: "button primary mr-2"
 
           span(class: "mr-2 text-small") { unsafe_raw "&bull;" }
 
           button_to "Reset to default",
-            settings_color_scheme_path(settings: {color_scale_id: ColorScale.cached_default.id}),
+            settings_color_scheme_path(settings: {color_scheme_id: ColorScheme.cached_default.id}),
             method: :patch,
             class: "button tertiary mr-2"
         end
       end
 
       h3 { display_name }
 
-      div(class: "color-scheme color-scheme__#{@color_scale.name.parameterize}") do
-        @color_scale.weights.each do |weight, color|
+      div(class: "color-scheme color-scheme__#{@color_scheme.name.parameterize}") do
+        @color_scheme.weights.each do |weight, color|
           div(class: "color-swatch color-swatch__weight:#{weight}", style: "background-color: #{color.hex}") do
             div(class: "color-swatch__weight") { weight }
             div(class: "color-swatch__color") { color.hex.delete("#").upcase }
@@ -104,13 +104,13 @@ def view_template
 
   private
 
-  def default_color_scale? = @color_scale.id == ColorScale.cached_default.id
+  def default_color_scheme? = @color_scheme.id == ColorScheme.cached_default.id
 
   def display_name
-    if default_color_scale?
-      "#{@color_scale.display_name} (default)"
+    if default_color_scheme?
+      "#{@color_scheme.display_name} (default)"
     else
-      @color_scale.display_name
+      @color_scheme.display_name
     end
   end
 end

app/views/components/color_scales/css.rb renamed to app/views/components/color_schemes/css.rb

@@ -1,12 +1,12 @@
-class ColorScales::Css < Phlex::HTML
-  attr_reader :color_scale
+class ColorSchemes::Css < Phlex::HTML
+  attr_reader :color_scheme
 
-  def initialize(color_scale:)
-    @color_scale = color_scale
+  def initialize(color_scheme:)
+    @color_scheme = color_scheme
   end
 
   def color_name
-    color_scale.name.parameterize
+    color_scheme.name.parameterize
   end
 
   def to_hsla_css(color)
@@ -15,10 +15,10 @@ def to_hsla_css(color)
   end
 
   def view_template
-    color_scale.weights.each do |weight, color|
+    color_scheme.weights.each do |weight, color|
       unsafe_raw "--color-#{color_name}-#{weight}: #{to_hsla_css(color)};\n"
     end
-    color_scale.weights.each do |weight, color|
+    color_scheme.weights.each do |weight, color|
       unsafe_raw "--my-color-#{weight}: var(--color-#{color_name}-#{weight});\n"
     end
   end

db/migrate/20240703114144_drop_color_scales.rb

@@ -0,0 +1,25 @@
+class DropColorScales < ActiveRecord::Migration[7.1]
+  def up
+    drop_table :color_scales
+  end
+
+  def down
+    create_table :color_scales, force: true, id: false do |t|
+      t.primary_key :id, :string, default: -> { "ULID()" }
+      t.string :name, null: false
+      t.string :weight_50, null: false
+      t.string :weight_100, null: false
+      t.string :weight_200, null: false
+      t.string :weight_300, null: false
+      t.string :weight_400, null: false
+      t.string :weight_500, null: false
+      t.string :weight_600, null: false
+      t.string :weight_700, null: false
+      t.string :weight_800, null: false
+      t.string :weight_900, null: false
+      t.string :weight_950, null: false
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240703114157_create_color_schemes.rb

@@ -0,0 +1,21 @@
+class CreateColorSchemes < ActiveRecord::Migration[7.1]
+  def change
+    create_table :color_schemes, force: true, id: false do |t|
+      t.primary_key :id, :string, default: -> { "ULID()" }
+      t.string :name, null: false, index: {unique: true}
+      t.string :weight_50, null: false
+      t.string :weight_100, null: false
+      t.string :weight_200, null: false
+      t.string :weight_300, null: false
+      t.string :weight_400, null: false
+      t.string :weight_500, null: false
+      t.string :weight_600, null: false
+      t.string :weight_700, null: false
+      t.string :weight_800, null: false
+      t.string :weight_900, null: false
+      t.string :weight_950, null: false
+
+      t.timestamps
+    end
+  end
+end