COMPATIBILITY: update linting

Author: angusmcleod

.rubocop.yml

@@ -1,5 +1,10 @@
 inherit_gem:
-  rubocop-discourse: default.yml
+  rubocop-discourse: stree-compat.yml
+
+AllCops:
+  Exclude:
+    - 'gems/**/*'
+    - 'vendor/**/*'
 
 RSpec/ContextWording:
   Enabled: false

.streerc

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

Gemfile

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

Gemfile.lock

@@ -28,6 +28,7 @@ GEM
     parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
+    prettier_print (1.2.1)
     racc (1.8.1)
     rack (3.1.7)
     rainbow (3.1.1)
@@ -68,6 +69,8 @@ GEM
       rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
@@ -79,6 +82,7 @@ PLATFORMS
 DEPENDENCIES
   racc
   rubocop-discourse
+  syntax_tree
 
 BUNDLED WITH
    2.5.18

app/controllers/custom_wizard/admin/api.rb

@@ -3,21 +3,28 @@ class CustomWizard::AdminApiController < CustomWizard::AdminController
   skip_before_action :check_xhr, only: [:redirect]
 
   def list
-    serializer = ActiveModel::ArraySerializer.new(CustomWizard::Api.list,
-      each_serializer: CustomWizard::BasicApiSerializer
-    )
+    serializer =
+      ActiveModel::ArraySerializer.new(
+        CustomWizard::Api.list,
+        each_serializer: CustomWizard::BasicApiSerializer,
+      )
     render json: MultiJson.dump(serializer)
   end
 
   def find
-    render_serialized(CustomWizard::Api.get(api_params[:name]), CustomWizard::ApiSerializer, root: false)
+    render_serialized(
+      CustomWizard::Api.get(api_params[:name]),
+      CustomWizard::ApiSerializer,
+      root: false,
+    )
   end
 
   def save
     current = CustomWizard::Api.get(api_params[:name])
 
     if api_params[:new] && current
-      raise Discourse::InvalidParameters, "An API with that name already exists: '#{current.title || current.name}'"
+      raise Discourse::InvalidParameters,
+            "An API with that name already exists: '#{current.title || current.name}'"
     end
 
     unless subscription.includes?(:api, :all)
@@ -28,28 +35,28 @@ def save
       CustomWizard::Api.set(api_params[:name], title: api_params[:title])
 
       if auth_data.present?
-        auth_data['auth_params'] = auth_data['auth_params'] || []
+        auth_data["auth_params"] = auth_data["auth_params"] || []
         CustomWizard::Api::Authorization.set(api_params[:name], auth_data)
       end
 
       if api_params[:endpoints].is_a? String
         begin
           endpoints = JSON.parse(api_params[:endpoints])
-          endpoints.each do |endpoint|
-            CustomWizard::Api::Endpoint.set(api_params[:name], endpoint)
-          end
+          endpoints.each { |endpoint| CustomWizard::Api::Endpoint.set(api_params[:name], endpoint) }
         rescue => e
           puts e
         end
       end
     end
 
-    render json: success_json.merge(
-      api: CustomWizard::ApiSerializer.new(
-        CustomWizard::Api.get(api_params[:name]),
-        root: false
-      )
-    )
+    render json:
+             success_json.merge(
+               api:
+                 CustomWizard::ApiSerializer.new(
+                   CustomWizard::Api.get(api_params[:name]),
+                   root: false,
+                 ),
+             )
   end
 
   def remove
@@ -67,14 +74,16 @@ def authorize
     result = CustomWizard::Api::Authorization.get_token(api_params[:name])
 
     if result.instance_variable_defined?(:@error)
-      render json: failed_json.merge(message: result['error_description'] || result['error'])
+      render json: failed_json.merge(message: result["error_description"] || result["error"])
     else
-      render json: success_json.merge(
-        api: CustomWizard::ApiSerializer.new(
-          CustomWizard::Api.get(api_params[:name]),
-          root: false
-        )
-      )
+      render json:
+               success_json.merge(
+                 api:
+                   CustomWizard::ApiSerializer.new(
+                     CustomWizard::Api.get(api_params[:name]),
+                     root: false,
+                   ),
+               )
     end
   end
 
@@ -90,47 +99,51 @@ def redirect
     CustomWizard::Api::Authorization.set(params[:name], code: params[:code])
     CustomWizard::Api::Authorization.get_token(params[:name])
 
-    redirect_to path('/admin/wizards/apis/' + params[:name])
+    redirect_to path("/admin/wizards/apis/" + params[:name])
   end
 
   private
 
   def api_params
     params.require(:name)
 
-    data = params.permit(
-      :name,
-      :title,
-      :auth_type,
-      :auth_url,
-      :token_url,
-      :client_id,
-      :client_secret,
-      :username,
-      :password,
-      :auth_params,
-      :endpoints,
-      :new
-    ).to_h
+    data =
+      params.permit(
+        :name,
+        :title,
+        :auth_type,
+        :auth_url,
+        :token_url,
+        :client_id,
+        :client_secret,
+        :username,
+        :password,
+        :auth_params,
+        :endpoints,
+        :new,
+      ).to_h
 
     data[:name] = data[:name].underscore
 
     @api_params ||= data
   end
 
   def auth_data
-    auth_data = api_params.slice(
-      :auth_type,
-      :auth_url,
-      :token_url,
-      :client_id,
-      :client_secret,
-      :username,
-      :password,
-      :auth_params
-    )
+    auth_data =
+      api_params.slice(
+        :auth_type,
+        :auth_url,
+        :token_url,
+        :client_id,
+        :client_secret,
+        :username,
+        :password,
+        :auth_params,
+      )
 
-    auth_data[:auth_params] = JSON.parse(auth_data[:auth_params]) if auth_data[:auth_params].present?
+    auth_data[:auth_params] = JSON.parse(auth_data[:auth_params]) if auth_data[
+      :auth_params
+    ].present?
 
     @auth_data ||= auth_data
   end

app/controllers/custom_wizard/admin/custom_fields.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 class CustomWizard::AdminCustomFieldsController < CustomWizard::AdminController
   def index
-    render_json_dump(
-      custom_fields: custom_field_list
-    )
+    render_json_dump(custom_fields: custom_field_list)
   end
 
   def update
@@ -12,23 +10,24 @@ def update
     field_data = {}
 
     if saved_field = CustomWizard::CustomField.find(field_params[:id].to_i)
-      CustomWizard::CustomField::ATTRS.each do |attr|
-        field_data[attr] = saved_field.send(attr)
-      end
+      CustomWizard::CustomField::ATTRS.each { |attr| field_data[attr] = saved_field.send(attr) }
       field_id = saved_field.id
     end
 
-    CustomWizard::CustomField::ATTRS.each do |attr|
-      field_data[attr] = field_params[attr]
-    end
+    CustomWizard::CustomField::ATTRS.each { |attr| field_data[attr] = field_params[attr] }
 
     field = CustomWizard::CustomField.new(field_id, field_data)
 
     PluginStoreRow.transaction do
       unless field.save
-        field_errors = field.errors.any? ?
-          field.errors.full_messages.join("\n\n") :
-          I18n.t("wizard.custom_field.error.save_default", name: field.name)
+        field_errors =
+          (
+            if field.errors.any?
+              field.errors.full_messages.join("\n\n")
+            else
+              I18n.t("wizard.custom_field.error.save_default", name: field.name)
+            end
+          )
         errors << field_errors
         raise ActiveRecord::Rollback.new
       end
@@ -54,13 +53,6 @@ def destroy
   private
 
   def field_params
-    params.required(:custom_field)
-      .permit(
-        :id,
-        :name,
-        :klass,
-        :type,
-        serializers: []
-      )
+    params.required(:custom_field).permit(:id, :name, :klass, :type, serializers: [])
   end
 end

app/controllers/custom_wizard/admin/logs.rb

@@ -3,42 +3,45 @@ class CustomWizard::AdminLogsController < CustomWizard::AdminController
   before_action :find_wizard, except: [:index]
 
   def index
-    render json: ActiveModel::ArraySerializer.new(
-      CustomWizard::Wizard.list(current_user),
-      each_serializer: CustomWizard::BasicWizardSerializer
-    )
+    render json:
+             ActiveModel::ArraySerializer.new(
+               CustomWizard::Wizard.list(current_user),
+               each_serializer: CustomWizard::BasicWizardSerializer,
+             )
   end
 
   def show
     render_json_dump(
       wizard: CustomWizard::BasicWizardSerializer.new(@wizard, root: false),
-      logs: ActiveModel::ArraySerializer.new(
-        log_list.logs,
-        each_serializer: CustomWizard::LogSerializer
-      ),
-      total: log_list.total
+      logs:
+        ActiveModel::ArraySerializer.new(
+          log_list.logs,
+          each_serializer: CustomWizard::LogSerializer,
+        ),
+      total: log_list.total,
     )
   end
 
   protected
 
   def log_list
-    @log_list ||= begin
-      list = CustomWizard::Log.list(params[:page].to_i, params[:limit].to_i, params[:wizard_id])
+    @log_list ||=
+      begin
+        list = CustomWizard::Log.list(params[:page].to_i, params[:limit].to_i, params[:wizard_id])
 
-      if list.logs.any? && (usernames = list.logs.map(&:username)).present?
-        user_map = User.where(username: usernames)
-          .reduce({}) do |result, user|
-            result[user.username] = user
-            result
-          end
+        if list.logs.any? && (usernames = list.logs.map(&:username)).present?
+          user_map =
+            User
+              .where(username: usernames)
+              .reduce({}) do |result, user|
+                result[user.username] = user
+                result
+              end
 
-        list.logs.each do |log_item|
-          log_item.user = user_map[log_item.username]
+          list.logs.each { |log_item| log_item.user = user_map[log_item.username] }
         end
-      end
 
-      list
-    end
+        list
+      end
   end
 end