Code style for controllers

Author: nygrenh

app/controllers/api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
+
 module Api
 end
-

app/controllers/api/beta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module Beta
   end

app/controllers/api/beta/base_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 class Api::Beta::BaseController < ApplicationController

app/controllers/api/beta/course_id_information_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Api::Beta::CourseIdInformationController < Api::Beta::BaseController
   before_action :doorkeeper_authorize!, scopes: [:public]
 

app/controllers/api/beta/participant_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Api::Beta::ParticipantController < Api::Beta::BaseController
   before_action :doorkeeper_authorize!, scopes: [:public]
 

app/controllers/api/beta/stats_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Api::Beta::StatsController < Api::Beta::BaseController
   before_action :doorkeeper_authorize!, scopes: [:public]
 

app/controllers/api/v8.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V8
   end

app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'version'
 require 'twitter-bootstrap-breadcrumbs'
 
@@ -71,10 +73,10 @@ def check_api_version
         return respond_with_error("Please update the TMC client. API version #{ApiVersion::API_VERSION} required but got #{params[:api_version]}", 404, nil, obsolete_client: true)
       end
 
-      unless params[:client].blank? # Client and client version checks are optional
+      if params[:client].present? # Client and client version checks are optional
         begin
           check_client_version(params[:client], params[:client_version])
-        rescue
+        rescue StandardError
           return respond_with_error($!.message, 404, nil, obsolete_client: true)
         end
       end
@@ -84,17 +86,17 @@ def check_api_version
   def check_client_version(client_name, client_version)
     begin
       client_version = Version.new(client_version) unless client_version.nil?
-    rescue
-      fail "Invalid version string: #{client_version}"
+    rescue StandardError
+      raise "Invalid version string: #{client_version}"
     end
 
     valid_clients = SiteSetting.value('valid_clients')
     if valid_clients.is_a?(Enumerable)
       vc = valid_clients.find { |c| c['name'] == client_name }
-      fail 'Invalid TMC client.' if vc.nil?
+      raise 'Invalid TMC client.' if vc.nil?
 
-      if !client_version.nil? && !vc['min_version'].blank?
-        fail 'Please update the TMC client.' if client_version < Version.new(vc['min_version'])
+      if !client_version.nil? && vc['min_version'].present?
+        raise 'Please update the TMC client.' if client_version < Version.new(vc['min_version'])
       else
         return # without version check
       end
@@ -119,7 +121,7 @@ def set_controller_and_action_name
   end
 
   def unauthorized!(message = nil)
-    raise CanCan::AccessDenied.new(message)
+    raise CanCan::AccessDenied, message
   end
 
   def unauthorize_guest!(message = 'Authentication required')
@@ -140,18 +142,20 @@ def respond_access_denied(msg = 'Access denied')
 
   def respond_with_error(msg, code = 500, exception = nil, extra_json_keys = {})
     respond_to do |format|
-      format.html { render 'shared/respond_with_error',
-                           locals: { message: ERB::Util.html_escape(msg), exception: exception },
-                           layout: true,
-                           status: code }
+      format.html do
+        render 'shared/respond_with_error',
+               locals: { message: ERB::Util.html_escape(msg), exception: exception },
+               layout: true,
+               status: code
+      end
       format.json do
         if code == 401
           # To support older TmcNetBeans versions using faulty http basic auth
           if client_supports_http_basic_auth?
             response.headers['WWW-Authenticate'] = "Basic realm=\"#{msg}\""
             render json: { error: msg }.merge(extra_json_keys), status: code
           else
-            render json: { error: msg }.merge(extra_json_keys), status: 403
+            render json: { error: msg }.merge(extra_json_keys), status: :forbidden
           end
         else
           render json: { error: msg }.merge(extra_json_keys), status: code
@@ -167,8 +171,8 @@ def client_supports_http_basic_auth?
     return true if params[:client].blank?
     client = params[:client]
     client_version = begin
-      Version.new(params['client_version']) unless params['client_version'].blank?
-    rescue
+      Version.new(params['client_version']) if params['client_version'].present?
+    rescue StandardError
     end
     !(client == 'netbeans_plugin' && client_version < Version.new('0.8.0'))
   end
@@ -189,7 +193,7 @@ def params_starting_with(prefix, permitted, options = {})
     permitted = permitted.map { |f| prefix + f } unless permitted == :all
 
     result = Hash[params.select do |k, v|
-      k.start_with?(prefix) && !v.blank? && (permitted == :all || permitted.include?(k))
+      k.start_with?(prefix) && v.present? && (permitted == :all || permitted.include?(k))
     end]
     if options[:remove_prefix]
       result = Hash[result.map { |k, v| [k.sub(/^#{prefix}/, ''), v] }]
@@ -207,7 +211,7 @@ def render_csv(options = {})
     headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
     headers['Expires'] = 'Thu, 01 Dec 1994 16:00:00 GMT'
 
-    if request.env['HTTP_USER_AGENT'] =~ /msie/i
+    if /msie/i.match?(request.env['HTTP_USER_AGENT'])
       headers['Pragma'] = 'public'
       headers['Content-type'] = 'text/plain'
     else

app/controllers/auths_controller.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 # Provides an authentication service.
 #
 # Lets external services such as tmc-comet check whether a given (username, password) or
 # (username, session_id) is valid.
 class AuthsController < ApplicationController
-  OK_MESSAGE = 'OK'.freeze
-  FAIL_MESSAGE = 'FAIL'.freeze
+  OK_MESSAGE = 'OK'
+  FAIL_MESSAGE = 'FAIL'
 
   skip_authorization_check
   skip_before_action :verify_authenticity_token
 
   def show
     if params[:username].present? && params[:session_id].present?
       user = User.find_by(login: params[:username])
-      user = User.find_by('lower(email) = ?', params[:username].downcase) unless user
+      user ||= User.find_by('lower(email) = ?', params[:username].downcase)
       # Allows using oauth2 tokens of the new api for authenticating
       res = if user && Doorkeeper::AccessToken.find_by(resource_owner_id: user.id, token: params[:session_id])
               OK_MESSAGE

app/controllers/breadcrumb_helpers.rb

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 # Helper methods for making breadcrumbs.
 #
 # See https://github.com/weppos/breadcrumbs_on_rails
@@ -15,12 +17,12 @@ def add_course_breadcrumb
   def add_exercise_breadcrumb
     if @exercise
       add_breadcrumb "Exercise #{@exercise.name}", exercise_path(@exercise)
-    elsif @submission && @submission.exercise
+    elsif @submission&.exercise
       add_breadcrumb "Exercise #{@submission.exercise.name}", exercise_path(@submission.exercise)
-    elsif @submission && @submission.exercise_name
+    elsif @submission&.exercise_name
       add_breadcrumb "(deleted exercise #{@submission.exercise_name}"
     else
-      fail 'Neither @exercise nor @submission.exercise_name set'
+      raise 'Neither @exercise nor @submission.exercise_name set'
     end
   end