Sign upLogin

reevoo/sapience-rb

View on GitHub
Star
lib/sapience/extensions/action_controller/log_subscriber.rb

Summary

Maintainability
A
0 mins
Test Coverage

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

        def request(payload) # rubocop:disable AbcSize
          {
            method: payload[:method].upcase,
            request_path: request_path(payload),
            format: format(payload),
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.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.

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

        def exception(payload)
          if payload[:exception]
            exception, message = payload[:exception]
            message ||= exception.message
            status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception)
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.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.

Avoid comma after the last item of a hash.
Open

            db: event.payload[:db_runtime],
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks for trailing comma in array and hash literals.

Example: EnforcedStyleForMultiline: consistent_comma

# bad
a = [1, 2,]

# good
a = [
  1, 2,
  3,
]

# good
a = [
  1,
  2,
]

Example: EnforcedStyleForMultiline: comma

# bad
a = [1, 2,]

# good
a = [
  1,
  2,
]

Example: EnforcedStyleForMultiline: no_comma (default)

# bad
a = [1, 2,]

# good
a = [
  1,
  2
]

Line is too long. [90/80]
Open

            status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception)
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Line is too long. [83/80]
Open

          if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Prefer single-quoted strings inside interpolations.
Open

            route: "#{payload[:params].delete("controller")}##{payload[:params]["action"]}",
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks that quotes inside the string interpolation match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
result = "Tests #{success ? "PASS" : "FAIL"}"

# good
result = "Tests #{success ? 'PASS' : 'FAIL'}"

Example: EnforcedStyle: double_quotes

# bad
result = "Tests #{success ? 'PASS' : 'FAIL'}"

# good
result = "Tests #{success ? "PASS" : "FAIL"}"

Avoid comma after the last item of a hash.
Open

            params: payload[:params],
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks for trailing comma in array and hash literals.

Example: EnforcedStyleForMultiline: consistent_comma

# bad
a = [1, 2,]

# good
a = [
  1, 2,
  3,
]

# good
a = [
  1,
  2,
]

Example: EnforcedStyleForMultiline: comma

# bad
a = [1, 2,]

# good
a = [
  1,
  2,
]

Example: EnforcedStyleForMultiline: no_comma (default)

# bad
a = [1, 2,]

# good
a = [
  1,
  2
]

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

            controller: payload[:params]["controller"],
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

          payload[:path].split("?").first
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

require "action_controller/log_subscriber"
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Add an empty line after magic comments.
Open

require "action_controller/log_subscriber"
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true

# Some documentation for Person
class Person
  # Some code
end

# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Prefer single-quoted strings inside interpolations.
Open

            route: "#{payload[:params].delete("controller")}##{payload[:params]["action"]}",
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks that quotes inside the string interpolation match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
result = "Tests #{success ? "PASS" : "FAIL"}"

# good
result = "Tests #{success ? 'PASS' : 'FAIL'}"

Example: EnforcedStyle: double_quotes

# bad
result = "Tests #{success ? 'PASS' : 'FAIL'}"

# good
result = "Tests #{success ? "PASS" : "FAIL"}"

Line is too long. [92/80]
Open

            route: "#{payload[:params].delete("controller")}##{payload[:params]["action"]}",
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Missing top-level class documentation comment.
Open

      class LogSubscriber < ::ActionController::LogSubscriber
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.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

Prefer single-quoted strings inside interpolations.
Open

            message: "Completed ##{payload[:params].delete("action")}",
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks that quotes inside the string interpolation match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
result = "Tests #{success ? "PASS" : "FAIL"}"

# good
result = "Tests #{success ? 'PASS' : 'FAIL'}"

Example: EnforcedStyle: double_quotes

# bad
result = "Tests #{success ? 'PASS' : 'FAIL'}"

# good
result = "Tests #{success ? "PASS" : "FAIL"}"

Use ::ActionPack::VERSION::MINOR.zero? instead of ::ActionPack::VERSION::MINOR == 0.
Open

          if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

This cop checks for usage of comparison operators (==, >, <) to test numbers as zero, positive, or negative. These can be replaced by their respective predicate methods. The cop can also be configured to do the reverse.

The cop disregards #nonzero? as it its value is truthy or falsey, but not true and false, and thus not always interchangeable with != 0.

The cop ignores comparisons to global variables, since they are often populated with objects which can be compared with integers, but are not themselves Interger polymorphic.

Example: EnforcedStyle: predicate (default)

# bad

foo == 0
0 > foo
bar.baz > 0

# good

foo.zero?
foo.negative?
bar.baz.positive?

Example: EnforcedStyle: comparison

# bad

foo.zero?
foo.negative?
bar.baz.positive?

# good

foo == 0
0 > foo
bar.baz > 0

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

            action: payload[:params]["action"],
Severity: Minor
Found in lib/sapience/extensions/action_controller/log_subscriber.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

There are no issues that match your filters.

Category
Status