Refactor with/against Rubocop

.rubocop.yml

@@ -0,0 +1,75 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+  DisplayCopNames: true
+
+# Config of cops
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+Style/FileName:
+  Exclude: [sup-add, sup-config, sup-dump, sup-import-dump, sup-psych-ify-config-files, sup-recover-sources,
+            sup-sync, sup-sync-back-maildir, sup-tweak-labels]
+
+Style/GlobalVars:
+  AllowedVariables: [$config, $cursing, $die, $encoding, $last_fn, $opts, $terminal]
+# Disabled cops
+
+Style/AndOr:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+# Even though there's a --auto-correct available, this
+# changed behavior.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+# Detection at this point flawed.. Maybe later
+Style/Next:
+  Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,83 @@
+# Offense count: 3
+Lint/Eval:
+  Enabled: false
+
+# Offense count: 5
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 10
+Lint/RescueException:
+  Enabled: false
+
+# If I recall correctly, this one is fixed allready by another PR. Remove me later.
+# Offense count: 1
+Lint/UselessElseWithoutRescue:
+  Enabled: false
+
+# Offense count: 179
+Metrics/AbcSize:
+  Max: 140
+
+# Offense count: 7
+Metrics/BlockNesting:
+  Max: 5
+
+# Offense count: 25
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 1000
+
+# Offense count: 90
+Metrics/CyclomaticComplexity:
+  Max: 40
+
+# Offense count: 613
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 213
+
+# Offense count: 199
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 100
+
+# Offense count: 5
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 82
+Metrics/PerceivedComplexity:
+  Max: 41
+
+# Offense count: 8
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 7
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 1
+Style/FlipFlop:
+  Enabled: false
+
+# Offense count: 18
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/FormatString:
+  Enabled: false
+
+# Offense count: 4
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 25
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/RaiseArgs:
+  Enabled: false

.travis.yml

@@ -10,4 +10,4 @@ before_install:
   - sudo apt-get install -qq uuid-dev uuid libncursesw5-dev libncursesw5 gnupg2 pandoc
   - git submodule update --init --recursive
 
-script: bundle exec rake travis
+script: bundle exec rake travis test

Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org/'
 
-if !RbConfig::CONFIG['arch'].include?('openbsd')
+unless RbConfig::CONFIG['arch'].include?('openbsd')
   gem 'xapian-ruby', '~> 1.2.15'
 end
 

Rakefile

@@ -1,39 +1,44 @@
 require 'rubygems'
 require 'rake/testtask'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 
-Rake::TestTask.new(:test) do |test|
+Rake::TestTask.new(:minitest) do |test|
   test.libs << 'test'
   test.test_files = FileList.new('test/**/test_*.rb')
   test.verbose = true
 end
-task :default => :test
+desc 'Run tests'
 
-task :build => [:man]
-task :travis => [:test, :build]
+RuboCop::RakeTask.new(:rubocop)
+desc 'Run Rubocop Linter'
+
+task test: [:minitest, :rubocop]
+task default: [:test]
+
+task build: [:man]
+task travis: [:test, :build]
 
 def test_pandoc
-  return system("pandoc -v > /dev/null 2>&1")
+  system('pandoc -v > /dev/null 2>&1')
 end
 
 task :man do
-  puts "building manpages from wiki.."
+  puts 'building manpages from wiki..'
   unless test_pandoc
-    puts "no pandoc installed, needed for manpage generation."
+    puts 'no pandoc installed, needed for manpage generation.'
     return
   end
 
   # test if wiki is cloned
   unless Dir.exist? 'doc/wiki/man'
-    puts "wiki git repository is not cloned in doc/wiki, try: git submodule update --init."
+    puts 'wiki git repository is not cloned in doc/wiki, try: git submodule update --init.'
     return
   end
 
-  unless Dir.exist? 'man'
-    Dir.mkdir 'man'
-  end
+  Dir.mkdir 'man' unless Dir.exist? 'man'
 
-  Dir.glob("doc/wiki/man/*.md").each do |md|
+  Dir.glob('doc/wiki/man/*.md').each do |md|
     m = /^.*\/(?<manpage>[^\/]*)\.md$/.match(md)[:manpage]
     puts "generating manpage for: #{m}.."
     r = system "pandoc -s -f markdown -t man #{md} -o man/#{m}"
@@ -46,7 +51,7 @@ task :man do
 end
 
 task :clean do
-  ['man', 'pkg'].each do |d|
+  %w(man pkg).each do |d|
     puts "cleaning #{d}.."
     FileUtils.rm_r d if Dir.exist? d
   end