logging and refactoring

Author: niquerio

Gemfile

@@ -7,6 +7,11 @@ gem "shale"
 gem "rexml"
 gem "thor"
 gem "yabeda-prometheus"
+gem "semantic_logger"
+
+gem "milemarker",
+  git: "https://github.com/niquerio/milemarker",
+  branch: "add-logger-to-runtime-dependencies"
 
 group :development, :test do
   gem "pry"

Gemfile.lock

@@ -1,3 +1,11 @@
+GIT
+  remote: https://github.com/niquerio/milemarker
+  revision: ce3cf65886015c08e9467254a0a9670f00abfc4b
+  branch: add-logger-to-runtime-dependencies
+  specs:
+    milemarker (1.0.1)
+      logger
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -16,6 +24,7 @@ GEM
     json (2.15.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
     method_source (1.1.0)
     net-ldap (0.20.0)
       base64
@@ -71,6 +80,8 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
     ruby-next-core (1.1.2)
     ruby-progressbar (1.13.0)
+    semantic_logger (4.17.0)
+      concurrent-ruby (~> 1.0)
     shale (1.2.2)
       bigdecimal
     simplecov (0.22.0)
@@ -111,11 +122,13 @@ DEPENDENCIES
   base64
   byebug
   csv
+  milemarker!
   net-ldap
   pry
   rack-test
   rexml
   rspec
+  semantic_logger
   shale
   simplecov
   standard

lib/patron.rb

@@ -80,8 +80,19 @@ def initialize(data:, name: Name.new(data), current_schedule: CurrentSchedule.ne
     @exclude_reasons = []
   end
 
-  def includable?
-    raise NotImplementedError
+  [
+    "campus_code",
+    "email_type",
+    "exclude_reason",
+    "includable?",
+    "job_description",
+    "statistic_category",
+    "umich_address_type",
+    "user_group"
+  ].each do |method|
+    define_method method do
+      raise NotImplementedError, "#{self.class}.#{method}"
+    end
   end
 
   def uniqname
@@ -108,33 +119,13 @@ def purge_date
     expiry_date.next_year(2)
   end
 
-  def campus_code
-    raise NotImplementedError
-  end
-
-  def user_group
-    raise NotImplementedError
-  end
-
   def status
     "ACTIVE"
   end
 
   def sponsor_reason
   end
 
-  def job_description
-    raise NotImplementedError
-  end
-
-  def statistic_category
-    raise NotImplementedError
-  end
-
-  def umich_address_type
-    raise NotImplementedError
-  end
-
   def umich_address
     raw_address = [@data["umichpostaladdressdata"]&.first, @data["umichhomepostaladdressdata"]&.first].compact.first
     return if raw_address.nil?
@@ -171,10 +162,6 @@ def email_address
     @data["mail"]&.first
   end
 
-  def email_type
-    raise NotImplementedError
-  end
-
   def phone_number
     @data["telephonenumber"]&.first || @data["umichpermanentphone"]&.first
   end

lib/patron/employee.rb

@@ -6,46 +6,49 @@ class Employee < Patron
       "um_dearborn" => "UMDB"
     }
 
-    def includable?
-      !hr_data.nil?
-    end
-
-    def user_group
-      raise NotImplementedError
-    end
-
     def role
       raise NotImplementedError
     end
 
-    def statistic_category
-      raise NotImplementedError
-    end
-
-    def exclude_reason
+    def hr_criteria(hr_item)
       raise NotImplementedError
     end
 
-    def hr_criteria(hr_item)
-      raise NotImplementedError
+    [
+      "statistic_category",
+      "user_group",
+      "exclude_reason"
+    ].each do |method|
+      define_method method do
+        # all of these are NotImplementedError
+        super
+      end
     end
 
     def campus_code
       HR_CAMPUS_MAP[hr_data.campus.downcase]
     end
 
-    def job_description
-      "#{hr_data.deptDescription} (#{hr_data.deptId})"
-    end
-
     def email_type
       "work"
     end
 
+    def exclude_reason
+      raise NotImplementedError
+    end
+
+    def includable?
+      !hr_data.nil?
+    end
+
     def umich_address_type
       "work"
     end
 
+    def job_description
+      "#{hr_data.deptDescription} (#{hr_data.deptId})"
+    end
+
     def hr_attribute
       "umichhr"
     end

lib/patron/regional_student.rb

@@ -15,24 +15,34 @@ class RegionalStudent < Patron::Student
       "PN" => "GR"
     }
 
-    def campus_code
+    def ldap_campus
       raise NotImplementedError
     end
 
-    def ldap_campus
+    def campus_code
       raise NotImplementedError
     end
 
-    def term(acad_period)
-      # 5th caracter in academic period is the index-1 of the semester
-      semester = ["F", "W", "SP", "SU"][acad_period[4].to_i - 1]
+    def exclude_reason
+      "not_registered" unless includable?
+    end
 
-      # the 2 digit year year unless it's fall.
-      year_ish = acad_period[2, 2].to_i
+    def includable?
+      current_term_status.any? do |term|
+        term.registered == "Y" && @current_schedule.includable_term?(term(term.academicPeriod))
+      end
+    end
 
-      year = (semester == "F") ? year_ish - 1 : year_ish
+    def job_description
+      current_term_status.map do |term|
+        term.programDesc
+      end.compact.first
+    end
 
-      "#{semester}#{year}"
+    def statistic_category
+      current_term_status.map do |term|
+        CLASS_STANDING_STATISTIC_CATEGORY_MAP[term.classStanding]
+      end.compact.first
     end
 
     def user_group
@@ -44,50 +54,40 @@ def user_group
       end
     end
 
-    def statistic_category
-      current_term_status.map do |term|
-        CLASS_STANDING_STATISTIC_CATEGORY_MAP[term.classStanding]
-      end.compact.first
-    end
+    def term(acad_period)
+      # 5th caracter in academic period is the index-1 of the semester
+      semester = ["F", "W", "SP", "SU"][acad_period[4].to_i - 1]
 
-    def current_term_status
-      ldap_fields(@data["umich#{ldap_campus}currenttermstatus"] || [])
-    end
+      # the 2 digit year year unless it's fall.
+      year_ish = acad_period[2, 2].to_i
 
-    def job_description
-      current_term_status.map do |term|
-        term.programDesc
-      end.compact.first
-    end
+      year = (semester == "F") ? year_ish - 1 : year_ish
 
-    def includable?
-      current_term_status.any? do |term|
-        term.registered == "Y" && @current_schedule.includable_term?(term(term.academicPeriod))
-      end
+      "#{semester}#{year}"
     end
 
-    def exclude_reason
-      "not_registered" unless includable?
+    def current_term_status
+      ldap_fields(@data["umich#{ldap_campus}currenttermstatus"] || [])
     end
   end
 
   class DearbornStudent < Patron::RegionalStudent
-    def campus_code
-      "UMDB"
-    end
-
     def ldap_campus
       "dbrn"
     end
-  end
 
-  class FlintStudent < Patron::RegionalStudent
     def campus_code
-      "UMFL"
+      "UMDB"
     end
+  end
 
+  class FlintStudent < Patron::RegionalStudent
     def ldap_campus
       "flnt"
     end
+
+    def campus_code
+      "UMFL"
+    end
   end
 end

lib/patron/skipped.rb

@@ -11,13 +11,14 @@ def includable?
       false
     end
 
-    def statistic_category
-    end
-
-    def campus_code
-    end
-
-    def user_group
-    end
+    [
+      "campus_code",
+      "email_type",
+      "exclude_reason",
+      "job_description",
+      "statistic_category",
+      "umich_address_type",
+      "user_group"
+    ].each { |method| define_method(method) {} }
   end
 end

lib/patron/student.rb

@@ -1,7 +1,17 @@
 class Patron
   class Student < Patron
-    def campus_code
-      raise NotImplementedError
+    [
+      "campus_code",
+      "exclude_reason",
+      "includable?",
+      "job_description",
+      "statistic_category",
+      "user_group"
+    ].each do |method|
+      define_method method do
+        # all of these are NotImplementedError
+        super
+      end
     end
 
     def email_type