karafka-core 2.0.10 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe29c2f11c04331a98b17f3828b1c3f06b98a262f52acccbdc16d7425db75c8a
-  data.tar.gz: c82f5aa772769ac4fb36729f17739d6ddc1adb01c2985739e91ebdc6590bbaa0
+  metadata.gz: 1896383dc8b2e0c161c30a66e3f95b91a83bd14b23f71f219a7aa58d3935410d
+  data.tar.gz: 7aff174b4151e3553767e39c2bcaa8227319e663c3d30ddcae0b3e3c8bca387c
 SHA512:
-  metadata.gz: 19b4410f4e65330729f8a11bf1af00b9820519f302eb93371ad48d9fe89a8b4e157f310e94d8cfa88fc0891902c52109e8bfd04200d6240e98246e925f1ad199
-  data.tar.gz: 8b0a2c93a04982e1fc593c793937af46812a3fb1e56dbda5ebb27b8c412685e73dbf03d55993ab68b6546002894281a40cff0830800e76f240c256dee982424b
+  metadata.gz: 64dd16a56f9ddc8e56e0c7fb7451df7b4e3d7b5d03c89d6a6c9f748d820b1203dfd436e1246fb596988d2a4757fc2bbca60252a37760bf04cbde72c63f5d0e62
+  data.tar.gz: ce8eb5da3c9ba4c765aa38ef3e91dd0b21809ca7f7e5833a7015ad434d5dd264af340fa7af509b0b7a1e3091e35d773e33ea620c7f79cb6acca403ed4622d733

data/.ruby-version

@@ -1 +1 @@
-3.2.0
+3.2.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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`.
+
 ## 2.0.10 (2023-02-01)
 - Move `RspecLocator` to core.
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.0.10)
+    karafka-core (2.0.12)
       concurrent-ruby (>= 1.1)
-      karafka-rdkafka (>= 0.12)
+      karafka-rdkafka (>= 0.12.1)
 
 GEM
   remote: https://rubygems.org/
@@ -22,7 +22,7 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    karafka-rdkafka (0.12.0)
+    karafka-rdkafka (0.12.1)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
@@ -33,7 +33,7 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -52,7 +52,6 @@ GEM
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
-  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -63,4 +62,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.4.5
+   2.4.6

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'
+  spec.add_dependency 'karafka-rdkafka', '>= 0.12.1'
 
   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.10'
+    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 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.0.10
+  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-01 00:00:00.000000000 Z
+date: 2023-02-23 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'
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.12.1
 description: A toolset of small support modules used throughout the Karafka ecosystem
 email:
 - contact@karafka.io
@@ -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
@@ -139,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Karafka ecosystem core modules