dry-monitor 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85738f938dcede38fc7ce87e0370b28d6007a4bc623add02b36266c92436ddc4
-  data.tar.gz: ff09a85ea8d421a6af32c711d2c84a62164f868462b2676cb5b644af6b5a4dcb
+  metadata.gz: e5f22e78dd92f5dd4177daec60c9d8bab1583df9478f4741780706c354607041
+  data.tar.gz: fe37f4deef05a9eb250d1afe730dffe4f803e22252a4b1ebef54a254f725a1dd
 SHA512:
-  metadata.gz: 57421c674b4a278f86ec556e84f09778400e30767cce50f5190dc0ddc1403f9c9cbb570fb45b7a481f2aecce325c52cc67f6ba0bdec55a8d58c92354845a1f3e
-  data.tar.gz: 3cd559b457cab3d252875a9464b9cc24d96e486f56f4ae31c50e1003aa81d7d63306ee77daa33116bf780c70a138f3c6b092b3796de9ed5e02bde7c5bc822c58
+  metadata.gz: 733d07a4274411c35a687052b46f007c8a678bf417b7f284fb06d9725f62827190717bf8611881fa10183c34620f795d33f0aa201a9ce98cb58e1203c2c6b3ce
+  data.tar.gz: 9a121f35e111f90de89fbb30429963127dff82bb2ae9ed4de1fbaeefb1874f7d573c52de0b0e7f5bb173ae7d6919c31d35101f7779713e51af980e4ec3c4f89a

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.6.0 2022-07-10
+
+
+### Added
+
+- Zeitwerk integration :tada: so that you can simply do `require "dry/monitor"` and other constants will be auto-loaded on demand (via #47) (@gmcgibbon)
+
+
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-monitor/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2021-09-12
+
+
+### Changed
+
+- [internal] Upgraded to new `setting` API provided in dry-configurable 0.13.0 (@timriley in #43)
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-monitor/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2021-04-09
+
+
+### Fixed
+
+- Compatibility with MRI 3.0 (@alex-damian-negru)
+
+
+[Compare v0.3.2...v0.4.0](https://github.com/dry-rb/dry-monitor/compare/v0.3.2...v0.4.0)
+
 ## 0.3.2 2020-04-09
 
 
@@ -8,7 +39,6 @@
 ### Changed
 
 - Performance improvements (@davydovanton)
-- Dependency on `dry-events` was bumped to `~> 0.5` (@davydovanton)
 
 [Compare v0.3.1...v0.3.2](https://github.com/dry-rb/dry-monitor/compare/v0.3.1...v0.3.2)
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-monitor
 [actions]: https://github.com/dry-rb/dry-monitor/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-monitor
@@ -10,19 +11,19 @@
 [![CI Status](https://github.com/dry-rb/dry-monitor/workflows/ci/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/984c4274e56d423a818e7a1bf5e963d0)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/984c4274e56d423a818e7a1bf5e963d0)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-monitor.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-monitor.svg?branch=main)][inchpages]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-monitor)
+* [User documentation](https://dry-rb.org/gems/dry-monitor)
 * [API documentation](http://rubydoc.info/gems/dry-monitor)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
-* jruby >= `9.2`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-monitor.gemspec

@@ -1,37 +1,38 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/monitor/version'
+require "dry/monitor/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-monitor'
+  spec.name          = "dry-monitor"
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Monitor::VERSION.dup
 
   spec.summary       = "Monitoring and instrumentation APIs"
   spec.description   = spec.summary
-  spec.homepage      = 'https://dry-rb.org/gems/dry-monitor'
+  spec.homepage      = "https://dry-rb.org/gems/dry-monitor"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-monitor.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-monitor/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-monitor'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-monitor/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-monitor/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-monitor"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-monitor/issues"
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-configurable", "~> 0.5"
-  spec.add_runtime_dependency "dry-core", "~> 0.4"
-  spec.add_runtime_dependency "dry-equalizer", "~> 0.2"
+  spec.add_runtime_dependency "dry-configurable", "~> 0.13", ">= 0.13.0"
+  spec.add_runtime_dependency "dry-core", "~> 0.5", ">= 0.5"
   spec.add_runtime_dependency "dry-events", "~> 0.2"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.5"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dry/monitor/notifications.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "dry/events/publisher"
-require "dry/monitor/constants"
 
 module Dry
   module Monitor
@@ -22,9 +21,7 @@ module Dry
     class Notifications
       include Events::Publisher["Dry::Monitor::Notifications"]
 
-      attr_reader :id
-
-      attr_reader :clock
+      attr_reader :id, :clock
 
       def initialize(id)
         @id = id
@@ -39,8 +36,8 @@ module Dry
         instrument(event_id, payload)
       end
 
-      def instrument(event_id, payload = EMPTY_HASH)
-        result, time = @clock.measure { yield } if block_given?
+      def instrument(event_id, payload = EMPTY_HASH, &block)
+        result, time = @clock.measure(&block) if block_given?
 
         process(event_id, payload) do |event, listener|
           if time

data/lib/dry/monitor/rack/logger.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
-require "dry/monitor/rack/middleware"
 
 module Dry
   module Monitor
@@ -9,7 +8,7 @@ module Dry
       class Logger
         extend Dry::Configurable
 
-        setting :filtered_params, %w[_csrf password]
+        setting :filtered_params, default: %w[_csrf password]
 
         REQUEST_METHOD = "REQUEST_METHOD"
         PATH_INFO = "PATH_INFO"
@@ -21,9 +20,7 @@ module Dry
         QUERY_MSG = %(  Query parameters )
         FILTERED = "[FILTERED]"
 
-        attr_reader :logger
-
-        attr_reader :config
+        attr_reader :logger, :config
 
         def initialize(logger, config = self.class.config)
           @logger = logger
@@ -31,17 +28,9 @@ module Dry
         end
 
         def attach(rack_monitor)
-          rack_monitor.on(:start) do |env:|
-            log_start_request(env)
-          end
-
-          rack_monitor.on(:stop) do |env:, status:, time:|
-            log_stop_request(env, status, time)
-          end
-
-          rack_monitor.on(:error) do |event|
-            log_exception(event[:exception])
-          end
+          rack_monitor.on(:start) { |params| log_start_request(params[:env]) }
+          rack_monitor.on(:stop) { |params| log_stop_request(**params) }
+          rack_monitor.on(:error) { |event| log_exception(event[:exception]) }
         end
 
         def log_exception(err)
@@ -59,11 +48,11 @@ module Dry
           log_request_params(request)
         end
 
-        def log_stop_request(request, status, time)
+        def log_stop_request(env:, status:, time:)
           logger.info STOP_MSG % [
-            request[REQUEST_METHOD],
-            request[PATH_INFO],
-            request[REMOTE_ADDR],
+            env[REQUEST_METHOD],
+            env[PATH_INFO],
+            env[REMOTE_ADDR],
             time,
             status
           ]

data/lib/dry/monitor/rack/middleware.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "dry/monitor/notifications"
-
 module Dry
   module Monitor
     module Rack
@@ -14,9 +12,7 @@ module Dry
         Notifications.register_event(REQUEST_STOP)
         Notifications.register_event(REQUEST_ERROR)
 
-        attr_reader :app
-
-        attr_reader :notifications
+        attr_reader :app, :notifications
 
         def initialize(*args)
           @notifications, @app = *args

data/lib/dry/monitor/sql/colorizers/rouge.rb

@@ -15,8 +15,7 @@ module Dry
     module SQL
       module Colorizers
         class Rouge
-          attr_reader :formatter
-          attr_reader :lexer
+          attr_reader :formatter, :lexer
 
           def initialize(theme)
             @formatter = ::Rouge::Formatters::Terminal256.new(theme || ::Rouge::Themes::Gruvbox.new)

data/lib/dry/monitor/sql/logger.rb

@@ -2,7 +2,6 @@
 
 require "dry-configurable"
 require "dry/core/extensions"
-require "dry/monitor/notifications"
 
 module Dry
   module Monitor
@@ -14,8 +13,6 @@ module Dry
         extend Dry::Configurable
 
         register_extension(:default_colorizer) do
-          require_relative "./colorizers/default"
-
           module DefaultColorizer
             def colorizer
               @colorizer ||= Colorizers::Default.new(config.theme)
@@ -26,8 +23,6 @@ module Dry
         end
 
         register_extension(:rouge_colorizer) do
-          require_relative "./colorizers/rouge"
-
           module RougeColorizer
             def colorizer
               @colorizer ||= Colorizers::Rouge.new(config.theme)
@@ -37,12 +32,10 @@ module Dry
           Logger.include(RougeColorizer)
         end
 
-        setting :theme, nil
-        setting :message_template, %(  Loaded %s in %sms %s)
+        setting :theme
+        setting :message_template, default: %(  Loaded %s in %sms %s)
 
-        attr_reader :config
-        attr_reader :logger
-        attr_reader :template
+        attr_reader :config, :logger, :template
 
         load_extensions(:default_colorizer)
 
@@ -53,12 +46,10 @@ module Dry
         end
 
         def subscribe(notifications)
-          notifications.subscribe(:sql) do |time:, name:, query:|
-            log_query(time, name, query)
-          end
+          notifications.subscribe(:sql) { |params| log_query(**params) }
         end
 
-        def log_query(time, name, query)
+        def log_query(time:, name:, query:)
           logger.info template % [name.inspect, time, colorizer.call(query)]
         end
       end

data/lib/dry/monitor/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Monitor
-    VERSION = "0.3.2"
+    VERSION = "0.6.0"
   end
 end

data/lib/dry/monitor.rb

@@ -1,20 +1,37 @@
 # frozen_string_literal: true
 
-require "dry/monitor/logger"
-require "dry/monitor/notifications"
 require "dry/core/extensions"
+require "dry/core/constants"
+require "zeitwerk"
 
 module Dry
   module Monitor
     extend Dry::Core::Extensions
+    include Dry::Core::Constants
 
     register_extension(:rack) do
       require "rack/utils"
-      require "dry/monitor/rack/logger"
+
+      Dry::Monitor::Rack::Logger
     end
 
     register_extension(:sql) do
-      require "dry/monitor/sql/logger"
+      Dry::Monitor::SQL::Logger
+    end
+
+    class << self
+      def loader
+        @loader ||= Zeitwerk::Loader.new.tap do |loader|
+          root = File.expand_path("..", __dir__)
+          loader.tag = "dry-monitor"
+          loader.inflector = Zeitwerk::GemInflector.new("#{root}/dry-monitor.rb")
+          loader.push_dir(root)
+          loader.ignore("#{root}/dry-monitor.rb")
+          loader.inflector.inflect "sql" => "SQL"
+        end
+      end
     end
   end
 end
+
+Dry::Monitor.loader.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-monitor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -16,30 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: dry-equalizer
+  name: dry-events
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -53,19 +65,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: dry-events
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +153,6 @@ files:
 - dry-monitor.gemspec
 - lib/dry-monitor.rb
 - lib/dry/monitor.rb
-- lib/dry/monitor/constants.rb
 - lib/dry/monitor/logger.rb
 - lib/dry/monitor/notifications.rb
 - lib/dry/monitor/rack/logger.rb
@@ -155,7 +166,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-monitor/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-monitor/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-monitor
   bug_tracker_uri: https://github.com/dry-rb/dry-monitor/issues
 post_install_message: 
@@ -166,14 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Monitoring and instrumentation APIs

data/lib/dry/monitor/constants.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/core/constants"
-
-module Dry
-  module Monitor
-    include Dry::Core::Constants
-  end
-end