faraday-logging-color_formatter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4fb2e825f76429ca21a14707249222982943bfb5d9c29d2ccfeb43fe719a918
-  data.tar.gz: 53d0dea6b30dba614ecd1d2babd6fdccd338d39032d3823d59fd96eaa8abd595
+  metadata.gz: 1253416d51b114229d35aa77e5ebd0529f5107919b41629dd292bfa43d23ce8f
+  data.tar.gz: cd4d8864d2ed7daf33dc5e1a2eb1efc5af2a2002c831bcaa741529c36fd1a290
 SHA512:
-  metadata.gz: aab013179d7416163d496c558a084fa9712efe5d4208daffd639b05fef1564342c29e7409ff3e4a301828877615ffe833b54e429cee2674009165055761d08a4
-  data.tar.gz: d3d58febcbba7a709d0ee95f087bd6fef65a7c49d600307760290b6ecb2cb37553b46fbca35c34b4d33deae62fe22a073bb7e9963c8c2504d93c7682b072d9c4
+  metadata.gz: fc451459e650541b1f3f8a1b4f4c4b48df34c4b86d5a10f941bdd8bbe196bc4b713f5e8a0213b463dd91447fde2e7aa6132bb8ba2868873716c44343f088d85c
+  data.tar.gz: 98440c5596cf19c8e346ebd80c2cda383f52618c2dc67ae1f5e06acd48b86dc5fb1ee1c6cb943b9c8086bc6dde527ce5d45ee9335a382e82ef8b0bfe5628906a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.2.0
+#### 2023-01-19
+* Allow to change log message indentation and request response messages using a new `prefix` option to the logger middleware.
+
 ## 0.1.1
 #### 2023-01-17
 * Gemspec homepage URI update to point to RubyGems.

data/README.md

@@ -34,6 +34,12 @@ And then add the `Faraday::Logging::ColorFormatter` formatter to your logger mid
       conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter
     end
 
+If you want to replace the default `HTTP Request` and `HTTP Response` prefixes or adjust the indentation, pass in a `prefix` hash with your own values.
+
+    connection = Faraday.new(url: 'http://httpbingo.org') do |conn|
+      conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter, prefix: { request: 'request', response: 'response', indent: 2 }
+    end
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests and `rake rubocop` to run the linters. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/faraday/logging/color_formatter/formatter.rb

@@ -8,11 +8,17 @@ module Faraday
       class Formatter < Faraday::Logging::Formatter
         ANSI_COLORS = { red: "\e[31m", green: "\e[32m", yellow: "\e[33m", blue: "\e[34m", magenta: "\e[35m", cyan: "\e[36m", reset: "\e[0m" }.freeze
 
+        def initialize(logger:, options:)
+          @prefix = { request: 'HTTP Request', response: 'HTTP Response', indent: 0 }.merge(options.delete(:prefix) || {})
+
+          super
+        end
+
         def request(env)
-          http_request_term = in_color(:blue) { 'HTTP Request' }
+          http_request_term = prefix[:request].nil? || prefix[:request].strip.empty? ? nil : in_color(:blue) { "#{prefix[:request]}  " }
           http_request_log  = in_color(request_log_color(env.method)) { "#{env.method.upcase} #{apply_filters(env.url.to_s)}" }
 
-          request_log = proc { "#{http_request_term}  #{http_request_log}" }
+          request_log = proc { "#{' ' * prefix[:indent]}#{http_request_term}#{http_request_log}" }
           public_send(log_level, &request_log)
 
           log_headers(nil, env.request_headers) if log_headers?(:request)
@@ -20,10 +26,10 @@ module Faraday
         end
 
         def response(env)
-          http_response_term = in_color(:blue) { 'HTTP Response' }
+          http_response_term = prefix[:response].nil? || prefix[:response].strip.empty? ? nil : in_color(:blue) { "#{prefix[:response]}  " }
           http_response_log  = in_color(response_log_color(env.status)) { "Status #{env.status}" }
 
-          status = proc { "#{http_response_term}  #{http_response_log}" }
+          status = proc { "#{' ' * prefix[:indent]}#{http_response_term}#{http_response_log}" }
           public_send(log_level, &status)
 
           log_headers(nil, env.response_headers) if log_headers?(:response)
@@ -32,6 +38,8 @@ module Faraday
 
         private
 
+        attr_reader :prefix
+
         def in_color(color)
           "#{ANSI_COLORS[color]}#{yield}#{ANSI_COLORS[:reset]}"
         end

data/lib/faraday/logging/color_formatter/version.rb

@@ -3,7 +3,7 @@
 module Faraday
   module Logging
     module ColorFormatter
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-logging-color_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday