chore: Update rubocop on multiple items to 1.3.x (#1367)

scotthain · web-flow · commit 7123346f9bdb · 2022-09-06T10:18:30.000-05:00
* Update rubocop on common to 1.3.x

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* Update registry to rubocop 1.3.x

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* Update jaeger exporter to rubocop 1.3.x

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* Update otlp exporter to rubocop 1.3.x

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* In looking at the PR this change adds too much risk so I'm disabling it

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* In looking at the PR this rubocop suggestion adds too much of an unknown for me to be comfortable with, so I'm disabling it

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

* Don't wrap cop, add it to the end

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;

Signed-off-by: Scott Hain &lt;elejia@gmail.com&gt;
diff --git a/common/.rubocop.yml b/common/.rubocop.yml
@@ -1,14 +1,24 @@
 AllCops:
   TargetRubyVersion: '2.6.0'
+  NewCops: disable
+  SuggestExtensions: false
 
 Bundler/OrderedGems:
   Exclude:
     - gemfiles/**/*
 Lint/UnusedMethodArgument:
   Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "test/**/*"
+Style/StringConcatenation:
+  Exclude:
+    - "test/**/*"
 Metrics/AbcSize:
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
   Max: 20
diff --git a/common/lib/opentelemetry/common/propagation/rack_env_getter.rb b/common/lib/opentelemetry/common/propagation/rack_env_getter.rb
@@ -29,15 +29,15 @@ def keys(carrier)
         private
 
         def to_rack_key(key)
-          ret = 'HTTP_' + key
+          ret = "HTTP_#{key}"
           ret.tr!('-', '_')
           ret.upcase!
           ret
         end
 
         def from_rack_key(key)
           start = key.start_with?('HTTP_') ? 5 : 0
-          ret = key[start..-1]
+          ret = key[start..]
           ret.tr!('_', '-')
           ret.downcase!
           ret
diff --git a/common/lib/opentelemetry/common/utilities.rb b/common/lib/opentelemetry/common/utilities.rb
@@ -84,7 +84,7 @@ def truncate_attribute_value(value, limit)
       end
 
       def untraced
-        OpenTelemetry::Trace.with_span(OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new)) { yield }
+        OpenTelemetry::Trace.with_span(OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new)) { yield } # rubocop:disable Style/ExplicitBlockArgument
       end
 
       # Returns a URL string with userinfo removed.
diff --git a/common/opentelemetry-common.gemspec b/common/opentelemetry-common.gemspec
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'opentelemetry-test-helpers'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.73.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-doctest', '~> 0.1.6'
diff --git a/exporter/jaeger/.rubocop.yml b/exporter/jaeger/.rubocop.yml
@@ -1,21 +1,42 @@
 AllCops:
   TargetRubyVersion: "2.6.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
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
-  Max: 21
+  Max: 20
 Metrics/ParameterLists:
   Enabled: false
-Naming/FileName:
+Style/FrozenStringLiteralComment:
   Exclude:
-    - "lib/opentelemetry-exporter-jaeger.rb"
+    - gemfiles/**/*
 Style/ModuleFunction:
   Enabled: false
+Style/StringLiterals:
+  Exclude:
+    - gemfiles/**/*
+Metrics/BlockLength:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - "lib/opentelemetry-exporter-jaeger.rb"
diff --git a/exporter/jaeger/lib/opentelemetry/exporter/jaeger.rb b/exporter/jaeger/lib/opentelemetry/exporter/jaeger.rb
@@ -18,7 +18,7 @@ module Jaeger
   end
 end
 
-$LOAD_PATH.push(File.dirname(__FILE__) + '/../../../thrift/gen-rb')
+$LOAD_PATH.push("#{File.dirname(__FILE__)}/../../../thrift/gen-rb")
 
 require 'agent'
 require 'collector'
diff --git a/exporter/jaeger/lib/opentelemetry/exporter/jaeger/encoder.rb b/exporter/jaeger/lib/opentelemetry/exporter/jaeger/encoder.rb
@@ -64,7 +64,7 @@ def encoded_tag(key, value)
           )
         end
 
-        def encoded_span(span_data) # rubocop:disable Metrics/MethodLength
+        def encoded_span(span_data) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
           start_time = span_data.start_timestamp / 1_000
           duration = span_data.end_timestamp / 1_000 - start_time
 
diff --git a/exporter/jaeger/opentelemetry-exporter-jaeger.gemspec b/exporter/jaeger/opentelemetry-exporter-jaeger.gemspec
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'opentelemetry-test-helpers'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec-mocks'
-  spec.add_development_dependency 'rubocop', '~> 0.73.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'webmock', '~> 3.7.6'
   spec.add_development_dependency 'yard', '~> 0.9'
diff --git a/exporter/jaeger/test/.rubocop.yml b/exporter/jaeger/test/.rubocop.yml
@@ -4,5 +4,5 @@ Metrics/AbcSize:
   Max: 18
 Metrics/BlockLength:
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
diff --git a/exporter/otlp/.rubocop.yml b/exporter/otlp/.rubocop.yml
@@ -1,21 +1,42 @@
 AllCops:
   TargetRubyVersion: "2.6.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
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
-  Max: 21
+  Max: 20
 Metrics/ParameterLists:
   Enabled: false
-Naming/FileName:
+Style/FrozenStringLiteralComment:
   Exclude:
-    - "lib/opentelemetry-exporter-otlp.rb"
+    - gemfiles/**/*
 Style/ModuleFunction:
   Enabled: false
+Style/StringLiterals:
+  Exclude:
+    - gemfiles/**/*
+Metrics/BlockLength:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - "lib/opentelemetry-exporter-otlp.rb"
diff --git a/exporter/otlp/lib/opentelemetry/exporter/otlp/exporter.rb b/exporter/otlp/lib/opentelemetry/exporter/otlp/exporter.rb
@@ -45,7 +45,7 @@ def self.ssl_verify_mode
           end
         end
 
-        def initialize(endpoint: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'http://localhost:4318/v1/traces'), # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def initialize(endpoint: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'http://localhost:4318/v1/traces'), # rubocop:disable Metrics/CyclomaticComplexity
                        certificate_file: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
                        ssl_verify_mode: Exporter.ssl_verify_mode,
                        headers: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS', default: {}),
@@ -128,7 +128,7 @@ def http_connection(uri, ssl_verify_mode, certificate_file)
         # and override this method's behaviour to explicitly trace the HTTP request.
         # This would allow you to trace your export pipeline.
         def around_request
-          OpenTelemetry::Common::Utilities.untraced { yield }
+          OpenTelemetry::Common::Utilities.untraced { yield } # rubocop:disable Style/ExplicitBlockArgument
         end
 
         def send_bytes(bytes, timeout:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
@@ -152,7 +152,7 @@ def send_bytes(bytes, timeout:) # rubocop:disable Metrics/CyclomaticComplexity,
           timeout ||= @timeout
           start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
 
-          around_request do # rubocop:disable Metrics/BlockLength
+          around_request do
             remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
             return FAILURE if remaining_timeout.zero?
 
@@ -248,7 +248,7 @@ def measure_request_duration
           end
         end
 
-        def backoff?(retry_after: nil, retry_count:, reason:)
+        def backoff?(retry_count:, reason:, retry_after: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
           @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => reason })
           return false if retry_count > RETRY_COUNT
 
@@ -274,7 +274,7 @@ def backoff?(retry_after: nil, retry_count:, reason:)
           true
         end
 
-        def encode(span_data) # rubocop:disable Metrics/MethodLength
+        def encode(span_data) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
           Opentelemetry::Proto::Collector::Trace::V1::ExportTraceServiceRequest.encode(
             Opentelemetry::Proto::Collector::Trace::V1::ExportTraceServiceRequest.new(
               resource_spans: span_data
@@ -304,7 +304,7 @@ def encode(span_data) # rubocop:disable Metrics/MethodLength
           nil
         end
 
-        def as_otlp_span(span_data) # rubocop:disable Metrics/MethodLength
+        def as_otlp_span(span_data) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           Opentelemetry::Proto::Trace::V1::Span.new(
             trace_id: span_data.trace_id,
             span_id: span_data.span_id,
diff --git a/exporter/otlp/opentelemetry-exporter-otlp.gemspec b/exporter/otlp/opentelemetry-exporter-otlp.gemspec
@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_dependency 'google-protobuf', '~> 3.19'
   spec.add_dependency 'googleapis-common-protos-types', '~> 1.3'
+  spec.add_dependency 'google-protobuf', '~> 3.19'
   spec.add_dependency 'opentelemetry-api', '~> 1.0'
   spec.add_dependency 'opentelemetry-common', '~> 0.19.6'
   spec.add_dependency 'opentelemetry-sdk', '~> 1.0'
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'opentelemetry-test-helpers'
   spec.add_development_dependency 'pry-byebug' unless RUBY_ENGINE == 'jruby'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.73.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'webmock', '~> 3.7.6'
   spec.add_development_dependency 'yard', '~> 0.9'
diff --git a/exporter/otlp/test/.rubocop.yml b/exporter/otlp/test/.rubocop.yml
@@ -1,11 +1,5 @@
 inherit_from: ../.rubocop.yml
 
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'opentelemetry/exporter/otlp/exporter_test.rb'
diff --git a/registry/.rubocop.yml b/registry/.rubocop.yml
@@ -1,30 +1,41 @@
 AllCops:
   TargetRubyVersion: "2.6.0"
+  NewCops: disable
+  SuggestExtensions: false
 
 Bundler/OrderedGems:
   Exclude:
-    - "**/gemfiles/**/*"
+    - gemfiles/**/*
 Lint/UnusedMethodArgument:
   Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "test/**/*"
+Style/StringConcatenation:
+  Exclude:
+    - "test/**/*"
 Metrics/AbcSize:
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
   Max: 20
-  Exclude:
-    - "**/test/**/*"
 Metrics/ParameterLists:
   Enabled: false
-Naming/FileName:
-  Exclude:
-    - "lib/opentelemetry-registry.rb"
 Style/FrozenStringLiteralComment:
   Exclude:
-    - "**/gemfiles/**/*"
+    - gemfiles/**/*
 Style/ModuleFunction:
   Enabled: false
 Style/StringLiterals:
   Exclude:
     - "**/gemfiles/**/*"
     - "**/example/Gemfile"
+Metrics/BlockLength:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - "lib/opentelemetry-registry.rb"
+
diff --git a/registry/opentelemetry-registry.gemspec b/registry/opentelemetry-registry.gemspec
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec-mocks'
-  spec.add_development_dependency 'rubocop', '~> 0.73.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-doctest', '~> 0.1.6'
diff --git a/registry/test/opentelemetry/instrumentation/registry_test.rb b/registry/test/opentelemetry/instrumentation/registry_test.rb

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ def encoded_tag(key, value)`
`64`	`64`	`)`
`65`	`65`	`end`
`66`	`66`
`67`		`- def encoded_span(span_data) # rubocop:disable Metrics/MethodLength`
	`67`	`+ def encoded_span(span_data) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity`
`68`	`68`	`start_time = span_data.start_timestamp / 1_000`
`69`	`69`	`duration = span_data.end_timestamp / 1_000 - start_time`
`70`	`70`