153 add rubocop for linting uniformity

.github/workflows/versionci.yml

@@ -12,9 +12,14 @@ jobs:
       matrix:
         ruby: ["3.2.0", "3.2.7", "3.3.0", "3.3.7"]
     steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - run: bundle exec rspec
+      - name: Run Rubocop
+        run: bundle exec rubocop --force-exclusion --autocorrect --fail-level autocorrect
+      - name: Run Tests
+        run: bundle exec rspec

.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  TargetRubyVersion: 3.3.0
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'coverage/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'decanter.gemspec'
+
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - 'lib/decanter/core.rb'
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'lib/decanter/core.rb'    
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'decanter.gemspec'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/decanter/core.rb'
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ModuleLength:
+  Max: 205
+
+Naming/PredicateName:
+  Exclude:
+    - 'lib/decanter/core.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

Gemfile

@@ -1,4 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in decanter.gemspec
 gemspec
+
+group :development, :test do
+  gem 'bundler', '~> 2.4.22'
+  gem 'dotenv'
+  gem 'rake', '~> 12.0'
+  gem 'rspec-rails', '~> 3.9'
+  gem 'rubocop', '~> 1.59'
+  gem 'simplecov', '~> 0.15.1'
+end

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (5.0.0)
+    decanter (5.1.0)
       actionpack (>= 7.1.3.2)
       activesupport
       rails (>= 7.1.3.2)
@@ -84,6 +84,7 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
+    ast (2.4.3)
     base64 (0.2.0)
     bigdecimal (3.1.7)
     builder (3.2.4)
@@ -105,6 +106,8 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -131,6 +134,11 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.4-x86_64-linux)
       racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.4)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
     psych (5.1.2)
       stringio
     racc (1.7.3)
@@ -171,9 +179,11 @@ GEM
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
+    rainbow (3.1.1)
     rake (12.3.3)
     rdoc (6.6.3.1)
       psych (>= 4.0.0)
+    regexp_parser (2.10.0)
     reline (0.5.5)
       io-console (~> 0.5)
     rspec-core (3.9.3)
@@ -193,6 +203,21 @@ GEM
       rspec-mocks (~> 3.9.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
+    rubocop (1.75.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -203,6 +228,9 @@ GEM
     timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     webrick (1.8.1)
     websocket-driver (0.7.7)
       base64
@@ -221,6 +249,7 @@ DEPENDENCIES
   dotenv
   rake (~> 12.0)
   rspec-rails (~> 3.9)
+  rubocop (~> 1.59)
   simplecov (~> 0.15.1)
 
 BUNDLED WITH

Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

decanter.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'decanter/version'
@@ -20,19 +22,17 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails', '>= 7.1.3.2'
   spec.add_dependency 'actionpack', '>= 7.1.3.2'
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'rails', '>= 7.1.3.2'
   spec.add_dependency 'rails-html-sanitizer', '>= 1.0.4'
 
-  spec.add_development_dependency 'bundler', '~> 2.4.22'
-  spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.9'
-  spec.add_development_dependency 'simplecov', '~> 0.15.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

lib/decanter.rb

@@ -1,23 +1,24 @@
+# frozen_string_literal: true
+
 require 'active_support/all'
 
 module Decanter
-
   class << self
-
     def decanter_for(klass_or_sym)
       decanter_name =
         case klass_or_sym
         when Class
-          klass_or_sym.name
+          "#{klass_or_sym.name}Decanter"
         when Symbol
-          klass_or_sym.to_s.singularize.camelize
+          "#{klass_or_sym.to_s.singularize.camelize}Decanter"
         else
-          raise ArgumentError.new("cannot lookup decanter for #{klass_or_sym} with class #{klass_or_sym.class}")
-        end + 'Decanter'
+          raise ArgumentError,
+                "cannot lookup decanter for #{klass_or_sym} with class #{klass_or_sym.class}"
+        end
       begin
         decanter_name.constantize
-      rescue
-        raise NameError.new("uninitialized constant #{decanter_name}")
+      rescue StandardError
+        raise NameError, "uninitialized constant #{decanter_name}"
       end
     end
 
@@ -29,22 +30,21 @@ def decanter_from(klass_or_string)
         when String
           begin
             klass_or_string.constantize
-          rescue
-            raise NameError.new("uninitialized constant #{klass_or_string}")
+          rescue StandardError
+            raise NameError, "uninitialized constant #{klass_or_string}"
           end
         else
-          raise ArgumentError.new("cannot find decanter from #{klass_or_string} with class #{klass_or_string.class}")
+          raise ArgumentError,
+                "cannot find decanter from #{klass_or_string} with class #{klass_or_string.class}"
         end
 
-      unless constant.ancestors.include? Decanter::Base
-        raise ArgumentError.new("#{constant.name} is not a decanter")
-      end
+      raise ArgumentError, "#{constant.name} is not a decanter" unless constant.ancestors.include? Decanter::Base
 
       constant
     end
 
     def configuration
-      @config ||= Decanter::Configuration.new
+      @configuration ||= Decanter::Configuration.new
     end
 
     def config
@@ -61,4 +61,4 @@ def config
 require 'decanter/extensions'
 require 'decanter/exceptions'
 require 'decanter/parser'
-require 'decanter/railtie' if defined?(::Rails)
+require 'decanter/railtie' if defined?(Rails)

lib/decanter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'decanter/core'
 require 'decanter/collection_detection'
 

lib/decanter/collection_detection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Decanter
   module CollectionDetection
     def self.included(base)
@@ -15,7 +17,12 @@ def decant(args, **options)
 
       # leveraging the approach used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization)
       def collection?(args, collection_option = nil)
-        raise(ArgumentError, "#{name}: Unknown collection option value: #{collection_option}") unless [true, false, nil].include? collection_option
+        unless [
+          true, false, nil
+        ].include? collection_option
+          raise(ArgumentError,
+                "#{name}: Unknown collection option value: #{collection_option}")
+        end
 
         return collection_option unless collection_option.nil?
 

lib/decanter/configuration.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Decanter
   class Configuration
-
     attr_accessor :strict, :log_unhandled_keys
 
     def initialize