docquet 1.0.0

data/config/defaults/metrics.yml

@@ -0,0 +1,119 @@
+# Department 'Metrics' (10):
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsabcsize
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  References:
+  - https://wiki.c2.com/?AbcMetric
+  - https://en.wikipedia.org/wiki/ABC_Software_Metric
+  Enabled: true
+  VersionAdded: '0.27'
+  VersionChanged: '1.5'
+  AllowedMethods: []
+  AllowedPatterns: []
+  CountRepeatedAttributes: true
+  Max: 17
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocklength
+Metrics/BlockLength:
+  Description: Avoid long blocks with many lines.
+  Enabled: true
+  VersionAdded: '0.44'
+  VersionChanged: '1.5'
+  CountComments: false
+  Max: 25
+  CountAsOne: []
+  AllowedMethods:
+  - refine
+  AllowedPatterns: []
+  Exclude:
+  - "**/*.gemspec"
+  - "**/*_spec.rb"
+  - "**/spec/**/*"
+  inherit_mode:
+    merge:
+    - Exclude
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocknesting
+Metrics/BlockNesting:
+  Description: Avoid excessive block nesting.
+  StyleGuide: "#three-is-the-number-thou-shalt-count"
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '1.65'
+  CountBlocks: false
+  CountModifierForms: false
+  Max: 3
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsclasslength
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '0.87'
+  CountComments: false
+  Max: 100
+  CountAsOne: []
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricscollectionliterallength
+Metrics/CollectionLiteralLength:
+  Description: Checks for `Array` or `Hash` literals with many entries.
+  Enabled: true # was pending
+  VersionAdded: '1.47'
+  LengthThreshold: 250
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricscyclomaticcomplexity
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '0.81'
+  AllowedMethods: []
+  AllowedPatterns: []
+  Max: 7
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmethodlength
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: "#short-methods"
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '1.5'
+  CountComments: false
+  Max: 10
+  CountAsOne: []
+  AllowedMethods: []
+  AllowedPatterns: []
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmodulelength
+Metrics/ModuleLength:
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: true
+  VersionAdded: '0.31'
+  VersionChanged: '0.87'
+  CountComments: false
+  Max: 100
+  CountAsOne: []
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsparameterlists
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: "#too-many-params"
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '1.5'
+  Max: 5
+  CountKeywordArgs: true
+  MaxOptionalParameters: 3
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsperceivedcomplexity
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human reader.
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '0.81'
+  AllowedMethods: []
+  AllowedPatterns: []
+  Max: 8
+

data/config/defaults/migration.yml

@@ -0,0 +1,9 @@
+# Department 'Migration' (1):
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_migration.html#migrationdepartmentname
+Migration/DepartmentName:
+  Description: Check that cop names in rubocop:disable (etc) comments are given with
+    department name.
+  Enabled: true
+  VersionAdded: '0.75'
+

data/config/defaults/naming.yml

@@ -0,0 +1,332 @@
+# Department 'Naming' (19):
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingaccessormethodname
+Naming/AccessorMethodName:
+  Description: Checks the naming of accessor methods for get_/set_.
+  StyleGuide: "#accessor_mutator_method_names"
+  Enabled: true
+  VersionAdded: '0.50'
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingasciiidentifiers
+Naming/AsciiIdentifiers:
+  Description: Use only ascii symbols in identifiers and constants.
+  StyleGuide: "#english-identifiers"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '0.87'
+  AsciiConstants: true
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingbinaryoperatorparametername
+Naming/BinaryOperatorParameterName:
+  Description: When defining binary operators, name the argument other.
+  StyleGuide: "#other-arg"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.2'
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingblockforwarding
+Naming/BlockForwarding:
+  Description: Use anonymous block forwarding.
+  StyleGuide: "#block-forwarding"
+  Enabled: true # was pending
+  VersionAdded: '1.24'
+  EnforcedStyle: anonymous
+  SupportedStyles:
+  - anonymous
+  - explicit
+  BlockForwardingName: block
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingblockparametername
+Naming/BlockParameterName:
+  Description: Checks for block parameter names that contain capital letters, end in
+    numbers, or do not meet a minimal length.
+  Enabled: true
+  VersionAdded: '0.53'
+  VersionChanged: '0.77'
+  MinNameLength: 1
+  AllowNamesEndingInNumbers: true
+  AllowedNames: []
+  ForbiddenNames: []
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingclassandmodulecamelcase
+Naming/ClassAndModuleCamelCase:
+  Description: Use CamelCase for classes and modules.
+  StyleGuide: "#camelcase-classes"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '0.85'
+  AllowedNames:
+  - module_parent
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingconstantname
+Naming/ConstantName:
+  Description: Constants should use SCREAMING_SNAKE_CASE.
+  StyleGuide: "#screaming-snake-case"
+  Enabled: true
+  VersionAdded: '0.50'
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingfilename
+Naming/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: "#snake-case-files"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.23'
+  Exclude:
+  - "Rakefile.rb"
+  ExpectMatchingDefinition: false
+  CheckDefinitionPathHierarchy: true
+  CheckDefinitionPathHierarchyRoots:
+  - lib
+  - spec
+  - test
+  - src
+  Regex:
+  IgnoreExecutableScripts: true
+  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
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingheredocdelimitercase
+Naming/HeredocDelimiterCase:
+  Description: Use configured case for heredoc delimiters.
+  StyleGuide: "#heredoc-delimiters"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.2'
+  EnforcedStyle: uppercase
+  SupportedStyles:
+  - lowercase
+  - uppercase
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingheredocdelimiternaming
+Naming/HeredocDelimiterNaming:
+  Description: Use descriptive heredoc delimiters.
+  StyleGuide: "#heredoc-delimiters"
+  Enabled: true
+  VersionAdded: '0.50'
+  ForbiddenDelimiters:
+  - !ruby/regexp /(^|\s)(EO[A-Z]{1}|END)(\s|$)/i
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#naminginclusivelanguage
+Naming/InclusiveLanguage:
+  Description: Recommend the use of inclusive language instead of problematic terms.
+  Enabled: true # was false
+  VersionAdded: '1.18'
+  VersionChanged: '1.49'
+  CheckIdentifiers: true
+  CheckConstants: true
+  CheckVariables: true
+  CheckStrings: false
+  CheckSymbols: true
+  CheckComments: true
+  CheckFilepaths: true
+  FlaggedTerms:
+    whitelist:
+      Regex: !ruby/regexp /white[-_\s]?list/
+      Suggestions:
+      - allowlist
+      - permit
+    blacklist:
+      Regex: !ruby/regexp /black[-_\s]?list/
+      Suggestions:
+      - denylist
+      - block
+    slave:
+      WholeWord: true
+      Suggestions:
+      - replica
+      - secondary
+      - follower
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingmemoizedinstancevariablename
+Naming/MemoizedInstanceVariableName:
+  Description: Memoized method name should match memo instance variable name.
+  Enabled: true
+  VersionAdded: '0.53'
+  VersionChanged: '1.2'
+  EnforcedStyleForLeadingUnderscores: disallowed
+  SupportedStylesForLeadingUnderscores:
+  - disallowed
+  - required
+  - optional
+  Safe: false
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingmethodname
+Naming/MethodName:
+  Description: Use the configured style when naming methods.
+  StyleGuide: "#snake-case-symbols-methods-vars"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.75'
+  EnforcedStyle: snake_case
+  SupportedStyles:
+  - snake_case
+  - camelCase
+  AllowedPatterns: []
+  ForbiddenIdentifiers:
+  - __id__
+  - __send__
+  ForbiddenPatterns: []
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingmethodparametername
+Naming/MethodParameterName:
+  Description: Checks for method parameter names that contain capital letters, end in
+    numbers, or do not meet a minimal length.
+  Enabled: true
+  VersionAdded: '0.53'
+  VersionChanged: '0.77'
+  MinNameLength: 3
+  AllowNamesEndingInNumbers: true
+  AllowedNames:
+  - as
+  - at
+  - by
+  - cc
+  - db
+  - id
+  - if
+  - in
+  - io
+  - ip
+  - of
+  - 'on'
+  - os
+  - pp
+  - to
+  ForbiddenNames: []
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicatemethod
+Naming/PredicateMethod:
+  Description: Checks that predicate methods end with `?` and non-predicate methods
+    do not.
+  Enabled: true # was pending
+  VersionAdded: '1.76'
+  VersionChanged: '1.78'
+  Mode: conservative
+  AllowedMethods:
+  - call
+  AllowedPatterns: []
+  AllowBangMethods: false
+  WaywardPredicates:
+  - nonzero?
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicateprefix
+Naming/PredicatePrefix:
+  Description: Predicate method names should not be prefixed and end with a `?`.
+  StyleGuide: "#bool-methods-qmark"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.75'
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  - does_
+  ForbiddenPrefixes:
+  - is_
+  - has_
+  - have_
+  - does_
+  AllowedMethods:
+  - is_a?
+  MethodDefinitionMacros:
+  - define_method
+  - define_singleton_method
+  UseSorbetSigs: false
+  Exclude:
+  - "spec/**/*"
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingrescuedexceptionsvariablename
+Naming/RescuedExceptionsVariableName:
+  Description: Use consistent rescued exceptions variables naming.
+  Enabled: true
+  VersionAdded: '0.67'
+  VersionChanged: '0.68'
+  PreferredName: e
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablename
+Naming/VariableName:
+  Description: Use the configured style when naming variables.
+  StyleGuide: "#snake-case-symbols-methods-vars"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.73'
+  EnforcedStyle: snake_case
+  SupportedStyles:
+  - snake_case
+  - camelCase
+  AllowedIdentifiers: []
+  AllowedPatterns: []
+  ForbiddenIdentifiers: []
+  ForbiddenPatterns: []
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablenumber
+Naming/VariableNumber:
+  Description: Use the configured style when numbering symbols, methods and variables.
+  StyleGuide: "#snake-case-symbols-methods-vars-with-numbers"
+  Enabled: true
+  VersionAdded: '0.50'
+  VersionChanged: '1.4'
+  EnforcedStyle: normalcase
+  SupportedStyles:
+  - snake_case
+  - normalcase
+  - non_integer
+  CheckMethodNames: true
+  CheckSymbols: true
+  AllowedIdentifiers:
+  - TLS1_1
+  - TLS1_2
+  - capture3
+  - iso8601
+  - rfc1123_date
+  - rfc822
+  - rfc2822
+  - rfc3339
+  - x86_64
+  AllowedPatterns: []
+