feat: use friendly id for snippet urls

Author: Lewis Youl

app/controllers/alerts/snippets_controller.rb

@@ -3,13 +3,13 @@ class Alerts::SnippetsController < AlertsController
   DELETE_CONFIRM_TEXT = "Are you sure you want to delete this snippet? You won't be able to undo this.".freeze
 
   def unfile
-    @snippet = current_user.filed_snippets.find(params[:id])
+    @snippet = current_user.filed_snippets.friendly.find(params[:id])
     @header = 'Remove Snippet'
     @message = UNFILE_CONFIRM_TEXT
   end
 
   def delete
-    @snippet = current_user.snippets.find(params[:id])
+    @snippet = current_user.snippets.friendly.find(params[:id])
     @header = 'Delete Snippet'
     @message = DELETE_CONFIRM_TEXT
   end

app/controllers/comments_controller.rb

@@ -3,7 +3,7 @@ class CommentsController < ApplicationController
   before_action :set_comment, only: :destroy
 
   def create
-    @snippet = Snippet.find(params[:snippet_id])
+    @snippet = Snippet.friendly.find(params[:snippet_id])
     @comment = @snippet.comments.new(comment_params)
 
     if @comment.save

app/controllers/modals/snippets_controller.rb

@@ -15,21 +15,21 @@ def edit
   end
 
   def move
-    @snippet = Snippet.find(params[:id])
-    @current_folder_id = current_user.snippet_folders.find_by(snippet_id: params[:id])&.folder&.id
+    @snippet = Snippet.friendly.find(params[:id])
+    @current_folder_id = current_user.snippet_folders.find_by(snippet_id: @snippet.id)&.folder&.id
     @header = @current_folder_id ? 'Move Snippet' : 'File Snippet'
     @folders = current_user.folders.order(name: :asc)
   end
 
   def picture
-    @snippet = Snippet.find(params[:id])
+    @snippet = Snippet.friendly.find(params[:id])
     @languages = Language.order(name: :asc)
   end
 
   private
 
   def set_snippet
-    unless @snippet = current_user.snippets.find_by(id: params[:id])
+    unless @snippet = current_user.snippets.find_by(slug: params[:id])
       respond_to do |format|
         format.html { redirect_to root_path, alert: UNAUTHORIZED }
         format.json { render json: { message: UNAUTHORIZED }, status: 401 }

app/controllers/snippets_controller.rb

@@ -29,7 +29,7 @@ def index
   end
 
   def popover
-    @snippet = Snippet.find(params[:id])
+    @snippet = Snippet.friendly.find(params[:id])
 
     @popover_options = current_user.popover_options_for(@snippet)
 
@@ -38,7 +38,8 @@ def popover
 
   # Does this belong on SnippetFoldersController?
   def unfile
-    snippet_folder = current_user.snippet_folders.find_by(snippet_id: params[:id])
+    snippet = current_user.filed_snippets.friendly.find(params[:id])
+    snippet_folder = current_user.snippet_folders.find_by(snippet_id: snippet.id)
 
     if snippet_folder && snippet_folder.destroy
       flash[:notice] = "Snippet removed from collection!"
@@ -55,13 +56,13 @@ def file
       format.json do
         begin
           Snippet.transaction do
-            snippet = Snippet.find(params[:id])
+            snippet = Snippet.friendly.find(params[:id])
 
-            if snippet_folder = current_user.snippet_folders.find_by(snippet_id: params[:id])
+            if snippet_folder = current_user.snippet_folders.find_by(snippet_id: snippet.id)
               snippet_folder.destroy!
             end  
 
-            snippet_folder = SnippetFolder.create!(snippet_id: params[:id], folder_id: params[:folder_id])
+            snippet_folder = SnippetFolder.create!(snippet_id: snippet.id, folder_id: params[:folder_id])
 
             unless current_user == snippet.user
               snippet_folder.notifications.create!(user: snippet.user)
@@ -78,7 +79,8 @@ def file
   end
 
   def current_folder
-    snippet_folder = current_user.snippet_folders.find_by(snippet_id: params[:id])
+    snippet = Snippet.friendly.find(params[:id])
+    snippet_folder = current_user.snippet_folders.find_by(snippet_id: snippet.id)
 
     res = { folders: current_user.folders.map { |folder| FolderSerializer.new(folder).to_h } }
 
@@ -92,7 +94,7 @@ def current_folder
   def show
     @page_title = "Snippet"
     @languages = Language.all.to_json
-    @snippet = Snippet.includes(comments: :user).find_by(id: params[:id])
+    @snippet = Snippet.includes(comments: :user).find_by(slug: params[:id])
 
     unless @snippet && @snippet.visible_to?(current_user)
       flash[:alert] = "You are not authorized to view that snippet"
@@ -148,13 +150,13 @@ def create
 
   #TODO: Use a different controller action for moving a snippet between folders
   def update
-    snippet = current_user.filed_snippets.find_by(id: params[:id])
+    snippet = current_user.filed_snippets.find_by(slug: params[:id])
 
     if snippet.update(snippet_params.except(:folder_id))
       folder = current_user.folders.find(snippet_params[:folder_id])
 
       Snippet.transaction do
-        snippet_folder = current_user.snippet_folders.find_by(snippet_id: params[:id])
+        snippet_folder = current_user.snippet_folders.find_by(snippet_id: snippet.id)
 
         if snippet_folder.folder_id != snippet_params[:folder_id].to_i
           snippet_folder.update!(folder_id: snippet_params[:folder_id])
@@ -179,7 +181,7 @@ def update
   end
 
   def destroy
-    @snippet = current_user.snippets.find(params[:id])
+    @snippet = current_user.snippets.friendly.find(params[:id])
 
     if @snippet&.destroy
       render json: { resource_id: @snippet.client_id }

app/controllers/tweets_controller.rb

@@ -1,4 +1,6 @@
 class TweetsController < ApplicationController
+  before_action :authenticate_user!
+
   def create
     tweet = twitter_client.tweet_media(params[:data].path)
 

app/controllers/users_controller.rb

@@ -80,15 +80,15 @@ def modify
   end
 
   def follow
-    @user = User.find_by(slug: params[:id])
+    @user = User.find_by(id: params[:id])
 
     current_user.follow(@user)
 
     render partial: 'users/follow_button', locals: { user: @user }
   end
 
   def unfollow
-    @user = User.find_by(slug: params[:id])
+    @user = User.find_by(id: params[:id])
 
     current_user.unfollow(@user)
 

app/models/snippet.rb

@@ -1,4 +1,7 @@
 class Snippet < ApplicationRecord
+  extend FriendlyId
+  friendly_id :description, use: :slugged
+
   has_many :snippet_folders, dependent: :destroy
   has_many :folders, through: :snippet_folders
   belongs_to :user, required: true

app/models/user.rb

@@ -4,7 +4,7 @@ class User < ApplicationRecord
   extend FriendlyId
   include Rails.application.routes.url_helpers
 
-  DEFAULT_FOLDER_NAME = 'My First Folder'.freeze
+  DEFAULT_FOLDER_NAME = 'My Snippets'.freeze
   ALPHANUMERIC = /\A[a-zA-Z0-9]*\z/.freeze
 
   friendly_id :name, use: :slugged

db/migrate/20210316073353_add_slug_to_snippets.rb

@@ -0,0 +1,8 @@
+class AddSlugToSnippets < ActiveRecord::Migration[6.0]
+  def change
+    add_column :snippets, :slug, :string
+    add_index :snippets, :slug, unique: true
+
+    Snippet.find_each(&:save!)
+  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.define(version: 2021_03_15_204751) do
+ActiveRecord::Schema.define(version: 2021_03_16_073353) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -120,7 +120,9 @@
     t.integer "comments_count", default: 0
     t.string "highlighted_body"
     t.bigint "language_id"
+    t.string "slug"
     t.index ["language_id"], name: "index_snippets_on_language_id"
+    t.index ["slug"], name: "index_snippets_on_slug", unique: true
     t.index ["user_id"], name: "index_snippets_on_user_id"
   end