Support ordering facets

Author: dmolesUC

app/models/facet.rb

@@ -11,4 +11,9 @@ class Facet < ApplicationRecord
 
   validates :name, presence: true
   validates :name, uniqueness: true
+
+  # ------------------------------------------------------------
+  # Scopes
+
+  default_scope { order(:ord) }
 end

db/migrate/20220921220637_support_ordered_facets.rb

@@ -0,0 +1,26 @@
+class SupportOrderedFacets < ActiveRecord::Migration[7.0]
+  ORDERED_FACETS = %w[
+    Size
+    Decade
+    Genre
+    Medium
+    Appearance
+  ].freeze
+
+  def change
+    add_column(:facets, :ord, :integer, default: 0, null: false)
+    set_order!
+    add_index(:facets, :ord, unique: true)
+  end
+
+  private
+
+  def set_order!
+    return if Rails.env.test?
+
+    ORDERED_FACETS.each_with_index do |name, index|
+      facet = Facet.find_by!(name: name)
+      facet.update(ord: index)
+    end
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2022_09_21_205344) do
+ActiveRecord::Schema[7.0].define(version: 2022_09_21_220637) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -19,7 +19,9 @@
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.boolean "ordered", default: false, null: false
+    t.integer "ord", default: 0, null: false
     t.index ["name"], name: "index_facets_on_name", unique: true
+    t.index ["ord"], name: "index_facets_on_ord", unique: true
   end
 
   create_table "items", force: :cascade do |t|

spec/factories/facets.rb

@@ -1,16 +1,18 @@
 FactoryBot.define do
   factory :facet do
     name { 'Concept' }
+    ord { -1 }
 
     to_create do |instance|
-      instance.id = Facet.find_or_create_by(name: instance.name).id
+      instance.id = Facet.find_or_create_by(name: instance.name, ord: instance.ord).id
       instance.reload
     end
 
-    %w[Appearance Size Decade Genre Medium].each do |facet_name|
+    %w[Size Decade Genre Medium Appearance].each_with_index do |facet_name, index|
       factory_name = "facet_#{facet_name.downcase}".to_sym
       factory(factory_name) do
         name { facet_name }
+        ord { index }
       end
     end
   end

spec/models/term_spec.rb

@@ -38,7 +38,7 @@
 
     it 'cannot have a parent in a different facet' do
       term = create(:term)
-      other_facet = create(:facet, name: "Not #{term.facet.name}")
+      other_facet = create(:facet, name: "Not #{term.facet.name}", ord: -2)
       other_term = create(:term, value: "Not #{term.value}", facet: other_facet)
       term.parent = other_term
       expect(term).not_to be_valid