feat: Use FriendlyId in JobPosts to avoid using IDs in URLs

Author: hussain-cdm

Gemfile

@@ -50,6 +50,7 @@ gem "googleauth", "~> 1.1.0"
 gem "dotenv-rails"
 gem "ruby-openai"
 gem "pdf-reader", "~> 2.11"
+gem "friendly_id", "~> 5.5.0"
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem

Gemfile.lock

@@ -134,6 +134,8 @@ GEM
       multipart-post (~> 2.0)
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
+    friendly_id (5.5.1)
+      activerecord (>= 4.0.0)
     fugit (1.11.1)
       et-orbi (~> 1, >= 1.2.11)
       raabro (~> 1.4)
@@ -497,6 +499,7 @@ DEPENDENCIES
   dotenv-rails
   factory_bot_rails
   faker
+  friendly_id (~> 5.5.0)
   google-api-client (~> 0.53.0)
   googleauth (~> 1.1.0)
   importmap-rails

app/controllers/employer/google_oauth_controller.rb

@@ -17,21 +17,22 @@ def callback
       update_google_tokens(client.authorization)
       return_to = session.delete(:return_to)
 
-      if return_to =~ %r{/employer/job_posts/(\d+)/job_applications/(\d+)/interviews}
-        job_post_id = $1
+      if return_to =~ %r{/employer/job_posts/([^/]+)/job_applications/(\d+)/interviews}
+        job_post_slug = $1
         job_application_id = $2
-        job_post = Current.user.organization.job_posts.find(job_post_id)
+
+        job_post = Current.user.organization.job_posts.friendly.find(job_post_slug)
         job_application = job_post.job_applications.find(job_application_id)
         interview = job_application.interviews.last
 
         creator = GoogleCalendar::GoogleCalendarEventCreator.new(interview)
         result = creator.create_event
 
         if result == true
-          redirect_to employer_job_post_job_application_path(job_post_id, job_application_id),
+          redirect_to employer_job_post_job_application_path(job_post_slug, job_application_id),
                       notice: "Interview scheduled successfully with Google Calendar!"
         else
-          redirect_to employer_job_post_job_application_path(job_post_id, job_application_id),
+          redirect_to employer_job_post_job_application_path(job_post_slug, job_application_id),
                       alert: "Failed to create Google Calendar event. Please try again."
         end
       else

app/controllers/employer/job_posts_controller.rb

@@ -16,7 +16,7 @@ def index
   end
 
   def show
-    @job_post = Current.user.organization.job_posts.find(params[:id])
+    @job_post = Current.user.organization.job_posts.friendly.find(params[:id])
   end
 
   def new

app/models/job_post.rb

@@ -1,4 +1,7 @@
 class JobPost < ApplicationRecord
+  extend FriendlyId
+  friendly_id :title, use: :slugged
+
   belongs_to :user
   belongs_to :organization
   has_many :job_applications, dependent: :destroy

config/initializers/friendly_id.rb

@@ -0,0 +1,107 @@
+# FriendlyId Global Configuration
+#
+# Use this to set up shared configuration options for your entire application.
+# Any of the configuration options shown here can also be applied to single
+# models by passing arguments to the `friendly_id` class method or defining
+# methods in your model.
+#
+# To learn more, check out the guide:
+#
+# http://norman.github.io/friendly_id/file.Guide.html
+
+FriendlyId.defaults do |config|
+  # ## Reserved Words
+  #
+  # Some words could conflict with Rails's routes when used as slugs, or are
+  # undesirable to allow as slugs. Edit this list as needed for your app.
+  config.use :reserved
+
+  config.reserved_words = %w[new edit index session login logout users admin
+    stylesheets assets javascripts images]
+
+  # This adds an option to treat reserved words as conflicts rather than exceptions.
+  # When there is no good candidate, a UUID will be appended, matching the existing
+  # conflict behavior.
+
+  # config.treat_reserved_as_conflict = true
+
+  #  ## Friendly Finders
+  #
+  # Uncomment this to use friendly finders in all models. By default, if
+  # you wish to find a record by its friendly id, you must do:
+  #
+  #    MyModel.friendly.find('foo')
+  #
+  # If you uncomment this, you can do:
+  #
+  #    MyModel.find('foo')
+  #
+  # This is significantly more convenient but may not be appropriate for
+  # all applications, so you must explicitly opt-in to this behavior. You can
+  # always also configure it on a per-model basis if you prefer.
+  #
+  # Something else to consider is that using the :finders addon boosts
+  # performance because it will avoid Rails-internal code that makes runtime
+  # calls to `Module.extend`.
+  #
+  config.use :finders
+  #
+  # ## Slugs
+  #
+  # Most applications will use the :slugged module everywhere. If you wish
+  # to do so, uncomment the following line.
+  #
+  config.use :slugged
+  #
+  # By default, FriendlyId's :slugged addon expects the slug column to be named
+  # 'slug', but you can change it if you wish.
+  #
+  # config.slug_column = 'slug'
+  #
+  # By default, slug has no size limit, but you can change it if you wish.
+  #
+  # config.slug_limit = 255
+  #
+  # When FriendlyId can not generate a unique ID from your base method, it appends
+  # a UUID, separated by a single dash. You can configure the character used as the
+  # separator. If you're upgrading from FriendlyId 4, you may wish to replace this
+  # with two dashes.
+  #
+  # config.sequence_separator = '-'
+  #
+  # Note that you must use the :slugged addon **prior** to the line which
+  # configures the sequence separator, or else FriendlyId will raise an undefined
+  # method error.
+  #
+  #  ## Tips and Tricks
+  #
+  #  ### Controlling when slugs are generated
+  #
+  # As of FriendlyId 5.0, new slugs are generated only when the slug field is
+  # nil, but if you're using a column as your base method can change this
+  # behavior by overriding the `should_generate_new_friendly_id?` method that
+  # FriendlyId adds to your model. The change below makes FriendlyId 5.0 behave
+  # more like 4.0.
+  # Note: Use(include) Slugged module in the config if using the anonymous module.
+  # If you have `friendly_id :name, use: slugged` in the model, Slugged module
+  # is included after the anonymous module defined in the initializer, so it
+  # overrides the `should_generate_new_friendly_id?` method from the anonymous module.
+  #
+  # config.use :slugged
+  # config.use Module.new {
+  #   def should_generate_new_friendly_id?
+  #     slug.blank? || <your_column_name_here>_changed?
+  #   end
+  # }
+  #
+  # FriendlyId uses Rails's `parameterize` method to generate slugs, but for
+  # languages that don't use the Roman alphabet, that's not usually sufficient.
+  # Here we use the Babosa library to transliterate Russian Cyrillic slugs to
+  # ASCII. If you use this, don't forget to add "babosa" to your Gemfile.
+  #
+  # config.use Module.new {
+  #   def normalize_friendly_id(text)
+  #     text.to_slug.normalize! :transliterations => [:russian, :latin]
+  #   end
+  # }
+end

db/migrate/20250505050209_create_friendly_id_slugs.rb

@@ -0,0 +1,21 @@
+MIGRATION_CLASS =
+  if ActiveRecord::VERSION::MAJOR >= 5
+    ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
+  else
+    ActiveRecord::Migration
+  end
+
+class CreateFriendlyIdSlugs < MIGRATION_CLASS
+  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/migrate/20250505060427_add_slug_to_job_posts.rb

@@ -0,0 +1,6 @@
+class AddSlugToJobPosts < ActiveRecord::Migration[8.0]
+  def change
+    add_column :job_posts, :slug, :string
+    add_index :job_posts, :slug, unique: true
+  end
+end