yabeda 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5aed70338bdfe24c4505a3cbe51cb4853c7c0e0c1842ef1cee93480ef517c02
-  data.tar.gz: 95dc76b40980f227abe24c7bf70339d47d81eaa91e6bdfa354c8b6e6b93c8170
+  metadata.gz: 52ac87de3f6f2edd66e88d967b2e2e7231a87a27189e9d0a129cbafc6041813f
+  data.tar.gz: 2096a9ea457d7aa10efdcb54bc29a6a6e520e15974bba1efafc53df2921b5116
 SHA512:
-  metadata.gz: 77e865d851f2e9f2a168426983df6693c9e655e0349107aafd25594eea12f9f83c14da519abbdfc5826f8c0e208d68b2a0616735771ba5ec82bde7acb3e71085
-  data.tar.gz: aa7596a3de80b063845d552136c882cbdf46e772a1f53998058ba894dc8428290fdbae391ef241f2264dd5e76bd41be8cfab0b8afad654152b50d3b47fd0ab3b
+  metadata.gz: 3a75f40eb17ab3d35feef5449bfe07e369487c61609eca03da0f7eec17d1d7e32ad5b51b4a5079d3247b994df8e9730d681d501b7fa7b71d17a9b7d1ede06993
+  data.tar.gz: bcf1c14781cb17a3621ed4f03a3431b2399ee9e4ec80bfa044455903d2d4e9ab25563b94a01207435b05e1898e681dda91c6f36d437e574c33060f0f7c1014ef

data/.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+name: Lint Ruby
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "gemfiles/*"
+      - "Gemfile"
+      - "**/*.rb"
+      - "**/*.gemspec"
+      - ".github/workflows/lint.yml"
+  pull_request:
+    paths:
+      - "gemfiles/*"
+      - "Gemfile"
+      - "**/*.rb"
+      - "**/*.gemspec"
+      - ".github/workflows/lint.yml"
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+        bundler-cache: true
+    - name: Lint Ruby code with RuboCop
+      run: |
+        bundle exec rubocop

data/.github/workflows/test.yml

@@ -16,12 +16,10 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - ruby: "3.2"
+          - ruby: "3.1"
           - ruby: "3.0"
           - ruby: "2.7"
-          - ruby: "2.6"
-          - ruby: "2.5"
-          - ruby: "2.4"
-          - ruby: "2.3"
     container:
       image: ruby:${{ matrix.ruby }}
       env:
@@ -35,14 +33,10 @@ jobs:
           restore-keys: |
             bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
             bundle-${{ matrix.ruby }}-
-      - name: Upgrade Bundler to 2.0 (for older Rubies)
-        run: gem install bundler -v '~> 2.0'
       - name: Bundle install
         run: |
           bundle config path vendor/bundle
           bundle install
           bundle update
-      - name: Run Rubocop
-        run: bundle exec rubocop
       - name: Run RSpec
         run: bundle exec rspec

data/.rubocop.yml

@@ -10,6 +10,9 @@ Metrics/BlockLength:
   - "Gemfile"
   - "spec/**/*"
 
+Metrics/AbcSize:
+  Max: 25
+
 Layout/LineLength:
   Max: 120
 
@@ -23,6 +26,15 @@ RSpec/LetSetup:
 RSpec/MultipleExpectations:
   Enabled: false
 
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 Bundler/OrderedGems:
   Enabled: false
 
@@ -52,3 +64,6 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 0.12.0 - 2023-07-28
+
+### Added
+
+- Summary metric type (mostly for Prometheus adapter).
+
+## 0.11.0 - 2021-09-25
+
+### Added
+
+- RSpec matchers `increment_yabeda_counter`, `update_yabeda_gauge`, and `measure_yabeda_histogram` for convenient testing. [#25](https://github.com/yabeda-rb/yabeda/pull/25) by [@Envek][]
+- Automatic setup of RSpec on `require "yabeda/rspec"`
+- Special test adapter that collects metric changes in memory
+
 ## 0.10.1 - 2021-08-30
 
 ### Fixed

data/Gemfile

@@ -8,9 +8,14 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development, :test do
+  gem "rake", "~> 12.0"
+  gem "rspec", "~> 3.0"
+  gem "yard"
+  gem "yard-dry-initializer"
+
   gem "pry"
   gem "pry-byebug", platform: :mri
 
-  gem "rubocop", "~> 0.80.0"
+  gem "rubocop", "~> 1.0"
   gem "rubocop-rspec"
 end

data/README.md

@@ -1,8 +1,7 @@
 # ![Yabeda](./yabeda-logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/yabeda.svg)](https://rubygems.org/gems/yabeda)
-
-**This software is Work in Progress: features will appear and disappear, API will be changed, your feedback is always welcome!**
+[![Tests status](https://github.com/yabeda-rb/yabeda/actions/workflows/test.yml/badge.svg)](https://github.com/yabeda-rb/yabeda/actions/workflows/test.yml)
 
 Extendable solution for easy setup of monitoring in your Ruby apps.
 
@@ -18,6 +17,11 @@ Most of the time you don't need to add this gem to your Gemfile directly (unless
 
 ```ruby
 gem 'yabeda'
+
+# Add some plugins to quickly start collecting some essential metrics:
+# gem 'yabeda-rails'
+# gem 'yabeda-sidekiq'
+
 # Then add monitoring system adapter, e.g.:
 # gem 'yabeda-prometheus'
 ```
@@ -39,6 +43,7 @@ And then execute:
           comment "How long whistles are being active"
           unit :seconds
         end
+        summary :bells_ringing_duration, unit: :seconds, comment: "How long bells are ringing"
       end
     end
     ```
@@ -124,6 +129,7 @@ And then execute:
 These are developed and maintained by other awesome folks:
 
  - [Statsd](https://github.com/asusikov/yabeda-statsd)
+ - [AWS CloudWatch](https://github.com/retsef/yabeda-cloudwatch)
  - _…and more! You can write your own adapter and open a pull request to add it into this list._
 
 ## Available plugins to collect metrics
@@ -131,6 +137,7 @@ These are developed and maintained by other awesome folks:
 ### Maintained by Yabeda
 
  - [yabeda-rails] — basic request metrics for [Ruby on Rails](https://rubyonrails.org/) applications.
+ - [yabeda-activerecord] — query performance and connection pool stats for apps using ActiveRecord to query databases.
  - [yabeda-sidekiq] — comprehensive set of metrics for monitoring [Sidekiq](https://sidekiq.org/) jobs execution and queues.
  - [yabeda-faktory] — metrics for monitoring jobs execution by Ruby workers of [Faktory](https://contribsys.com/faktory/).
  - [yabeda-graphql] — metrics to query and field-level monitoring for apps using [GraphQL-Ruby](https://graphql-ruby.org/).
@@ -146,6 +153,9 @@ These are developed and maintained by other awesome folks:
  - [yabeda-grape](https://github.com/efigence/yabeda-grape) — metrics for [Grape](https://github.com/ruby-grape/grape) framework.
  - [yabeda-gruf](https://github.com/Placewise/yabeda-gruf) — metrics for [gRPC Ruby Framework](https://github.com/bigcommerce/gruf)
  - [yabeda-gc](https://github.com/ianks/yabeda-gc) — metrics for Ruby garbage collection.
+ - [yabeda-activejob](https://github.com/Fullscript/yabeda-activejob) — backend-agnostic metrics for background jobs.
+ - [yabeda-shoryuken](https://github.com/retsef/yabeda-shoryuken) — metrics for [Shoryuken](https://github.com/ruby-shoryuken/shoryuken) jobs execution message queues.
+ - [yabeda-rack-ratelimit](https://github.com/basecamp/yabeda-rack-ratelimit) — metrics for [Rack::Ratelimit](https://github.com/jeremy/rack-ratelimit)
  - _…and more! You can write your own adapter and open a pull request to add it into this list._
 
 ## Configuration
@@ -162,6 +172,44 @@ Config key | Type     | Default | Description |
 
 These are only enabled in debug mode. To enable it either set `debug` config key to `true` (e.g. by specifying `YABEDA_DEBUG=true` in your environment variables or executing `Yabeda.debug!` in your code).
 
+## Testing
+
+### RSpec
+
+Add the following to your `rails_helper.rb` (or `spec_helper.rb`):
+
+```ruby
+require "yabeda/rspec"
+```
+
+Now you can use `increment_yabeda_counter`, `update_yabeda_gauge`, `measure_yabeda_histogram`, and `observe_yabeda_summary` matchers:
+
+```ruby
+it "increments counters" do
+  expect { subject }.to increment_yabeda_counter(Yabeda.myapp.foo_count).by(3)
+end
+```
+
+You can scope metrics by used tags with `with_tags`:
+
+```ruby
+it "updates gauges" do
+  expect { subject }.to \
+    update_yabeda_gauge("some_gauge_name").
+    with_tags(method: "command", command: "subscribe")
+end
+```
+
+Note that tags you specified doesn't need to be exact, but can be a subset of tags used on metric update. In this example updates with following sets of tags `{ method: "command", command: "subscribe", status: "SUCCESS" }` and `{ method: "command", command: "subscribe", status: "FAILURE" }` will make test example to pass.
+
+And check for values with `by` for counters, `to` for gauges, and `with` for histograms and summaries (and you [can use other matchers here](https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/composing-matchers)):
+
+```ruby
+expect { subject }.to \
+  measure_yabeda_histogram(Yabeda.something.anything_runtime).
+  with(be_between(0.005, 0.05))
+```
+
 ## Roadmap (aka TODO or Help wanted)
 
  - Ability to change metric settings for individual adapters
@@ -229,6 +277,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 [yabeda-rails]: https://github.com/yabeda-rb/yabeda-rails/ "Yabeda plugin for collecting and exporting basic metrics for Rails applications"
+[yabeda-activerecord]: https://github.com/yabeda-rb/yabeda-activerecord/ "Yabeda plugin to collect query performance metrics and connection pool statistics"
 [yabeda-sidekiq]: https://github.com/yabeda-rb/yabeda-sidekiq/ "Yabeda plugin for complete monitoring of Sidekiq metrics"
 [yabeda-faktory]: https://github.com/yabeda-rb/yabeda-faktory/ "Yabeda plugin for complete monitoring of Faktory Ruby Workers"
 [yabeda-graphql]: https://github.com/yabeda-rb/yabeda-graphql/ "Measure and understand how good your GraphQL-Ruby application works"

data/lib/yabeda/base_adapter.rb

@@ -8,6 +8,7 @@ module Yabeda
       when Counter   then register_counter!(metric)
       when Gauge     then register_gauge!(metric)
       when Histogram then register_histogram!(metric)
+      when Summary   then register_summary!(metric)
       else raise "#{metric.class} is unknown metric type"
       end
     end
@@ -36,6 +37,14 @@ module Yabeda
       raise NotImplementedError, "#{self.class} doesn't support measuring histograms"
     end
 
+    def register_summary!(_metric)
+      raise NotImplementedError, "#{self.class} doesn't support summaries as metric type!"
+    end
+
+    def perform_summary_observe!(_metric, _tags, _value)
+      raise NotImplementedError, "#{self.class} doesn't support observing summaries"
+    end
+
     # Hook to enable debug mode in adapters when it is enabled in Yabeda itself
     def debug!; end
   end

data/lib/yabeda/dsl/class_methods.rb

@@ -4,6 +4,7 @@ require "yabeda/metric"
 require "yabeda/counter"
 require "yabeda/gauge"
 require "yabeda/histogram"
+require "yabeda/summary"
 require "yabeda/group"
 require "yabeda/global_group"
 require "yabeda/dsl/metric_builder"
@@ -11,7 +12,6 @@ require "yabeda/dsl/metric_builder"
 module Yabeda
   # DSL for ease of work with Yabeda
   module DSL
-    # rubocop: disable Style/Documentation
     module ClassMethods
       # Block for grouping and simplifying configuration of related metrics
       def configure(&block)
@@ -56,6 +56,12 @@ module Yabeda
         register_metric(metric)
       end
 
+      # Register a summary
+      def summary(*args, **kwargs, &block)
+        metric = MetricBuilder.new(Summary).build(args, kwargs, @group, &block)
+        register_metric(metric)
+      end
+
       # Add default tag for all metric
       #
       # @param name [Symbol] Name of default tag
@@ -110,6 +116,5 @@ module Yabeda
         group.register_metric(metric)
       end
     end
-    # rubocop: enable Style/Documentation
   end
 end

data/lib/yabeda/global_group.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "forwardable"
-require_relative "./group"
+require_relative "group"
 
 module Yabeda
   # Represents implicit global group

data/lib/yabeda/metric.rb

@@ -29,5 +29,9 @@ module Yabeda
     def tags
       (Yabeda.groups[group].default_tags.keys + Array(super)).uniq
     end
+
+    def inspect
+      "#<#{self.class.name}: #{[@group, @name].compact.join('.')}>"
+    end
   end
 end

data/lib/yabeda/rspec/base_matcher.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module RSpec
+    # Notes:
+    #  +expected+ is always a metric instance
+    #  +actual+ is always a block of code
+    # Example:
+    #  expect { anything }.to do_whatever_with_yabeda_metric(Yabeda.something)
+    class BaseMatcher < ::RSpec::Matchers::BuiltIn::BaseMatcher
+      attr_reader :tags, :metric
+
+      # Specify a scope of labels (tags). Subset of tags can be specified.
+      def with_tags(tags)
+        @tags = tags
+        self
+      end
+
+      def initialize(expected)
+        super
+        @expected = @metric = resolve_metric(expected)
+      rescue KeyError
+        raise ArgumentError, <<~MSG
+          Pass metric name or metric instance to matcher (e.g. `increment_yabeda_counter(Yabeda.metric_name)` or \
+          increment_yabeda_counter('metric_name')). Got #{expected.inspect} instead
+        MSG
+      end
+
+      # RSpec doesn't define this method, but it is more convenient to rely on +match_when_negated+ method presence
+      def does_not_match?(actual)
+        @actual = actual
+        if respond_to?(:match_when_negated)
+          match_when_negated(expected, actual)
+        else
+          !match(expected, actual)
+        end
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      # Pretty print metric name (expected is expected to always be a Yabeda metric instance)
+      def expected_formatted
+        "Yabeda.#{[metric.group, metric.name].compact.join('.')}"
+      end
+
+      private
+
+      def resolve_metric(instance_or_name)
+        return instance_or_name if instance_or_name.is_a? Yabeda::Metric
+
+        Yabeda.metrics.fetch(instance_or_name.to_s)
+      end
+
+      # Filter metric changes by tags.
+      # If tags specified, treat them as subset of real tags (to avoid bothering with default tags in tests)
+      def filter_matching_changes(changes)
+        return changes if tags.nil?
+
+        changes.select { |t, _v| t >= tags }
+      end
+    end
+  end
+end

data/lib/yabeda/rspec/increment_yabeda_counter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "base_matcher"
+
+module Yabeda
+  module RSpec
+    # Checks whether Yabeda counter was incremented during test run or not
+    # @param metric [Yabeda::Counter,String,Symbol] metric instance or name
+    # @return [Yabeda::RSpec::IncrementYabedaCounter]
+    def increment_yabeda_counter(metric)
+      IncrementYabedaCounter.new(metric)
+    end
+
+    # Custom matcher class with implementation for +increment_yabeda_counter+
+    class IncrementYabedaCounter < BaseMatcher
+      def by(increment)
+        @expected_increment = increment
+        self
+      end
+
+      attr_reader :expected_increment
+
+      def initialize(*)
+        super
+        return if metric.is_a? Yabeda::Counter
+
+        raise ArgumentError, "Pass counter instance/name to `increment_yabeda_counter`. Got #{metric.inspect} instead"
+      end
+
+      def match(metric, block)
+        block.call
+
+        increments = filter_matching_changes(Yabeda::TestAdapter.instance.counters.fetch(metric))
+
+        increments.values.any? do |actual_increment|
+          expected_increment.nil? || values_match?(expected_increment, actual_increment)
+        end
+      end
+
+      def match_when_negated(metric, block)
+        unless expected_increment.nil?
+          raise NotImplementedError, <<~MSG
+            `expect(Yabeda.metric_name).not_to increment_yabeda_counter` doesn't support specifying increment
+             with `.by` as it can lead to false positives.
+          MSG
+        end
+
+        block.call
+
+        increments = filter_matching_changes(Yabeda::TestAdapter.instance.counters.fetch(metric))
+
+        increments.none?
+      end
+
+      def failure_message
+        "expected #{expected_formatted} " \
+          "to be incremented #{"by #{description_of(expected_increment)} " unless expected_increment.nil?}" \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_increments_message}"
+      end
+
+      def failure_message_when_negated
+        "expected #{expected_formatted} " \
+          "not to be incremented " \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_increments_message}"
+      end
+
+      def actual_increments_message
+        counter_increments = Yabeda::TestAdapter.instance.counters.fetch(metric)
+        if counter_increments.empty?
+          "no increments of this counter have been made"
+        elsif tags && counter_increments.key?(tags)
+          "has been incremented by #{counter_increments.fetch(tags)}"
+        else
+          "following increments have been made: #{::RSpec::Support::ObjectFormatter.format(counter_increments)}"
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/rspec/measure_yabeda_histogram.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "base_matcher"
+
+module Yabeda
+  module RSpec
+    # Checks whether Yabeda histogram was measured during test run or not
+    # @param metric [Yabeda::Histogram,String,Symbol] metric instance or name
+    # @return [Yabeda::RSpec::MeasureYabedaHistogram]
+    def measure_yabeda_histogram(metric)
+      MeasureYabedaHistogram.new(metric)
+    end
+
+    # Custom matcher class with implementation for +measure_yabeda_histogram+
+    class MeasureYabedaHistogram < BaseMatcher
+      def with(value)
+        @expected_value = value
+        self
+      end
+
+      attr_reader :expected_value
+
+      def initialize(*)
+        super
+        return if metric.is_a? Yabeda::Histogram
+
+        raise ArgumentError, "Pass histogram instance/name to `measure_yabeda_histogram`. Got #{metric.inspect} instead"
+      end
+
+      def match(metric, block)
+        block.call
+
+        measures = filter_matching_changes(Yabeda::TestAdapter.instance.histograms.fetch(metric))
+
+        measures.values.any? { |measure| expected_value.nil? || values_match?(expected_value, measure) }
+      end
+
+      def match_when_negated(metric, block)
+        unless expected_value.nil?
+          raise NotImplementedError, <<~MSG
+            `expect {}.not_to measure_yabeda_histogram` doesn't support specifying values with `.with`
+            as it can lead to false positives.
+          MSG
+        end
+
+        block.call
+
+        measures = filter_matching_changes(Yabeda::TestAdapter.instance.histograms.fetch(metric))
+
+        measures.none?
+      end
+
+      def failure_message
+        "expected #{expected_formatted} " \
+          "to be changed #{"to #{expected} " unless expected_value.nil?}" \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def failure_message_when_negated
+        "expected #{expected_formatted} " \
+          "not to be incremented " \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def actual_changes_message
+        measures = Yabeda::TestAdapter.instance.histograms.fetch(metric)
+        if measures.empty?
+          "no changes of this gauge have been made"
+        elsif tags && measures.key?(tags)
+          "has been changed to #{measures.fetch(tags)} with tags #{::RSpec::Support::ObjectFormatter.format(tags)}"
+        else
+          "following changes have been made: #{::RSpec::Support::ObjectFormatter.format(measures)}"
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/rspec/observe_yabeda_summary.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "base_matcher"
+
+module Yabeda
+  module RSpec
+    # Checks whether Yabeda summary was observed during test run or not
+    # @param metric [Yabeda::Summary,String,Symbol] metric instance or name
+    # @return [Yabeda::RSpec::ObserveYabedaSummary]
+    def observe_yabeda_summary(metric)
+      ObserveYabedaSummary.new(metric)
+    end
+
+    # Custom matcher class with implementation for +observe_yabeda_summary+
+    class ObserveYabedaSummary < BaseMatcher
+      def with(value)
+        @expected_value = value
+        self
+      end
+
+      attr_reader :expected_value
+
+      def initialize(*)
+        super
+        return if metric.is_a? Yabeda::Summary
+
+        raise ArgumentError, "Pass summary instance/name to `observe_yabeda_summary`. Got #{metric.inspect} instead"
+      end
+
+      def match(metric, block)
+        block.call
+
+        observations = filter_matching_changes(Yabeda::TestAdapter.instance.summaries.fetch(metric))
+
+        observations.values.any? { |observation| expected_value.nil? || values_match?(expected_value, observation) }
+      end
+
+      def match_when_negated(metric, block)
+        unless expected_value.nil?
+          raise NotImplementedError, <<~MSG
+            `expect {}.not_to observe_yabeda_summary` doesn't support specifying values with `.with`
+            as it can lead to false positives.
+          MSG
+        end
+
+        block.call
+
+        observations = filter_matching_changes(Yabeda::TestAdapter.instance.summaries.fetch(metric))
+
+        observations.none?
+      end
+
+      def failure_message
+        "expected #{expected_formatted} " \
+          "to be observed #{"with #{expected} " unless expected_value.nil?}" \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def failure_message_when_negated
+        "expected #{expected_formatted} " \
+          "not to be observed " \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def actual_changes_message
+        observations = Yabeda::TestAdapter.instance.summaries.fetch(metric)
+        if observations.empty?
+          "no observations of this summary have been made"
+        elsif tags && observations.key?(tags)
+          formatted_tags = ::RSpec::Support::ObjectFormatter.format(tags)
+          "has been observed with #{observations.fetch(tags)} with tags #{formatted_tags}"
+        else
+          "following observations have been made: #{::RSpec::Support::ObjectFormatter.format(observations)}"
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/rspec/update_yabeda_gauge.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "base_matcher"
+
+module Yabeda
+  module RSpec
+    # Checks whether Yabeda gauge was set to some value during test run or not
+    # @param metric [Yabeda::Gauge,String,Symbol] metric instance or name
+    # @return [Yabeda::RSpec::UpdateYabedaGauge]
+    def update_yabeda_gauge(metric)
+      UpdateYabedaGauge.new(metric)
+    end
+
+    # Custom matcher class with implementation for +update_yabeda_gauge+
+    class UpdateYabedaGauge < BaseMatcher
+      def with(value)
+        @expected_value = value
+        self
+      end
+
+      attr_reader :expected_value
+
+      def initialize(*)
+        super
+        return if metric.is_a? Yabeda::Gauge
+
+        raise ArgumentError, "Pass gauge instance/name to `update_yabeda_gauge`. Got #{metric.inspect} instead"
+      end
+
+      def match(metric, block)
+        block.call
+
+        updates = filter_matching_changes(Yabeda::TestAdapter.instance.gauges.fetch(metric))
+
+        updates.values.any? { |update| expected_value.nil? || values_match?(expected_value, update) }
+      end
+
+      def match_when_negated(metric, block)
+        unless expected_value.nil?
+          raise NotImplementedError, <<~MSG
+            `expect(Yabeda.metric_name).not_to update_yabeda_gauge` doesn't support specifying values with `.with`
+            as it can lead to false positives.
+          MSG
+        end
+
+        block.call
+
+        updates = filter_matching_changes(Yabeda::TestAdapter.instance.gauges.fetch(metric))
+
+        updates.none?
+      end
+
+      def failure_message
+        "expected #{expected_formatted} " \
+          "to be changed #{"to #{expected_value} " unless expected_value.nil?}" \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def failure_message_when_negated
+        "expected #{expected_formatted} " \
+          "not to be changed " \
+          "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+          "but #{actual_changes_message}"
+      end
+
+      def actual_changes_message
+        updates = Yabeda::TestAdapter.instance.gauges.fetch(metric)
+        if updates.empty?
+          "no changes of this gauge have been made"
+        elsif tags && updates.key?(tags)
+          "has been changed to #{updates.fetch(tags)} with tags #{::RSpec::Support::ObjectFormatter.format(tags)}"
+        else
+          "following changes have been made: #{::RSpec::Support::ObjectFormatter.format(updates)}"
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/rspec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "testing"
+
+module Yabeda
+  # RSpec integration for Yabeda: custom matchers, etc
+  module RSpec
+  end
+end
+
+require_relative "rspec/increment_yabeda_counter"
+require_relative "rspec/update_yabeda_gauge"
+require_relative "rspec/measure_yabeda_histogram"
+require_relative "rspec/observe_yabeda_summary"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Yabeda.configure! unless Yabeda.already_configured?
+  end
+
+  config.after(:each) do
+    Yabeda::TestAdapter.instance.reset!
+  end
+
+  config.include(Yabeda::RSpec)
+end

data/lib/yabeda/summary.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yabeda
+  # Base class for complex metric for measuring time values that allow to
+  # calculate averages, percentiles, and so on.
+  class Summary < Metric
+    # rubocop: disable Metrics/MethodLength
+    def observe(tags, value = nil)
+      if value.nil? ^ block_given?
+        raise ArgumentError, "You must provide either numeric value or block for Yabeda::Summary#observe!"
+      end
+
+      if block_given?
+        starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+        value = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - starting)
+      end
+
+      all_tags = ::Yabeda::Tags.build(tags, group)
+      values[all_tags] = value
+      ::Yabeda.adapters.each do |_, adapter|
+        adapter.perform_summary_observe!(self, all_tags, value)
+      end
+      value
+    end
+    # rubocop: enable Metrics/MethodLength
+  end
+end

data/lib/yabeda/test_adapter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+require_relative "base_adapter"
+
+module Yabeda
+  # Fake monitoring system adapter that collects latest metric values for later inspection
+  class TestAdapter < BaseAdapter
+    include Singleton
+
+    attr_reader :counters, :gauges, :histograms, :summaries
+
+    # rubocop:disable Metrics/AbcSize
+    def initialize
+      super
+      @counters   = Hash.new { |ch, ck| ch[ck] = Hash.new { |th, tk| th[tk] = 0 } }
+      @gauges     = Hash.new { |gh, gk| gh[gk] = Hash.new { |th, tk| th[tk] = nil } }
+      @histograms = Hash.new { |hh, hk| hh[hk] = Hash.new { |th, tk| th[tk] = nil } }
+      @summaries  = Hash.new { |sh, sk| sh[sk] = Hash.new { |th, tk| th[tk] = nil } }
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Call this method after every test example to quickly get blank state for the next test example
+    def reset!
+      [@counters, @gauges, @histograms, @summaries].each do |collection|
+        collection.each_value(&:clear) # Reset tag-values hash to be empty
+      end
+    end
+
+    def register_counter!(metric)
+      @counters[metric]
+    end
+
+    def register_gauge!(metric)
+      @gauges[metric]
+    end
+
+    def register_histogram!(metric)
+      @histograms[metric]
+    end
+
+    def register_summary!(metric)
+      @summaries[metric]
+    end
+
+    def perform_counter_increment!(counter, tags, increment)
+      @counters[counter][tags] += increment
+    end
+
+    def perform_gauge_set!(gauge, tags, value)
+      @gauges[gauge][tags] = value
+    end
+
+    def perform_histogram_measure!(histogram, tags, value)
+      @histograms[histogram][tags] = value
+    end
+
+    def perform_summary_observe!(summary, tags, value)
+      @summaries[summary][tags] = value
+    end
+  end
+end

data/lib/yabeda/testing.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Include this file to get things prepared for testing
+
+require_relative "test_adapter"
+
+Yabeda.register_adapter(:test, Yabeda::TestAdapter.instance)

data/lib/yabeda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yabeda
-  VERSION = "0.10.1"
+  VERSION = "0.12.0"
 end

data/lib/yabeda.rb

@@ -86,7 +86,7 @@ module Yabeda
 
     # Perform configuration: registration of metrics and collector blocks
     # @return [void]
-    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
     def configure!
       raise(AlreadyConfiguredError, @configured_by) if already_configured?
 
@@ -129,12 +129,11 @@ module Yabeda
 
       true
     end
-    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
 
     # Forget all the configuration.
     # For testing purposes as it doesn't rollback changes in adapters.
     # @api private
-    # rubocop: disable Metrics/AbcSize
     def reset!
       default_tags.clear
       adapters.clear
@@ -147,6 +146,5 @@ module Yabeda
       instance_variable_set(:@configured_by, nil)
       instance_variable_set(:@debug_was_enabled_by, nil)
     end
-    # rubocop: enable Metrics/AbcSize
   end
 end

data/yabeda.gemspec

@@ -29,9 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "dry-initializer"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "yard-dry-initializer"
+  spec.required_ruby_version = ">= 2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -58,76 +58,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard-dry-initializer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 'Collect statistics about how your application is performing with ease.
   Export metrics to various monitoring systems.
 
@@ -139,6 +69,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-release.yml"
+- ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -166,7 +97,16 @@ files:
 - lib/yabeda/histogram.rb
 - lib/yabeda/metric.rb
 - lib/yabeda/railtie.rb
+- lib/yabeda/rspec.rb
+- lib/yabeda/rspec/base_matcher.rb
+- lib/yabeda/rspec/increment_yabeda_counter.rb
+- lib/yabeda/rspec/measure_yabeda_histogram.rb
+- lib/yabeda/rspec/observe_yabeda_summary.rb
+- lib/yabeda/rspec/update_yabeda_gauge.rb
+- lib/yabeda/summary.rb
 - lib/yabeda/tags.rb
+- lib/yabeda/test_adapter.rb
+- lib/yabeda/testing.rb
 - lib/yabeda/version.rb
 - yabeda-logo.png
 - yabeda.gemspec
@@ -182,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="