From c029a5b647db9633a1b8255c851e996297ec0b85 Mon Sep 17 00:00:00 2001
From: Francois Buys <buys.fran@gmail.com>
Date: Tue, 5 Oct 2021 10:51:23 +0200
Subject: [PATCH] Add rubocop_todo

So we can ignore the non-safe linting errors for now.
We can open additional issues to fix the remaining linting issues.

CI will use the todo file and therefore not fail while we have time to
fix the remaining linting issues.

IDE integration should still report on all the errors until we fix them.
---
 .github/workflows/rubocop.yml |   1 -
 .rubocop_todo.yml             | 439 ++++++++++++++++++++++++++++++++++
 2 files changed, 439 insertions(+), 1 deletion(-)
 create mode 100644 .rubocop_todo.yml

diff --git a/.github/workflows/rubocop.yml b/.github/workflows/rubocop.yml
index a412645..1f067ad 100644
--- a/.github/workflows/rubocop.yml
+++ b/.github/workflows/rubocop.yml
@@ -14,5 +14,4 @@ jobs:
           ruby-version: '2.7'
       - run: gem install rubocop bundler
       - run: bundle install
-      - run: bundle exec rubocop -A lib/Getopt/Declare.rb
       - run: bundle exec rubocop -c .rubocop_with_todo.yml
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
new file mode 100644
index 0000000..4194630
--- /dev/null
+++ b/.rubocop_todo.yml
@@ -0,0 +1,439 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-10-05 08:47:12 UTC using RuboCop version 1.20.0.
+# 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: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: leading, trailing
+Layout/DotPosition:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'timetrap.gemspec'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/timetrap/models.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+    - 'timetrap.gemspec'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/FirstHashElementIndentation:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 22
+# Cop supports --auto-correct.
+Layout/HeredocIndentation:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: symmetrical, new_line, same_line
+Layout/MultilineHashBraceLayout:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: symmetrical, new_line, same_line
+Layout/MultilineMethodCallBraceLayout:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceBeforeComma:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/timetrap/cli.rb'
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 1
+Lint/UnreachableCode:
+  Exclude:
+    - 'lib/timetrap/formatters/factor.rb'
+
+# Offense count: 18
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+    - 'lib/timetrap/helpers.rb'
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+Naming/BlockParameterName:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+
+# Offense count: 5
+Naming/ConstantName:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+
+# Offense count: 136
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+
+# Offense count: 2
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: SkipBlocks, EnforcedStyle.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowConsecutiveOneLiners.
+RSpec/EmptyLineAfterExample:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterExampleGroup:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterFinalLet:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterHook:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 153
+# Cop supports --auto-correct.
+# Configuration parameters: CustomTransform, IgnoredWords.
+RSpec/ExampleWording:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 6
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 2
+RSpec/ExpectOutput:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, each, example
+RSpec/HookArgument:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 88
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 54
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 67
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Strict, EnforcedStyle, AllowedExplicitMatchers.
+# SupportedStyles: inflected, explicit
+RSpec/PredicateMatcher:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 2
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 6
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+Security/Eval:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'timetrap.gemspec'
+
+# Offense count: 143
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantPercentQ:
+  Exclude:
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/timetrap/schema.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantSort:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/StringChars:
+  Exclude:
+    - 'lib/Getopt/DelimScanner.rb'
+
+# Offense count: 477
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+    - 'lib/timetrap/version.rb'
+    - 'spec/timetrap_spec.rb'
+    - 'timetrap.gemspec'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiteralsInInterpolation:
+  Exclude:
+    - 'lib/timetrap/timer.rb'
+    - 'spec/timetrap_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: forbid_for_all_comparison_operators, forbid_for_equality_operators_only, require_for_all_comparison_operators, require_for_equality_operators_only
+Style/YodaCondition:
+  Exclude:
+    - 'lib/timetrap/auto_sheets/nested_dotfiles.rb'