karafka-core 2.0.11 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5593ddb70f6e2cf57e058e2d8688dc55121ac02b9d6882358979edceff41dd87
-  data.tar.gz: f2d5546158923107a84934711c567e4beb0a8e3bfa8b7697505eb94b70d90a9f
+  metadata.gz: a938e6718cc3ecdc211ec088db5ab5902864f5bacadd3289fb2b87491378c31c
+  data.tar.gz: aa170f595eaab2748bd8e8455eb82f0b32b66020553e166bbc876a2d5f8e06c4
 SHA512:
-  metadata.gz: aaa78148833a7eda544fb5c03eb1f226422a439d27d08e8d431070ac944234b00d884fb9056e80f9327b461cc8dd80d44a782734655706a1a4841c4aa4b5f8c7
-  data.tar.gz: '008ddf1bb91fb5b237d531337eb216d0870dbb39dd2cfe646b6dac07046a2b14891be02efb3957e1f8dc9742eae5586eeb20a21b39380d0f445a58124f6599ae'
+  metadata.gz: e6e442ddb36335271c9b848a28c0f8ff97a3921384b0b11cb91cbd03f3c83871759482f4bdf931e51bb9cfdf58be04aa20b72f79224113ffba9000842691ea1d
+  data.tar.gz: '08f3a05acc898b7f27d9aa9b3ddbe450142334710670f0d39e0de1bee4f942a5c7ebaf25279b177b45ea165ce5bd654403bc34eae598170ac2f49331ba6dd4ef'

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Karafka core changelog
 
+## 2.0.13 (2023-05-26)
+- Set minimum `karafka-rdkafka` on `0.12.3`.
+
+## 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,20 +1,20 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.0.11)
+    karafka-core (2.0.13)
       concurrent-ruby (>= 1.1)
-      karafka-rdkafka (>= 0.12.1)
+      karafka-rdkafka (>= 0.12.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     byebug (11.1.3)
-    concurrent-ruby (1.2.0)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
     factory_bot (6.2.1)
@@ -22,12 +22,12 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    karafka-rdkafka (0.12.1)
+    karafka-rdkafka (0.12.3)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.1)
-    minitest (5.17.0)
+    minitest (5.18.0)
     rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -38,7 +38,7 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -52,6 +52,7 @@ GEM
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -62,4 +63,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.4.6
+   2.4.12

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/karafka-core.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[MIT]
 
   spec.add_dependency 'concurrent-ruby', '>= 1.1'
-  spec.add_dependency 'karafka-rdkafka', '>= 0.12.1'
+  spec.add_dependency 'karafka-rdkafka', '>= 0.12.3'
 
   spec.required_ruby_version = '>= 2.6.0'
 

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.13'
   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/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.0.13
 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-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.3
 description: A toolset of small support modules used throughout the Karafka ecosystem
 email:
 - contact@karafka.io
@@ -111,8 +111,11 @@ 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
+- renovate.json
 homepage: https://karafka.io
 licenses:
 - MIT
@@ -139,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Karafka ecosystem core modules