Add rubocop settings and run safe autocorrect

.rubocop.yml

@@ -1,8 +1,11 @@
+require: rubocop-rails
 AllCops:
   Include:
     - '**/Rakefile'
     - '**/config.ru'
     - 'spec/factories/*.rb'
+    - 'app/controllers/*.rb'
+    - 'app/models/*.rb'
   Exclude:
     - 'assessmentConfig/**/*'
     - 'attachments/**/*'
@@ -16,7 +19,7 @@ AllCops:
 Rails:
   Enabled: true
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   # To make it possible to copy or click on URIs in the code, we allow lines
   # contaning a URI to be longer than Max.
@@ -25,10 +28,6 @@ Metrics/LineLength:
     - http
     - https
 
-Metrics/MethodLength:
-  CountComments: false  # count full line comments?
-  Max: 20
-
 # Indent private/protected/public as deep as method definitions
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
@@ -41,3 +40,172 @@ Style/StringLiterals:
   SupportedStyles:
     - single_quotes
     - double_quotes
+
+# Frozen string literals will introduce breaking changes to existing ruby files.
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/NumericPredicate:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/SymbolArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics:
+  Enabled: false

Rakefile

@@ -2,6 +2,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path("../config/application", __FILE__)
+require File.expand_path("config/application", __dir__)
 
 Autolab3::Application.load_tasks

app/controllers/admins_controller.rb

@@ -2,29 +2,29 @@
 # this controller contains methods for system-wise
 # admin functionality
 class AdminsController < ApplicationController
-  rescue_from ActionView::MissingTemplate do |exception|
+  rescue_from ActionView::MissingTemplate do |_exception|
     redirect_to("/home/error_404")
   end
 
   skip_before_action :set_course
 
   action_auth_level :show, :administrator
-  def show
-  end
+  def show; end
 
   action_auth_level :email_instructors, :administrator
   def email_instructors
     @cuds = CourseUserDatum.select(:user_id).distinct.joins(:course).joins(:user)
-            .where(instructor: true)
-            .order("users.email ASC")
+                           .where(instructor: true)
+                           .order("users.email ASC")
 
     return unless request.post?
 
     @email = CourseMailer.system_announcement(
       params[:from],
       make_dlist(@cuds),
       params[:subject],
-      params[:body])
+      params[:body]
+    )
     @email.deliver
   end
 end

app/controllers/annotations_controller.rb

@@ -8,9 +8,9 @@ class AnnotationsController < ApplicationController
   before_action :set_assessment
   before_action :set_submission
   before_action :set_annotation, except: [:create]
-    rescue_from ActionView::MissingTemplate do |exception|
-      redirect_to("/home/error_404")
-    end
+  rescue_from ActionView::MissingTemplate do |_exception|
+    redirect_to("/home/error_404")
+  end
 
   respond_to :json
 
@@ -21,7 +21,7 @@ def create
 
     ActiveRecord::Base.transaction do
       annotation.save
-      annotation.update_non_autograded_score()
+      annotation.update_non_autograded_score
     end
 
     respond_with(@course, @assessment, @submission, annotation)
@@ -32,7 +32,7 @@ def create
   def update
     ActiveRecord::Base.transaction do
       @annotation.update(annotation_params)
-      @annotation.update_non_autograded_score()
+      @annotation.update_non_autograded_score
     end
 
     respond_with(@course, @assessment, @submission, @annotation) do |format|
@@ -45,7 +45,7 @@ def update
   def destroy
     ActiveRecord::Base.transaction do
       @annotation.destroy
-      @annotation.update_non_autograded_score()
+      @annotation.update_non_autograded_score
     end
 
     head :no_content
@@ -58,7 +58,7 @@ def annotation_params
     params[:annotation].delete(:created_at)
     params[:annotation].delete(:updated_at)
     params.require(:annotation).permit(:filename, :position, :line, :submitted_by,
-                                       :comment, :value, :problem_id,:submission_id, :coordinate)
+                                       :comment, :value, :problem_id, :submission_id, :coordinate)
   end
 
   def set_annotation

app/controllers/announcements_controller.rb

@@ -1,19 +1,19 @@
 # Extend the Rails ApplicationController to define some RESTful endpoints for
 # dealing with Announcements.
 class AnnouncementsController < ApplicationController
-  before_action :set_announcement, except: [:index, :new, :create]
+  before_action :set_announcement, except: %i[index new create]
 
-    rescue_from ActionView::MissingTemplate do |exception|
-      redirect_to("/home/error_404")
+  rescue_from ActionView::MissingTemplate do |_exception|
+    redirect_to("/home/error_404")
   end
 
   action_auth_level :index, :instructor
   def index
-    if @cud.user.administrator?
-      @announcements = Announcement.where("course_id=? or system", @course.id)
-    else
-      @announcements = @course.announcements
-    end
+    @announcements = if @cud.user.administrator?
+                       Announcement.where("course_id=? or system", @course.id)
+                     else
+                       @course.announcements
+                     end
   end
 
   action_auth_level :new, :instructor
@@ -35,8 +35,7 @@ def create
   end
 
   action_auth_level :edit, :instructor
-  def edit
-  end
+  def edit; end
 
   action_auth_level :update, :instructor
   def update
@@ -63,9 +62,9 @@ def destroy
 private
 
   def set_announcement
-    @announcement = @course.announcements.find_by_id(params[:id])
-    if @announcement.nil?   # May be system announcement / from another course
-      @announcement = Announcement.find_by_id(params[:id])
+    @announcement = @course.announcements.find_by(id: params[:id])
+    if @announcement.nil? # May be system announcement / from another course
+      @announcement = Announcement.find_by(id: params[:id])
       if @announcement.nil?
         flash[:error] = "Announcement not found."
         redirect_to(action: :index) && return
@@ -76,6 +75,7 @@ def set_announcement
     end
     # Sanity check
     return unless @announcement.system && !@cud.user.administrator?
+
     flash[:error] = "You don't have permission to access system announcements."
     redirect_to(action: :index) && return
   end