add rubocop

Author: o-200

.github/workflows/ci.yml

@@ -31,5 +31,8 @@ jobs:
       - name: Run tests
         run: bundle exec rake
 
+      - name: Run RuboCop
+        run: bundle exec rubocop
+
       - name: Build gem
         run: gem build *.gemspec

.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - '*.gem'
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+    - 'rack-url-canonicalizer.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'rack-url-canonicalizer.gemspec'
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 50
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rack-url-canonicalizer.rb'

Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

Gemfile.lock

@@ -7,11 +7,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.3)
     diff-lcs (1.6.2)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    parallel (2.1.0)
+    parser (3.3.12.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
     rack (3.2.7)
     rack-test (2.2.0)
       rack (>= 1.3)
+    rainbow (3.1.1)
     rake (13.4.2)
+    regexp_parser (2.12.0)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -25,6 +37,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
+    rubocop (1.89.0)
+      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.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   ruby
@@ -36,19 +66,35 @@ DEPENDENCIES
   rack-url-canonicalizer!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop (~> 1.0)
 
 CHECKSUMS
+  ast (2.4.3)
   bundler (4.0.17) sha256=214e21431b5665dd2f99df8a5511c6b151d7a72e8015c8b38f8b775b61cbb6c1
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  json (2.21.2)
+  language_server-protocol (3.17.0.6)
+  lint_roller (1.1.0)
+  parallel (2.1.0)
+  parser (3.3.12.0)
+  prism (1.9.0)
+  racc (1.8.1)
   rack (3.2.7) sha256=93e13e1c24f93556671d85d2d79fa228c3485815c50d7e2f265b5330c6528fb7
   rack-test (2.2.0) sha256=005a36692c306ac0b4a9350355ee080fd09ddef1148a5f8b2ac636c720f5c463
   rack-url-canonicalizer (0.1.0)
+  rainbow (3.1.1)
   rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  regexp_parser (2.12.0)
   rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
   rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.89.0)
+  rubocop-ast (1.50.0)
+  ruby-progressbar (1.13.0)
+  unicode-display_width (3.2.0)
+  unicode-emoji (4.2.0)
 
 BUNDLED WITH
   4.0.17

Rakefile

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

lib/rack-url-canonicalizer.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "rack/url_canonicalizer"
+require 'rack/url_canonicalizer'

lib/rack/url_canonicalizer.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "rack"
-require_relative "url_canonicalizer/version"
-require_relative "url_canonicalizer/configuration"
-require_relative "url_canonicalizer/railtie"
+require 'rack'
+require_relative 'url_canonicalizer/version'
+require_relative 'url_canonicalizer/configuration'
+require_relative 'url_canonicalizer/railtie'
 
 module Rack
   class UrlCanonicalizer
@@ -37,25 +37,21 @@ def call(env)
       return @app.call(env) unless req.get? || req.head?
       return @app.call(env) if xhr_request?(req, env)
 
-      path_info = env["PATH_INFO"] || ""
+      path_info = env['PATH_INFO'] || ''
 
-      if excluded_path?(path_info)
-        return @app.call(env)
-      end
+      return @app.call(env) if excluded_path?(path_info)
 
-      host = req.host || ""
-      host_redirect = @config.strip_www && host.start_with?("www.")
-      target_host = host_redirect ? host.sub(/\Awww\./, "") : host
+      host = req.host || ''
+      host_redirect = @config.strip_www && host.start_with?('www.')
+      target_host = host_redirect ? host.sub(/\Awww\./, '') : host
 
       raw_path = path_info
       normalized_path = raw_path.dup
 
-      if @config.collapse_slashes
-        normalized_path.gsub!(%r{/{2,}}, "/")
-      end
+      normalized_path.gsub!(%r{/{2,}}, '/') if @config.collapse_slashes
 
-      if @config.strip_trailing_slash && normalized_path.length > 1 && normalized_path.end_with?("/")
-        normalized_path.chomp!("/")
+      if @config.strip_trailing_slash && normalized_path.length > 1 && normalized_path.end_with?('/')
+        normalized_path.chomp!('/')
       end
 
       query_params = req.GET.dup
@@ -73,20 +69,20 @@ def call(env)
       if host_redirect || raw_path != normalized_path || locale_redirect
         scheme = req.scheme
         port = req.port
-        port_part = [ 80, 443 ].include?(port) ? "" : ":#{port}"
+        port_part = [80, 443].include?(port) ? '' : ":#{port}"
 
         new_query = Rack::Utils.build_nested_query(query_params)
-        new_url = +"#{scheme}://#{target_host}#{port_part}#{normalized_path}"
+        new_url = "#{scheme}://#{target_host}#{port_part}#{normalized_path}"
         new_url << "?#{new_query}" unless new_query.empty?
 
         return [
           @config.redirect_status,
           {
-            "location" => new_url,
-            "content-type" => "text/html",
-            "cache-control" => @config.cache_control
+            'location' => new_url,
+            'content-type' => 'text/html',
+            'cache-control' => @config.cache_control
           },
-          [ redirect_body(@config.redirect_status) ]
+          [redirect_body(@config.redirect_status)]
         ]
       end
 
@@ -98,7 +94,7 @@ def call(env)
     def xhr_request?(req, env)
       return true if req.respond_to?(:xhr?) && req.xhr?
 
-      env["HTTP_X_REQUESTED_WITH"] == "XMLHttpRequest"
+      env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
     end
 
     def excluded_path?(path_info)
@@ -111,11 +107,11 @@ def excluded_path?(path_info)
 
     def redirect_body(status)
       case status
-      when 301 then "Moved Permanently"
-      when 302 then "Found"
-      when 307 then "Temporary Redirect"
-      when 308 then "Permanent Redirect"
-      else "Redirected"
+      when 301 then 'Moved Permanently'
+      when 302 then 'Found'
+      when 307 then 'Temporary Redirect'
+      when 308 then 'Permanent Redirect'
+      else 'Redirected'
       end
     end
   end

lib/rack/url_canonicalizer/configuration.rb

@@ -17,10 +17,10 @@ def initialize
         @collapse_slashes = true
         @strip_trailing_slash = true
         @exclude_paths = []
-        @locale_param = "locale"
+        @locale_param = 'locale'
         @allowed_locales = nil
         @redirect_status = 301
-        @cache_control = "public, max-age=86400"
+        @cache_control = 'public, max-age=86400'
       end
 
       def allowed_locales_list

lib/rack/url_canonicalizer/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class UrlCanonicalizer
-    VERSION = "0.1.0"
+    VERSION = '0.1.0'
   end
 end

rack-url-canonicalizer.gemspec

@@ -1,26 +1,28 @@
 # frozen_string_literal: true
 
-require_relative "lib/rack/url_canonicalizer/version"
+require_relative 'lib/rack/url_canonicalizer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rack-url-canonicalizer"
+  spec.name          = 'rack-url-canonicalizer'
   spec.version       = Rack::UrlCanonicalizer::VERSION
-  spec.authors       = [ "Alex Abramov" ]
-  spec.email         = [ "omgout.200@gmail.com" ]
+  spec.authors       = ['Alex Abramov']
+  spec.email         = ['omgout.200@gmail.com']
 
-  spec.summary       = "Rack middleware for URL normalization and SEO canonicalization"
-  spec.description   = "Removes www, collapses slashes, strips trailing slashes, and validates locale params to prevent duplicate content SEO penalties."
-  spec.homepage      = "https://github.com/o-200/rack-url-canonicalizer"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.summary       = 'Rack middleware for URL normalization and SEO canonicalization'
+  spec.description   = 'Removes www, collapses slashes, strips trailing slashes, and validates locale params to prevent duplicate content SEO penalties.'
+  spec.homepage      = 'https://github.com/o-200/rack-url-canonicalizer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
 
-  spec.files         = Dir["LICENSE.txt", "README.md", "lib/**/*"]
-  spec.require_paths = [ "lib" ]
+  spec.files         = Dir['LICENSE.txt', 'README.md', 'lib/**/*']
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rack", ">= 2.0"
+  spec.add_dependency 'rack', '>= 2.0'
 
-  spec.add_development_dependency "bundler", ">= 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rack-test", ">= 2.0"
+  spec.add_development_dependency 'bundler', '>= 2.0'
+  spec.add_development_dependency 'rack-test', '>= 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end