Merge pull request #96 from n-rodriguez/wip/improve

Improve gem loading

CHANGELOG.md

@@ -3,7 +3,10 @@
 ## [3.0.1] - Unreleased
 
 ### Changed or Fixed or Added
-- Your contribution here.
+
+### Changed
+- Move dev dependencies to Gemfile
+- Use zeitwerk to load gem
 
 [3.0.1]: https://github.com/aserafin/grape_logging/compare/v3.0.0...master
 

Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grape_logging.gemspec
 gemspec
+
+gem 'rake', '~> 13.3'
+gem 'rspec', '~> 3.5'
+
+# This is pinned to an exact version otherwise we can't know which rules
+# are in play at any given time in different environments.
+gem 'rubocop', '1.77.0'

grape_logging.gemspec

@@ -22,11 +22,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'grape', '>= 2.4.0'
   spec.add_dependency 'rack'
-
-  spec.add_development_dependency 'rake', '~> 13.3'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-
-  # This is pinned to an exact version otherwise we can't know which rules
-  # are in play at any given time in different environments.
-  spec.add_development_dependency 'rubocop', '1.77.0'
+  spec.add_dependency 'zeitwerk'
 end

lib/grape_logging.rb

@@ -1,17 +1,12 @@
-require 'grape_logging/multi_io'
-require 'grape_logging/version'
-require 'grape_logging/formatters/default'
-require 'grape_logging/formatters/json'
-require 'grape_logging/formatters/lograge'
-require 'grape_logging/formatters/logstash'
-require 'grape_logging/formatters/rails'
-require 'grape_logging/loggers/base'
-require 'grape_logging/loggers/response'
-require 'grape_logging/loggers/filter_parameters'
-require 'grape_logging/loggers/client_env'
-require 'grape_logging/loggers/request_headers'
-require 'grape_logging/reporters/active_support_reporter'
-require 'grape_logging/reporters/logger_reporter'
-require 'grape_logging/timings'
-require 'grape_logging/middleware/request_logger'
-require 'grape_logging/util/parameter_filter'
+require 'grape'
+require 'rack/utils'
+require 'zeitwerk'
+
+# load zeitwerk
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.inflector.inflect 'multi_io' => 'MultiIO'
+  loader.setup
+end
+
+module GrapeLogging
+end

lib/grape_logging/formatters/rails.rb

@@ -1,5 +1,3 @@
-require 'rack/utils'
-
 module GrapeLogging
   module Formatters
     class Rails

lib/grape_logging/loggers/filter_parameters.rb

@@ -16,7 +16,7 @@ module GrapeLogging
       private
 
       def parameter_filter
-        @parameter_filter ||= ParameterFilter.new(@replacement, @filter_parameters)
+        @parameter_filter ||= GrapeLogging::Util::ParameterFilter.new(@replacement, @filter_parameters)
       end
 
       def safe_parameters(request)

lib/grape_logging/middleware/request_logger.rb

@@ -1,5 +1,3 @@
-require 'grape'
-
 module GrapeLogging
   module Middleware
     class RequestLogger < Grape::Middleware::Base

lib/grape_logging/reporters/active_support_reporter.rb

@@ -1,4 +1,5 @@
-module Reporters
+module GrapeLogging
+  module Reporters
     class ActiveSupportReporter
       def initialize(instrumentation_key)
         @instrumentation_key = instrumentation_key
@@ -8,4 +9,5 @@ module Reporters
         ActiveSupport::Notifications.instrument @instrumentation_key, params
       end
     end
+  end
 end

lib/grape_logging/reporters/logger_reporter.rb

@@ -1,4 +1,5 @@
-module Reporters
+module GrapeLogging
+  module Reporters
     class LoggerReporter
       def initialize(logger, formatter, log_level)
         @logger = logger.clone || Logger.new(STDOUT)
@@ -10,4 +11,5 @@ module Reporters
         @logger.send(@log_level, params)
       end
     end
+  end
 end

lib/grape_logging/util/parameter_filter.rb

@@ -1,4 +1,6 @@
-if defined?(Rails.application)
+module GrapeLogging
+  module Util
+    if defined?(Rails.application)
       if Gem::Version.new(Rails.version) < Gem::Version.new('6.0.0')
         class ParameterFilter < ActionDispatch::Http::ParameterFilter
           def initialize(_replacement, filter_parameters)
@@ -14,7 +16,7 @@ if defined?(Rails.application)
           end
         end
       end
-else
+    else
       #
       # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/http/parameter_filter.rb
       # we could depend on Rails specifically, but that would us way to hefty!
@@ -99,4 +101,6 @@ else
           end
         end
       end
+    end
+  end
 end