Use zeitwerk to load gem

Author: n-rodriguez

crono.gemspec

@@ -30,5 +30,7 @@ Gem::Specification.new do |s|
   s.bindir      = 'exe'
   s.executables = ['crono']
 
+  s.add_dependency 'optparse'
   s.add_dependency 'rails', '>= 7.0'
+  s.add_dependency 'zeitwerk'
 end

exe/crono

@@ -1,36 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'crono/cli'
-
-def integrate_with_systemd(cli) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-  return unless ENV['NOTIFY_SOCKET']
-
-  Crono.logger.info 'Enabling systemd notification integration'
-
-  cli.config.on(:startup) do
-    Crono.logger.debug 'Emit systemd startup event'
-    Crono::SdNotify.ready
-  end
-
-  cli.config.on(:shutdown) do
-    Crono.logger.debug 'Emit systemd shutdown event'
-    Crono::SdNotify.stopping
-  end
-
-  if Crono::SdNotify.watchdog? # rubocop:disable Style/GuardClause
-    Crono.logger.debug 'Start systemd watchdog'
-    Crono.start_watchdog
-  end
-end
+require_relative '../lib/crono'
 
 # rubocop:disable Style/StderrPuts
 begin
   cli = Crono::CLI.instance
   cli.parse
-
-  integrate_with_systemd(cli)
-
+  cli.integrate_with_systemd
   cli.run
 rescue => e
   raise e if $DEBUG

lib/crono.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+# require ruby dependencies
+require 'optparse'
+require 'socket'
+require 'stringio'
+require 'logger'
+
 # require external dependencies
 require 'active_record'
 require 'active_support/all'
-require 'socket'
+require 'zeitwerk'
 
-# require internal dependencies
-require_relative 'crono/util'
-require_relative 'crono/config'
-require_relative 'crono/cronotab'
-require_relative 'crono/launcher'
-require_relative 'crono/performer_proxy'
-require_relative 'crono/scheduler'
-require_relative 'crono/sd_notify'
-require_relative 'crono/version'
+# load zeitwerk
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore("#{__dir__}/generators")
+  loader.inflector.inflect('cli' => 'CLI')
+  loader.setup
+end
 
 module Crono
   require_relative 'crono/engine' if defined?(Rails)

lib/crono/cli.rb

@@ -2,15 +2,9 @@
 
 Thread.abort_on_exception = true
 
-# require external dependencies
-require 'optparse'
-
-# require ourself
-require 'crono'
-
 module Crono
   # Crono::CLI - The main class for the crono daemon exacutable `bin/crono`
-  class CLI
+  class CLI # rubocop:disable Metrics/ClassLength
     include Singleton
     include Util
 
@@ -65,6 +59,28 @@ def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     end
 
 
+    def integrate_with_systemd # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      return unless ENV['NOTIFY_SOCKET']
+
+      Crono.logger.info 'Enabling systemd notification integration'
+
+      cli.config.on(:startup) do
+        Crono.logger.debug 'Emit systemd startup event'
+        Crono::SdNotify.ready
+      end
+
+      cli.config.on(:shutdown) do
+        Crono.logger.debug 'Emit systemd shutdown event'
+        Crono::SdNotify.stopping
+      end
+
+      if Crono::SdNotify.watchdog? # rubocop:disable Style/GuardClause
+        Crono.logger.debug 'Start systemd watchdog'
+        Crono.start_watchdog
+      end
+    end
+
+
     private
 
 

lib/crono/interval.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# require internal dependencies
-require_relative 'time_of_day'
-
 module Crono
   # Interval describes a period between two specific times of day
   class Interval

lib/crono/job.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-# require external dependencies
-require 'stringio'
-require 'logger'
-
 module Crono
   # Crono::Job represents a Crono job
   class Job # rubocop:disable Metrics/ClassLength

lib/crono/performer_proxy.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-# require internal dependencies
-require_relative 'job'
-require_relative 'period'
-
 module Crono
   # Crono::PerformerProxy is a proxy used in cronotab.rb semantic
   class PerformerProxy

lib/crono/period.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# require internal dependencies
-require_relative 'interval'
-
 module Crono
   # Period describe frequency of jobs
   class Period

lib/crono/sd_notify.rb

@@ -25,8 +25,6 @@
 # The only changes made was "rehoming" it within the Crono module to avoid
 # namespace collisions and applying standard's code formatting style.
 
-require 'socket'
-
 # SdNotify is a pure-Ruby implementation of sd_notify(3). It can be used to
 # notify systemd about state changes. Methods of this package are no-op on
 # non-systemd systems (eg. Darwin).

spec/crono/assets/bad_cronotab.rb

@@ -2,12 +2,6 @@
 
 # This is an example of a bad cronotab for tests
 
-class TestJob
-  def perform
-    puts 'Test!'
-  end
-end
-
 # This is an error, because you can use `on` options with
 # a period less than 7 days.