Merge pull request #154 from maxmind/horgh/plugins

Enable additional rubocop plugins

Author: oschwald

.rubocop.yml

@@ -1,3 +1,9 @@
+plugins:
+    - rubocop-performance
+    - rubocop-rake
+    - rubocop-rspec
+    - rubocop-thread_safety
+
 AllCops:
     TargetRubyVersion: '3.2'
     NewCops: enable
@@ -88,3 +94,20 @@ Naming/VariableNumber:
 
 Gemspec/DevelopmentDependencies:
   Enabled: false
+
+# This might make sense, but I don't think it's worth moving things around for.
+RSpec/SpecFilePathFormat:
+  Enabled: false
+# Sometimes it makes sense to have lots of assertions.
+RSpec/MultipleExpectations:
+  Enabled: false
+# Sometimes it makes sense to have long tests.
+RSpec/ExampleLength:
+  Enabled: false
+# This seems okay.
+RSpec/MultipleDescribes:
+  Enabled: false
+# This seems to give a bunch of false positives. Specifically it's flagging
+# things where we are creating an object and checking no exception happens.
+RSpec/NoExpectationExample:
+  Enabled: false

Rakefile

@@ -8,5 +8,5 @@ RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new
 
-task default: :spec
-task default: :rubocop
+desc 'Run tests and RuboCop'
+task default: %i[spec rubocop]

lib/minfraud.rb

@@ -32,6 +32,9 @@
 # for the gem's classes.
 module Minfraud
   class << self
+    # rubocop:disable ThreadSafety/ClassAndModuleAttributes
+    # This is a false positive - these configuration attributes are set during initialization
+
     # The MaxMind account ID that is used for authorization.
     #
     # @return [Integer, nil]
@@ -57,6 +60,8 @@ class << self
     # @return [String, nil]
     attr_accessor :license_key
 
+    # rubocop:enable ThreadSafety/ClassAndModuleAttributes
+
     # @!visibility private
     attr_reader :connection_pool
 
@@ -67,19 +72,25 @@ def configure
       yield self
 
       pool_size        = 5
+      # rubocop:disable ThreadSafety/ClassInstanceVariable
+      # This is a false positive - this configuration is set during initialization
       host             = @host.nil? ? 'minfraud.maxmind.com' : @host
       @connection_pool = ConnectionPool.new(size: pool_size) do
+        # rubocop:enable ThreadSafety/ClassInstanceVariable
         make_http_client.persistent("https://#{host}")
       end
     end
 
     private
 
     def make_http_client
+      # rubocop:disable ThreadSafety/ClassInstanceVariable
+      # This is a false positive - this configuration is set during initialization
       HTTP.basic_auth(
         user: @account_id,
         pass: @license_key,
       ).headers(
+        # rubocop:enable ThreadSafety/ClassInstanceVariable
         accept:     'application/json',
         user_agent: "minfraud-api-ruby/#{Minfraud::VERSION} ruby/#{RUBY_VERSION} http/#{HTTP::VERSION}",
       )

lib/minfraud/components/email.rb

@@ -99,7 +99,7 @@ def clean_email_address(address)
         end
 
         if domain == 'gmail.com'
-          local_part.gsub!('.', '')
+          local_part.delete!('.')
         end
 
         domain_parts = domain.split('.')

lib/minfraud/components/report/transaction.rb

@@ -103,7 +103,7 @@ def validate
         end
 
         def empty_uuid?(value)
-          stripped_value = value.to_s.gsub('-', '')
+          stripped_value = value.to_s.delete('-')
           stripped_value == '0' * 32
         end
       end

lib/minfraud/components/shopping_cart.rb

@@ -17,7 +17,7 @@ class ShoppingCart < Base
       #   to an item's field, or as a Minfraud:::Components::ShoppingCartItem
       #   object.
       def initialize(params = [])
-        @items = params.map(&method(:resolve))
+        @items = params.map { |param| resolve(param) }
       end
 
       # A JSON representation of Minfraud::Components::ShoppingCart items.

lib/minfraud/enum.rb

@@ -15,7 +15,10 @@ module ClassMethods
       #
       # @return [Hash]
       def mapping
+        # rubocop:disable ThreadSafety/ClassInstanceVariable
+        # This is a false positive - this is set during class definition and then only read
         @mapping ||= {}
+        # rubocop:enable ThreadSafety/ClassInstanceVariable
       end
 
       # Create a set of methods for enum-like behavior of the attribute.

lib/minfraud/validates.rb

@@ -27,7 +27,7 @@ def validate_md5(field, value)
     def validate_uuid(field, value)
       return if !value
 
-      stripped_value = value.to_s.gsub('-', '')
+      stripped_value = value.to_s.delete('-')
 
       # Define a regex pattern for a valid UUID without dashes
       uuid_regex = /\A[0-9a-f]{32}\z/i
@@ -78,7 +78,7 @@ def validate_credit_card_token(field, value)
         raise InvalidInputError, "The #{field} value is not valid. It must contain only non-space printable ASCII characters."
       end
 
-      if /\A[0-9]{1,19}\z/.match(s)
+      if /\A[0-9]{1,19}\z/.match?(s)
         raise InvalidInputError, "The #{field} value is not valid. If it is all digits, it must be longer than 19 characters."
       end
     end
@@ -147,7 +147,7 @@ def validate_nonnegative_integer(field, value)
     def validate_email(field, value)
       return if !value
 
-      if /.@./.match(value)
+      if /.@./.match?(value)
         validate_string(field, 255, value)
         return
       end

minfraud.gemspec

@@ -31,6 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 1.23'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-thread_safety'
   spec.add_development_dependency 'webmock', '~> 3.14'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'

spec/assessments_spec.rb

@@ -3,22 +3,23 @@
 require 'spec_helper'
 
 describe Minfraud::Assessments do
-  let(:resolver)      { double(Minfraud::Resolver) }
-  subject             { described_class.new({}, resolver) }
+  subject(:assessment) { described_class.new({}, resolver) }
+
+  let(:resolver)       { class_double(Minfraud::Resolver) }
 
   before { allow(resolver).to receive(:assign) }
 
   %w[account billing credit_card custom_inputs device email event order payment shipping shopping_cart].each do |attribute|
     it "responds_to #{attribute}" do
-      expect(subject).to respond_to(attribute)
+      expect(assessment).to respond_to(attribute)
     end
   end
 
   describe '#initialize' do
     it { is_expected.to be_an_instance_of described_class }
 
     it 'calls resolver for components assignment' do
-      expect(resolver).to have_received(:assign).with(subject, {})
+      expect(resolver).to have_received(:assign).with(assessment, {})
     end
   end
 
@@ -63,7 +64,7 @@
       ]
 
       tests.each do |i|
-        assessment = Minfraud::Assessments.new(
+        assessment = described_class.new(
           email: i[:email],
         )
         body       = assessment.send :request_body