Support term ordering; fix migrations to run in test

Author: dmolesUC

app/models/term.rb

@@ -19,6 +19,8 @@ class Term < ApplicationRecord
   # ------------------------------------------------------------
   # Scopes
 
+  default_scope { order(:facet_id, :parent_id, :ord, :value) }
+
   scope :find_by_self_or_parent, ->(**conditions) {
     sql = <<~SQL.squish
       INNER JOIN (#{Term.where(**conditions).to_sql})#{' '}

app/serializers/term_serializer.rb

@@ -1,7 +1,7 @@
 class TermSerializer
   include JSONAPI::Serializer
 
-  attributes(:value)
+  attributes(:value, :ord)
 
   belongs_to :facet
   belongs_to :parent, serializer: TermSerializer

db/migrate/20220810184802_drop_test_item.rb

@@ -24,14 +24,18 @@ class DropTestItem < ActiveRecord::Migration[7.0]
   }
 
   def up
+    return if Rails.env.test?
+
     item = Item.find_by!(ITEM_ATTRS)
     item.destroy!
   end
 
   def down
+    return if Rails.env.test?
+
     item = Item.create!(ITEM_ATTRS)
     item.terms = ITEM_TERMS.map do |fn, tv|
-      facet = Facet.find_by!(name: fn)
+      facet = Facet.find_by(name: fn)
       facet.terms.where(value: tv).first
     end
   end

db/migrate/20220908164857_suppress_additional_items.rb

@@ -9,6 +9,8 @@ class SuppressAdditionalItems < ActiveRecord::Migration[7.0]
   ]
 
   def up
+    return if Rails.env.test?
+
     ITEM_ATTRS.each do |attrs|
       item = Item.find_by!(suppressed: false, **attrs)
       item.suppressed = true
@@ -17,6 +19,8 @@ def up
   end
 
   def down
+    return if Rails.env.test?
+
     ITEM_ATTRS.each do |attrs|
       item = Item.find_by!(suppressed: true, **attrs)
       item.suppressed = false

db/migrate/20220914235036_add_risograph_to_medium.rb

@@ -4,10 +4,14 @@
 
 class AddRisographToMedium < ActiveRecord::Migration[7.0]
   def up
+    return if Rails.env.test?
+
     Term.create!(value: 'Risograph', facet: facet_medium)
   end
 
   def down
+    return if Rails.env.test?
+
     term = Term.find_by!(value: 'Risograph', facet: facet_medium)
     term.destroy!
   end

db/migrate/20220920203301_drop_incomplete_items.rb

@@ -38,11 +38,15 @@ class DropIncompleteItems < ActiveRecord::Migration[7.0]
   ]
 
   def up
+    return if Rails.env.test?
+
     DATA.each { |attrs| Item.find_by!(attrs).destroy! }
     ActiveRecord::Base.connection.reset_pk_sequence!('items', :id, 'items_id_seq')
   end
 
   def down
+    return if Rails.env.test?
+
     DATA.each { |attrs| Item.create!(attrs) }
   end
 end

db/migrate/20220920213123_add_fall2022_items.rb

@@ -36,12 +36,16 @@ class AddFall2022Items < ActiveRecord::Migration[7.0]
   ]
 
   def up
+    return if Rails.env.test?
+
     raise ArgumentError, "Missing images:\n\t#{image_errors.join("\n\t")}" if image_errors.any?
     ActiveRecord::Base.connection.reset_pk_sequence!('items', :id, 'items_id_seq')
     importer.import_items!
   end
 
   def down
+    return if Rails.env.test?
+
     Item.where(mms_id: mms_ids).destroy_all
   end
 

db/migrate/20220921205344_support_ordered_terms.rb

@@ -0,0 +1,51 @@
+class SupportOrderedTerms < ActiveRecord::Migration[7.0]
+
+  ORDERED_FACET_VALUES = {
+    'Decade' => [
+      'Before 1900',
+      '1900-1909',
+      '1910-1919',
+      '1920-1929',
+      '1930-1939',
+      '1940-1949',
+      '1950-1959',
+      '1960-1969',
+      '1970-1979',
+      '1980-1989',
+      '1990-1999',
+      'After 1999',
+      'No Date'
+    ].freeze,
+    'Size' => [
+      'Small',
+      'Medium',
+      'Large',
+      'Oversized'
+    ].freeze
+  }.freeze
+
+  def change
+    add_column(:facets, :ordered, :boolean, default: false, null: false)
+    add_column(:terms, :ord, :integer)
+
+    set_order!
+
+    add_index(:terms, [:facet_id, :ord], unique: true)
+  end
+
+  private
+
+  def set_order!
+    return if Rails.env.test?
+
+    ORDERED_FACET_VALUES.each do |facet_name, values|
+      facet = Facet.find_by!(name: facet_name)
+      facet.update(ordered: true)
+
+      values.each_with_index do |value, i|
+        term = Term.find_by!(facet: facet, value: value)
+        term.update(ord: i)
+      end
+    end
+  end
+end

db/schema.rb

@@ -10,14 +10,15 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2022_09_20_213123) do
+ActiveRecord::Schema[7.0].define(version: 2022_09_21_205344) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
   create_table "facets", force: :cascade do |t|
     t.string "name", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.boolean "ordered", default: false, null: false
     t.index ["name"], name: "index_facets_on_name", unique: true
   end
 
@@ -60,6 +61,8 @@
     t.bigint "parent_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.integer "ord"
+    t.index ["facet_id", "ord"], name: "index_terms_on_facet_id_and_ord", unique: true
     t.index ["facet_id"], name: "index_terms_on_facet_id"
     t.index ["parent_id"], name: "index_terms_on_parent_id"
     t.index ["value"], name: "index_terms_on_value", unique: true

spec/factories/terms.rb

@@ -25,81 +25,97 @@
 
     factory(:term_small) do
       value { 'Small' }
+      ord { 0 }
       facet { association :facet_size }
     end
 
     factory(:term_medium) do
       value { 'Medium' }
+      ord { 1 }
       facet { association :facet_size }
     end
 
     factory(:term_large) do
       value { 'Large' }
+      ord { 2 }
       facet { association :facet_size }
     end
 
     factory(:term_oversized) do
       value { 'Oversized' }
+      ord { 3 }
       facet { association :facet_size }
     end
 
     factory(:term_before_1900) do
       value { 'Before 1900' }
+      ord { 0 }
       facet { association :facet_decade }
     end
 
     factory(:term_1900_1909) do
       value { '1900-1909' }
+      ord { 1 }
       facet { association :facet_decade }
     end
 
     factory(:term_1910_1919) do
       value { '1910-1919' }
+      ord { 2 }
       facet { association :facet_decade }
     end
 
     factory(:term_1920_1929) do
       value { '1920-1929' }
+      ord { 3 }
       facet { association :facet_decade }
     end
 
     factory(:term_1930_1939) do
       value { '1930-1939' }
+      ord { 4 }
       facet { association :facet_decade }
     end
 
     factory(:term_1940_1949) do
       value { '1940-1949' }
+      ord { 5 }
       facet { association :facet_decade }
     end
 
     factory(:term_1950_1959) do
       value { '1950-1959' }
+      ord { 6 }
       facet { association :facet_decade }
     end
 
     factory(:term_1960_1969) do
       value { '1960-1969' }
+      ord { 7 }
       facet { association :facet_decade }
     end
 
     factory(:term_1970_1979) do
       value { '1970-1979' }
+      ord { 8 }
       facet { association :facet_decade }
     end
 
     factory(:term_1980_1989) do
       value { '1980-1989' }
+      ord { 9 }
       facet { association :facet_decade }
     end
 
     factory(:term_1990_1999) do
       value { '1990-1999' }
+      ord { 10 }
       facet { association :facet_decade }
     end
 
     factory(:term_after_1999) do
       value { 'After 1999' }
+      ord { 11 }
       facet { association :facet_decade }
     end