Merge pull request #203 from joyofrails/feat/code-screenshots

Support Snippet Screenshots and Twitter sharing

Author: rossta

.gitignore

@@ -72,3 +72,5 @@ config/litestream/*.yml
 spec/failures.txt
 
 /coverage
+
+.rspec

.rspec

@@ -29,7 +29,7 @@ gem "postmark-rails" # Postmark Rails gem [https://github.com/ActiveCampaign/pos
 gem "scout_apm" # Scout APM Ruby Agent [https://scoutapm.com]
 
 # Rendering
-# gem "image_processing" # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+gem "image_processing", group: [:default, :wasm] # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 gem "inline_svg" # Embed SVGs in Rails views and style them with CSS [https://github.com/jamesmartin/inline_svg
 gem "rouge", group: [:default, :wasm] # Pure Ruby syntaix highlighter [https://github.com/rouge-ruby/rouge
 gem "sitepress-rails", group: [:default, :wasm] # Static site generator for Rails [https://sitepress.cc/getting-started/rails]
@@ -47,6 +47,7 @@ gem "honeybadger" # Error monitoring and uptime reporting [https://www.honeybadg
 gem "litestream" # Standalone streaming replication for SQLite [https://litestream.io]
 gem "web-push" # Web Push library for Ruby [https://github.com/pushpad/web-push]
 gem "fog-aws", require: false # Module for the 'fog' gem to support Amazon Web Services [https://github.com/fog/fog-aws]
+gem "aws-sdk-s3" # Official AWS Ruby gem for Amazon S3 [https://github.com/aws/aws-sdk-ruby]
 
 # Admin
 gem "flipper-ui" # UI for the Flipper gem [https://www.flippercloud.io/docs/ui]

Gemfile

@@ -83,6 +83,22 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.970.0)
+    aws-sdk-core (3.202.2)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.9)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-kms (1.88.0)
+      aws-sdk-core (~> 3, >= 3.201.0)
+      aws-sigv4 (~> 1.5)
+    aws-sdk-s3 (1.159.0)
+      aws-sdk-core (~> 3, >= 3.201.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.9.1)
+      aws-eventstream (~> 1, >= 1.0.2)
     base64 (0.2.0)
     bcrypt (3.1.20)
     better_html (2.1.1)
@@ -191,6 +207,8 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (~> 0.7)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
     flipper (1.3.0)
       concurrent-ruby (< 2)
     flipper-active_record (1.3.0)
@@ -231,6 +249,9 @@ GEM
       http-2 (>= 1.0.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
+    image_processing (1.13.0)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
     importmap-rails (2.0.1)
       actionpack (>= 6.0.0)
       activesupport (>= 6.0.0)
@@ -244,6 +265,7 @@ GEM
     irb (1.14.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
+    jmespath (1.6.2)
     js (2.6.2)
     json (2.7.2)
     jwt (2.8.2)
@@ -262,6 +284,7 @@ GEM
       logfmt (>= 0.0.10)
       sqlite3
     logfmt (0.0.10)
+    logger (1.6.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -277,6 +300,7 @@ GEM
     mime-types (3.5.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2024.0702)
+    mini_magick (4.13.2)
     mini_mime (1.1.5)
     mini_portile2 (2.8.7)
     minitest (5.24.1)
@@ -430,6 +454,9 @@ GEM
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
+    ruby-vips (2.2.2)
+      ffi (~> 1.12)
+      logger
     ruby_wasm (2.6.2-arm64-darwin)
     ruby_wasm (2.6.2-x86_64-linux)
     sanitize (6.1.1)
@@ -547,6 +574,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord-enhancedsqlite3-adapter
   activerecord-nulldb-adapter
+  aws-sdk-s3
   bcrypt (~> 3.1.7)
   bootsnap
   brakeman
@@ -568,6 +596,7 @@ DEPENDENCIES
   fog-aws
   honeybadger
   httpx
+  image_processing
   inline_svg
   invisible_captcha
   js

Gemfile.lock

@@ -2,20 +2,13 @@
   title: current_page.data.title!,
   description: current_page.data.description,
   keywords: %w[rails hotwire],
-  index: true,
-  icon: "/favicon.ico",
   og: {
-    title: :title,
-    description: :description,
     type: "article",
     url: current_page.url,
-    site_name: "Joy of Rails",
-    locale: "en_US",
     image: current_page.data.meta_image && asset_url(current_page.data.meta_image)
   },
   twitter: {
     card: current_page.data.meta_image ? "summary_large_image" : "summary",
-    site: "@joyofrails",
   }
 ) %>
 <%= render "application/skip_to_content" %>

app/content/layouts/article.html.erb

@@ -0,0 +1,19 @@
+class Share::SnippetScreenshotsController < ApplicationController
+  using Refinements::Emojoy
+
+  def show
+    @snippet = Snippet.find(params[:snippet_id])
+
+    render layout: false
+  end
+
+  def new
+    @snippet = Snippet.find(params[:snippet_id])
+  end
+
+  def create
+    @snippet = Snippet.find(params[:snippet_id])
+    @snippet.attach_screenshot_from_base64(params[:screenshot])
+    redirect_to new_share_snippet_tweet_path(@snippet, auto: true), notice: "Screenshot attached".emojoy
+  end
+end

app/controllers/share/snippet_screenshots_controller.rb

@@ -0,0 +1,8 @@
+class Share::SnippetTweetsController < ApplicationController
+  using Refinements::Emojoy
+
+  def new
+    @snippet = Snippet.find(params[:snippet_id])
+    @auto = params[:auto] == "true"
+  end
+end

app/controllers/share/snippet_tweets_controller.rb

@@ -0,0 +1,87 @@
+class Share::SnippetsController < ApplicationController
+  using Refinements::Emojoy
+
+  before_action :feature_enabled!, except: %i[index show]
+  before_action :authenticate_user!, only: %i[new create edit update destroy]
+
+  # GET /snippets
+  def index
+    @snippets = Snippet.all.with_attached_screenshot.includes(:author).order(created_at: :desc)
+  end
+
+  # GET /snippets/1
+  def show
+    @snippet = Snippet.find(params[:id])
+
+    fresh_when(@snippet, public: true) unless user_signed_in?
+  end
+
+  # GET /snippets/new
+  def new
+    default_params = {
+      filename: "app/models/user.rb",
+      source: "class User < ApplicationRecord\n\s\shas_many :posts\nend",
+      language: "ruby"
+    }
+    @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.assign_attributes(snippet_params)
+  end
+
+  # POST /snippets
+  def create
+    @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
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /snippets/1
+  def update
+    @snippet = current_user.snippets.find(params[:id])
+    if @snippet.update(snippet_params)
+      @snippet.attach_screenshot_from_base64(params[:screenshot]) if params[:screenshot]
+
+      redirect_to share_snippet_redirect_url(@snippet), notice: "Your snippet has been saved".emojoy, status: :see_other
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /snippets/1
+  def destroy
+    @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
+
+  private
+
+  def share_snippet_redirect_url(snippet)
+    case params[:commit]
+    when "Share"
+      new_share_snippet_screenshot_url(snippet)
+    else
+      edit_share_snippet_url(snippet)
+    end
+  end
+
+  # Only allow a list of trusted parameters through.
+  def snippet_params
+    params.fetch(:snippet, {}).permit(:filename, :source, :language)
+  end
+
+  def feature_enabled!
+    return if user_signed_in? &&
+      Flipper.enabled?(:snippets, current_user)
+
+    raise ActionController::RoutingError.new("Not Found")
+  end
+end

app/controllers/share/snippets_controller.rb

@@ -6,6 +6,19 @@ def seo_meta_tags
       {rel: "apple-touch-icon", href: "/apple-touch-icon.png?v1.0"},
       {rel: "manifest", href: "/manifest.webmanifest?v1.0"}
     ]
+    set_meta_tags index: true
+    set_meta_tags icon: "/favicon.ico"
+    set_meta_tags og: {
+      title: :title,
+      description: :description,
+      type: "article",
+      url: url_for,
+      site_name: "Joy of Rails",
+      locale: "en_US"
+    }
+    set_meta_tags twitter: {
+      site: "@joyofrails"
+    }
     display_meta_tags site: "Joy of Rails"
   end
 end