Resolve RuboCop offenses (#534)

* Simple RuboCop fixes

* Add `max_line_length` into EditorConfig

Duplicate value from RuboCop config.

* Remove RuboCop config file from `.gitignore`

* Breaking changes with optional arguments

There were RuboCop offenses, and I think keyword approaches is better.

* Add Changelog entries

* Fix error with `Image.file`

* Resolve RuboCop offense about global variable

I don't know a way better, the whole approach is not the best.

* Replace manual `autoload` list with dynamic one

* Resolve RuboCop offense about block length in `scripts/reference`

* Add `.rubocop_todo` file

Resolve these issues later.

* Add `rubocop-performance` and `rubocop-rake` gems

Resolve new offenses.

* Add `inherit_mode` for RuboCop config

* Resolve Ruby warning about `-` char in Regex

* Add RuboCop GitHub Action

* Add `bundle exec` for GitHub Actions

* Rename `autoload_abbreviations` into `autoload_acronyms`

* Resolve a new RuboCop offense

* Add file exclusions for `Style/AsciiComments` RuboCop cop

Also turn them into mask by locale.

* Revert breaking changes, return positional arguments

Leave keyword arguments, add deprecation warning for positional.

---------

Co-authored-by: marocchino <marocchino@users.noreply.github.com>

.editorconfig

@@ -7,3 +7,4 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+max_line_length = 120

.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: RuboCop
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: RuboCop lint
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 'ruby'
+          bundler-cache: true # 'bundle install' and cache
+      - run: bundle exec rake rubocop

.github/workflows/test.yml

@@ -20,4 +20,4 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true # 'bundle install' and cache
-      - run: rake test
+      - run: bundle exec rake test

.gitignore

@@ -17,4 +17,3 @@ Gemfile.lock
 .ruby-gemset
 .ruby-version
 .rvmrc
-.rubocop.yml

.rubocop.yml

@@ -1,3 +1,15 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
+inherit_from:
+  - ./.rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable
@@ -24,13 +36,23 @@ Style/Documentation:
 Style/AsciiComments:
   Enabled: true
   Exclude:
-    - 'lib/ffaker/address_ja.rb'
-    - 'lib/ffaker/address_se.rb'
+    - '**/*_cs.rb'
+    - '**/*_ja.rb'
+    - '**/*_mx.rb'
+    - '**/*_se.rb'
 Style/OptionalBooleanParameter:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: true
+  Max: 200
+Metrics/ClassLength:
   Exclude:
-    - 'lib/ffaker/bank.rb'
+    - 'test/**/*.rb'
+Metrics/MethodLength:
+  AllowedPatterns:
+    - 'test_'
+Metrics/AbcSize:
+  AllowedPatterns:
+    - 'test_'
 Style/RedundantArgument:
   Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,6 @@
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false

Changelog.md

@@ -1,6 +1,8 @@
 ## development
 
   - Add your change HERE
+  - Resolve a lot of RuboCop offenses [@AlexWayfer]
+  - Change `Image.url`, `Image.file`, `Book.cover` and `Avatar.image` arguments to keywords [@AlexWayfer]
   - Adds FFaker::Date.birthday [@professor]
   - Adds FFaker::Crypto.sha256 [@professor]
   - Update README [@professor]

Gemfile

@@ -1,4 +1,19 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
+
 gemspec
+
+group :development do
+  gem 'rake', '~> 13.0'
+end
+
+group :development, :lint do
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+end
+
+group :development, :test do
+  gem 'test-unit'
+end

REFERENCE.md

@@ -88,7 +88,7 @@
  * [FFaker::IdentificationESCO](#ffakeridentificationesco)
  * [FFaker::IdentificationIN](#ffakeridentificationin)
  * [FFaker::IdentificationIT](#ffakeridentificationit)
- * [FFaker::IdentificationKr](#ffakeridentificationkr)
+ * [FFaker::IdentificationKR](#ffakeridentificationkr)
  * [FFaker::IdentificationMX](#ffakeridentificationmx)
  * [FFaker::IdentificationPL](#ffakeridentificationpl)
  * [FFaker::IdentificationTW](#ffakeridentificationtw)
@@ -1385,7 +1385,7 @@
 | `gender` | ‼️ FFaker::UniqueUtils::RetryLimitExceeded: Retry limit exceeded for gender |
 | `ssn` | 11830877014613103430, 45436375172610549922, 29278264986997805738 |
 
-## FFaker::IdentificationKr
+## FFaker::IdentificationKR
 
 | Method | Example |
 | ------ | ------- |

Rakefile

@@ -23,6 +23,10 @@ module Test
   end
 end
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
 #############################################################################
 #
 # Helper functions
@@ -80,14 +84,9 @@ rescue LoadError
   end
 end
 
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
+desc 'Packaging tasks'
 task release: :build do
-  unless `git branch` =~ /^\* main$/
+  unless `git branch`.match?(/^\* main$/)
     puts 'You must be on the main branch to release!'
     exit!
   end
@@ -103,6 +102,7 @@ task build: %i[validate reference] do
   sh "gem build #{gemspec_file} --output=pkg/#{gem_file}"
 end
 
+desc 'Validate library files'
 task :validate do
   libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
   unless libfiles.empty?

ffaker.gemspec

@@ -29,16 +29,12 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`
             .split("\n")
             .sort
-            .reject { |file| file =~ /^\./ }
-            .reject { |file| file =~ /^(rdoc|pkg)/ }
+            .grep_v(/^\./)
+            .grep_v(/^(rdoc|pkg)/)
 
   s.metadata = {
     'changelog_uri' => 'https://github.com/ffaker/ffaker/blob/main/Changelog.md',
     'documentation_uri' => 'https://github.com/ffaker/ffaker/blob/main/REFERENCE.md',
     'rubygems_mfa_required' => 'true'
   }
-
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'test-unit'
 end