Upgrade Rubocop and move it to separate CI job

yabeda-rb · Jul 27, 2023 · 5456049 · 5456049
1 parent 717b515
commit 5456049
Show file tree

Hide file tree

Showing 21 changed files with 98 additions and 61 deletions.
diff --git a/.github/workflows/lint.yml b/.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
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -38,7 +38,5 @@ jobs:
  bundle config path vendor/bundle
  bundle install
  bundle update
- - name: Run Rubocop
- run: bundle exec rubocop
  - name: Run RSpec
  run: bundle exec rspec
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -10,6 +10,9 @@ Metrics/BlockLength:
  - "Gemfile"
  - "spec/**/*"
 
+Metrics/AbcSize:
+ Max: 25
+
 Layout/LineLength:
  Max: 120
 
@@ -29,6 +32,9 @@ RSpec/DescribeClass:
 RSpec/NestedGroups:
  Max: 4
 
+RSpec/MultipleMemoizedHelpers:
+ Enabled: false
+
 Bundler/OrderedGems:
  Enabled: false
 

diff --git a/Gemfile b/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
diff --git a/lib/yabeda.rb b/lib/yabeda.rb
@@ -86,7 +86,7 @@ def configured?
 
  # 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 @@ def debug!
 
  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 @@ def reset!
  instance_variable_set(:@configured_by, nil)
  instance_variable_set(:@debug_was_enabled_by, nil)
  end
- # rubocop: enable Metrics/AbcSize
  end
 end
diff --git a/lib/yabeda/global_group.rb b/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

diff --git a/lib/yabeda/rspec.rb b/lib/yabeda/rspec.rb
@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative "./testing"
+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/increment_yabeda_counter"
+require_relative "rspec/update_yabeda_gauge"
+require_relative "rspec/measure_yabeda_histogram"
 
-::RSpec.configure do |config|
+RSpec.configure do |config|
  config.before(:suite) do
  Yabeda.configure! unless Yabeda.already_configured?
  end

diff --git a/lib/yabeda/rspec/base_matcher.rb b/lib/yabeda/rspec/base_matcher.rb
@@ -17,6 +17,7 @@ def with_tags(tags)
  end
 
  def initialize(expected)
+ super
  @expected = @metric = resolve_metric(expected)
  rescue KeyError
  raise ArgumentError, <<~MSG

diff --git a/lib/yabeda/rspec/increment_yabeda_counter.rb b/lib/yabeda/rspec/increment_yabeda_counter.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base_matcher"
+require_relative "base_matcher"
 
 module Yabeda
  module RSpec
@@ -54,16 +54,16 @@ def match_when_negated(metric, block)
 
  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}"
+  "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}"
+  "not to be incremented " \
+  "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+  "but #{actual_increments_message}"
  end
 
  def actual_increments_message

diff --git a/lib/yabeda/rspec/measure_yabeda_histogram.rb b/lib/yabeda/rspec/measure_yabeda_histogram.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base_matcher"
+require_relative "base_matcher"
 
 module Yabeda
  module RSpec
@@ -52,16 +52,16 @@ def match_when_negated(metric, block)
 
  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}"
+  "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}"
+  "not to be incremented " \
+  "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+  "but #{actual_changes_message}"
  end
 
  def actual_changes_message

diff --git a/lib/yabeda/rspec/update_yabeda_gauge.rb b/lib/yabeda/rspec/update_yabeda_gauge.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base_matcher"
+require_relative "base_matcher"
 
 module Yabeda
  module RSpec
@@ -52,16 +52,16 @@ def match_when_negated(metric, block)
 
  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}"
+  "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}"
+  "not to be changed " \
+  "#{"with tags #{::RSpec::Support::ObjectFormatter.format(tags)} " if tags}" \
+  "but #{actual_changes_message}"
  end
 
  def actual_changes_message

diff --git a/lib/yabeda/test_adapter.rb b/lib/yabeda/test_adapter.rb
@@ -2,7 +2,7 @@
 
 require "singleton"
 
-require_relative "./base_adapter"
+require_relative "base_adapter"
 
 module Yabeda
  # Fake monitoring system adapter that collects latest metric values for later inspection
@@ -12,6 +12,7 @@ class TestAdapter < BaseAdapter
  attr_reader :counters, :gauges, :histograms
 
  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 } }

diff --git a/lib/yabeda/testing.rb b/lib/yabeda/testing.rb
@@ -2,6 +2,6 @@
 
 # Include this file to get things prepared for testing
 
-require_relative "./test_adapter"
+require_relative "test_adapter"
 
 Yabeda.register_adapter(:test, Yabeda::TestAdapter.instance)
diff --git a/spec/yabeda/counter_spec.rb b/spec/yabeda/counter_spec.rb
@@ -5,17 +5,17 @@
 
  let(:tags) { { foo: "bar" } }
  let(:metric_value) { 10 }
- let(:counter) { ::Yabeda.test_counter }
+ let(:counter) { Yabeda.test_counter }
  let(:built_tags) { { built_foo: "built_bar" } }
- let(:adapter) { instance_double("Yabeda::BaseAdapter", perform_counter_increment!: true, register!: true) }
+ let(:adapter) { instance_double(Yabeda::BaseAdapter, perform_counter_increment!: true, register!: true) }
 
  before do
- ::Yabeda.configure do
+ Yabeda.configure do
  counter :test_counter
  end
  Yabeda.configure! unless Yabeda.already_configured?
  allow(Yabeda::Tags).to receive(:build).with(tags, anything).and_return(built_tags)
- ::Yabeda.register_adapter(:test_adapter, adapter)
+ Yabeda.register_adapter(:test_adapter, adapter)
  end
 
  it { expect(increment_counter).to eq(metric_value) }

diff --git a/spec/yabeda/gauge_spec.rb b/spec/yabeda/gauge_spec.rb
@@ -5,17 +5,17 @@
 
  let(:tags) { { foo: "bar" } }
  let(:metric_value) { 10 }
- let(:gauge) { ::Yabeda.test_gauge }
+ let(:gauge) { Yabeda.test_gauge }
  let(:built_tags) { { built_foo: "built_bar" } }
- let(:adapter) { instance_double("Yabeda::BaseAdapter", perform_gauge_set!: true, register!: true) }
+ let(:adapter) { instance_double(Yabeda::BaseAdapter, perform_gauge_set!: true, register!: true) }
 
  before do
- ::Yabeda.configure do
+ Yabeda.configure do
  gauge :test_gauge
  end
  Yabeda.configure! unless Yabeda.already_configured?
  allow(Yabeda::Tags).to receive(:build).with(tags, anything).and_return(built_tags)
- ::Yabeda.register_adapter(:test_adapter, adapter)
+ Yabeda.register_adapter(:test_adapter, adapter)
  end
 
  it { expect(set_gauge).to eq(metric_value) }

diff --git a/spec/yabeda/histogram_spec.rb b/spec/yabeda/histogram_spec.rb
@@ -6,17 +6,17 @@
  let(:tags) { { foo: "bar" } }
  let(:metric_value) { 10 }
  let(:block) { proc { 1 + 1 } }
- let(:histogram) { ::Yabeda.test_histogram }
+ let(:histogram) { Yabeda.test_histogram }
  let(:built_tags) { { built_foo: "built_bar" } }
- let(:adapter) { instance_double("Yabeda::BaseAdapter", perform_histogram_measure!: true, register!: true) }
+ let(:adapter) { instance_double(Yabeda::BaseAdapter, perform_histogram_measure!: true, register!: true) }
 
  before do
- ::Yabeda.configure do
+ Yabeda.configure do
  histogram :test_histogram, buckets: [1, 10, 100]
  end
  Yabeda.configure! unless Yabeda.already_configured?
  allow(Yabeda::Tags).to receive(:build).with(tags, anything).and_return(built_tags)
- ::Yabeda.register_adapter(:test_adapter, adapter)
+ Yabeda.register_adapter(:test_adapter, adapter)
  end
 
  context "with value given" do

diff --git a/spec/yabeda/rspec/increment_yabeda_counter_spec.rb b/spec/yabeda/rspec/increment_yabeda_counter_spec.rb
@@ -5,7 +5,7 @@
 RSpec.describe "Yabeda RSpec matchers" do
  before do
  Yabeda.reset!
- ::Yabeda.configure do
+ Yabeda.configure do
  counter :test_counter
  counter :other_counter
  end

diff --git a/spec/yabeda/rspec/measure_yabeda_histogram_spec.rb b/spec/yabeda/rspec/measure_yabeda_histogram_spec.rb
@@ -5,7 +5,7 @@
 RSpec.describe "Yabeda RSpec matchers" do
  before do
  Yabeda.reset!
- ::Yabeda.configure do
+ Yabeda.configure do
  histogram :test_histogram, buckets: [1, 10, 100]
  histogram :other_histogram, buckets: [1, 10, 100]
  end

diff --git a/spec/yabeda/rspec/update_yabeda_gauge_spec.rb b/spec/yabeda/rspec/update_yabeda_gauge_spec.rb
@@ -5,7 +5,7 @@
 RSpec.describe "Yabeda RSpec matchers" do
  before do
  Yabeda.reset!
- ::Yabeda.configure do
+ Yabeda.configure do
  gauge :test_gauge
  gauge :other_gauge
  end