console-adapter-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2a82903d05ac6520b80c7be32d31966b0722e9baa52b257dd713217d58f8e83
+  data.tar.gz: 2174b91d8eb53600298fbd84e508d383ce1728ace3f7bbf0e8ded6db918b6011
+SHA512:
+  metadata.gz: 577bba47591db55d1b3239a9c54295f14e5b774097b589cf1bf31c3200ed7238925bdb3101b573bc25fdb80c4a94c5a8b6482fa4bb145f396b7a50f67304ae5b
+  data.tar.gz: b55c5b2627474074e15f5848fc05174d7d10f3bf879d70f5a3750f2aae418e372c16222ece0654758dff8e6e4faa5461dbc6e33e4ce3c123ac45d454237ac01f

data/lib/console/adapter/sidekiq/error_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console'
+require 'sidekiq'
+
+module Console
+	module Adapter
+		module Sidekiq
+			# Custom error handler for Sidekiq.
+			ErrorHandler = lambda do |exception, context|
+				job = context[:job] || {}
+				Console.error(::Sidekiq, exception, **job)
+			end
+		end
+	end
+end

data/lib/console/adapter/sidekiq/logger.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console'
+require 'console/compatible/logger'
+require 'sidekiq'
+
+module Console
+	module Adapter
+		module Sidekiq
+			# An output wrapper that adds Sidekiq context to the output.
+			class Wrapper
+				def initialize(output)
+					@output = output
+				end
+
+				def call(*arguments, **options, &block)
+					if (context = ::Sidekiq::Context.current)
+						options.update(context)
+					end
+
+					@output.call(*arguments, **options, &block)
+				end
+			end
+			
+			# A compatible logger for sidekiq that prevents monkey patching.
+			class Logger < Console::Compatible::Logger
+				def initialize(subject, output = Console)
+					super(subject, Wrapper.new(output))
+				end
+
+				# Prevent Sidekiq from messing with internal behaviour.
+				# see: https://github.com/mperham/sidekiq/blob/v6.5.8/lib/sidekiq.rb#L285
+				def extend(*args); end
+			end
+		end
+	end
+end

data/lib/console/adapter/sidekiq/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Console
+	module Adapter
+		module Sidekiq
+			VERSION = "0.1.0"
+		end
+	end
+end

data/lib/console/adapter/sidekiq.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'sidekiq'
+
+require_relative 'sidekiq/error_handler'
+require_relative 'sidekiq/logger'
+
+module Console
+	module Adapter
+		module Sidekiq
+			def self.apply!
+				if ::Sidekiq.respond_to?(:default_configuration)
+					# Sidekiq 7+
+					::Sidekiq.default_configuration.logger = Logger.new(::Sidekiq)
+					::Sidekiq.default_configuration[:error_handlers] = [ErrorHandler]
+				else
+					# Sidekiq < 7
+					::Sidekiq.logger = Logger.new(::Sidekiq)
+					::Sidekiq.error_handlers << ErrorHandler
+				end
+			end
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023, by Samuel Williams.  
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,33 @@
+# Console::Adapter::Sidekiq
+
+Adapt Sidekiq event logs for `console`.
+
+[![Development
+Status](https://github.com/socketry/console-adapter-sidekiq/workflows/Test/badge.svg)](https://github.com/socketry/console-adapter-sidekiq/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://github.com/socketry/console-adapter-sidekiq) for more details.
+
+  - [Getting Started](https://github.com/socketry/console-adapter-sidekiqguides/getting-started/index) - This guide
+    explains how to integrate the `console-adapter-sidekiq` gem into your Sidekiq application.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this
+project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
+participants agree to abide by its terms.

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: console-adapter-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/console/adapter/sidekiq.rb
+- lib/console/adapter/sidekiq/error_handler.rb
+- lib/console/adapter/sidekiq/logger.rb
+- lib/console/adapter/sidekiq/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/console-adapter-sidekiq
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Adapt Sidekiq logs and events to the console gem.
+test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+3��sQ�2����s�\�H�����Ta�Ex�Za
+!"fK��K�		l�T�a}a@��
�q՛��s��@	�
+W0�fQ/6�6�� ��~�j\ �B	�暧��rm�X�-=��Y �ˇ������˧CY�Ph��F��B$geY}y��1Y�}�ii�WOZu���LKl�0B*שƬ�ܴ�x��K�ei�׮\rm4���:޳���G䱘Xfj�d����'�k\���u�1z}�3�^D�;/�!����������e�+�#5��	�F�� �:�_���������q5%CF�� ��^��kΊ��