faraday-logging-color_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ae45ba949e38fd7d48e52261a5a970a9dbc6364418ec3e9d63390f94ec4f2e5
-  data.tar.gz: 9cc5d52fede52c09b37cfdc5cca4a33f6aa8c00787df2a99307782e7025219a7
+  metadata.gz: 1253416d51b114229d35aa77e5ebd0529f5107919b41629dd292bfa43d23ce8f
+  data.tar.gz: cd4d8864d2ed7daf33dc5e1a2eb1efc5af2a2002c831bcaa741529c36fd1a290
 SHA512:
-  metadata.gz: a7475d9f73f29aab4631bb938cf1d85af1c14d7649c7ffe48157deb4df7c6178eee2e48ae7cb8e4a173eab47f1a0c7d7b94340f7dee579a78751ae21c40d4985
-  data.tar.gz: b4063955edb24f02e2494b1d9a661eaef4ca006de74c42346208e1b8e3a32fefa3a4d9dd3a801721c0afecff85ff35d4bbca1e3b3470d2307e480f95035d25f5
+  metadata.gz: fc451459e650541b1f3f8a1b4f4c4b48df34c4b86d5a10f941bdd8bbe196bc4b713f5e8a0213b463dd91447fde2e7aa6132bb8ba2868873716c44343f088d85c
+  data.tar.gz: 98440c5596cf19c8e346ebd80c2cda383f52618c2dc67ae1f5e06acd48b86dc5fb1ee1c6cb943b9c8086bc6dde527ce5d45ee9335a382e82ef8b0bfe5628906a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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.
+* Gemspec changelog URI update.
+
 ## 0.1.0
 #### 2023-01-11
 * Initial commit.

data/README.md

@@ -1,5 +1,7 @@
 # Faraday::Logging::ColorFormatter
 
+[![Gem Version](https://badge.fury.io/rb/faraday-logging-color_formatter.svg)](https://badge.fury.io/rb/faraday-logging-color_formatter)
+
 Add some color to your Faraday logging output.
 
 Before...
@@ -12,15 +14,13 @@ After...
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add faraday-logging-color_formatter
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install faraday-logging-color_formatter
 
 ## Usage
 
@@ -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/faraday-logging-color_formatter.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Faraday color logging formatter'
   spec.description = 'Add some color to your Faraday logging output.'
-  spec.homepage = 'https://github.com/kobusjoubert/faraday-logging-color_formatter'
+  spec.homepage = 'https://rubygems.org/gems/faraday-logging-color_formatter'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.7.0'
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/kobusjoubert/faraday-logging-color_formatter'
-  spec.metadata['changelog_uri'] = 'https://github.com/kobusjoubert/faraday-logging-color_formatter/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/kobusjoubert/faraday-logging-color_formatter/blob/main/CHANGELOG.md'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.

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.0'
+      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.0
+  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
@@ -127,13 +127,13 @@ files:
 - lib/faraday/logging/color_formatter/formatter.rb
 - lib/faraday/logging/color_formatter/version.rb
 - sig/faraday/logging/color_formatter.rbs
-homepage: https://github.com/kobusjoubert/faraday-logging-color_formatter
+homepage: https://rubygems.org/gems/faraday-logging-color_formatter
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter
+  homepage_uri: https://rubygems.org/gems/faraday-logging-color_formatter
   source_code_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter
-  changelog_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter/CHANGELOG.md
+  changelog_uri: https://github.com/kobusjoubert/faraday-logging-color_formatter/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []