Documented Worker

docker/backend/src/backend/worker.cr

@@ -1,8 +1,5 @@
 require "mosquito"
 
-module Mosquito::Serializers::Array
-end
-
 module Mosquito::Serializers::Granite
   macro serialize_granite_model(klass)
     {% method_suffix = klass.resolve.stringify.underscore.gsub(/::/, "__").id %}
@@ -21,6 +18,7 @@ end
 require "./worker/*"
 
 module Backend
+  # Worker module
   module Worker
     Mosquito.configure do |settings|
       settings.redis_url = Backend.config.worker.redis_url

docker/backend/src/backend/worker/jobs.cr

@@ -1 +1,5 @@
 require "./jobs/*"
+
+# Job definitions
+module Jobs
+end

docker/backend/src/backend/worker/jobs/send_teachers_registration_email_job.cr

@@ -3,7 +3,9 @@ require "../../db/user"
 module Backend
   module Worker
     module Jobs
+      # Sends all unregistered teachers a polite registration mail to ask if they may input their data
       class SendTeachersRegistrationEmailJob < Mosquito::QueuedJob
+        # :ditto:
         def perform : Nil
           users = Db::User.where(role: Db::UserRole::Teacher.to_s, teacher_id: nil)
           count = users.count.run.as(Int64).to_i

docker/backend/src/backend/worker/run.cr

@@ -2,6 +2,7 @@ module Backend
   module Worker
     extend self
 
+    # Runs the worker
     def run : Nil
       Mosquito::Runner.start
     end

docker/backend/src/backend/worker/service.cr

@@ -1,5 +1,6 @@
 module Backend
   module Worker
+    # Worker service
     SERVICE = ->do
       Log.info { "Starting worker service..." }
       run