friendly_id fixes, annotate

Author: manuelmeurer

Gemfile

@@ -12,6 +12,7 @@ gem "bootsnap",                                 "~> 1.13", require: false
 gem "bootstrap",                                "~> 5.2"
 gem "cloudflare",                               "~> 4.3"
 gem "envkey",                                   "~> 1.0"
+gem "friendly_id",                              "~> 5.5"
 gem "git",                                      "~> 1.12"
 gem "haml",                                     "~> 6.0"
 gem "hiredis",                                  "~> 0.6"

Gemfile.lock

@@ -156,6 +156,8 @@ GEM
     execjs (2.8.1)
     ffi (1.15.5)
     fiber-local (1.0.0)
+    friendly_id (5.5.0)
+      activerecord (>= 4.0.0)
     fugit (1.7.2)
       et-orbi (~> 1, >= 1.2.7)
       raabro (~> 1.4)
@@ -355,6 +357,7 @@ DEPENDENCIES
   database_consistency (~> 1.0)
   dotenv-rails (~> 2.8)
   envkey (~> 1.0)
+  friendly_id (~> 5.5)
   git (~> 1.12)
   haml (~> 6.0)
   hiredis (~> 0.6)

app/models/doc.rb

@@ -1,5 +1,7 @@
 class Doc < ApplicationRecord
-  include FriendlyId, LocalPath
+  extend FriendlyId
+
+  include LocalPath
 
   friendly_id :name, use: :slugged
 
@@ -30,3 +32,15 @@ def name
   end
   alias :to_s :name
 end
+
+# == Schema Information
+#
+# Table name: docs
+#
+#  id         :integer          not null, primary key
+#  slug       :string           not null
+#  tag        :string
+#  created_at :datetime
+#  updated_at :datetime
+#  project_id :integer
+#

app/models/doc_collection.rb

@@ -1,5 +1,7 @@
 class DocCollection < ApplicationRecord
-  include FriendlyId, LocalPath
+  extend FriendlyId
+
+  include LocalPath
 
   friendly_id :name, use: :slugged
 
@@ -37,3 +39,16 @@ def uploaded?
     !!uploaded_at
   end
 end
+
+# == Schema Information
+#
+# Table name: doc_collections
+#
+#  id             :integer          not null, primary key
+#  generated_at   :datetime
+#  generated_with :string
+#  slug           :string           not null
+#  uploaded_at    :datetime
+#  created_at     :datetime
+#  updated_at     :datetime
+#

app/models/doc_collection_membership.rb

@@ -5,3 +5,12 @@ class DocCollectionMembership < ApplicationRecord
   validates :doc, presence: true
   validates :doc_id, uniqueness: { scope: :doc_collection_id }
 end
+
+# == Schema Information
+#
+# Table name: doc_collection_memberships
+#
+#  id                :integer          not null, primary key
+#  doc_collection_id :integer
+#  doc_id            :integer
+#

app/models/project.rb

@@ -1,5 +1,7 @@
 class Project < ApplicationRecord
-  include FriendlyId, LocalPath
+  extend FriendlyId
+
+  include LocalPath
 
   friendly_id :name, use: :slugged
 
@@ -9,3 +11,17 @@ class Project < ApplicationRecord
   validates :name, presence: true, uniqueness: true
   validates :git, presence: true, uniqueness: true
 end
+
+# == Schema Information
+#
+# Table name: projects
+#
+#  id         :integer          not null, primary key
+#  git        :string
+#  links      :text             default([]), not null, is an Array
+#  name       :string
+#  slug       :string           not null
+#  tags       :json
+#  created_at :datetime
+#  updated_at :datetime
+#

config/initializers/friendly_id.rb

@@ -0,0 +1,4 @@
+FriendlyId.defaults do |config|
+  config.use :reserved
+  config.reserved_words = %w(new edit index session login logout users admin stylesheets assets javascripts images)
+end

db/migrate/20221204174611_create_friendly_id_slugs.rb

@@ -0,0 +1,14 @@
+class CreateFriendlyIdSlugs < ActiveRecord::Migration[7.0]
+  def change
+    create_table :friendly_id_slugs do |t|
+      t.string :slug, null: false
+      t.integer :sluggable_id, null: false
+      t.string :sluggable_type, limit: 50
+      t.string :scope
+      t.datetime :created_at
+    end
+    add_index :friendly_id_slugs, [:sluggable_type, :sluggable_id]
+    add_index :friendly_id_slugs, [:slug, :sluggable_type], length: {slug: 140, sluggable_type: 50}
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], length: {slug: 70, sluggable_type: 50, scope: 70}, unique: true
+  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: 2018_09_02_164850) do
+ActiveRecord::Schema[7.0].define(version: 2022_12_04_174611) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -39,6 +39,17 @@
     t.index ["slug"], name: "index_docs_on_slug", unique: true
   end
 
+  create_table "friendly_id_slugs", force: :cascade do |t|
+    t.string "slug", null: false
+    t.integer "sluggable_id", null: false
+    t.string "sluggable_type", limit: 50
+    t.string "scope"
+    t.datetime "created_at"
+    t.index ["slug", "sluggable_type", "scope"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type_and_scope", unique: true
+    t.index ["slug", "sluggable_type"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type"
+    t.index ["sluggable_type", "sluggable_id"], name: "index_friendly_id_slugs_on_sluggable_type_and_sluggable_id"
+  end
+
   create_table "projects", id: :serial, force: :cascade do |t|
     t.string "name"
     t.string "git"