Add Rubocop Action & autocorrect violations (#112)

* Add Rubocop Action

* Update changelog

Author: duffn

.github/workflows/rubocop.yml

@@ -0,0 +1,14 @@
+name: Rubocop
+on: [pull_request]
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rubocop

.rubocop.yml

@@ -1,5 +1,4 @@
 AllCops:
-  Exclude:
-    - vendor/**/*
+  TargetRubyVersion: 2.7
 
 inherit_from: .rubocop_todo.yml

.rubocop_todo.yml

@@ -1,105 +1,47 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-08 10:39:57 -0500 using RuboCop version 0.77.0.
+# on 2023-03-30 00:44:45 UTC using RuboCop version 1.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 8
-# Configuration parameters: Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/DuplicatedGem:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'app/controllers/grape_swagger_rails/application_controller.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterMagicComment:
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
   Exclude:
     - 'grape-swagger-rails.gemspec'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLinesAroundArguments:
-  Exclude:
-    - 'lib/grape-swagger-rails.rb'
-
-# Offense count: 12
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/grape-swagger-rails.rb'
-
-# Offense count: 1
-Lint/AmbiguousRegexpLiteral:
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
   Exclude:
     - 'lib/tasks/swagger_ui.rake'
 
 # Offense count: 1
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'spec/dummy/bin/spring'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Lint/ScriptPermission:
-  Exclude:
-    - 'Rakefile'
-    - 'spec/dummy/Rakefile'
-
-# Offense count: 2
-# Configuration parameters: AllowComments.
-Lint/SuppressedException:
+Lint/MixedRegexpCaptureTypes:
   Exclude:
-    - 'spec/dummy/bin/rails'
-    - 'spec/dummy/bin/rake'
+    - 'lib/tasks/swagger_ui.rake'
 
 # Offense count: 9
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
   Max: 282
 
 # Offense count: 2
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
     - 'lib/grape-swagger-rails.rb'
     - 'spec/features/grape-swagger-rails_spec.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'lib/tasks/swagger_ui.rake'
-
 # Offense count: 4
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -108,72 +50,9 @@ Style/Documentation:
     - 'lib/grape-swagger-rails.rb'
     - 'lib/grape-swagger-rails/engine.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: compact, expanded
-Style/EmptyMethod:
-  Exclude:
-    - 'app/controllers/grape_swagger_rails/application_controller.rb'
-    - 'spec/dummy/app/controllers/welcome_controller.rb'
-
 # Offense count: 1
-# Cop supports --auto-correct.
-Style/Encoding:
-  Exclude:
-    - 'grape-swagger-rails.gemspec'
-
-# Offense count: 14
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'Rakefile'
-    - 'grape-swagger-rails.gemspec'
-    - 'lib/script/rails'
-    - 'lib/tasks/swagger_ui.rake'
-    - 'spec/dummy/Rakefile'
-    - 'spec/dummy/bin/bundle'
-    - 'spec/dummy/bin/rails'
-    - 'spec/dummy/bin/rake'
-    - 'spec/dummy/config/application.rb'
-    - 'spec/dummy/config/boot.rb'
-    - 'spec/dummy/config/environment.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 37
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'grape-swagger-rails.gemspec'
-    - 'lib/grape-swagger-rails.rb'
-    - 'spec/features/swagger_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/tasks/swagger_ui.rake'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: MinSize.
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-# Offense count: 48
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 129
+Layout/LineLength:
+  Max: 124

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Your contribution here.
 * [#110](https://github.com/ruby-grape/grape-swagger-rails/pull/110): Update dummy app to current rails conventions - [@duffn](https://github.com/duffn).
+* [#112](https://github.com/ruby-grape/grape-swagger-rails/pull/112): Add Rubocop Action & autocorrect violations - [@duffn](https://github.com/duffn).
 
 ### 0.4.0 (2023/03/28)
 

Dangerfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -6,8 +8,8 @@ case version = ENV['GRAPE_SWAGGER_VERSION'] || '~> 1.6.0'
 when 'HEAD'
   gem 'grape-swagger', github: 'ruby-grape/grape-swagger'
 else
-  gem 'grape-swagger', version
   gem 'grape', '>= 1.3.0'
+  gem 'grape-swagger', version
 end
 
 group :development, :test do

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
@@ -16,4 +18,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

app/controllers/grape_swagger_rails/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwaggerRails
   class ApplicationController < ActionController::Base
     if Rails::VERSION::MAJOR >= 4
@@ -6,13 +8,13 @@ class ApplicationController < ActionController::Base
       before_filter { run_before_action }
     end
 
-    def index
-    end
+    def index; end
 
     private
 
     def run_before_action
       return unless GrapeSwaggerRails.options.before_action
+
       instance_exec(request, &GrapeSwaggerRails.options.before_action)
     end
   end

config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 GrapeSwaggerRails::Engine.routes.draw do
   root to: 'application#index'
 end

grape-swagger-rails.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 'grape-swagger-rails/version'

lib/grape-swagger-rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape-swagger-rails/engine'
 
 module GrapeSwaggerRails
@@ -20,24 +22,23 @@ def before_action(&block)
   mattr_accessor :options
 
   self.options = Options.new(
+    url: '/swagger_doc',
+    app_name: 'Swagger',
+    app_url: 'http://swagger.wordnik.com',
 
-    url:                    '/swagger_doc',
-    app_name:               'Swagger',
-    app_url:                'http://swagger.wordnik.com',
-
-    headers:                {},
+    headers: {},
 
-    api_auth:               '', # 'basic' or 'bearer'
-    api_key_name:           'api_key', # 'Authorization'
-    api_key_type:           'query', # 'header'
-    api_key_default_value:  '', # Auto populates api_key
+    api_auth: '', # 'basic' or 'bearer'
+    api_key_name: 'api_key', # 'Authorization'
+    api_key_type: 'query', # 'header'
+    api_key_default_value: '', # Auto populates api_key
 
-    doc_expansion:          'none',
-    supported_submit_methods: %w(get post put delete patch),
+    doc_expansion: 'none',
+    supported_submit_methods: %w[get post put delete patch],
 
-    before_action_proc:     nil, # Proc used as a controller before action
+    before_action_proc: nil, # Proc used as a controller before action
 
-    hide_url_input:         false,
-    hide_api_key_input:     false
+    hide_url_input: false,
+    hide_api_key_input: false
   )
 end

lib/grape-swagger-rails/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwaggerRails
   class Engine < ::Rails::Engine
     paths['lib/tasks'] = 'lib/tasks/exported'

lib/grape-swagger-rails/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwaggerRails
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.0'
 end

lib/script/rails

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/grape-swagger-rails/engine', __FILE__)
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/grape-swagger-rails/engine', __dir__)
 
 require 'rails/all'
 require 'rails/engine/commands'

lib/tasks/swagger_ui.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'git'
 
 namespace :swagger_ui do
@@ -9,15 +11,16 @@ namespace :swagger_ui do
         # clone wordnik/swagger-ui
         Git.clone 'git@github.com:wordnik/swagger-ui.git', 'swagger-ui', path: dir, depth: 0
         # prune local files
-        root = File.expand_path '../../..', __FILE__
+        root = File.expand_path '../..', __dir__
         puts "Removing files from #{root} ..."
         repo = Git.open root
         # Javascripts
         puts 'Copying Javascripts ...'
         FileUtils.rm_r "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp_r "#{dir}/swagger-ui/dist/lib", "#{root}/app/assets/javascripts"
         FileUtils.mv "#{root}/app/assets/javascripts/lib", "#{root}/app/assets/javascripts/grape_swagger_rails"
-        FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/swagger-ui.min.js"), "#{root}/app/assets/javascripts/grape_swagger_rails"
+        FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/swagger-ui.min.js"),
+                       "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp Dir.glob("#{root}/lib/javascripts/*.js"), "#{root}/app/assets/javascripts/grape_swagger_rails"
         # Generate application.js
         JAVASCRIPT_FILES = [
@@ -74,7 +77,7 @@ namespace :swagger_ui do
         # rewrite screen.css into screen.css.erb with dynamic image paths
         File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css.erb", 'w+' do |file|
           contents = File.read "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
-          contents.gsub! /url\((\'*).*\/(?<filename>[\w\.]*)(\'*)\)/ do |_match|
+          contents.gsub!(%r{url\(('*).*/(?<filename>[\w.]*)('*)\)}) do |_match|
             "url(<%= image_path('grape_swagger_rails/#{$LAST_MATCH_INFO[:filename]}') %>)"
           end
           file.write contents