karafka-core 2.0.11 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5593ddb70f6e2cf57e058e2d8688dc55121ac02b9d6882358979edceff41dd87
-  data.tar.gz: f2d5546158923107a84934711c567e4beb0a8e3bfa8b7697505eb94b70d90a9f
+  metadata.gz: 1896383dc8b2e0c161c30a66e3f95b91a83bd14b23f71f219a7aa58d3935410d
+  data.tar.gz: 7aff174b4151e3553767e39c2bcaa8227319e663c3d30ddcae0b3e3c8bca387c
 SHA512:
-  metadata.gz: aaa78148833a7eda544fb5c03eb1f226422a439d27d08e8d431070ac944234b00d884fb9056e80f9327b461cc8dd80d44a782734655706a1a4841c4aa4b5f8c7
-  data.tar.gz: '008ddf1bb91fb5b237d531337eb216d0870dbb39dd2cfe646b6dac07046a2b14891be02efb3957e1f8dc9742eae5586eeb20a21b39380d0f445a58124f6599ae'
+  metadata.gz: 64dd16a56f9ddc8e56e0c7fb7451df7b4e3d7b5d03c89d6a6c9f748d820b1203dfd436e1246fb596988d2a4757fc2bbca60252a37760bf04cbde72c63f5d0e62
+  data.tar.gz: ce8eb5da3c9ba4c765aa38ef3e91dd0b21809ca7f7e5833a7015ad434d5dd264af340fa7af509b0b7a1e3091e35d773e33ea620c7f79cb6acca403ed4622d733

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Karafka core changelog
 
+## 2.0.12 (2023-02-23)
+- Introduce ability to tag certain objects by including the `Karafka::Core::Taggable` module.
+
 ## 2.0.11 (2023-02-12)
 - Set minimum `karafka-rdkafka` on `0.12.1`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.0.11)
+    karafka-core (2.0.12)
       concurrent-ruby (>= 1.1)
       karafka-rdkafka (>= 0.12.1)
 

data/README.md

@@ -6,11 +6,12 @@
 
 Karafka-Core contains toolset of small support modules used throughout the [Karafka](https://github.com/karafka/karafka/) ecosystem.
 
-It includes
+It includes:
 
 - `Karafka::Core::Monitoring` - default instrumentation and abstraction that allows to use either itself, `dry-monitor` or `ActiveSupport::Notifications`.
 - `Karafka::Core::Configurable` - configuration engine inspired by `dry-config` with similar but simplified API.
 - `Karafka::Core::Contractable` - contracts inspired by `dry-validation` but with simplified API.
+- `Karafka::Core::Taggable` - adds ability to attach `#tags` to objects for extra labeling.
 
 ## Note on contributions
 

data/lib/karafka/core/taggable/tags.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    module Taggable
+      # This allows us to collect tags about given object. We attach name to each tag, because we
+      # may want to replace given tag with a different one and we need to have a reference of
+      # what we want to replace
+      class Tags
+        # Creates new tags accumulator
+        def initialize
+          @accu = {}
+        end
+
+        # Adds a tag with a given name to tags
+        # @param name [Symbol] name we want to use for a given tag
+        # @param tag [#to_s] any object that can be converted into a string via `#to_s`
+        def add(name, tag)
+          @accu[name] = tag.to_s
+        end
+
+        # Removes all the tags
+        def clear
+          @accu.clear
+        end
+
+        # Removes a tag with a given name
+        # @param name [Symbol] name of the tag
+        def delete(name)
+          @accu.delete(name)
+        end
+
+        # @return [Array<String>] all unique tags registered
+        def to_a
+          @accu.values.tap(&:uniq!)
+        end
+
+        # @param _args [Object] anything that the standard `to_json` accepts
+        # @return [String] json representation of tags
+        def to_json(*_args)
+          to_a.to_json
+        end
+
+        # @param _args [Object] anything that the standard `as_json` accepts
+        # @return [Array<String>] array that can be converted to json
+        def as_json(*_args)
+          to_a
+        end
+      end
+    end
+  end
+end

data/lib/karafka/core/taggable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    # Namespace related to extension allowing to attach tags to any object.
+    # It can be used to assign tags in runtime to objects and use those tags in metrics, reporting
+    # and other places.
+    #
+    # Tags will be converted to strings when they are added
+    module Taggable
+      # @return [::Karafka::Core::Taggable::Tags] tags object
+      def tags
+        @tags ||= Taggable::Tags.new
+      end
+    end
+  end
+end

data/lib/karafka/core/version.rb

@@ -4,6 +4,6 @@ module Karafka
   module Core
     # Current Karafka::Core version
     # We follow the versioning schema of given Karafka version
-    VERSION = '2.0.11'
+    VERSION = '2.0.12'
   end
 end

data/lib/karafka-core.rb

@@ -30,6 +30,9 @@
   karafka/core/instrumentation
   karafka/core/instrumentation/callbacks_manager
 
+  karafka/core/taggable
+  karafka/core/taggable/tags
+
   karafka/core/patches/rdkafka/bindings
 ].each { |dependency| require dependency }
 

data.tar.gz.sig

@@ -1,2 +1 @@
-�,�9[��V""�o�Qy	�T(j+�Q�lҙ�G�GPK�� �'��
�nW:�jL�uT?�rs��n���5C�s�gu�&[9��;�9x�ŀ��+e.$�=dX���߯�u�;�+��Z�Bn.�܁Ԋ���B�&'��>%H}MH|����n�8���r���ܖ�;^����i�����3dQ?c�}�1,�!����B�L����
-��q�^���X痹F 5���Q֘V�hCތ���Lw��o�~
+�v���]z��,��"a����ٙӬj������
�O�
��!���̀��ͽ~%��J*d��#�Zq��{Ÿ 0lm�=��G-~־��[38��H�%t�������;�2���%il�K������J�\�ac�R2E+,��얠t�{Y�"h�YꩯPL}tQ��ܵ„����$�e�?<蹫m|�,��);�s� �B��3��jq��z��7JeXͣ�wo��p������@�D]۫���כj*�+jj�:�Q
$�����v�yh��_9N��np	��д�����*�Y���=��\��l<*�?�Q�x�1A)�0���A��Q�q&�_�E�Ej6�y$��p�ט.̔��}]26E���l��sVk,�WR

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.0.12
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,6 +111,8 @@ files:
 - lib/karafka/core/monitoring/notifications.rb
 - lib/karafka/core/monitoring/statistics_decorator.rb
 - lib/karafka/core/patches/rdkafka/bindings.rb
+- lib/karafka/core/taggable.rb
+- lib/karafka/core/taggable/tags.rb
 - lib/karafka/core/version.rb
 - log/.gitkeep
 homepage: https://karafka.io

metadata.gz.sig

@@ -1,3 +1 @@
--<�BE�"���&��9l��qb�Q3[�]�Ay�J4�|��f����
�Ԍ�D� �@�	��	���A*����=BVW��:�;��~�������$
-G��Cġv�B)�c�}��b�M�TA�:��~�����g�'�!
-��9�B�"�P�1l�K,~����:l�53��fxx-M��9���+s�JOu@T�3't�pC�ΣSl&��i�}>{��R�)��]����St�4��!t��`As�i�?�|4�M{�<}}*?9^�f�Bm�ڶ�n�+�,1˃;�(h��~�3���<��f����c��t�v�C�i3�"�2�e�O�����4�H+���\��ъxWC�G��F���E?�
�u թ�
+_�r`���:jf�Ϋ͂���Q�����*�������>���S���K�H>�PU�75���`t��T�}����pHaK.>�2���n�6H��E�AJ�1�(t�Z�Xv?8�?id���;��C�v[M+�-dD����E�ۜ[id���G��g7\	y�s��p�7֧=�Oq,�l�l|Y��??Q``�Z����CR�vU8ȃc2����V^Z�kͥn.��b��g�
\��b��%j�R�`�2O�x!