Sign upLogin

mgleon08/slack_neuralyzer

View on GitHub
Star
lib/slack_neuralyzer/cleaner/files.rb

Summary

Maintainability
A
1 hr
Test Coverage

Assignment Branch Condition size for clean_channel_file is too high. [25.71/15]
Open

      def clean_channel_file(channel_id, user_id)
        page, total_page = 0, nil
        until page == total_page
          page += 1
          res = Slack.files_list(page: page, channel: channel_id, types: args.file, ts_from: start_time, ts_to: end_time)
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for delete_file is too high. [19.26/15]
Open

      def delete_file(file)
        file_time = time_format(file['timestamp'])
        file_url  = light_magenta("(#{file['permalink']})")
        delete    = delete_format
        Slack.files_delete(file: file['id']) if args.execute
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [14/10]
Open

      def clean_channel_file(channel_id, user_id)
        page, total_page = 0, nil
        until page == total_page
          page += 1
          res = Slack.files_list(page: page, channel: channel_id, types: args.file, ts_from: start_time, ts_to: end_time)
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for clean_channel_file is too high. [7/6]
Open

      def clean_channel_file(channel_id, user_id)
        page, total_page = 0, nil
        until page == total_page
          page += 1
          res = Slack.files_list(page: page, channel: channel_id, types: args.file, ts_from: start_time, ts_to: end_time)
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method clean_channel_file has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

      def clean_channel_file(channel_id, user_id)
        page, total_page = 0, nil
        until page == total_page
          page += 1
          res = Slack.files_list(page: page, channel: channel_id, types: args.file, ts_from: start_time, ts_to: end_time)
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Do not use parallel assignment.
Open

        page, total_page = 0, nil
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

Checks for simple usages of parallel assignment. This will only complain when the number of variables being assigned matched the number of assigning variables.

Example:

# bad
a, b, c = 1, 2, 3
a, b, c = [1, 2, 3]

# good
one, two = *foo
a, b = foo()
a, b = b, a

a = 1
b = 2
c = 3

Line is too long. [121/80]
Open

          res = Slack.files_list(page: page, channel: channel_id, types: args.file, ts_from: start_time, ts_to: end_time)
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

Missing top-level class documentation comment.
Open

    class Files < Base
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Line is too long. [109/80]
Open

        logger.info "#{delete}#{file_time} #{dict.find_user_name(file['user'])}: #{file['name']} #{file_url}"
Severity: Minor
Found in lib/slack_neuralyzer/cleaner/files.rb by rubocop

There are no issues that match your filters.

Category
Status