grape_logging 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06aaf18280f4233ee64c9ec952860f1db9e6119ea832efc5a29d93601b73f0ce
-  data.tar.gz: bab90314228b6b136cb6b726328bcf06753ca808c6dd49d42b548356672f5e8f
+  metadata.gz: 812a02e3c1b1f55003d060c5d31887be91cd73115cdb366c36c4e29c8e5507a0
+  data.tar.gz: 929dec60825b2aa8ec50c349506f383cd58a01d987bc8eb8b02990c225279e34
 SHA512:
-  metadata.gz: 81ad7895d92bfdbc1a581d2d618875419c5dc5eed78172d6b4785cf4ec62b466e634eab831a28f39b799c126d430643a5bf438d14ba31bba4e93bba368790e57
-  data.tar.gz: d917cfb3390d1b205133ee84d16b86b5b9904e3a8a16fdc05d987057a7fefb06df005a6e5b65b708c15546b973bfa8ebf64472ac9d471cc1c42b4f3dfea0d445
+  metadata.gz: 3043a583d5b227f2fb474a1e036ad0f27589dafa1a11d428b0e93c3441e6cc6204001bfe26dbd6f925ea2fe2a6a681ff3e6c2853979e458f19c43ece1696e0ec
+  data.tar.gz: 9ea303723891185798f23494e53c542c73ceee318f4fa72c073277e263e72e1f1dac885729126eda13c3aee89893488d88b4173eff877b2ff30998d77c944435

data/.github/workflows/ci.yml

@@ -9,26 +9,26 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
+        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4", "4.0"]
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
       - name: Install dependencies
-        run: bundle install
+        run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake spec
   lint:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.4"
+          ruby-version: "4.0"
           bundler-cache: true
       - name: Install dependencies
         run: bundle install

data/.rubocop.yml

@@ -2,9 +2,12 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 3.0
 
 Metrics/BlockLength:
   CountAsOne: [array, hash, heredoc, method_call]
+  Exclude:
+    - 'spec/**/*'
 
 Metrics/ClassLength:
   CountAsOne: [array, hash, heredoc, method_call]

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [3.0.1] - 2026-09-11
+
+### Added
+- [#98](https://github.com/aserafin/grape_logging/pull/98) Adapt to new Grape::Exceptions::ErrorResponse throwable for Grape 3.3.0 support - [@leoarnold](https://github.com/leoarnold).
+
+### Changed
+- [#96](https://github.com/aserafin/grape_logging/pull/96) Move dev dependencies to Gemfile and use zeitwerk to load files - [@n-rodriguez](https://github.com/n-rodriguez).
+
+[3.0.1]: https://github.com/aserafin/grape_logging/compare/v3.0.0...v3.0.1
+
 ## [3.0.0] - 2025-08-07
 
 ### Changed

data/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'

data/README.md

@@ -209,8 +209,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-For maintainers releasing a new version, please see [Releasing.md](Releasing.md).
+For maintainers releasing a new version, please see [RELEASING.md](RELEASING.md).
 
 ## Contributing
 
-See [Contributing.md](Contributing.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md).

data/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

data/lib/grape_logging/formatters/rails.rb

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

data/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)
@@ -31,7 +31,7 @@ module GrapeLogging
       def clean_parameters(parameters)
         original_encoding_map = build_encoding_map(parameters)
         params = transform_key_encoding(parameters, Hash.new { |h, _| [Encoding::ASCII_8BIT, h] })
-        cleaned_params = parameter_filter.filter(params).reject { |key, _value| @exceptions.include?(key) }
+        cleaned_params = parameter_filter.filter(params).except(*@exceptions)
         transform_key_encoding(cleaned_params, original_encoding_map)
       end
 

data/lib/grape_logging/middleware/request_logger.rb

@@ -1,5 +1,3 @@
-require 'grape'
-
 module GrapeLogging
   module Middleware
     class RequestLogger < Grape::Middleware::Base
@@ -72,7 +70,9 @@ module GrapeLogging
         # when no error occurs.
         if error
           # Call with error & response
-          after(error[:status], error[:message])
+          status, message = status_and_message(error)
+
+          after(status, message)
 
           # Throw again
           throw(:error, error)
@@ -150,6 +150,17 @@ module GrapeLogging
           logger.send(method_name) if logger.respond_to?(method_name)
         end
       end
+
+      def status_and_message(error)
+        case Gem::Version.new(Grape::VERSION)
+        when Gem::Requirement.new('>= 3.3.0')
+          # `error` is a `Grape::Exceptions::ErrorResponse`
+          [error.status, error.message]
+        else
+          # `error` is a `Hash`
+          [error[:status], error[:message]]
+        end
+      end
     end
   end
 end

data/lib/grape_logging/reporters/active_support_reporter.rb

@@ -1,11 +1,13 @@
-module Reporters
-  class ActiveSupportReporter
-    def initialize(instrumentation_key)
-      @instrumentation_key = instrumentation_key
-    end
+module GrapeLogging
+  module Reporters
+    class ActiveSupportReporter
+      def initialize(instrumentation_key)
+        @instrumentation_key = instrumentation_key
+      end
 
-    def perform(params)
-      ActiveSupport::Notifications.instrument @instrumentation_key, params
+      def perform(params)
+        ActiveSupport::Notifications.instrument @instrumentation_key, params
+      end
     end
   end
 end

data/lib/grape_logging/reporters/logger_reporter.rb

@@ -1,13 +1,15 @@
-module Reporters
-  class LoggerReporter
-    def initialize(logger, formatter, log_level)
-      @logger = logger.clone || Logger.new(STDOUT)
-      @log_level = log_level || :info
-      @logger.formatter = formatter || @logger.formatter || GrapeLogging::Formatters::Default.new if @logger.respond_to?(:formatter=)
-    end
+module GrapeLogging
+  module Reporters
+    class LoggerReporter
+      def initialize(logger, formatter, log_level)
+        @logger = logger.clone || Logger.new(STDOUT)
+        @log_level = log_level || :info
+        @logger.formatter = formatter || @logger.formatter || GrapeLogging::Formatters::Default.new if @logger.respond_to?(:formatter=)
+      end
 
-    def perform(params)
-      @logger.send(@log_level, params)
+      def perform(params)
+        @logger.send(@log_level, params)
+      end
     end
   end
 end

data/lib/grape_logging/util/parameter_filter.rb

@@ -1,101 +1,105 @@
-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)
-        super(filter_parameters)
-      end
-    end
-  else
-    require 'active_support/parameter_filter'
+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)
+            super(filter_parameters)
+          end
+        end
+      else
+        require 'active_support/parameter_filter'
 
-    class ParameterFilter < ActiveSupport::ParameterFilter
-      def initialize(_replacement, filter_parameters)
-        super(filter_parameters)
+        class ParameterFilter < ActiveSupport::ParameterFilter
+          def initialize(_replacement, filter_parameters)
+            super(filter_parameters)
+          end
+        end
       end
-    end
-  end
-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!
-  #
-  class ParameterFilter
-    def initialize(replacement, filters = [])
-      @replacement = replacement
-      @filters = filters
-    end
-
-    def filter(params)
-      compiled_filter.call(params)
-    end
+    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!
+      #
+      class ParameterFilter
+        def initialize(replacement, filters = [])
+          @replacement = replacement
+          @filters = filters
+        end
 
-    private
+        def filter(params)
+          compiled_filter.call(params)
+        end
 
-    def compiled_filter
-      @compiled_filter ||= CompiledFilter.compile(@replacement, @filters)
-    end
+        private
 
-    class CompiledFilter # :nodoc:
-      def self.compile(replacement, filters)
-        return ->(params) { params.dup } if filters.empty?
-
-        strings = []
-        regexps = []
-        blocks = []
-
-        filters.each do |item|
-          case item
-          when Proc
-            blocks << item
-          when Regexp
-            regexps << item
-          else
-            strings << Regexp.escape(item.to_s)
-          end
+        def compiled_filter
+          @compiled_filter ||= CompiledFilter.compile(@replacement, @filters)
         end
 
-        deep_regexps, regexps = regexps.partition { |r| r.to_s.include?('\\.'.freeze) }
-        deep_strings, strings = strings.partition { |s| s.include?('\\.'.freeze) }
+        class CompiledFilter # :nodoc:
+          def self.compile(replacement, filters)
+            return ->(params) { params.dup } if filters.empty?
 
-        regexps << Regexp.new(strings.join('|'.freeze), true) unless strings.empty?
-        deep_regexps << Regexp.new(deep_strings.join('|'.freeze), true) unless deep_strings.empty?
+            strings = []
+            regexps = []
+            blocks = []
 
-        new replacement, regexps, deep_regexps, blocks
-      end
+            filters.each do |item|
+              case item
+              when Proc
+                blocks << item
+              when Regexp
+                regexps << item
+              else
+                strings << Regexp.escape(item.to_s)
+              end
+            end
 
-      attr_reader :regexps, :deep_regexps, :blocks
+            deep_regexps, regexps = regexps.partition { |r| r.to_s.include?('\\.'.freeze) }
+            deep_strings, strings = strings.partition { |s| s.include?('\\.'.freeze) }
 
-      def initialize(replacement, regexps, deep_regexps, blocks)
-        @replacement = replacement
-        @regexps = regexps
-        @deep_regexps = deep_regexps.any? ? deep_regexps : nil
-        @blocks = blocks
-      end
+            regexps << Regexp.new(strings.join('|'.freeze), true) unless strings.empty?
+            deep_regexps << Regexp.new(deep_strings.join('|'.freeze), true) unless deep_strings.empty?
 
-      def call(original_params, parents = [])
-        filtered_params = {}
-
-        original_params.each do |key, value|
-          parents.push(key) if deep_regexps
-          if regexps.any? { |r| key =~ r }
-            value = @replacement
-          elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| joined =~ r }
-            value = @replacement
-          elsif value.is_a?(Hash)
-            value = call(value, parents)
-          elsif value.is_a?(Array)
-            value = value.map { |v| v.is_a?(Hash) ? call(v, parents) : v }
-          elsif blocks.any?
-            key = key.dup if key.duplicable?
-            value = value.dup if value.duplicable?
-            blocks.each { |b| b.call(key, value) }
+            new replacement, regexps, deep_regexps, blocks
           end
-          parents.pop if deep_regexps
 
-          filtered_params[key] = value
-        end
+          attr_reader :regexps, :deep_regexps, :blocks
+
+          def initialize(replacement, regexps, deep_regexps, blocks)
+            @replacement = replacement
+            @regexps = regexps
+            @deep_regexps = deep_regexps.any? ? deep_regexps : nil
+            @blocks = blocks
+          end
 
-        filtered_params
+          def call(original_params, parents = [])
+            filtered_params = {}
+
+            original_params.each do |key, value|
+              parents.push(key) if deep_regexps
+              if regexps.any? { |r| key =~ r }
+                value = @replacement
+              elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| joined =~ r }
+                value = @replacement
+              elsif value.is_a?(Hash)
+                value = call(value, parents)
+              elsif value.is_a?(Array)
+                value = value.map { |v| v.is_a?(Hash) ? call(v, parents) : v }
+              elsif blocks.any?
+                key = key.dup if key.duplicable?
+                value = value.dup if value.duplicable?
+                blocks.each { |b| b.call(key, value) }
+              end
+              parents.pop if deep_regexps
+
+              filtered_params[key] = value
+            end
+
+            filtered_params
+          end
+        end
       end
     end
   end

data/lib/grape_logging/version.rb

@@ -1,3 +1,3 @@
 module GrapeLogging
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_logging
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - aserafin
@@ -39,47 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.77.0
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.77.0
+        version: '0'
 description: This gem provides simple request logging for Grape with just few lines
   of code you have to put in your project! In return you will get response codes,
   paths, parameters and more!
@@ -140,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Out of the box request logging for Grape!
 test_files: []