.rubocop_todo.yml

# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2021-05-05 23:47:56 UTC using RuboCop version 1.13.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: 1
# Cop supports --auto-correct.
# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
# Include: **/*.gemspec
Gemspec/OrderedDependencies:
  Exclude:
    - 'blacklight-spotlight.gemspec'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleAlignWith, Severity.
# SupportedStylesAlignWith: start_of_line, begin
Layout/BeginEndAlignment:
  Exclude:
    - 'app/models/spotlight/analytics/ga.rb'
    - 'app/services/spotlight/iiif_resource_resolver.rb'

# Offense count: 3
# Cop supports --auto-correct.
Layout/RescueEnsureAlignment:
  Exclude:
    - 'app/models/spotlight/analytics/ga.rb'
    - 'app/services/spotlight/iiif_resource_resolver.rb'

# Offense count: 4
# Configuration parameters: IgnoredMethods.
Lint/AmbiguousBlockAssociation:
  Exclude:
    - 'spec/controllers/spotlight/featured_images_controller_spec.rb'
    - 'spec/controllers/spotlight/roles_controller_spec.rb'
    - 'spec/features/report_a_problem_spec.rb'
    - 'spec/models/spotlight/resources/iiif_service_spec.rb'

# Offense count: 6
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
  Exclude:
    - 'Rakefile'
    - 'spec/lib/spotlight/controller_spec.rb'
    - 'spec/models/sir_trevor_rails/blocks/textable_spec.rb'
    - 'spec/models/spotlight/access_controls_enforcement_search_builder_spec.rb'
    - 'spec/models/spotlight/browse_category_search_builder_spec.rb'
    - 'spec/models/spotlight/resources/web_spec.rb'

# Offense count: 2
# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
Lint/DuplicateBranch:
  Exclude:
    - 'app/controllers/spotlight/concerns/application_controller.rb'
    - 'app/models/spotlight/resources/iiif_manifest.rb'

# Offense count: 1
Lint/DuplicateRequire:
  Exclude:
    - 'spec/spec_helper.rb'

# Offense count: 2
# Configuration parameters: AllowComments, AllowEmptyLambdas.
Lint/EmptyBlock:
  Exclude:
    - 'Rakefile'
    - 'spec/factories/users.rb'

# Offense count: 1
# Configuration parameters: AllowComments.
Lint/EmptyFile:
  Exclude:
    - 'spec/lib/spotlight/catalog_spec.rb'

# Offense count: 4
# Configuration parameters: MaximumRangeSize.
Lint/MissingCopEnableDirective:
  Exclude:
    - 'app/controllers/spotlight/catalog_controller.rb'
    - 'app/models/spotlight/blacklight_configuration.rb'
    - 'lib/spotlight/engine.rb'

# Offense count: 2
Lint/MissingSuper:
  Exclude:
    - 'app/services/spotlight/carrierwave_file_resolver.rb'
    - 'spec/models/spotlight/access_controls_enforcement_search_builder_spec.rb'

# Offense count: 1
Lint/NoReturnInBeginEndBlocks:
  Exclude:
    - 'app/models/spotlight/exhibit.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowedMethods.
# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal?
Lint/RedundantSafeNavigation:
  Exclude:
    - 'app/controllers/spotlight/catalog_controller.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AllowComments.
Lint/UselessMethodDefinition:
  Exclude:
    - 'app/controllers/spotlight/about_pages_controller.rb'
    - 'app/controllers/spotlight/feature_pages_controller.rb'
    - 'app/controllers/spotlight/home_pages_controller.rb'

# Offense count: 25
# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
Metrics/AbcSize:
  Max: 22

# Offense count: 7
# Configuration parameters: IgnoredMethods.
Metrics/CyclomaticComplexity:
  Max: 9

# Offense count: 10
# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
Metrics/MethodLength:
  Max: 11

# Offense count: 2
# Configuration parameters: IgnoredMethods.
Metrics/PerceivedComplexity:
  Max: 10

# Offense count: 6
# Configuration parameters: ForbiddenDelimiters.
# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
Naming/HeredocDelimiterNaming:
  Exclude:
    - 'lib/generators/spotlight/install_generator.rb'
    - 'spec/support/features/test_features_helpers.rb'
    - 'spec/test_app_templates/lib/generators/test_app_generator.rb'

# Offense count: 8
# Configuration parameters: EnforcedStyleForLeadingUnderscores.
# SupportedStylesForLeadingUnderscores: disallowed, required, optional
Naming/MemoizedInstanceVariableName:
  Exclude:
    - 'app/controllers/concerns/spotlight/controller.rb'
    - 'app/controllers/spotlight/admin_users_controller.rb'
    - 'app/controllers/spotlight/resources/csv_upload_controller.rb'
    - 'app/controllers/spotlight/resources/upload_controller.rb'
    - 'app/controllers/spotlight/sites_controller.rb'
    - 'app/models/concerns/spotlight/solr_document/finder.rb'
    - 'app/models/spotlight/field_metadata.rb'

# Offense count: 9
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
Naming/MethodParameterName:
  Exclude:
    - 'app/helpers/spotlight/crop_helper.rb'
    - 'app/models/concerns/spotlight/sitemap.rb'
    - 'app/models/spotlight/blacklight_configuration.rb'
    - 'app/models/spotlight/filter.rb'
    - 'app/models/spotlight/resources/iiif_manifest.rb'

# Offense count: 14
# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
# SupportedStyles: snake_case, normalcase, non_integer
# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
Naming/VariableNumber:
  Exclude:
    - 'spec/features/browse_category_navigation_spec.rb'
    - 'spec/features/exhibits/administration_spec.rb'
    - 'spec/models/sir_trevor_rails/blocks/browse_block_spec.rb'
    - 'spec/services/spotlight/exhibit_import_export_service_spec.rb'

# Offense count: 64
RSpec/AnyInstance:
  Enabled: false

# Offense count: 2
RSpec/BeforeAfterAll:
  Exclude:
    - 'spec/features/exhibits/translation_editing_spec.rb'
    - 'spec/features/javascript/locale_selector_spec.rb'

# Offense count: 56
# Configuration parameters: Prefixes.
# Prefixes: when, with, without
RSpec/ContextWording:
  Enabled: false

# Offense count: 1
RSpec/EmptyExampleGroup:
  Exclude:
    - 'spec/factories/tags.rb'

# Offense count: 8
RSpec/ExpectInHook:
  Exclude:
    - 'spec/lib/migration/iiif_spec.rb'
    - 'spec/services/spotlight/iiif_resource_resolver_spec.rb'
    - 'spec/views/spotlight/catalog/_edit_default.html.erb_spec.rb'

# Offense count: 5
RSpec/LeakyConstantDeclaration:
  Exclude:
    - 'spec/lib/spotlight/controller_spec.rb'
    - 'spec/models/sir_trevor_rails/blocks/textable_spec.rb'
    - 'spec/models/spotlight/access_controls_enforcement_search_builder_spec.rb'
    - 'spec/models/spotlight/browse_category_search_builder_spec.rb'
    - 'spec/models/spotlight/resources/web_spec.rb'

# Offense count: 57
RSpec/LetSetup:
  Enabled: false

# Offense count: 4
RSpec/MessageChain:
  Exclude:
    - 'spec/helpers/spotlight/application_helper_spec.rb'
    - 'spec/models/spotlight/analytics/ga_spec.rb'
    - 'spec/models/spotlight/blacklight_configuration_spec.rb'
    - 'spec/views/spotlight/browse/_search.html.erb_spec.rb'

# Offense count: 207
# Configuration parameters: EnforcedStyle.
# SupportedStyles: have_received, receive
RSpec/MessageSpies:
  Enabled: false

# Offense count: 2
RSpec/MissingExampleGroupArgument:
  Exclude:
    - 'spec/factories/tags.rb'
    - 'spec/views/spotlight/search_configurations/_facets.html.erb_spec.rb'

# Offense count: 84
# Configuration parameters: AllowSubject.
RSpec/MultipleMemoizedHelpers:
  Max: 18

# Offense count: 804
# Configuration parameters: IgnoreSharedExamples.
RSpec/NamedSubject:
  Enabled: false

# Offense count: 8
RSpec/RepeatedDescription:
  Exclude:
    - 'spec/models/spotlight/blacklight_configuration_spec.rb'
    - 'spec/models/spotlight/solr_document_sidecar_spec.rb'

# Offense count: 3
RSpec/RepeatedExampleGroupBody:
  Exclude:
    - 'spec/controllers/spotlight/featured_images_controller_spec.rb'

# Offense count: 20
RSpec/ScatteredSetup:
  Exclude:
    - 'spec/controllers/spotlight/solr_controller_spec.rb'
    - 'spec/features/item_admin_spec.rb'
    - 'spec/helpers/spotlight/main_app_helpers_spec.rb'
    - 'spec/views/spotlight/browse/_search.html.erb_spec.rb'
    - 'spec/views/spotlight/browse/show.html.erb_spec.rb'
    - 'spec/views/spotlight/sir_trevor/blocks/_solr_documents_block.html.erb_spec.rb'
    - 'spec/views/spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb_spec.rb'
    - 'spec/views/spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb_spec.rb'

# Offense count: 59
RSpec/StubbedMock:
  Enabled: false

# Offense count: 70
RSpec/SubjectStub:
  Enabled: false

# Offense count: 71
# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
RSpec/VerifiedDoubles:
  Enabled: false

# Offense count: 4
RSpec/VoidExpect:
  Exclude:
    - 'spec/helpers/spotlight/crud_link_helpers_spec.rb'

# Offense count: 1
# Cop supports --auto-correct.
Rails/ApplicationController:
  Exclude:
    - 'spec/lib/spotlight/controller_spec.rb'

# Offense count: 3
# Cop supports --auto-correct.
Rails/ApplicationMailer:
  Exclude:
    - 'app/mailers/spotlight/confirmation_mailer.rb'
    - 'app/mailers/spotlight/indexing_complete_mailer.rb'
    - 'app/mailers/spotlight/invitation_mailer.rb'

# Offense count: 23
# Cop supports --auto-correct.
Rails/ApplicationRecord:
  Enabled: false

# Offense count: 12
# Cop supports --auto-correct.
# Configuration parameters: NilOrEmpty, NotPresent, UnlessPresent.
Rails/Blank:
  Exclude:
    - 'app/controllers/spotlight/exhibits_controller.rb'
    - 'app/helpers/spotlight/application_helper.rb'
    - 'app/jobs/spotlight/add_uploads_from_csv.rb'
    - 'app/models/spotlight/blacklight_configuration.rb'
    - 'app/models/spotlight/featured_image.rb'
    - 'app/models/spotlight/page.rb'
    - 'app/models/spotlight/resources/iiif_manifest.rb'
    - 'app/models/spotlight/resources/iiif_service.rb'
    - 'lib/migration/iiif.rb'
    - 'spec/support/features/test_features_helpers.rb'

# Offense count: 9
# Cop supports --auto-correct.
Rails/ContentTag:
  Exclude:
    - 'app/builders/spotlight/bootstrap_breadcrumbs_builder.rb'
    - 'app/helpers/spotlight/crop_helper.rb'
    - 'app/helpers/spotlight/crud_link_helpers.rb'
    - 'app/helpers/spotlight/title_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: Whitelist, AllowedMethods, AllowedReceivers.
# Whitelist: find_by_sql
# AllowedMethods: find_by_sql
# AllowedReceivers: Gem::Specification
Rails/DynamicFindBy:
  Exclude:
    - 'app/models/spotlight/role.rb'

# Offense count: 6
# Configuration parameters: Include.
# Include: app/models/**/*.rb
Rails/HasManyOrHasOneDependent:
  Exclude:
    - 'app/models/spotlight/exhibit.rb'
    - 'app/models/spotlight/feature_page.rb'
    - 'app/models/spotlight/group.rb'
    - 'app/models/spotlight/resource.rb'
    - 'app/models/spotlight/site.rb'

# Offense count: 5
# Configuration parameters: Include.
# Include: app/helpers/**/*.rb
Rails/HelperInstanceVariable:
  Exclude:
    - 'app/helpers/spotlight/application_helper.rb'
    - 'app/helpers/spotlight/browse_helper.rb'
    - 'app/helpers/spotlight/pages_helper.rb'
    - 'app/helpers/spotlight/title_helper.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: numeric, symbolic
Rails/HttpStatus:
  Exclude:
    - 'app/controllers/spotlight/lock_controller.rb'
    - 'app/controllers/spotlight/solr_controller.rb'

# Offense count: 2
# Cop supports --auto-correct.
Rails/IndexBy:
  Exclude:
    - 'app/helpers/spotlight/roles_helper.rb'
    - 'app/models/spotlight/resources/iiif_manifest.rb'

# Offense count: 6
# Cop supports --auto-correct.
Rails/IndexWith:
  Exclude:
    - 'app/controllers/spotlight/metadata_configurations_controller.rb'
    - 'app/controllers/spotlight/search_configurations_controller.rb'
    - 'app/models/spotlight/blacklight_configuration.rb'

# Offense count: 4
# Configuration parameters: Include.
# Include: app/models/**/*.rb
Rails/InverseOf:
  Exclude:
    - 'app/models/spotlight/exhibit.rb'
    - 'app/models/spotlight/site.rb'

# Offense count: 4
# Configuration parameters: Include.
# Include: app/controllers/**/*.rb
Rails/LexicallyScopedActionFilter:
  Exclude:
    - 'app/controllers/spotlight/catalog_controller.rb'
    - 'app/controllers/spotlight/resources/upload_controller.rb'
    - 'app/controllers/spotlight/resources_controller.rb'

# Offense count: 4
Rails/OutputSafety:
  Exclude:
    - 'app/controllers/spotlight/application_controller.rb'
    - 'app/helpers/spotlight/pages_helper.rb'
    - 'app/helpers/spotlight/rendering_helper.rb'
    - 'app/helpers/spotlight/title_helper.rb'

# Offense count: 3
# Cop supports --auto-correct.
Rails/Pluck:
  Exclude:
    - 'app/models/sir_trevor_rails/blocks/displayable.rb'
    - 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: conservative, aggressive
Rails/PluckInWhere:
  Exclude:
    - 'app/models/concerns/spotlight/user.rb'

# Offense count: 5
# Cop supports --auto-correct.
Rails/Presence:
  Exclude:
    - 'app/helpers/spotlight/application_helper.rb'
    - 'app/helpers/spotlight/title_helper.rb'
    - 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb'
    - 'app/models/spotlight/main_navigation.rb'

# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: NotNilAndNotEmpty, NotBlank, UnlessBlank.
Rails/Present:
  Exclude:
    - 'app/models/concerns/spotlight/exhibit_defaults.rb'
    - 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb'
    - 'app/models/spotlight/blacklight_configuration.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: Include.
# Include: **/Rakefile, **/*.rake
Rails/RakeEnvironment:
  Exclude:
    - 'Rakefile'
    - 'spec/test_app_templates/spotlight_test.rake'

# Offense count: 4
Rails/ReflectionClassName:
  Exclude:
    - 'app/models/spotlight/exhibit.rb'
    - 'app/models/spotlight/page.rb'
    - 'app/models/spotlight/role.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: conservative, aggressive
Rails/ShortI18n:
  Exclude:
    - 'app/models/concerns/spotlight/translatables.rb'

# Offense count: 6
# Configuration parameters: ForbiddenMethods, AllowedMethods.
# ForbiddenMethods: decrement!, decrement_counter, increment!, increment_counter, insert, insert!, insert_all, insert_all!, toggle!, touch, touch_all, update_all, update_attribute, update_column, update_columns, update_counters, upsert, upsert_all
Rails/SkipsModelValidations:
  Exclude:
    - 'app/models/spotlight/featured_image.rb'
    - 'app/models/spotlight/resource.rb'

# Offense count: 1
# Configuration parameters: Environments.
# Environments: development, test, production
Rails/UnknownEnv:
  Exclude:
    - 'spec/test_app_templates/carrierwave.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: separated, grouped
Style/AccessorGrouping:
  Exclude:
    - 'app/jobs/spotlight/add_uploads_from_csv.rb'

# Offense count: 1
# Configuration parameters: AllowedChars.
# AllowedChars: ©
Style/AsciiComments:
  Exclude:
    - 'app/models/spotlight/featured_image.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Exclude:
    - 'lib/generators/spotlight/templates/config/initializers/sir_trevor_rails.rb'

# Offense count: 1
Style/CombinableLoops:
  Exclude:
    - 'app/services/spotlight/exhibit_import_export_service.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: Keywords.
# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
Style/CommentAnnotation:
  Exclude:
    - 'app/models/concerns/spotlight/solr_document.rb'
    - 'app/models/spotlight/exhibit.rb'
    - 'app/models/spotlight/page.rb'
    - 'spec/controllers/spotlight/contact_email_controller_spec.rb'

# Offense count: 2
# Cop supports --auto-correct.
Style/CommentedKeyword:
  Exclude:
    - 'spec/features/javascript/search_config_admin_spec.rb'

# Offense count: 4
# Cop supports --auto-correct.
Style/ExplicitBlockArgument:
  Exclude:
    - 'app/controllers/spotlight/translations_controller.rb'
    - 'app/models/concerns/spotlight/exhibit_documents.rb'
    - 'app/models/concerns/spotlight/solr_document/finder.rb'
    - 'app/models/spotlight/search.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/GlobalStdStream:
  Exclude:
    - 'lib/tasks/spotlight_tasks.rake'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: braces, no_braces
Style/HashAsLastArrayItem:
  Exclude:
    - 'app/controllers/spotlight/catalog_controller.rb'
    - 'app/controllers/spotlight/pages_controller.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/HashEachMethods:
  Exclude:
    - 'app/models/spotlight/blacklight_configuration.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/HashTransformKeys:
  Exclude:
    - 'app/models/spotlight/field_metadata.rb'

# Offense count: 4
# Cop supports --auto-correct.
Style/HashTransformValues:
  Exclude:
    - 'app/models/concerns/spotlight/blacklight_configuration_defaults.rb'
    - 'app/models/spotlight/field_metadata.rb'
    - 'app/models/spotlight/page_configurations.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/KeywordParametersOrder:
  Exclude:
    - 'lib/spotlight/upload_field_config.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, IgnoredMethods.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  Exclude:
    - 'lib/tasks/spotlight_tasks.rake'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: Methods.
Style/RedundantArgument:
  Exclude:
    - 'app/helpers/spotlight/search_configurations_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/RedundantRegexpCharacterClass:
  Exclude:
    - 'app/models/spotlight/contact_form.rb'

# Offense count: 3
# Cop supports --auto-correct.
Style/RedundantRegexpEscape:
  Exclude:
    - 'app/helpers/spotlight/pages_helper.rb'
    - 'app/models/spotlight/contact_form.rb'

# Offense count: 4
# Cop supports --auto-correct.
Style/StringConcatenation:
  Exclude:
    - 'lib/generators/spotlight/install_generator.rb'
    - 'spec/features/feature_page_spec.rb'
    - 'spec/support/features/test_features_helpers.rb'
    - 'spec/views/spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb_spec.rb'