Update rubocop config

Author: lsegal

.github/workflows/ci.yml

@@ -22,6 +22,8 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - name: Lint
+        run: bundle exec rubocop
       - name: Run Test
         run: |
           ruby -v

.rubocop.yml

@@ -1,11 +1,32 @@
-#inherit_from:
-#  - .rubocop_todo.yml
-
+plugins:
+  - rubocop-rake
+  - rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.0
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - lib/yard/parser/ruby/legacy/irb/slex.rb
+    - lib/yard/parser/ruby/legacy/ruby_lex.rb
+    - lib/yard/server/http_utils.rb
 Metrics:
   Enabled: false
+Performance:
+  Exclude:
+    - spec/**/*.rb
+Gemspec/RequireMFA:
+  Enabled: false
 Layout/LineLength:
   AutoCorrect: true
-  Max: 100
+  Max: 120
+  Exclude:
+    - spec/**/*.rb
+Naming/MethodParameterName:
+  Enabled: false
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
 Style/Semicolon:
   AllowAsExpressionSeparator: true
 Style/Documentation:
@@ -30,19 +51,57 @@ Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
-
-# Disable these until we know what to do with them
 Style/SafeNavigation:
   Enabled: false # not supported in 1.8...2.1
+Style/DocumentDynamicEvalDefinition: # not helpful
+  Enabled: false
+Style/OpenStructUse:
+  Enabled: false
+Style/MixinUsage:
+  Exclude:
+    - docs/**/*.rb
+    - benchmarks/**/*.rb
+    - spec/**/*
+    - templates/**/*
+    - lib/yard/templates/**/*
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "()"
+    "%W": "()"
+    "%i": "()"
+    "%I": "()"
+Style/MultilineIfModifier: # autocorrect usually fails
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
 Style/GuardClause: # does not provide much value
   Enabled: false
+Style/IfWithBooleanLiteralBranches: # this isn't reliable
+  Enabled: false
+Lint/DuplicateMethods:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - benchmarks/**/*.rb
+    - docs/**/*.rb
+    - spec/**/*.rb
+Style/FormatStringToken:
+  Enabled: false
+Lint/UselessConstantScoping:
+  Enabled: false
+Lint/SuppressedException:
+  Enabled: false
+Bundler/GemFilename:
+  Enabled: false
 Naming/VariableNumber:
   Enabled: false
 Naming/AccessorMethodName: # this creates breaking changes in the API
   Enabled: false
 Naming/PredicateName: # this creates breaking changes in the API
   Enabled: false
-Style/MethodMissingSuper: # this doesn't exist in 1.8/1.9
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Lint/MissingSuper: # this doesn't exist in 1.8/1.9
   Enabled: false
 Style/MissingRespondToMissing: # this doesn't exist in 1.8/1.9
   Enabled: false
@@ -62,6 +121,10 @@ Style/ClassAndModuleChildren:
   Enabled: false
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+Style/EvalWithLocation:
+  Enabled: false
 Style/SingleLineMethods:
   Enabled: false
 Style/SingleLineBlockParams:
@@ -89,13 +152,20 @@ Style/GlobalVars:
   Exclude:
     - benchmarks/**/*.rb
     - spec/**/*.rb
+Style/StderrPuts:
+  Enabled: false
+Style/FileWrite:
+  Enabled: false
+Style/FileRead:
+  Enabled: false
 Lint/RedundantSplatExpansion:
   Enabled: false
 Security/Eval:
   Exclude:
     - benchmarks/**/*.rb
     - spec/**/*.rb
-
+Security/MarshalLoad:
+  Enabled: false
 Layout/SpaceAroundMethodCallOperator:
   Enabled: false
 Lint/RaiseException:

Gemfile

@@ -2,23 +2,30 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'rspec', '>= 3.11.0'
+  gem 'coveralls_reborn', :require => false
+  gem 'json'
   gem 'rake'
   gem 'rdoc', '= 6.1.2.1'
-  gem 'json'
-  gem 'simplecov'
+  gem 'rspec', '>= 3.11.0'
   gem 'samus', '~> 3.0.9', :require => false
-  gem 'coveralls_reborn', :require => false
+  gem 'simplecov'
   gem 'webrick'
 end
 
+group :lint do
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+end
+
 group :asciidoc do
   gem 'asciidoctor'
+  gem 'logger' # needed for asciidoctor
 end
 
 group :markdown do
+  gem 'commonmarker', '~> 0.x'
   gem 'redcarpet'
-  gem 'commonmarker'
 end
 
 group :textile do

Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
-require File.dirname(__FILE__) + '/lib/yard'
-require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
+require "#{File.dirname(__FILE__)}/lib/yard"
+require "#{File.dirname(__FILE__)}/lib/yard/rubygems/specification"
 require 'rbconfig'
 
 YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
 
-Dir['tasks/**/*.rake'].each { |task_file| load task_file }
+Dir['tasks/**/*.rake'].each {|task_file| load task_file }
 
 desc "Builds the gem"
 task :gem do
@@ -29,7 +29,7 @@ task :test_doc do
   sh "ruby bin/yard --fail-on-warning #{"--no-progress" if ENV["CI"]}"
 end
 
-task :default => [:spec, :test_doc]
+task :default => %i(spec test_doc)
 
 YARD::Rake::YardocTask.new do |t|
   t.options += ['--title', "YARD #{YARD::VERSION} Documentation"]

benchmarks/builtins_vs_eval.rb

@@ -10,7 +10,7 @@ def bench_builtins(name)
 
 def bench_eval(name)
   eval(name).is_a?(Class)
-rescue
+rescue StandardError
   false
 end
 

benchmarks/erb_vs_erubis.rb

@@ -13,41 +13,41 @@ def rungen
 
 Benchmark.bmbm do |x|
   x.report("erubis") do
-    eval <<-eof
+    eval <<-EOF
       module YARD; module Templates; module Template
         def erb_with(str, x) Erubis::Eruby.new(str) end
       end end end
-    eof
+    EOF
 
     rungen
   end
 
   x.report("fast-erubis") do
-    eval <<-eof
+    eval <<-EOF
       module YARD; module Templates; module Template
         def erb_with(str, x) Erubis::FastEruby.new(str) end
       end end end
-    eof
+    EOF
 
     rungen
   end
 
   x.report("tiny-erubis") do
-    eval <<-eof
+    eval <<-EOF
       module YARD; module Templates; module Template
         def erb_with(str, x) Erubis::TinyEruby.new(str) end
       end end end
-    eof
+    EOF
 
     rungen
   end
 
   x.report("erb") do
-    eval <<-eof
+    eval <<-EOF
        module YARD; module Templates; module Template
         def erb_with(str, x) ERB.new(str) end
       end end end
-    eof
+    EOF
 
     rungen
   end

benchmarks/format_args.rb

@@ -11,19 +11,19 @@ def format_args_regex(object)
 end
 
 def format_args_parameters(object)
-  if !object.parameters.empty?
+  if object.parameters.empty?
+    ""
+  else
     args = object.parameters.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
     "(#{args})"
-  else
-    ""
   end
 end
 
 YARD::Registry.load
 $object = YARD::Registry.at('YARD::Generators::Base#G')
 
-log.puts "regex:  " + format_args_regex($object)
-log.puts "params: " + format_args_parameters($object)
+log.puts "regex:  #{format_args_regex($object)}"
+log.puts "params: #{format_args_parameters($object)}"
 log.puts
 
 TIMES = 100_000

benchmarks/generation.rb

@@ -12,13 +12,13 @@ def rungen
 end
 
 def redef(lock = false)
-  eval <<-eof
+  eval <<-EOF
     class YARD::CodeObjects::Proxy;
       def to_obj
         @obj #{lock ? '||' : ''}= YARD::Registry.resolve(@namespace, @name)
       end
     end
-  eof
+  EOF
 end
 
 Benchmark.bmbm do |x|

benchmarks/marshal_vs_dbm.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'benchmark'
 require 'dbm'
+require 'fileutils'
 
 MARSHAL_FILE = "marshal_test.db"
 DBM_FILE = "dbm_test"
@@ -14,7 +15,7 @@ def generate_index
 end
 
 def write_dbm
-  File.unlink(DBM_FILE + ".db") if File.exist?(DBM_FILE + ".db")
+  FileUtils.rm_f("#{DBM_FILE}.db")
   handle = DBM.new(DBM_FILE)
   NUM_INDICES.times {|t| handle[t.to_s] = Marshal.dump(generate_index) }
   handle.close
@@ -27,7 +28,7 @@ def read_dbm
 end
 
 def write_marshal
-  File.unlink(MARSHAL_FILE) if File.exist?(MARSHAL_FILE)
+  FileUtils.rm_f(MARSHAL_FILE)
   handle = {}
   NUM_INDICES.times {|t| handle[t.to_s] = generate_index }
   File.open(MARSHAL_FILE, "wb") {|f| f.write(Marshal.dump(handle)) }
@@ -46,7 +47,7 @@ def read_marshal
 end
 
 File.unlink(MARSHAL_FILE)
-File.unlink(DBM_FILE + ".db")
+File.unlink("#{DBM_FILE}.db")
 
 __END__
 

benchmarks/pathname_vs_string.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'pathname'
 require "benchmark"
-require File.dirname(__FILE__) + '/../lib/yard'
+require "#{File.dirname(__FILE__)}/../lib/yard"
 
 pathobj = Pathname.new("a/b/c")
 strobj  = "a/b/c"