DEV: Introduce syntax_tree for ruby formatting (#46)

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

@@ -4,4 +4,5 @@ source "https://rubygems.org"
 
 group :development do
   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,6 +28,8 @@ 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
@@ -39,6 +42,7 @@ PLATFORMS
 
 DEPENDENCIES
   rubocop-discourse
+  syntax_tree
 
 BUNDLED WITH
    2.3.10

app/controllers/discourse_teambuild/targets_controller.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_dependency 'teambuild_target'
-require_dependency 'teambuild_target_serializer'
+require_dependency "teambuild_target"
+require_dependency "teambuild_target_serializer"
 
 module DiscourseTeambuild
   class TargetsController < ApplicationController
-
     requires_login
     before_action :ensure_enabled
 
@@ -15,13 +14,16 @@ def index
         targets,
         TeambuildTargetSerializer,
         rest_serializer: true,
-        root: 'teambuild_targets',
-        extras: { groups: Group.all }
+        root: "teambuild_targets",
+        extras: {
+          groups: Group.all,
+        },
       )
     end
 
     def create
-      target = TeambuildTarget.create!(params[:teambuild_target].permit(:name, :target_type_id, :group_id))
+      target =
+        TeambuildTarget.create!(params[:teambuild_target].permit(:name, :target_type_id, :group_id))
       render_serialized(target, TeambuildTargetSerializer, rest_serializer: true)
     end
 
@@ -44,9 +46,15 @@ def swap_position
       raise Discourse::NotFound if target_position.nil? || other_position.nil?
 
       TeambuildTarget.transaction do
-        TeambuildTarget.where(id: params[:target_id], position: target_position).update_all(position: other_position * -1)
-        TeambuildTarget.where(id: params[:other_id], position: other_position).update_all(position: target_position)
-        TeambuildTarget.where(id: params[:target_id], position: other_position * -1).update_all(position: other_position)
+        TeambuildTarget.where(id: params[:target_id], position: target_position).update_all(
+          position: other_position * -1,
+        )
+        TeambuildTarget.where(id: params[:other_id], position: other_position).update_all(
+          position: target_position,
+        )
+        TeambuildTarget.where(id: params[:target_id], position: other_position * -1).update_all(
+          position: other_position,
+        )
       end
       render json: success_json
     end

app/controllers/discourse_teambuild/teambuild_controller.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_dependency 'teambuild_target'
-require_dependency 'teambuild_progress_serializer'
+require_dependency "teambuild_target"
+require_dependency "teambuild_progress_serializer"
 
 module DiscourseTeambuild
   class TeambuildController < ApplicationController
-
     requires_login
     before_action :ensure_can_access
 
@@ -19,21 +18,17 @@ def progress
 
       completed = []
 
-      progress = {
-        user: user,
-        teambuild_targets: TeambuildTarget.all,
-        completed: completed
-      }
+      progress = { user: user, teambuild_targets: TeambuildTarget.all, completed: completed }
 
-      TeambuildTargetUser.where(user_id: user.id).each do |t|
-        completed << "#{t.teambuild_target_id}:#{t.target_user_id}"
-      end
+      TeambuildTargetUser
+        .where(user_id: user.id)
+        .each { |t| completed << "#{t.teambuild_target_id}:#{t.target_user_id}" }
 
       render_serialized(
         progress,
         TeambuildProgressSerializer,
         rest_serializer: true,
-        include_users: true
+        include_users: true,
       )
     end
 
@@ -54,32 +49,37 @@ def scores
         ORDER BY score DESC, u.username
       SQL
 
-      scores = results.map do |r|
-        r.as_json.tap do |result|
-          result['trophy'] = true if r.rank == 1
-          result['me'] = r.id == current_user.id
-          result['avatar_template'] = User.avatar_template(r.username_lower, r.uploaded_avatar_id)
-          result.delete('uploaded_avatar_id')
+      scores =
+        results.map do |r|
+          r.as_json.tap do |result|
+            result["trophy"] = true if r.rank == 1
+            result["me"] = r.id == current_user.id
+            result["avatar_template"] = User.avatar_template(r.username_lower, r.uploaded_avatar_id)
+            result.delete("uploaded_avatar_id")
+          end
         end
-      end
 
       render json: { scores: scores }
     end
 
     def complete
-      TeambuildTargetUser.create!(
-        user_id: current_user.id,
-        teambuild_target_id: params[:target_id].to_i,
-        target_user_id: params[:user_id].to_i
-      ) rescue ActiveRecord::RecordNotUnique
+      begin
+        TeambuildTargetUser.create!(
+          user_id: current_user.id,
+          teambuild_target_id: params[:target_id].to_i,
+          target_user_id: params[:user_id].to_i,
+        )
+      rescue StandardError
+        ActiveRecord::RecordNotUnique
+      end
       render json: success_json
     end
 
     def undo
       TeambuildTargetUser.where(
         user_id: current_user.id,
         teambuild_target_id: params[:target_id].to_i,
-        target_user_id: params[:user_id].to_i
+        target_user_id: params[:user_id].to_i,
       ).delete_all
 
       render json: success_json

app/models/teambuild_target.rb

@@ -9,7 +9,9 @@ class TeambuildTarget < ActiveRecord::Base
   validates_uniqueness_of :name
   default_scope { order(:position) }
 
-  validates :group_id, presence: true, if: -> { target_type_id == TeambuildTarget.target_types[:user_group] }
+  validates :group_id,
+            presence: true,
+            if: -> { target_type_id == TeambuildTarget.target_types[:user_group] }
 
   def self.target_types
     @target_types ||= Enum.new(regular: 1, user_group: 2)
@@ -20,5 +22,4 @@ def self.target_types
   def default_position
     self.position = (TeambuildTarget.maximum(:position) || 0) + 1
   end
-
 end

app/models/teambuild_target_user.rb

@@ -3,5 +3,5 @@
 class TeambuildTargetUser < ActiveRecord::Base
   belongs_to :user
   belongs_to :teambuild_target
-  belongs_to :teambuild_target_user, class_name: 'User'
+  belongs_to :teambuild_target_user, class_name: "User"
 end

app/serializers/teambuild_progress_serializer.rb

@@ -22,9 +22,6 @@ def completed
   end
 
   def total
-    teambuild_targets.inject(0) do |total, t|
-      total + (t.group.present? ? t.group.users.size : 1)
-    end
+    teambuild_targets.inject(0) { |total, t| total + (t.group.present? ? t.group.users.size : 1) }
   end
-
 end

app/serializers/teambuild_target_serializer.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 class TeambuildTargetSerializer < ApplicationSerializer
-  attributes(
-    :id,
-    :target_type_id,
-    :name,
-    :group_id,
-    :group_name,
-    :position
-  )
+  attributes(:id, :target_type_id, :name, :group_id, :group_name, :position)
 
   has_many :users, serializer: BasicUserSerializer
 

config/routes.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 DiscourseTeambuild::Engine.routes.draw do
-  get '/' => 'teambuild#index'
-  get '/scores' => 'teambuild#scores'
-  get '/manage' => 'teambuild#index', constraints: StaffConstraint.new
-  get "/progress" => 'teambuild#progress'
-  get "/progress/:username" => 'teambuild#progress', constraints: { username: RouteFormat.username }
-  put '/complete/:target_id/:user_id' => 'teambuild#complete'
-  delete '/undo/:target_id/:user_id' => 'teambuild#undo'
+  get "/" => "teambuild#index"
+  get "/scores" => "teambuild#scores"
+  get "/manage" => "teambuild#index", :constraints => StaffConstraint.new
+  get "/progress" => "teambuild#progress"
+  get "/progress/:username" => "teambuild#progress",
+      :constraints => {
+        username: RouteFormat.username,
+      }
+  put "/complete/:target_id/:user_id" => "teambuild#complete"
+  delete "/undo/:target_id/:user_id" => "teambuild#undo"
 
   resources :targets, constraints: StaffConstraint.new do
-    put "/swap-position" => 'targets#swap_position'
+    put "/swap-position" => "targets#swap_position"
   end
 end

db/migrate/20191112145431_create_teambuild_target_users.rb

@@ -9,6 +9,9 @@ def change
       t.timestamps null: false
     end
 
-    add_index :teambuild_target_users, [:user_id, :teambuild_target_id, :target_user_id], name: :teambuild_unique_choice, unique: true
+    add_index :teambuild_target_users,
+              %i[user_id teambuild_target_id target_user_id],
+              name: :teambuild_unique_choice,
+              unique: true
   end
 end

lib/discourse_teambuild/engine.rb

@@ -2,7 +2,7 @@
 
 module ::DiscourseTeambuild
   class Engine < ::Rails::Engine
-    engine_name 'discourse_teambuild'
+    engine_name "discourse_teambuild"
     isolate_namespace DiscourseTeambuild
   end
 end

plugin.rb

@@ -7,16 +7,14 @@
 # url: https://github.com/discourse/discourse-teambuild
 # transpile_js: true
 
-load File.expand_path('../lib/discourse_teambuild/engine.rb', __FILE__)
+load File.expand_path("../lib/discourse_teambuild/engine.rb", __FILE__)
 
 enabled_site_setting :teambuild_enabled
 
 register_svg_icon "campground" if respond_to?(:register_svg_icon)
-register_asset 'stylesheets/team-build.scss'
+register_asset "stylesheets/team-build.scss"
 
-Discourse::Application.routes.append do
-  mount ::DiscourseTeambuild::Engine, at: "/team-build"
-end
+Discourse::Application.routes.append { mount ::DiscourseTeambuild::Engine, at: "/team-build" }
 
 after_initialize do
   add_to_class(:guardian, :has_teambuild_access?) do
@@ -25,7 +23,5 @@
     @user.groups.where(name: SiteSetting.teambuild_access_group).exists?
   end
 
-  add_to_serializer(:current_user, :can_access_teambuild) do
-    object.guardian.has_teambuild_access?
-  end
+  add_to_serializer(:current_user, :can_access_teambuild) { object.guardian.has_teambuild_access? }
 end