ruby-grape/grape

View on GitHub
.rubocop_todo.yml

Summary

Maintainability
Test Coverage
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2024-04-17 16:26:06 UTC using RuboCop version 1.63.2.
# 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: 1
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: Severity, Include.
# Include: **/*.gemspec
Gemspec/RequireMFA:
  Exclude:
    - 'grape.gemspec'

# Offense count: 1
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowedMethods, AllowedPatterns.
Lint/AmbiguousBlockAssociation:
  Exclude:
    - 'spec/grape/dsl/routing_spec.rb'

# Offense count: 1
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
  Exclude:
    - 'spec/grape/validations/validators/except_values_spec.rb'

# Offense count: 3
# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
Lint/DuplicateBranch:
  Exclude:
    - 'spec/support/versioned_helpers.rb'

# Offense count: 1
# Configuration parameters: AllowComments.
Lint/EmptyClass:
  Exclude:
    - 'lib/grape/dsl/parameters.rb'

# Offense count: 5
# Configuration parameters: AllowedParentClasses.
Lint/MissingSuper:
  Exclude:
    - 'lib/grape/api/instance.rb'
    - 'lib/grape/exceptions/validation_array_errors.rb'
    - 'lib/grape/namespace.rb'
    - 'lib/grape/path.rb'
    - 'lib/grape/router/pattern.rb'

# Offense count: 1
# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
Metrics/MethodLength:
  Exclude:
    - 'lib/grape/endpoint.rb'

# Offense count: 2
# This cop supports unsafe autocorrection (--autocorrect-all).
# Configuration parameters: EnforcedStyleForLeadingUnderscores.
# SupportedStylesForLeadingUnderscores: disallowed, required, optional
Naming/MemoizedInstanceVariableName:
  Exclude:
    - 'lib/grape/api/instance.rb'
    - 'lib/grape/middleware/base.rb'

# Offense count: 5
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
Naming/MethodParameterName:
  Exclude:
    - 'lib/grape/endpoint.rb'
    - 'lib/grape/middleware/error.rb'
    - 'lib/grape/middleware/stack.rb'
    - 'spec/grape/api_spec.rb'

# Offense count: 18
# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
# SupportedStyles: snake_case, normalcase, non_integer
# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
Naming/VariableNumber:
  Exclude:
    - 'spec/grape/dsl/settings_spec.rb'
    - 'spec/grape/exceptions/validation_errors_spec.rb'
    - 'spec/grape/validations_spec.rb'

# Offense count: 2
RSpec/AnyInstance:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/middleware/base_spec.rb'

# Offense count: 1
# Configuration parameters: IgnoredMetadata.
RSpec/DescribeClass:
  Exclude:
    - '**/spec/features/**/*'
    - '**/spec/requests/**/*'
    - '**/spec/routing/**/*'
    - '**/spec/system/**/*'
    - '**/spec/views/**/*'
    - 'spec/grape/named_api_spec.rb'

# Offense count: 3
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples.
# DisallowedExamples: works
RSpec/ExampleWording:
  Exclude:
    - 'spec/grape/integration/global_namespace_function_spec.rb'
    - 'spec/grape/validations_spec.rb'

# Offense count: 7
# This cop supports safe autocorrection (--autocorrect).
RSpec/ExpectActual:
  Exclude:
    - '**/spec/routing/**/*'
    - 'spec/grape/endpoint/declared_spec.rb'
    - 'spec/grape/middleware/exception_spec.rb'

# Offense count: 3
RSpec/ExpectInHook:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/validations/validators/values_spec.rb'

# Offense count: 6
# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
RSpec/IndexedLet:
  Exclude:
    - 'spec/grape/exceptions/validation_errors_spec.rb'
    - 'spec/grape/presenters/presenter_spec.rb'
    - 'spec/shared/versioning_examples.rb'

# Offense count: 39
# Configuration parameters: AssignmentOnly.
RSpec/InstanceVariable:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/endpoint_spec.rb'
    - 'spec/grape/middleware/base_spec.rb'
    - 'spec/grape/middleware/versioner/accept_version_header_spec.rb'
    - 'spec/grape/middleware/versioner/header_spec.rb'
    - 'spec/grape/validations/validators/except_values_spec.rb'

# Offense count: 6
RSpec/LeakyConstantDeclaration:
  Exclude:
    - 'spec/grape/validations/validators/except_values_spec.rb'

# Offense count: 2
RSpec/MessageChain:
  Exclude:
    - 'spec/grape/middleware/formatter_spec.rb'

# Offense count: 144
# Configuration parameters: .
# SupportedStyles: have_received, receive
RSpec/MessageSpies:
  EnforcedStyle: receive

# Offense count: 12
RSpec/MissingExampleGroupArgument:
  Exclude:
    - 'spec/grape/middleware/exception_spec.rb'

# Offense count: 17
# Configuration parameters: AllowedPatterns.
# AllowedPatterns: ^expect_, ^assert_
RSpec/NoExpectationExample:
  Exclude:
    - 'spec/grape/api_remount_spec.rb'
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/validations_spec.rb'

# Offense count: 12
RSpec/RepeatedDescription:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/endpoint_spec.rb'
    - 'spec/grape/validations/validators/allow_blank_spec.rb'
    - 'spec/grape/validations/validators/values_spec.rb'

# Offense count: 8
RSpec/RepeatedExample:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/middleware/versioner/accept_version_header_spec.rb'
    - 'spec/grape/validations/validators/allow_blank_spec.rb'

# Offense count: 10
RSpec/RepeatedExampleGroupDescription:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/endpoint_spec.rb'
    - 'spec/grape/util/inheritable_setting_spec.rb'
    - 'spec/grape/validations/validators/values_spec.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
RSpec/ScatteredSetup:
  Exclude:
    - 'spec/grape/util/inheritable_setting_spec.rb'

# Offense count: 8
RSpec/StubbedMock:
  Exclude:
    - 'spec/grape/dsl/inside_route_spec.rb'
    - 'spec/grape/dsl/routing_spec.rb'
    - 'spec/grape/middleware/formatter_spec.rb'
    - 'spec/grape/parser_spec.rb'

# Offense count: 122
RSpec/SubjectStub:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/dsl/callbacks_spec.rb'
    - 'spec/grape/dsl/helpers_spec.rb'
    - 'spec/grape/dsl/inside_route_spec.rb'
    - 'spec/grape/dsl/middleware_spec.rb'
    - 'spec/grape/dsl/parameters_spec.rb'
    - 'spec/grape/dsl/request_response_spec.rb'
    - 'spec/grape/dsl/routing_spec.rb'
    - 'spec/grape/dsl/settings_spec.rb'
    - 'spec/grape/middleware/base_spec.rb'
    - 'spec/grape/middleware/formatter_spec.rb'
    - 'spec/grape/middleware/globals_spec.rb'
    - 'spec/grape/middleware/stack_spec.rb'
    - 'spec/grape/parser_spec.rb'

# Offense count: 24
# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
RSpec/VerifiedDoubles:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/dsl/inside_route_spec.rb'
    - 'spec/grape/integration/rack_sendfile_spec.rb'
    - 'spec/grape/middleware/formatter_spec.rb'
    - 'spec/grape/validations/multiple_attributes_iterator_spec.rb'
    - 'spec/grape/validations/single_attribute_iterator_spec.rb'

# Offense count: 2
RSpec/VoidExpect:
  Exclude:
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/dsl/headers_spec.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/CombinableLoops:
  Exclude:
    - 'spec/grape/endpoint_spec.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
# SupportedStyles: annotated, template, unannotated
Style/FormatStringToken:
  EnforcedStyle: template

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/MapIntoArray:
  Exclude:
    - 'spec/support/chunks.rb'

# Offense count: 12
# Configuration parameters: AllowedMethods.
# AllowedMethods: respond_to_missing?
Style/OptionalBooleanParameter:
  Exclude:
    - 'lib/grape/api.rb'
    - 'lib/grape/dsl/inside_route.rb'
    - 'lib/grape/dsl/parameters.rb'
    - 'lib/grape/endpoint.rb'
    - 'lib/grape/serve_stream/sendfile_response.rb'
    - 'lib/grape/validations/params_scope.rb'
    - 'lib/grape/validations/types/array_coercer.rb'
    - 'lib/grape/validations/types/custom_type_collection_coercer.rb'
    - 'lib/grape/validations/types/dry_type_coercer.rb'
    - 'lib/grape/validations/types/primitive_coercer.rb'
    - 'lib/grape/validations/types/set_coercer.rb'

# Offense count: 29
# This cop supports safe autocorrection (--autocorrect).
Style/RedundantConstantBase:
  Exclude:
    - 'spec/grape/api/invalid_format_spec.rb'
    - 'spec/grape/api_spec.rb'
    - 'spec/grape/dsl/logger_spec.rb'
    - 'spec/grape/endpoint/declared_spec.rb'
    - 'spec/grape/endpoint_spec.rb'
    - 'spec/grape/middleware/formatter_spec.rb'
    - 'spec/grape/validations/validators/coerce_spec.rb'
    - 'spec/grape/validations/validators/default_spec.rb'
    - 'spec/integration/multi_json/json_spec.rb'
    - 'spec/integration/multi_xml/xml_spec.rb'

# Offense count: 2
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowAsExpressionSeparator.
Style/Semicolon:
  Exclude:
    - 'spec/grape/api_spec.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
# 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/grape/api.rb'

# Offense count: 1
# This cop supports unsafe autocorrection (--autocorrect-all).
Style/ZeroLengthPredicate:
  Exclude:
    - 'lib/grape/validations/validators/exactly_one_of_validator.rb'