DEV: Introduce syntax_tree for ruby formatting (#73)

Author: davidtaylorhq

.github/workflows/plugin-linting.yml

@@ -55,3 +55,12 @@ jobs:
       - name: Rubocop
         if: ${{ !cancelled() }}
         run: bundle exec rubocop .
+
+      - name: Syntax Tree
+        if: ${{ !cancelled() }}
+        run: |
+          if test -f .streerc; then
+            bundle exec stree check Gemfile $(git ls-files '*.rb') $(git ls-files '*.rake')
+          else
+            echo "Stree config not detected for this repository. Skipping."
+          fi

.github/workflows/plugin-tests.yml

@@ -80,7 +80,7 @@ jobs:
 
       - name: Get yarn cache directory
         id: yarn-cache-dir
-        run: echo "::set-output name=dir::$(yarn cache dir)"
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
 
       - name: Yarn cache
         uses: actions/cache@v3
@@ -130,7 +130,7 @@ jobs:
         shell: bash
         run: |
           if [ 0 -lt $(find plugins/${{ github.event.repository.name }}/spec -type f -name "*.rb" 2> /dev/null | wc -l) ]; then
-            echo "::set-output name=files_exist::true"
+            echo "files_exist=true" >> $GITHUB_OUTPUT
           fi
 
       - name: Plugin RSpec
@@ -142,7 +142,7 @@ jobs:
         shell: bash
         run: |
           if [ 0 -lt $(find plugins/${{ github.event.repository.name }}/test/javascripts -type f \( -name "*.js" -or -name "*.es6" \) 2> /dev/null | wc -l) ]; then
-            echo "::set-output name=files_exist::true"
+            echo "files_exist=true" >> $GITHUB_OUTPUT
           fi
 
       - name: Plugin QUnit

.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_gem:
-  rubocop-discourse: default.yml
+  rubocop-discourse: stree-compat.yml

.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma

Gemfile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 group :development do
-  gem 'rubocop-discourse'
+  gem "rubocop-discourse"
+  gem "syntax_tree"
 end

Gemfile.lock

@@ -6,6 +6,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    prettier_print (1.2.0)
     rainbow (3.1.1)
     regexp_parser (2.6.0)
     rexml (3.2.5)
@@ -27,13 +28,16 @@ GEM
     rubocop-rspec (2.13.2)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
+    syntax_tree (5.1.0)
+      prettier_print (>= 1.2.0)
     unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rubocop-discourse
+  syntax_tree
 
 BUNDLED WITH
    2.1.4

db/migrate/20191031193436_remove_old_akismet_states.rb

@@ -2,11 +2,10 @@
 
 class RemoveOldAkismetStates < ActiveRecord::Migration[5.2]
   def up
-    DB.exec(<<~SQL, updated_at: 5.minutes.ago
+    DB.exec(<<~SQL, updated_at: 5.minutes.ago)
       DELETE FROM post_custom_fields
       WHERE name = 'AKISMET_STATE' AND value = 'needs_review' AND updated_at < :updated_at
     SQL
-    )
   end
 
   def down

jobs/regular/check_akismet_post.rb

@@ -8,7 +8,7 @@ def execute(args)
       return if Reviewable.exists?(target: post)
 
       DistributedMutex.synchronize("akismet_post_#{post.id}") do
-        if post.custom_fields[DiscourseAkismet::Bouncer::AKISMET_STATE] == 'pending'
+        if post.custom_fields[DiscourseAkismet::Bouncer::AKISMET_STATE] == "pending"
           DiscourseAkismet::PostsBouncer.new.perform_check(Akismet::Client.build_client, post)
         end
       end

jobs/regular/check_akismet_user.rb

@@ -8,7 +8,7 @@ def execute(args)
       return if Reviewable.exists?(target: user)
 
       DistributedMutex.synchronize("akismet_user_#{user.id}") do
-        if user.custom_fields[DiscourseAkismet::Bouncer::AKISMET_STATE] == 'pending'
+        if user.custom_fields[DiscourseAkismet::Bouncer::AKISMET_STATE] == "pending"
           DiscourseAkismet::UsersBouncer.new.perform_check(Akismet::Client.build_client, user)
         end
       end

jobs/regular/confirm_akismet_flagged_posts.rb

@@ -9,9 +9,9 @@ def execute(args)
       performed_by = User.find_by(id: args[:performed_by_id])
       post_ids = Post.with_deleted.where(user_id: args[:user_id]).pluck(:id)
 
-      ReviewableAkismetPost.where(target_id: post_ids, status: Reviewable.statuses[:pending]).find_each do |reviewable|
-        reviewable.perform(performed_by, :confirm_spam)
-      end
+      ReviewableAkismetPost
+        .where(target_id: post_ids, status: Reviewable.statuses[:pending])
+        .find_each { |reviewable| reviewable.perform(performed_by, :confirm_spam) }
     end
   end
 end