datamolecule/door_mat

View on GitHub
lib/door_mat/process/actor_password_change.rb

Summary

Maintainability
B
4 hrs
Test Coverage

Method with has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

      def self.with(actor, new_password, old_password='', save_session=true)
        actor.with_lock do

          unless old_password.nil?
            return false unless actor.authenticate(old_password)
Severity: Minor
Found in lib/door_mat/process/actor_password_change.rb - About 3 hrs 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

Method has too many lines. [40/30]
Open

      def self.with(actor, new_password, old_password='', save_session=true)
        actor.with_lock do

          unless old_password.nil?
            return false unless actor.authenticate(old_password)

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 with is too high. [9/6]
Open

      def self.with(actor, new_password, old_password='', save_session=true)
        actor.with_lock do

          unless old_password.nil?
            return false unless actor.authenticate(old_password)

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 with has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def self.with(actor, new_password, old_password='', save_session=true)
        actor.with_lock do

          unless old_password.nil?
            return false unless actor.authenticate(old_password)
Severity: Minor
Found in lib/door_mat/process/actor_password_change.rb - About 1 hr to fix

    Avoid rescuing the Exception class. Perhaps you meant to rescue StandardError?
    Open

          rescue Exception => e
            DoorMat.configuration.logger.error "ERROR: Failed to change actor password - #{e}"
            raise e

    This cop checks for rescue blocks targeting the Exception class.

    Example:

    # bad
    
    begin
      do_something
    rescue Exception
      handle_exception
    end

    Example:

    # good
    
    begin
      do_something
    rescue ArgumentError
      handle_exception
    end

    There are no issues that match your filters.

    Category
    Status