DEV: Introduce syntax_tree for ruby formatting (#217)

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.1.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.0.1)
+      prettier_print (>= 1.1.0)
     unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rubocop-discourse
+  syntax_tree
 
 BUNDLED WITH
    2.1.4

app/lib/first_accepted_post_solution_validator.rb

@@ -4,11 +4,9 @@ class FirstAcceptedPostSolutionValidator
   def self.check(post, trust_level:)
     return false if post.archetype != Archetype.default
     return false if !post&.user&.human?
-    return true if trust_level == 'any'
+    return true if trust_level == "any"
 
-    if TrustLevel.compare(post&.user&.trust_level, trust_level.to_i)
-      return false
-    end
+    return false if TrustLevel.compare(post&.user&.trust_level, trust_level.to_i)
 
     if !UserAction.where(user_id: post&.user_id, action_type: UserAction::SOLVED).exists?
       return true

db/migrate/20191209095548_ensures_unique_accepted_answer_post_id.rb

@@ -12,9 +12,9 @@ def change
     SQL
 
     add_index :topic_custom_fields,
-      :topic_id,
-      name: :idx_topic_custom_fields_accepted_answer,
-      unique: true,
-      where: "name = 'accepted_answer_post_id'"
+              :topic_id,
+              name: :idx_topic_custom_fields_accepted_answer,
+              unique: true,
+              where: "name = 'accepted_answer_post_id'"
   end
 end

db/migrate/20221121223417_rename_badges.rb

@@ -18,7 +18,7 @@ class RenameBadges < ActiveRecord::Migration[6.1]
     "sv" => "Kundtjänst",
     "tr_TR" => "Yardım masası",
     "zh_CN" => "帮助台",
-    "zh_TW" => "服務台"
+    "zh_TW" => "服務台",
   }
 
   TECH_SUPPORT_TRANSLATIONS = {
@@ -43,11 +43,12 @@ class RenameBadges < ActiveRecord::Migration[6.1]
     "sv" => "Teknisk support",
     "tr_TR" => "Teknik Destek",
     "zh_CN" => "技术支持",
-    "zh_TW" => "技術支援"
+    "zh_TW" => "技術支援",
   }
 
   def up
-    default_locale = DB.query_single("SELECT value FROM site_settings WHERE name = 'default_locale'").first || "en"
+    default_locale =
+      DB.query_single("SELECT value FROM site_settings WHERE name = 'default_locale'").first || "en"
 
     sql = <<~SQL
       UPDATE badges