chore: Implement shared RuboCop configuration (#1587)

Mostly all gems and folders contains the same `.rubocop.yml` config file. It requires mostly to touch and verify 36 files for changes. Extract common cops and settings of rubocop to `contrib/rubocop.yml` and update all other to use it. Most common Cops put in the file and remove duplications. In an effort to streamline maintenance, a common configuration file, `contrib/rubocop.yml`, has been introduced. The majority of gems and folders previously relied on individual `.rubocop.yml` files, leading to redundancy. This change involves consolidating common Cops and settings in `contrib/rubocop.yml`, thereby reducing the need for modifications across 36 files. This modification enhances consistency and eliminates duplications in the RuboCop configurations. Signed-off-by: Michael Nikitochkin <michael.nikitochkin@gmx.net> Co-authored-by: Matthew Wear <matthew.wear@gmail.com>
open-telemetry · Mar 8, 2024 · bffcb77 · bffcb77
1 parent 94832be
commit bffcb77
Show file tree

Hide file tree

Showing 34 changed files with 85 additions and 339 deletions.
diff --git a/Rakefile b/Rakefile
@@ -21,6 +21,7 @@ namespace :each do
     foreach_gem('bundle exec rake yard')
   end
 
+  desc "Run rubocop in each gem"
   task :rubocop do
     foreach_gem('bundle exec rake rubocop')
   end

diff --git a/api/.rubocop.yml b/api/.rubocop.yml
@@ -1,28 +1,7 @@
-AllCops:
-  TargetRubyVersion: "3.0"
+inherit_from: ../contrib/rubocop.yml
 
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 20
-Metrics/ParameterLists:
-  Enabled: false
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-api.rb"
-Lint/MissingSuper:
-  Enabled: false
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "test/**/*"
-Style/StringConcatenation:
-  Exclude:
-    - "test/**/*"
-Style/ModuleFunction:
-  Enabled: false
 Style/ExplicitBlockArgument:
   Enabled: false
diff --git a/api/lib/opentelemetry/trace/trace_flags.rb b/api/lib/opentelemetry/trace/trace_flags.rb
@@ -18,7 +18,7 @@ class << self
         # @param [Integer] flags 8-bit byte of bit flags
         # @return [TraceFlags]
         def from_byte(flags)
-          flags = 0 unless flags & ~0xFF == 0 # rubocop:disable Style/NumericPredicate
+          flags = 0 unless flags & ~0xFF == 0
 
           new(flags)
         end

diff --git a/common/.rubocop.yml b/common/.rubocop.yml
@@ -1,34 +1,11 @@
-AllCops:
-  TargetRubyVersion: '3.0'
-  NewCops: disable
-  SuggestExtensions: false
+inherit_from: ../contrib/rubocop.yml
 
 Bundler/OrderedGems:
   Exclude:
     - gemfiles/**/*
-Lint/UnusedMethodArgument:
-  Enabled: false
-Lint/MissingSuper:
-  Enabled: false
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "test/**/*"
-Style/StringConcatenation:
-  Exclude:
-    - "test/**/*"
-Metrics/AbcSize:
-  Enabled: false
-Layout/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 20
-Metrics/ParameterLists:
-  Enabled: false
 Style/FrozenStringLiteralComment:
   Exclude:
     - gemfiles/**/*
-Style/ModuleFunction:
-  Enabled: false
 Style/StringLiterals:
   Exclude:
     - gemfiles/**/*

diff --git a/contrib/rubocop.yml b/contrib/rubocop.yml
@@ -0,0 +1,32 @@
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: "3.0"
+  Exclude:
+    - "vendor/**/*"
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "test/**/*"
+Lint/MissingSuper:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 21
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/StringConcatenation:
+  Exclude:
+    - "test/**/*"
diff --git a/exporter/jaeger/.rubocop.yml b/exporter/jaeger/.rubocop.yml
@@ -1,37 +1,16 @@
+inherit_from: ../../contrib/rubocop.yml
+
 AllCops:
-  TargetRubyVersion: "3.0"
-  NewCops: disable
-  SuggestExtensions: false
   Exclude:
     - "thrift/**/*"
     - "vendor/**/*"
 
 Bundler/OrderedGems:
   Exclude:
     - gemfiles/**/*
-Lint/UnusedMethodArgument:
-  Enabled: false
-Lint/MissingSuper:
-  Enabled: false
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "test/**/*"
-Style/StringConcatenation:
-  Exclude:
-    - "test/**/*"
-Metrics/AbcSize:
-  Enabled: false
-Layout/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 20
-Metrics/ParameterLists:
-  Enabled: false
 Style/FrozenStringLiteralComment:
   Exclude:
     - gemfiles/**/*
-Style/ModuleFunction:
-  Enabled: false
 Style/StringLiterals:
   Exclude:
     - gemfiles/**/*

diff --git a/exporter/otlp-common/.rubocop.yml b/exporter/otlp-common/.rubocop.yml
@@ -1,25 +1,17 @@
+inherit_from: ../../contrib/rubocop.yml
+
 AllCops:
-  TargetRubyVersion: "3.0"
   Exclude:
     - "lib/opentelemetry/proto/**/*"
     - "vendor/**/*"
 
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
+Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
+
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-exporter-otlp-common.rb"
-Style/ModuleFunction:
-  Enabled: false
diff --git a/exporter/otlp-common/test/.rubocop.yml b/exporter/otlp-common/test/.rubocop.yml
@@ -1,8 +1,4 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/AbcSize:
-  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
diff --git a/exporter/otlp-grpc/.rubocop.yml b/exporter/otlp-grpc/.rubocop.yml
@@ -1,18 +1,5 @@
-AllCops:
-  TargetRubyVersion: "3.0"
+inherit_from: ../../contrib/rubocop.yml
 
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 21
-Metrics/ParameterLists:
-  Enabled: false
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-exporter-otlp-grpc.rb"
-Style/ModuleFunction:
-  Enabled: false
diff --git a/exporter/otlp-grpc/test/.rubocop.yml b/exporter/otlp-grpc/test/.rubocop.yml
@@ -1,11 +1,7 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/AbcSize:
-  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'opentelemetry/exporter/otlp/grpc/exporter_test.rb'

diff --git a/exporter/otlp-http/.rubocop.yml b/exporter/otlp-http/.rubocop.yml
@@ -1,25 +1,14 @@
+inherit_from: ../../contrib/rubocop.yml
+
 AllCops:
-  TargetRubyVersion: "3.0"
   Exclude:
     - "lib/opentelemetry/proto/**/*"
     - "vendor/**/*"
 
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 21
-Metrics/ParameterLists:
-  Enabled: false
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-exporter-otlp-http.rb"
-Style/ModuleFunction:
-  Enabled: false
diff --git a/exporter/otlp-http/test/.rubocop.yml b/exporter/otlp-http/test/.rubocop.yml
@@ -1,11 +1,7 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/AbcSize:
-  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'opentelemetry/exporter/otlp/http/exporter_test.rb'

diff --git a/exporter/otlp/.rubocop.yml b/exporter/otlp/.rubocop.yml
@@ -1,32 +1,13 @@
+inherit_from: ../../contrib/rubocop.yml
+
 AllCops:
-  TargetRubyVersion: "3.0"
-  NewCops: disable
-  SuggestExtensions: false
   Exclude:
     - "lib/opentelemetry/proto/**/*"
     - "vendor/**/*"
 
 Bundler/OrderedGems:
   Exclude:
     - gemfiles/**/*
-Lint/UnusedMethodArgument:
-  Enabled: false
-Lint/MissingSuper:
-  Enabled: false
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "test/**/*"
-Style/StringConcatenation:
-  Exclude:
-    - "test/**/*"
-Metrics/AbcSize:
-  Enabled: false
-Layout/LineLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 20
-Metrics/ParameterLists:
-  Enabled: false
 Style/FrozenStringLiteralComment:
   Exclude:
     - gemfiles/**/*

diff --git a/exporter/otlp/lib/opentelemetry/exporter/otlp/exporter.rb b/exporter/otlp/lib/opentelemetry/exporter/otlp/exporter.rb
@@ -244,7 +244,7 @@ def measure_request_duration
           end
         end
 
-        def backoff?(retry_count:, reason:, retry_after: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        def backoff?(retry_count:, reason:, retry_after: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => reason })
           return false if retry_count > RETRY_COUNT
 

diff --git a/exporter/zipkin/.rubocop.yml b/exporter/zipkin/.rubocop.yml
@@ -1,17 +1,12 @@
-inherit_from: .rubocop_todo.yml
+inherit_from:
+  - ../../contrib/rubocop.yml
+  - .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: "3.0"
   Exclude:
     - "thrift/**/*"
     - "vendor/**/*"
 
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Metrics/ModuleLength:
   Max: 130
 Metrics/MethodLength:
@@ -20,12 +15,8 @@ Metrics/PerceivedComplexity:
   Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-exporter-zipkin.rb"
 Style/ExplicitBlockArgument:
   Enabled: false
-Style/ModuleFunction:
-  Enabled: false
diff --git a/exporter/zipkin/test/.rubocop.yml b/exporter/zipkin/test/.rubocop.yml
@@ -1,8 +1,4 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/AbcSize:
-  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
diff --git a/logs_api/.rubocop.yml b/logs_api/.rubocop.yml
@@ -1,24 +1,12 @@
-# inherit_from: .rubocop_todo.yml
+inherit_from: ../contrib/rubocop.yml
 
-AllCops:
-  TargetRubyVersion: '3.0'
-
-Lint/UnusedMethodArgument:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Metrics/MethodLength:
   Max: 50
 Metrics/PerceivedComplexity:
   Max: 30
 Metrics/CyclomaticComplexity:
   Max: 20
-Metrics/ParameterLists:
-  Enabled: false
+
 Naming/FileName:
   Exclude:
     - "lib/opentelemetry-logs-api.rb"
-Style/ModuleFunction:
-  Enabled: false
diff --git a/logs_api/test/.rubocop.yml b/logs_api/test/.rubocop.yml
@@ -1,8 +1,9 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/BlockLength:
-  Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false