Merge pull request #293 from jcraigk/rubocop

Rubocop auto-correct and comprehensive todo

Author: dblock

.rubocop.yml

@@ -1,21 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
+  DisplayCopNames: true
   Exclude:
+    - bin/**/*
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
-
-Metrics:
+    - lib/slack/web/api/endpoints/* # Auto-generated
+    - spec/slack/web/api/endpoints/* # Auto-generated
+Layout/EmptyLineAfterMagicComment:
   Enabled: false
-
+Metrics/BlockLength:
+  Max: 250
+Metrics/ClassLength:
+  Max: 250
 Metrics/LineLength:
-  Max: 512
-
+  Max: 100
 Style/Documentation:
   Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Style/ModuleFunction:
-  Enabled: false
-
-inherit_from: .rubocop_todo.yml

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-07-21 18:39:19 -0400 using RuboCop version 0.61.1.
+# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 100`
+# on 2019-08-01 15:06:19 -0700 using RuboCop version 0.73.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
@@ -14,22 +14,61 @@ Lint/AssignmentInCondition:
     - 'lib/slack/real_time/socket.rb'
 
 # Offense count: 5
+# Configuration parameters: AllowComments.
 Lint/HandleExceptions:
   Exclude:
     - 'lib/slack-ruby-client.rb'
     - 'lib/slack/real_time/concurrency/async.rb'
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
-# Offense count: 4
+# Offense count: 9
+# Configuration parameters: Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/slack/real_time/client.rb'
+    - 'lib/slack/real_time/concurrency/async.rb'
+    - 'lib/slack/real_time/stores/store.rb'
+    - 'lib/slack/web/api/mixins/users.search.rb'
+    - 'lib/slack/web/faraday/connection.rb'
+    - 'lib/slack/web/pagination/cursor.rb'
+    - 'spec/integration/integration_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/slack/web/faraday/connection.rb'
+
+# Offense count: 13
+# Configuration parameters: CountComments, Max, ExcludedMethods.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/slack/messages/formatting.rb'
+    - 'lib/slack/real_time/client.rb'
+    - 'lib/slack/real_time/concurrency/async.rb'
+    - 'lib/slack/real_time/concurrency/celluloid.rb'
+    - 'lib/slack/real_time/config.rb'
+    - 'lib/slack/real_time/stores/store.rb'
+    - 'lib/slack/web/api/mixins/users.search.rb'
+    - 'lib/slack/web/config.rb'
+    - 'lib/slack/web/faraday/connection.rb'
+    - 'lib/slack/web/faraday/request.rb'
+    - 'lib/slack/web/pagination/cursor.rb'
+    - 'spec/integration/integration_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/slack/web/faraday/connection.rb'
+
+# Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # 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
 Naming/FileName:
   Exclude:
-    - 'bin/commands/chat_scheduledMessages.rb'
     - 'lib/slack-ruby-client.rb'
-    - 'lib/slack/web/api/endpoints/chat_scheduledMessages.rb'
-    - 'spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
@@ -38,6 +77,229 @@ Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'lib/slack/logger.rb'
 
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+
+# Offense count: 69
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/events/config_spec.rb'
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/messages/formatting_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/event_handlers/bot_spec.rb'
+    - 'spec/slack/real_time/event_handlers/channel_spec.rb'
+    - 'spec/slack/real_time/event_handlers/group_spec.rb'
+    - 'spec/slack/real_time/event_handlers/im_spec.rb'
+    - 'spec/slack/real_time/event_handlers/team_spec.rb'
+    - 'spec/slack/real_time/event_handlers/user_spec.rb'
+    - 'spec/slack/slack_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/channels_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/groups_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+    - 'spec/slack/web/api/mixins/channels_spec.rb'
+    - 'spec/slack/web/api/mixins/groups_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
+    - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterExampleGroup:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterFinalLet:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/channels_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/groups_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+
+# Offense count: 63
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/event_handlers/bot_spec.rb'
+    - 'spec/slack/real_time/event_handlers/channel_spec.rb'
+    - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/real_time/event_handlers/group_spec.rb'
+    - 'spec/slack/real_time/event_handlers/im_spec.rb'
+    - 'spec/slack/real_time/event_handlers/team_spec.rb'
+    - 'spec/slack/real_time/event_handlers/user_spec.rb'
+    - 'spec/slack/slack_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+    - 'spec/slack/web/api/error_spec.rb'
+    - 'spec/slack/web/api/errors/service_unavailable_spec.rb'
+    - 'spec/slack/web/api/errors/slack_error_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
+
+# Offense count: 2
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/slack/real_time/client_spec.rb'
+
+# Offense count: 16
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/slack/real_time/api/message_spec.rb'
+    - 'spec/slack/real_time/api/ping_spec.rb'
+    - 'spec/slack/real_time/api/typing_spec.rb'
+    - 'spec/slack/real_time/event_handlers/bot_spec.rb'
+    - 'spec/slack/real_time/event_handlers/channel_spec.rb'
+    - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/real_time/event_handlers/group_spec.rb'
+    - 'spec/slack/real_time/event_handlers/im_spec.rb'
+    - 'spec/slack/real_time/event_handlers/user_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/channels_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/groups_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+    - 'spec/slack/web/api/errors/service_unavailable_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, each, example
+RSpec/HookArgument:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+
+# Offense count: 13
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/slack_spec.rb'
+
+# Offense count: 68
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 92
+# Configuration parameters: Max, AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/events/config_spec.rb'
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+    - 'spec/slack/real_time/event_handlers/bot_spec.rb'
+    - 'spec/slack/real_time/event_handlers/channel_spec.rb'
+    - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/real_time/event_handlers/group_spec.rb'
+    - 'spec/slack/real_time/event_handlers/im_spec.rb'
+    - 'spec/slack/real_time/event_handlers/team_spec.rb'
+    - 'spec/slack/real_time/event_handlers/user_spec.rb'
+    - 'spec/slack/real_time/store_spec.rb'
+    - 'spec/slack/slack_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+    - 'spec/slack/web/api/error_spec.rb'
+    - 'spec/slack/web/api/errors/service_unavailable_spec.rb'
+    - 'spec/slack/web/api/errors/slack_error_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
+
+# Offense count: 53
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/messages/formatting_spec.rb'
+    - 'spec/slack/web/api/mixins/channels_spec.rb'
+    - 'spec/slack/web/api/mixins/groups_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
+
+# Offense count: 32
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
+
+# Offense count: 15
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: not_to, to_not
+RSpec/NotToNot:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
+
+# Offense count: 2
+RSpec/ScatteredLet:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+
+# Offense count: 4
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+
+# Offense count: 3
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/slack/web/api/mixins/channels_spec.rb'
+    - 'spec/slack/web/api/mixins/groups_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
+
+# Offense count: 16
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
+    - 'spec/support/real_time/connected_client.rb'
+
 # Offense count: 1
 Security/Open:
   Exclude:
@@ -51,25 +313,46 @@ Style/AccessModifierDeclarations:
     - 'lib/slack/real_time/concurrency/eventmachine.rb'
     - 'lib/slack/real_time/socket.rb'
 
-# Offense count: 155
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Enabled: false
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/auth_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/channels_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/groups_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom_specs/users_spec.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/slack/real_time/socket.rb'
-    - 'lib/slack/real_time/stores/store.rb'
     - 'lib/slack/web/faraday/response/raise_error.rb'
 
-# Offense count: 1
-Style/MixinUsage:
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, Autocorrect.
+# SupportedStyles: module_function, extend_self
+Style/ModuleFunction:
   Exclude:
-    - 'bin/slack'
+    - 'lib/slack/config.rb'
+    - 'lib/slack/events/config.rb'
+    - 'lib/slack/web/config.rb'
 
 # Offense count: 1
 Style/MultilineTernaryOperator:
   Exclude:
     - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/slack/real_time/client.rb'