Merge pull request #209 from joyofrails/feat/snippet-content

Add description to code snippets

Author: rossta

app/controllers/share/snippets_controller.rb

@@ -23,18 +23,18 @@ def new
       source: "class User < ApplicationRecord\n\s\shas_many :posts\nend",
       language: "ruby"
     }
-    @snippet = current_user.snippets.new(snippet_params.presence || default_params)
+    @snippet = Current.user.snippets.new(snippet_params.presence || default_params)
   end
 
   # GET /snippets/1/edit
   def edit
-    @snippet = current_user.snippets.find(params[:id])
+    @snippet = Current.user.snippets.find(params[:id])
     @snippet.assign_attributes(snippet_params)
   end
 
   # POST /snippets
   def create
-    @snippet = current_user.snippets.new(snippet_params)
+    @snippet = Current.user.snippets.new(snippet_params)
 
     if @snippet.save
       redirect_to share_snippet_redirect_url(@snippet), notice: "Your snippet has been saved".emojoy, status: :see_other
@@ -45,7 +45,7 @@ def create
 
   # PATCH/PUT /snippets/1
   def update
-    @snippet = current_user.snippets.find(params[:id])
+    @snippet = Current.user.snippets.find(params[:id])
     if @snippet.update(snippet_params)
       @snippet.attach_screenshot_from_base64(params[:screenshot]) if params[:screenshot]
 
@@ -57,7 +57,7 @@ def update
 
   # DELETE /snippets/1
   def destroy
-    @snippet = current_user.snippets.find(params[:id])
+    @snippet = Current.user.snippets.find(params[:id])
     @snippet.destroy!
     redirect_to share_snippets_url, notice: "Your snippet has been deleted permanently".emojoy, status: :see_other
   end
@@ -77,7 +77,7 @@ def share_snippet_redirect_url(snippet)
 
   # Only allow a list of trusted parameters through.
   def snippet_params
-    params.fetch(:snippet, {}).permit(:filename, :source, :language)
+    params.fetch(:snippet, {}).permit(:filename, :source, :language, :description)
   end
 
   def feature_enabled!

app/views/admin/home/index.html.erb

@@ -8,7 +8,7 @@ nav = {
 %>
 <article>
   <%= render Pages::Header.new(title: "Admin") %>
-  <div class="section-content container">
+  <div class="section-content container py-gap mb-3xl">
     <ul>
       <% nav.each do |label, url| %>
       <li>

app/views/components/code_block/container.rb

@@ -10,10 +10,6 @@ def initialize(language: "plain", **options)
   end
 
   def view_template(&)
-    div(
-      class: class_names("code-wrapper", "highlight", "language-#{language}", *classes),
-      **options,
-      &
-    )
+    div(class: class_names("code-wrapper", "highlight", "language-#{language}", *classes), **options, &)
   end
 end

app/views/components/layouts/front_door_form.rb

@@ -30,11 +30,7 @@ def form_layout(&block)
   end
 
   def form_with(**, &)
-    super(
-      class: "grid grid-row-tight",
-      **,
-      &
-    )
+    super(class: "grid grid-row-tight", **, &)
   end
 
   def form_label(form, *args, **opts)

app/views/components/markdown/safe.rb

@@ -0,0 +1,2 @@
+class Markdown::Safe < Markdown::Base
+end

app/views/share/snippet_tweets/tweet_button.rb

@@ -28,7 +28,7 @@ def share_url
   end
 
   def tweet_text
-    "Created with @joyofrails #{share_url}"
+    [@snippet.description.presence, "Created with @joyofrails #{share_url}"].compact.join("\n\n")
   end
 
   def encode(text)

app/views/share/snippets/form.rb

@@ -53,7 +53,15 @@ def view_template
         fieldset do
           flex_block do
             language_select(form, data: {action: "change->snippet-preview#preview"})
+          end
+        end
 
+        fieldset do
+          form.text_area :description, placeholder: "Say a few words about this code snippet", class: "w-full"
+        end
+
+        fieldset do
+          flex_block do
             plain form.submit "Share", class: "button primary"
 
             plain form.submit "Save", class: "button secondary"

app/views/share/snippets/index.html.erb

@@ -8,7 +8,8 @@
 
   <% @snippets.each do |snippet| %>
     <div id="<%= dom_id(snippet) %>" class="section-content mb-xl">
-      <%= link_to share_snippet_path(snippet), class: "block" do %>
+      <%= render Markdown::Safe.new(snippet.description) if snippet.description %>
+      <%= link_to share_snippet_path(snippet), class: "section-content" do %>
         <%= render CodeBlock::Snippet.new(snippet) %>
       <% end %>
       <div>

app/views/share/snippets/show.html.erb

@@ -14,6 +14,7 @@
 <div class="section-content container py-gap mb-3xl">
   <%= turbo_frame_tag :snippet_form do %>
     <div class="section-content">
+      <%= render Markdown::Safe.new(@snippet.description) if @snippet.description %>
       <%= render CodeBlock::Snippet.new(@snippet) %>
       <div>
         <%= render Share::Snippets::Toolbar.new(@snippet, current_user: current_user) %>

db/migrate/20240905104301_alter_snippets_change_url_to_description.rb

@@ -0,0 +1,9 @@
+class AlterSnippetsChangeUrlToDescription < ActiveRecord::Migration[7.2]
+  def up
+    rename_column :snippets, :url, :description
+  end
+
+  def down
+    rename_column :snippets, :description, :url
+  end
+end