Fix rubocop config to include .rb files and resolve all offenses

midwire · midwire · commit 906f30c61cb0 · 2026-02-14T12:26:05.000-07:00
Add **/*.rb to rubocop Include list so all source files are inspected.
Fix offenses across the codebase: use Dir.home, safe navigation,
anonymous forwarding, respond_to_missing?, const_get instead of
instance_eval, rename exception param, use $stdout, sort redundant
Dir.glob, and various layout/style fixes. Exclude Metrics/BlockLength
and Style/OpenStructUse for spec files.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,23 +1,24 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.4
 
   # Include gemspec and Rakefile
   Include:
-    - '**/*.gemspec'
-    - '**/*.podspec'
-    - '**/*.jbuilder'
-    - '**/*.rake'
-    - '**/Gemfile'
-    - '**/Rakefile'
-    - '**/Capfile'
-    - '**/Guardfile'
-    - '**/Podfile'
-    - '**/Thorfile'
-    - '**/Vagrantfile'
+    - "**/*.rb"
+    - "**/*.gemspec"
+    - "**/*.podspec"
+    - "**/*.jbuilder"
+    - "**/*.rake"
+    - "**/Gemfile"
+    - "**/Rakefile"
+    - "**/Capfile"
+    - "**/Guardfile"
+    - "**/Podfile"
+    - "**/Thorfile"
+    - "**/Vagrantfile"
   Exclude:
-    - 'vendor/**/*'
-    - 'stubs/**/*'
-    - 'spec/support/shared_contexts/*'
+    - "vendor/**/*"
+    - "stubs/**/*"
+    - "spec/support/shared_contexts/*"
 
   NewCops: enable
 
@@ -51,6 +52,10 @@ Style/DoubleNegation:
 Style/PerlBackrefs:
   Enabled: false
 
+Style/OpenStructUse:
+  Exclude:
+    - "spec/**/*"
+
 ########################################
 # Lint Cops
 
@@ -66,6 +71,10 @@ Security/Eval:
 ########################################
 # Metrics Cops
 
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
 Metrics/MethodLength:
   CountComments: false # count full line comments?
   Max: 30
diff --git a/Rakefile b/Rakefile
@@ -4,7 +4,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'rake'
-Dir['lib/tasks/**/*.rake'].sort.each { |ext| load ext }
+Dir['lib/tasks/**/*.rake'].each { |ext| load ext }
 
 # Install rubygem tasks
 Bundler::GemHelper.install_tasks
diff --git a/lib/etl/common.rb b/lib/etl/common.rb
@@ -16,6 +16,7 @@ def show_me
 def limit(count)
   count = Integer(count || -1)
   return if count == -1
+
   transform do |row|
     @counter ||= 0
     @counter += 1
diff --git a/lib/etl/csv_source.rb b/lib/etl/csv_source.rb
@@ -14,10 +14,10 @@ def initialize(filename:, headers: true, delimeter: "\t", quote_char: '"')
 
   def each
     CSV.open(filename,
-      col_sep: delimeter,
-      headers: headers,
-      header_converters: :symbol,
-      quote_char: quote_char) do |csv|
+             col_sep: delimeter,
+             headers: headers,
+             header_converters: :symbol,
+             quote_char: quote_char) do |csv|
       csv.each do |row|
         yield(row.to_hash)
       end
diff --git a/lib/free_zipcode_data.rb b/lib/free_zipcode_data.rb
@@ -14,16 +14,16 @@ def self.current_environment
     ENV.fetch('APP_ENV', 'development')
   end
 
-  #:nocov:
+  # :nocov:
   def self.config_file(filename = '.free_zipcode_data.yml')
     return root.join('spec', 'fixtures', filename) if current_environment == 'test'
 
-    home = ENV.fetch('HOME')
+    home = Dir.home
     file = ENV.fetch('FZD_CONFIG_FILE', File.join(home, '.free_zipcode_data.yml'))
     FileUtils.touch(file)
     file
   end
-  #:nocov:
+  # :nocov:
 
   def self.os
     if RUBY_PLATFORM.match?(/cygwin|mswin|mingw|bccwin|wince|emx/)
diff --git a/lib/free_zipcode_data/county_table.rb b/lib/free_zipcode_data/county_table.rb
@@ -41,8 +41,8 @@ def write(row)
         database.execute(sql)
       rescue SQLite3::ConstraintException
         # swallow duplicates
-      rescue StandardError => err
-        raise "Please file an issue at #{ISSUE_URL}: [#{err}] -> SQL: [#{sql}]"
+      rescue StandardError => e
+        raise "Please file an issue at #{ISSUE_URL}: [#{e}] -> SQL: [#{sql}]"
       end
 
       update_progress
diff --git a/lib/free_zipcode_data/db_table.rb b/lib/free_zipcode_data/db_table.rb
@@ -8,6 +8,7 @@ class DbTable
     ISSUE_URL = 'https://github.com/midwire/free_zipcode_data/issues/new'
 
     attr_reader :database, :tablename
+
     @@progressbar = nil
 
     def initialize(database:, tablename:)
@@ -33,9 +34,9 @@ def country_lookup_table
 
     def select_first(sql)
       rows = database.execute(sql)
-      rows[0].nil? ? nil : rows[0].first
-    rescue SQLite3::SQLException => err
-      raise "Please file an issue at #{ISSUE_URL}: [#{err}] -> SQL: [#{sql}]"
+      rows[0]&.first
+    rescue SQLite3::SQLException => e
+      raise "Please file an issue at #{ISSUE_URL}: [#{e}] -> SQL: [#{sql}]"
     end
 
     def get_country_id(country)
@@ -51,12 +52,13 @@ def get_state_id(state_abbr, state_name)
 
     def get_county_id(county)
       return nil if county.nil?
+
       sql = "SELECT id FROM counties WHERE name = '#{escape_single_quotes(county)}'"
       select_first(sql)
     end
 
     def escape_single_quotes(string)
-      string&.gsub(/[']/, '\'\'') || ''
+      string&.gsub('\'', '\'\'') || ''
     end
   end
 end
diff --git a/lib/free_zipcode_data/logger.rb b/lib/free_zipcode_data/logger.rb
@@ -13,27 +13,23 @@ def initialize(provider = default_logger)
       @log_provider = provider
     end
 
-    def log_exception(e, data = {})
-      msg = "EXCEPTION : #{e.class.name} : #{e.message}"
+    def log_exception(error, data = {})
+      msg = "EXCEPTION : #{error.class.name} : #{error.message}"
       msg += "\n data : #{data.inspect}" if data && !data.empty?
-      msg += "\n  #{e.backtrace[0, 6].join("\n  ")}"
+      msg += "\n  #{error.backtrace[0, 6].join("\n  ")}"
       log_provider.error(msg)
     end
 
-    def method_missing(meth, *args, &block)
+    def method_missing(meth, *, &)
       if log_provider.respond_to?(meth)
-        log_provider.send(meth, *args, &block)
+        log_provider.send(meth, *, &)
       else
         super
       end
     end
 
-    def respond_to?(meth, include_private = false)
-      if log_provider.respond_to?(meth)
-        true
-      else
-        super
-      end
+    def respond_to_missing?(meth, include_private = false)
+      log_provider.respond_to?(meth) || super
     end
 
     def verbose(msg)
@@ -43,7 +39,7 @@ def verbose(msg)
     private
 
     def default_logger
-      logger = ::Logger.new(STDOUT)
+      logger = ::Logger.new($stdout)
       logger.formatter = proc do |_, _, _, msg|
         "#{msg}\n"
       end
diff --git a/lib/free_zipcode_data/runner.rb b/lib/free_zipcode_data/runner.rb
@@ -58,9 +58,9 @@ def start
     private
 
     def initialize_table(table_sym, database)
-      tablename = options["#{table_sym}_tablename".to_sym]
+      tablename = options[:"#{table_sym}_tablename"]
       logger.verbose("Initializing #{table_sym} table: '#{tablename}'...")
-      klass = instance_eval("#{titleize(table_sym)}Table", __FILE__, __LINE__)
+      klass = FreeZipcodeData.const_get(:"#{titleize(table_sym)}Table")
       table = klass.new(
         database: database.conn,
         tablename: tablename
diff --git a/lib/free_zipcode_data/state_table.rb b/lib/free_zipcode_data/state_table.rb
@@ -30,6 +30,7 @@ def build
 
     def write(row)
       return nil unless row[:short_state]
+
       row[:state] = 'Marshall Islands' if row[:short_state] == 'MH' && row[:state].nil?
       country_id = get_country_id(row[:country])
       sql = <<-SQL
diff --git a/lib/free_zipcode_data/version.rb b/lib/free_zipcode_data/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FreeZipcodeData
-  VERSION = '1.0.6'.freeze
+  VERSION = '1.0.6'
 end
diff --git a/lib/free_zipcode_data/zipcode_table.rb b/lib/free_zipcode_data/zipcode_table.rb
@@ -45,10 +45,10 @@ def write(row)
 
       begin
         database.execute(sql)
-      rescue SQLite3::ConstraintException => _err
+      rescue SQLite3::ConstraintException => _e
         # there are some duplicates - swallow them
-      rescue StandardError => err
-        raise "Please file an issue at #{ISSUE_URL}: [#{err}] -> SQL: [#{sql}]"
+      rescue StandardError => e
+        raise "Please file an issue at #{ISSUE_URL}: [#{e}] -> SQL: [#{sql}]"
       end
 
       update_progress
diff --git a/spec/etl/csv_source_spec.rb b/spec/etl/csv_source_spec.rb
@@ -20,6 +20,8 @@
     end
   end
 
+  # CsvSource implements only #each (Kiba source protocol), not Enumerable
+  # rubocop:disable Style/MapIntoArray
   describe '#each' do
     it 'yields each row as a hash with symbolized keys' do
       source = described_class.new(filename: fixture_csv, delimeter: ',', quote_char: '"')
@@ -51,4 +53,5 @@
       expect(countries.uniq.sort).to eq(%w[CA GB US])
     end
   end
+  # rubocop:enable Style/MapIntoArray
 end
diff --git a/spec/etl/free_zipcode_data_job_spec.rb b/spec/etl/free_zipcode_data_job_spec.rb
@@ -20,7 +20,7 @@
 
   before do
     FreeZipcodeData::Options.instance.initialize_hash(options)
-    logger.log_provider = ::Logger.new(string_io)
+    logger.log_provider = Logger.new(string_io)
   end
 
   describe '.setup' do
@@ -72,7 +72,7 @@
         JOIN states s ON CAST(z.state_id AS INTEGER) = s.id
         WHERE z.code = '60601'
       SQL
-      expect(rows[0]).to eq(['60601', 'IL'])
+      expect(rows[0]).to eq(%w[60601 IL])
     end
 
     it 'links states to countries' do
@@ -82,7 +82,7 @@
         JOIN countries c ON s.country_id = c.id
         WHERE s.abbr = 'NY'
       SQL
-      expect(rows[0]).to eq(['NY', 'US'])
+      expect(rows[0]).to eq(%w[NY US])
     end
 
     it 'stores geocode data for zipcodes' do
diff --git a/spec/free_zipcode_data/county_table_spec.rb b/spec/free_zipcode_data/county_table_spec.rb
@@ -35,7 +35,7 @@
       table.write({ county: 'Cook', short_county: '031', short_state: 'IL', state: 'Illinois' })
       rows = db.execute('SELECT name, abbr FROM counties')
       expect(rows.length).to eq(1)
-      expect(rows[0]).to eq(['Cook', '031'])
+      expect(rows[0]).to eq(%w[Cook 031])
     end
 
     it 'links the county to its state' do
@@ -53,17 +53,18 @@
     end
 
     it 'returns nil when state cannot be found' do
-      result = table.write({ county: 'Unknown', short_county: '999', short_state: 'ZZ', state: 'Nonexistent' })
+      result = table.write({ county: 'Unknown', short_county: '999', short_state: 'ZZ',
+                             state: 'Nonexistent' })
       expect(result).to be_nil
       rows = db.execute('SELECT COUNT(*) FROM counties')
       expect(rows[0][0]).to eq(0)
     end
 
     it 'silently ignores duplicate county entries' do
       table.write({ county: 'Cook', short_county: '031', short_state: 'IL', state: 'Illinois' })
-      expect {
+      expect do
         table.write({ county: 'Cook', short_county: '031', short_state: 'IL', state: 'Illinois' })
-      }.not_to raise_error
+      end.not_to raise_error
       rows = db.execute('SELECT COUNT(*) FROM counties')
       expect(rows[0][0]).to eq(1)
     end
diff --git a/spec/free_zipcode_data/data_source_spec.rb b/spec/free_zipcode_data/data_source_spec.rb
@@ -57,7 +57,8 @@
 
     it 'redownloads if clobber is true' do
       FileUtils.touch(File.join(work_dir, 'US.zip'))
-      options_instance.initialize_hash(OpenStruct.new(work_dir: work_dir, clobber: true, country: 'US', verbose: false))
+      options_instance.initialize_hash(OpenStruct.new(work_dir: work_dir, clobber: true, country: 'US',
+                                                      verbose: false))
 
       uri_object = instance_double(URI::HTTP)
       allow(URI).to receive(:parse).and_return(uri_object)
diff --git a/spec/free_zipcode_data/db_table_spec.rb b/spec/free_zipcode_data/db_table_spec.rb
@@ -64,9 +64,9 @@ def build; end
     end
 
     it 'raises with issue URL on SQL error' do
-      expect {
+      expect do
         table.send(:select_first, 'SELECT * FROM nonexistent_table')
-      }.to raise_error(/Please file an issue/)
+      end.to raise_error(/Please file an issue/)
     end
   end
 
diff --git a/spec/free_zipcode_data/logger_spec.rb b/spec/free_zipcode_data/logger_spec.rb
@@ -3,15 +3,15 @@
 RSpec.describe FreeZipcodeData::Logger do
   let(:logger) { described_class.instance }
   let(:string_io) { StringIO.new }
-  let(:test_provider) { ::Logger.new(string_io) }
+  let(:test_provider) { Logger.new(string_io) }
 
   before do
     logger.log_provider = test_provider
   end
 
   after do
     # Restore default logger
-    logger.log_provider = ::Logger.new($stdout)
+    logger.log_provider = Logger.new($stdout)
   end
 
   describe '#info' do
diff --git a/spec/free_zipcode_data/runner_spec.rb b/spec/free_zipcode_data/runner_spec.rb
@@ -29,7 +29,7 @@
 
     before do
       # Suppress logger output
-      runner.logger.log_provider = ::Logger.new(string_io)
+      runner.logger.log_provider = Logger.new(string_io)
 
       # Copy fixture zip and pre-extracted text into work_dir
       fixture_dir = File.join(FreeZipcodeData.root, 'spec', 'fixtures')
@@ -39,10 +39,10 @@
 
       # Stub ARGV to provide required CLI args
       stub_const('ARGV', [
-        '--work-dir', work_dir,
-        '--country', 'US',
-        '--generate-files'
-      ])
+                   '--work-dir', work_dir,
+                   '--country', 'US',
+                   '--generate-files'
+                 ])
     end
 
     it 'creates an SQLite database in the work directory' do
@@ -76,9 +76,9 @@
     context 'without --generate-files' do
       before do
         stub_const('ARGV', [
-          '--work-dir', work_dir,
-          '--country', 'US'
-        ])
+                     '--work-dir', work_dir,
+                     '--country', 'US'
+                   ])
       end
 
       it 'creates the database but not CSV files' do
diff --git a/spec/free_zipcode_data/zipcode_table_spec.rb b/spec/free_zipcode_data/zipcode_table_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
