Code style for lib

nygrenh · nygrenh · commit 267f2683eb22 · 2018-09-28T20:47:37.000+03:00
diff --git a/lib/background_course_refresher.rb b/lib/background_course_refresher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class BackgroundCourseRefresher
   # Called periodically by script/background_daemon, does full refresh on courses which
   # still need full initial refresh.
diff --git a/lib/background_task_registry.rb b/lib/background_task_registry.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BackgroundTaskRegistry
   def self.register(cls)
     classes << cls
diff --git a/lib/course_info.rb b/lib/course_info.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'natsort'
 
 # Builds /courses/:id.json
@@ -45,7 +47,7 @@ def course_data_core_api(course)
                     exercises.where(unlock_spec: nil)
                   else
                     exercises.where(["unlock_spec IS NULL OR exercises.name IN (#{@unlocked_exercises.map { |_| '?' }.join(', ')})", *@unlocked_exercises])
-      end.select { |e| e._fast_visible? }
+      end.select(&:_fast_visible?)
     end
 
     exercises = exercises.to_a.natsort_by(&:name)
diff --git a/lib/course_list.rb b/lib/course_list.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Builds /courses.json
 class CourseList
   def initialize(user, helpers)
diff --git a/lib/course_refresher.rb b/lib/course_refresher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'find'
 require 'pathname'
 require 'recursive_yaml_reader'
@@ -97,44 +99,42 @@ def refresh_course(course, options)
       # I prefer suggestion 1.
 
       Course.transaction(requires_new: true) do
-        begin
-          @course = Course.lock(true).find(course.id)
-
-          @old_cache_path = @course.cache_path
-
-          @course.increment_cache_version                         unless options[:no_directory_changes] # causes @course.*_path to return paths in the new cache
-
-          FileUtils.rm_rf(@course.cache_path)                     unless options[:no_directory_changes]
-          FileUtils.mkdir_p(@course.cache_path)                   unless options[:no_directory_changes]
-
-          measure_and_log :update_or_clone_repository             unless options[:no_directory_changes]
-          measure_and_log :check_directory_names                  unless options[:no_directory_changes]
-          measure_and_log :update_course_options
-          measure_and_log :add_records_for_new_exercises
-          measure_and_log :delete_records_for_removed_exercises
-          measure_and_log :update_exercise_options
-          measure_and_log :set_has_tests_flags
-          measure_and_log :update_available_points, options[:no_directory_changes] unless options[:no_background_operations]
-          measure_and_log :make_solutions                         unless options[:no_directory_changes]
-          measure_and_log :make_stubs                             unless options[:no_directory_changes]
-          measure_and_log :checksum_stubs
-          measure_and_log :make_zips_of_stubs                     unless options[:no_directory_changes]
-          measure_and_log :make_zips_of_solutions                 unless options[:no_directory_changes]
-          measure_and_log :set_permissions                        unless options[:no_directory_changes]
-          measure_and_log :invalidate_unlocks
-
-          @course.course_template.save!
-          @course.refreshed_at = Time.now
-          @course.save!
-          @course.exercises.each &:save!
-
-          CourseRefresher.simulate_failure! if ::Rails.env.test? && CourseRefresher.respond_to?('simulate_failure!')
-        rescue StandardError, ScriptError # Some YAML parsers throw ScriptError on syntax errors
-          @report.errors << $!.message + "\n" + $!.backtrace.join("\n")
-          # Delete the new cache we were working on
-          FileUtils.rm_rf(@course.cache_path) unless options[:no_directory_changes]
-          raise ActiveRecord::Rollback
-        end
+        @course = Course.lock(true).find(course.id)
+
+        @old_cache_path = @course.cache_path
+
+        @course.increment_cache_version                         unless options[:no_directory_changes] # causes @course.*_path to return paths in the new cache
+
+        FileUtils.rm_rf(@course.cache_path)                     unless options[:no_directory_changes]
+        FileUtils.mkdir_p(@course.cache_path)                   unless options[:no_directory_changes]
+
+        measure_and_log :update_or_clone_repository             unless options[:no_directory_changes]
+        measure_and_log :check_directory_names                  unless options[:no_directory_changes]
+        measure_and_log :update_course_options
+        measure_and_log :add_records_for_new_exercises
+        measure_and_log :delete_records_for_removed_exercises
+        measure_and_log :update_exercise_options
+        measure_and_log :set_has_tests_flags
+        measure_and_log :update_available_points, options[:no_directory_changes] unless options[:no_background_operations]
+        measure_and_log :make_solutions                         unless options[:no_directory_changes]
+        measure_and_log :make_stubs                             unless options[:no_directory_changes]
+        measure_and_log :checksum_stubs
+        measure_and_log :make_zips_of_stubs                     unless options[:no_directory_changes]
+        measure_and_log :make_zips_of_solutions                 unless options[:no_directory_changes]
+        measure_and_log :set_permissions                        unless options[:no_directory_changes]
+        measure_and_log :invalidate_unlocks
+
+        @course.course_template.save!
+        @course.refreshed_at = Time.now
+        @course.save!
+        @course.exercises.each &:save!
+
+        CourseRefresher.simulate_failure! if ::Rails.env.test? && CourseRefresher.respond_to?('simulate_failure!')
+      rescue StandardError, ScriptError # Some YAML parsers throw ScriptError on syntax errors
+        @report.errors << $!.message + "\n" + $!.backtrace.join("\n")
+        # Delete the new cache we were working on
+        FileUtils.rm_rf(@course.cache_path) unless options[:no_directory_changes]
+        raise ActiveRecord::Rollback
       end
 
       if @report.errors.empty? && !options[:no_directory_changes]
@@ -236,24 +236,22 @@ def update_exercise_options
       reader = RecursiveYamlReader.new
       @review_points = {}
       @course.exercises.each do |e|
-        begin
-          metadata = reader.read_settings(root_dir: @course.clone_path,
-                                          target_dir: File.join(@course.clone_path, e.relative_path),
-                                          file_name: 'metadata.yml',
-                                          defaults: Exercise.default_options,
-                                          file_preprocessor: proc do |opts|
-                                            merge_course_specific_suboptions(opts)
-                                          end)
-          @review_points[e.name] = parse_review_points(metadata['review_points'])
-
-          e.options = metadata
-
-          e.disabled! if e.new_record? && e.course.refreshed?
-
-          e.save!
-        rescue SyntaxError
-          @report.errors << "Failed to parse metadata: #{$!}"
-        end
+        metadata = reader.read_settings(root_dir: @course.clone_path,
+                                        target_dir: File.join(@course.clone_path, e.relative_path),
+                                        file_name: 'metadata.yml',
+                                        defaults: Exercise.default_options,
+                                        file_preprocessor: proc do |opts|
+                                          merge_course_specific_suboptions(opts)
+                                        end)
+        @review_points[e.name] = parse_review_points(metadata['review_points'])
+
+        e.options = metadata
+
+        e.disabled! if e.new_record? && e.course.refreshed?
+
+        e.save!
+      rescue SyntaxError
+        @report.errors << "Failed to parse metadata: #{$!}"
       end
     end
 
diff --git a/lib/course_refresher/block_comment_based_filter.rb b/lib/course_refresher/block_comment_based_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 class CourseRefresher
diff --git a/lib/course_refresher/css_filter.rb b/lib/course_refresher/css_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/block_comment_based_filter'
 
diff --git a/lib/course_refresher/exercise_file_filter.rb b/lib/course_refresher/exercise_file_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'fileutils'
 require 'mimemagic'
diff --git a/lib/course_refresher/java_filter.rb b/lib/course_refresher/java_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/line_comment_based_filter'
 
diff --git a/lib/course_refresher/js_filter.rb b/lib/course_refresher/js_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/line_comment_based_filter'
 
diff --git a/lib/course_refresher/line_comment_based_filter.rb b/lib/course_refresher/line_comment_based_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 class CourseRefresher
diff --git a/lib/course_refresher/makefile_c_filter.rb b/lib/course_refresher/makefile_c_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/line_comment_based_filter'
 
diff --git a/lib/course_refresher/properties_filter.rb b/lib/course_refresher/properties_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/line_comment_based_filter'
 
diff --git a/lib/course_refresher/xml_filter.rb b/lib/course_refresher/xml_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'course_refresher/block_comment_based_filter'
 
diff --git a/lib/date_and_time_utils.rb b/lib/date_and_time_utils.rb
@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 module DateAndTimeUtils
   def self.to_time(input, options = {})
     options = {
@@ -29,9 +31,9 @@ def self.parse_date_or_time(input)
 
     result = nil
     begin
-      if s =~ /^\d+-\d+-\d+$/
+      if /^\d+-\d+-\d+$/.match?(s)
         result = Date.parse(s)
-      elsif s =~ /^\d+-\d+-\d+\s+\d+:\d+(:?:\d+(:?\.\d+)?)?(:?\s+\S+)?$/
+      elsif /^\d+-\d+-\d+\s+\d+:\d+(:?:\d+(:?\.\d+)?)?(:?\s+\S+)?$/.match?(s)
         result = Time.zone.parse(s)
       end
     rescue StandardError
diff --git a/lib/doc_gen.rb b/lib/doc_gen.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'erb'
 require 'system_commands'
diff --git a/lib/doc_gen/shell_session.rb b/lib/doc_gen/shell_session.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi' # for escapeHTML
 
 class DocGen
diff --git a/lib/exercise_completion_status_generator.rb b/lib/exercise_completion_status_generator.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Generates a progress percentage [0..100] telling how much a user has completed of a course's exercises.
 class ExerciseCompletionStatusGenerator
   def self.completion_status(user, course)
diff --git a/lib/file_tree_hasher.rb b/lib/file_tree_hasher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'find'
 require 'digest/sha2'
 
@@ -18,13 +20,11 @@ def self.hash_file_tree(root_path)
 
     digest = Digest::SHA2.new
     paths.each do |path|
-      begin
-        raise "Find didn't work as expected." unless path.start_with?(root_path)
-        relative_path = path[(root_path.length + 1)...path.length]
-        digest << relative_path << File.read(path)
-      rescue StandardError
-        raise "Failed to hash file #{path}: #{$!.message}"
-      end
+      raise "Find didn't work as expected." unless path.start_with?(root_path)
+      relative_path = path[(root_path.length + 1)...path.length]
+      digest << relative_path << File.read(path)
+    rescue StandardError
+      raise "Failed to hash file #{path}: #{$!.message}"
     end
     digest.hexdigest
   end
diff --git a/lib/gdocs_export.rb b/lib/gdocs_export.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'google_spreadsheet'
 
 module GDocsExport
diff --git a/lib/maven_cache_seeder.rb b/lib/maven_cache_seeder.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'find'
 
diff --git a/lib/maven_pom_file.rb b/lib/maven_pom_file.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xmlsimple'
 
 class MavenPomFile
diff --git a/lib/maven_project.rb b/lib/maven_project.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'system_commands'
 require 'maven_pom_file'
diff --git a/lib/natsort.rb b/lib/natsort.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'natcmp'
 
 # Adds natsort methods to Ruby arrays and similar collections.
diff --git a/lib/portable_csv.rb b/lib/portable_csv.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'csv'
 begin
   require 'fastercsv'
diff --git a/lib/recursive_yaml_reader.rb b/lib/recursive_yaml_reader.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Reads yaml files such that settings in child dirs are
 # merged into settings from parent dirs.
 # Usage:
diff --git a/lib/rspec_remote_formatter.rb b/lib/rspec_remote_formatter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 
diff --git a/lib/ruby_init_script.rb b/lib/ruby_init_script.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'system_commands'
 require 'erb'
diff --git a/lib/safe_unzipper.rb b/lib/safe_unzipper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'system_commands'
 
 class SafeUnzipper
diff --git a/lib/sandbox_results_saver.rb b/lib/sandbox_results_saver.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Saves results from a remote sandbox to the database.
 #
 # See also: TestRunGrader
diff --git a/lib/student_submission_migrator.rb b/lib/student_submission_migrator.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Used to migrate students between similar courses. This requires for the GIT repos to be checkout to same version to ensure safe transition
 class StudentSubmissionMigrator
   class CannotRefreshError < RuntimeError; end
diff --git a/lib/submission_list.rb b/lib/submission_list.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SubmissionList
   def initialize(user, helpers)
     @user = user
diff --git a/lib/submission_packager.rb b/lib/submission_packager.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 require 'fileutils'
 require 'pathname'
diff --git a/lib/submission_packager/java_maven.rb b/lib/submission_packager/java_maven.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SubmissionPackager
   class JavaMaven < SubmissionPackager
     private
diff --git a/lib/submission_packager/java_simple.rb b/lib/submission_packager/java_simple.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SubmissionPackager
   class JavaSimple < SubmissionPackager
     private
diff --git a/lib/submission_packager/langs.rb b/lib/submission_packager/langs.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SubmissionPackager
   class Langs < SubmissionPackager
     private
diff --git a/lib/submission_packager/makefile_c.rb b/lib/submission_packager/makefile_c.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SubmissionPackager
   class MakefileC < SubmissionPackager
     private
diff --git a/lib/submission_processor.rb b/lib/submission_processor.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Attempts to send submissions for processing to a free tmc-sandbox.
 # Also called by the reprocessor background task to attempt reprocessing if
 # the sandbox was previously unavailable.
diff --git a/lib/system_commands.rb b/lib/system_commands.rb
diff --git a/lib/tailoring.rb b/lib/tailoring.rb
diff --git a/lib/tasks/comet.rake b/lib/tasks/comet.rake
diff --git a/lib/tasks/dev.rake b/lib/tasks/dev.rake
diff --git a/lib/tasks/diagrams.rake b/lib/tasks/diagrams.rake
diff --git a/lib/tasks/init.rake b/lib/tasks/init.rake
diff --git a/lib/tasks/submodules.rake b/lib/tasks/submodules.rake
diff --git a/lib/tasks/test-scanner-cache.rake b/lib/tasks/test-scanner-cache.rake
diff --git a/lib/tasks/travis.rake b/lib/tasks/travis.rake
diff --git a/lib/tasks/usermanual.rake b/lib/tasks/usermanual.rake
diff --git a/lib/test_scanner.rb b/lib/test_scanner.rb
diff --git a/lib/tmc_checkstyle_runner.rb b/lib/tmc_checkstyle_runner.rb
diff --git a/lib/tmc_comet.rb b/lib/tmc_comet.rb
diff --git a/lib/tmc_dir_utils.rb b/lib/tmc_dir_utils.rb
diff --git a/lib/tmc_langs.rb b/lib/tmc_langs.rb
diff --git a/lib/twitter-bootstrap-breadcrumbs.rb b/lib/twitter-bootstrap-breadcrumbs.rb
diff --git a/lib/version.rb b/lib/version.rb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`class BackgroundCourseRefresher`
`2`	`4`	`# Called periodically by script/background_daemon, does full refresh on courses which`
`3`	`5`	`# still need full initial refresh.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module BackgroundTaskRegistry`
`2`	`4`	`def self.register(cls)`
`3`	`5`	`classes << cls`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`# Builds /courses.json`
`2`	`4`	`class CourseList`
`3`	`5`	`def initialize(user, helpers)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'pathname'`
`2`	`4`
`3`	`5`	`class CourseRefresher`