appsignal-ruby icon indicating copy to clipboard operation
appsignal-ruby copied to clipboard

Rename Minutely module to Probes

Open tombruijn opened this issue 3 years ago • 4 comments

To be consistent with other integrations, rename the Minutely module to the Probes module.

TODO

  • [ ] Rename the Minutely module to `Probes.
  • [ ] Set up a class alias so that Minutely will continue to work.
    • [ ] Deprecate the Minutely module.
    • See this code example of how we've done this before: https://github.com/appsignal/appsignal-ruby/blob/2c12f99bc66ee558d189ae09ea4823b867e2c192/lib/appsignal/hooks.rb#L73-L87
  • [ ] Update the public docs to use the Probes module.

tombruijn avatar Jan 27 '22 12:01 tombruijn

Greetings @tombruijn There's already module Probes created in main branch. Is this issue closed or someone currently working on it? New to contribution, looking forward to it.

AnshulRiyal avatar Jun 01 '22 15:06 AnshulRiyal

Hi @AnshulRiyal, This isn't can't be closed yet. No one is currently working on it. I was thinking of changing the Probes module to a class, then it would work. Let me know if you have other questions :)

diff --git lib/appsignal/probes.rb lib/appsignal/probes.rb
index cdc360ff..4cf5f65f 100644
--- lib/appsignal/probes.rb
+++ lib/appsignal/probes.rb
@@ -1,5 +1,5 @@
 module Appsignal
-  module Probes
+  class Probes
   end
 end
 
diff --git lib/appsignal/probes/mri.rb lib/appsignal/probes/mri.rb
index 51bf4ac8..fcb5c83d 100644
--- lib/appsignal/probes/mri.rb
+++ lib/appsignal/probes/mri.rb
@@ -1,5 +1,5 @@
 module Appsignal
-  module Probes
+  class Probes
     class MriProbe
       # @api private
       def self.dependencies_present?
diff --git lib/appsignal/probes/sidekiq.rb lib/appsignal/probes/sidekiq.rb
index d4d09fde..73cbc3bb 100644
--- lib/appsignal/probes/sidekiq.rb
+++ lib/appsignal/probes/sidekiq.rb
@@ -1,5 +1,5 @@
 module Appsignal
-  module Probes
+  class Probes
     class SidekiqProbe
       # @api private
       attr_reader :config

tombruijn avatar Jun 02 '22 11:06 tombruijn

@tombruijn Please let me know if i can raise the PR for renaming the modules to classes 🙇

AnshulRiyal avatar Jun 10 '22 11:06 AnshulRiyal

@AnshulRiyal you're welcome to send in a PR to fix the issue as described :)

tombruijn avatar Jun 13 '22 06:06 tombruijn