Explicit modules (#425)

* explicit modules

* changelog update

CHANGELOG.md

@@ -1,6 +1,7 @@
 # WaterDrop changelog
 
 ## 2.6.12 (Unreleased)
+- [Fix] Use explicit file modules declarations to avoid potential loading errors.
 - [Change] Remove usage of concurrent ruby.
 
 ## 2.6.11 (2023-10-25)

lib/waterdrop/clients.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # Namespace for all the clients that WaterDrop may use under the hood
+  module Clients
+  end
+end

lib/waterdrop/clients/rdkafka.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module WaterDrop
-  # Namespace for all the clients that WaterDrop may use under the hood
   module Clients
     # Default Rdkafka client.
     # Since we use the ::Rdkafka::Producer under the hood, this is just a module that aligns with

lib/waterdrop/helpers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # Extra internal helper objects
+  module Helpers
+  end
+end

lib/waterdrop/helpers/counter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module WaterDrop
-  # Extra internal helper objects
   module Helpers
     # Atomic counter that we can safely increment and decrement without race conditions
     class Counter

lib/waterdrop/instrumentation.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # WaterDrop instrumentation related module
+  module Instrumentation
+  end
+end

lib/waterdrop/instrumentation/callbacks.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Instrumentation
+    # Namespace for handlers of callbacks emitted by the kafka client lib
+    module Callbacks
+    end
+  end
+end

lib/waterdrop/instrumentation/callbacks/statistics.rb

@@ -2,7 +2,6 @@
 
 module WaterDrop
   module Instrumentation
-    # Namespace for handlers of callbacks emitted by the kafka client lib
     module Callbacks
       # Statistics callback handler
       # @note We decorate the statistics with our own decorator because some of the metrics from

lib/waterdrop/instrumentation/logger_listener.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module WaterDrop
-  # WaterDrop instrumentation related module
   module Instrumentation
     # Default listener that hooks up to our instrumentation and uses its events for logging
     # It can be removed/replaced or anything without any harm to the Waterdrop flow

lib/waterdrop/instrumentation/vendors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Instrumentation
+    # Namespace for vendor specific instrumentation
+    module Vendors
+    end
+  end
+end

lib/waterdrop/instrumentation/vendors/datadog.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Instrumentation
+    module Vendors
+      # Datadog specific instrumentation
+      module Datadog
+      end
+    end
+  end
+end

lib/waterdrop/instrumentation/vendors/datadog/metrics_listener.rb

@@ -2,9 +2,7 @@
 
 module WaterDrop
   module Instrumentation
-    # Namespace for vendor specific instrumentation
     module Vendors
-      # Datadog specific instrumentation
       module Datadog
         # Listener that can be used to subscribe to WaterDrop producer to receive stats via StatsD
         # and/or Datadog

spec/lib/waterdrop_spec.rb

@@ -10,4 +10,17 @@
       it { expect(waterdrop.gem_root.to_path).to eq path }
     end
   end
+
+  describe 'modules files existence' do
+    let(:lib_location) { File.join(WaterDrop.gem_root, 'lib', 'waterdrop', '**/**') }
+    let(:candidates) { Dir[lib_location].to_a }
+
+    it do
+      failed = candidates.select do |path|
+        File.directory?(path) && !File.exist?("#{path}.rb")
+      end
+
+      expect(failed).to eq([])
+    end
+  end
 end