karafka-core 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82bb5d4340cf638f60cb93f47188e0eb09c25a47a8c4a0d3cfbe556b2d861703
+  data.tar.gz: f2fec7fa22658d92539e3cfae8c73f4a00a903160e7b5ca73b5f5236873f2195
+SHA512:
+  metadata.gz: 480bc8f93ca8efd92cad4c9bc77c28ef5e43947f9603b1b56060bd8ff769a1b7f0c83729d2ad8f22b2a37e57aa913b996ea919458f4c60491c9266d772eba5ea
+  data.tar.gz: 8c578ff0a9d8a0e7e81601ae5a1e6b318b79dc12b9aeba65046bebf384e16fdd9adfac03aec60adbd3d4f03a4ab396fd3aeeea4219c1b29bb91741c72cb26df8

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: 'd3cd0fec-757e-47be-87ca-7829dff0c5f4'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.console_irbrc

@@ -0,0 +1,11 @@
+# irbrc for Karafka console
+
+IRB.conf[:AUTO_INDENT] = true
+IRB.conf[:SAVE_HISTORY] = 1000
+IRB.conf[:USE_READLINE] = true
+IRB.conf[:HISTORY_FILE] = ".irb-history"
+IRB.conf[:LOAD_MODULES] = [] unless IRB.conf.key?(:LOAD_MODULES)
+
+unless IRB.conf[:LOAD_MODULES].include?('irb/completion')
+  IRB.conf[:LOAD_MODULES] << 'irb/completion'
+end

data/.diffend.yml

@@ -0,0 +1,3 @@
+project_id: '199f1b30-ba87-49e1-96d8-f4ea86732443'
+shareable_id: '6a6f2b22-021c-40cd-885c-82838f84f2f9'
+shareable_key: '9c7e0a66-7bff-4b90-9528-69d8d4c0bba4'

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: Bug Report
+about: Report an issue with Karafka you've discovered.
+---
+
+*Be clear, concise and precise in your description of the problem.
+Open an issue with a descriptive title and a summary in grammatically correct,
+complete sentences.*
+
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable Karafka and that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+*Before filing the ticket you should replace all text above the horizontal
+rule with your own words.*
+
+--------
+
+## Expected behavior
+
+Describe here how you expected Karafka to behave in this particular situation.
+
+## Actual behavior
+
+Describe here what actually happened.
+
+## Steps to reproduce the problem
+
+This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.
+
+## Your setup details
+
+Please provide kafka version and the output of `karafka info` or `bundle exec karafka info` if using Bundler.
+
+Here's an example:
+
+```
+$ [bundle exec] karafka info
+Karafka version: 1.3.0
+Ruby version: 2.6.3
+Ruby-kafka version: 0.7.9
+Application client id: karafka-local
+Backend: inline
+Batch fetching: true
+Batch consuming: true
+Boot file: /app/karafka/karafka.rb
+Environment: development
+Kafka seed brokers: ["kafka://kafka:9092"]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest new Karafka features or improvements to existing features.
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: ci
+
+concurrency: ci-${{ github.ref }}
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron:  '0 1 * * *'
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    needs: diffend
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.1'
+          - '3.0'
+          - '2.7'
+        include:
+          - ruby: '3.1'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+          bundle config set without 'tools benchmarks docs'
+      - name: Bundle install
+        run: |
+          bundle config set without development
+          bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        env:
+          GITHUB_COVERAGE: ${{matrix.coverage}}
+        run: bundle exec rspec
+
+  diffend:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+      - name: Install latest bundler
+        run: gem install bundler --no-document
+      - name: Install Diffend plugin
+        run: bundle plugin install diffend
+      - name: Bundle Secure
+        run: bundle secure
+
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Run Coditsu
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -0,0 +1,69 @@
+# bundler state
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+/ruby/
+app.god
+
+# minimal Rails specific artifacts
+/.coditsu/local.yml
+db/*.sqlite3
+/log/development.log
+/log/production.log
+/log/test.log
+/tmp/*
+*.gem
+*.~
+
+# various artifacts
+**.war
+*.rbc
+*.sassc
+.byebug_history
+.redcar/
+.capistrano/
+.sass-cache
+/config/god/sidekiq.rb
+/config/puma.rb
+/coverage.data
+/coverage/
+/doc/api/
+/doc/app/
+/doc/yard
+/doc/features.html
+/doc/specs.html
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+pickle-email-*.html
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp
+
+# documentation
+.yardoc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+karafka-core

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Karafka core changelog
+
+## 2.0.0.beta1
+- Initial extraction of common components used in the Karafka ecosystem from WaterDrop.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at maciej@mensfeld.pl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+plugin 'diffend'
+
+gemspec
+
+group :test do
+  gem 'byebug'
+  gem 'factory_bot'
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    karafka-core (2.0.0)
+      concurrent-ruby (>= 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  factory_bot
+  karafka-core!
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.3.15

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+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,21 @@
+[![Build Status](https://github.com/karafka/karafka-core/actions/workflows/ci.yml/badge.svg)](https://github.com/karafka/karafka-core/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/karafka-core.svg)](http://badge.fury.io/rb/karafka-core)
+[![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
+
+## Karafka-Core
+
+Karafka-Core contains toolset of small support modules used throughout the [Karafka](https://github.com/karafka/karafka/) ecosystem.
+
+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.
+
+## Note on contributions
+
+First, thank you for considering contributing to the Karafka ecosystem! It's people like you that make the open source community such a great community!
+
+Each pull request must pass all the RSpec specs, integration tests and meet our quality requirements.
+
+Fork it, update and wait for the Github Actions results.

data/certs/mensfeld.pem

@@ -0,0 +1,25 @@
+-----BEGIN CERTIFICATE-----
+MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
+ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjEwODExMTQxNTEzWhcNMjIwODExMTQx
+NTEzWjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDV2jKH4Ti87GM6nyT6D+ESzTI0MZDj
+ak2/TEwnxvijMJyCCPKT/qIkbW4/f0VHM4rhPr1nW73sb5SZBVFCLlJcOSKOBdUY
+TMY+SIXN2EtUaZuhAOe8LxtxjHTgRHvHcqUQMBENXTISNzCo32LnUxweu66ia4Pd
+1mNRhzOqNv9YiBZvtBf7IMQ+sYdOCjboq2dlsWmJiwiDpY9lQBTnWORnT3mQxU5x
+vPSwnLB854cHdCS8fQo4DjeJBRZHhEbcE5sqhEMB3RZA3EtFVEXOxlNxVTS3tncI
+qyNXiWDaxcipaens4ObSY1C2HTV7OWb7OMqSCIybeYTSfkaSdqmcl4S6zxXkjH1J
+tnjayAVzD+QVXGijsPLE2PFnJAh9iDET2cMsjabO1f6l1OQNyAtqpcyQcgfnyW0z
+g7tGxTYD+6wJHffM9d9txOUw6djkF6bDxyqB8lo4Z3IObCx18AZjI9XPS9QG7w6q
+LCWuMG2lkCcRgASqaVk9fEf9yMc2xxz5o3kCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFBqUFCKCOe5IuueUVqOB991jyCLLMB0GA1Ud
+EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
+c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBADD0/UuTTFgW+CGk2U0RDw2RBOca
+W2LTF/G7AOzuzD0Tc4voc7WXyrgKwJREv8rgBimLnNlgmFJLmtUCh2U/MgxvcilH
+yshYcbseNvjkrtYnLRlWZR4SSB6Zei5AlyGVQLPkvdsBpNegcG6w075YEwzX/38a
+8V9B/Yri2OGELBz8ykl7BsXUgNoUPA/4pHF6YRLz+VirOaUIQ4JfY7xGj6fSOWWz
+/rQ/d77r6o1mfJYM/3BRVg73a3b7DmRnE5qjwmSaSQ7u802pJnLesmArch0xGCT/
+fMmRli1Qb+6qOTl9mzD6UDMAyFR4t6MStLm0mIEqM0nBO5nUdUWbC7l9qXEf8XBE
+2DP28p3EqSuS+lKbAWKcqv7t0iRhhmaod+Yn9mcrLN1sa3q3KSQ9BCyxezCD4Mk2
+R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
+pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
+-----END CERTIFICATE-----

data/config/errors.yml

@@ -0,0 +1,10 @@
+en:
+  validations:
+    test:
+      missing: needs to be present
+      id_format: needs to be a String
+      nested.id2_format: needs to be a String
+
+    config:
+      missing: needs to be present
+      id_format: needs to be a String

data/karafka-core.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'karafka/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'karafka-core'
+  spec.version     = ::Karafka::Core::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Maciej Mensfeld']
+  spec.email       = %w[maciej@mensfeld.pl]
+  spec.homepage    = 'https://karafka.io'
+  spec.summary     = 'Karafka ecosystem core modules'
+  spec.description = 'A toolset of small support modules used throughout the Karafka ecosystem'
+  spec.licenses    = %w[MIT]
+  spec.add_dependency 'concurrent-ruby', '>= 1.1'
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  if $PROGRAM_NAME.end_with?('gem')
+    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  end
+
+  spec.cert_chain    = %w[certs/mensfeld.pem]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = %w[lib]
+
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/karafka/karafka-core',
+    'rubygems_mfa_required' => 'true'
+  }
+end

data/lib/karafka/core/configurable/leaf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    module Configurable
+      # Single end config value representation
+      Leaf = Struct.new(:name, :default, :constructor)
+    end
+  end
+end

data/lib/karafka/core/configurable/node.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    module Configurable
+      # Single non-leaf node
+      # This is a core component for the configurable settings
+      #
+      # The idea here is simple: we collect settings (leafs) and children (nodes) information and
+      # we only compile/initialize the values prior to user running the `#configure` API. This API
+      # needs to run prior to using the result stuff even if there is nothing to configure
+      class Node
+        attr_reader :name, :nestings
+
+        # We need to be able to redefine children for deep copy
+        attr_accessor :children
+
+        # @param name [Symbol] node name
+        # @param nestings [Proc] block for nested settings
+        def initialize(name, nestings = ->(_) {})
+          @name = name
+          @children = []
+          @nestings = nestings
+          instance_eval(&nestings)
+        end
+
+        # Allows for a single leaf or nested node definition
+        #
+        # @param name [Symbol] setting or nested node name
+        # @param default [Object] default value
+        # @param constructor [#call, nil] callable or nil
+        # @param block [Proc] block for nested settings
+        def setting(name, default: nil, constructor: nil, &block)
+          @children << if block
+                         Node.new(name, block)
+                       else
+                         Leaf.new(name, default, constructor)
+                       end
+        end
+
+        # Allows for the configuration and setup of the settings
+        #
+        # Compile settings, allow for overrides via yielding
+        # @return [Node] returns self after configuration
+        def configure
+          compile
+          yield(self) if block_given?
+          self
+        end
+
+        # @return [Hash] frozen config hash representation
+        def to_h
+          config = {}
+
+          @children.each do |value|
+            config[value.name] = if value.is_a?(Leaf)
+                                   public_send(value.name)
+                                 else
+                                   value.to_h
+                                 end
+          end
+
+          config.freeze
+        end
+
+        # Deep copies all the children nodes to allow us for templates building on a class level
+        # and non-side-effect usage on an instance/inherited.
+        # @return [Node] duplicated node
+        def deep_dup
+          dupped = Node.new(name, nestings)
+
+          dupped.children += children.map do |value|
+            value.is_a?(Leaf) ? value.dup : value.deep_dup
+          end
+
+          dupped
+        end
+
+        # Converts the settings definitions into end children
+        # @note It runs once, after things are compiled, they will not be recompiled again
+        def compile
+          @children.each do |value|
+            # Do not redefine something that was already set during compilation
+            # This will allow us to reconfigure things and skip override with defaults
+            next if respond_to?(value.name)
+
+            singleton_class.attr_accessor value.name
+
+            initialized = if value.is_a?(Leaf)
+                            value.constructor ? value.constructor.call(value.default) : value.default
+                          else
+                            value.compile
+                            value
+                          end
+
+            public_send("#{value.name}=", initialized)
+          end
+        end
+      end
+    end
+  end
+end