Sign upLogin

reevoo/sapience-rb

View on GitHub
Star
lib/sapience/extensions/rails/rack/logger.rb

Summary

Maintainability
A
0 mins
Test Coverage

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

  def started_request_message(request) # rubocop:disable AbcSize
    {
      message: "Started #{request.request_method} #{request.filtered_path}",
      method:  request.request_method,
      path:    request.filtered_path,
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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.

Missing top-level class documentation comment.
Open

class Rails::Rack::Logger # rubocop:disable ClassAndModuleChildren
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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

Add an empty line after magic comments.
Open

# Replace rack started message with a semantic equivalent
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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

Avoid comma after the last item of a hash.
Open

      request_id: request.uuid,
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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

      remote_host: request.env["HTTP_X_FORWARDED_HOST"] || request.remote_host,
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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

      ip:      request.env["HTTP_X_FORWARDED_FOR"] || request.remote_addr,
Severity: Minor
Found in lib/sapience/extensions/rails/rack/logger.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