expertiza/expertiza

View on GitHub
app/controllers/account_request_controller.rb

Summary

Maintainability
A
2 hrs
Test Coverage
F
0%

Class has too many lines. [127/100]
Open

class AccountRequestController < ApplicationController
  include AuthorizationHelper
  autocomplete :user, :name
  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
  verify method: :post, only: %i[destroy create update],

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

Assignment Branch Condition size for create_approved_user is too high. [32.09/15]
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'

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. [26/10]
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'

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.

Assignment Branch Condition size for create_requested_user_record is too high. [24.84/15]
Open

  def create_requested_user_record
    requested_user = AccountRequest.new(requested_user_params)
    # An object is created with respect to AccountRequest model inorder to populate the users information when account is requested
    (user_exists = User.find_by(name: requested_user.name)) || User.find_by(name: requested_user.email)
    requested_user_saved = save_requested_user(requested_user, params)

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 user_new is too high. [22.85/15]
Open

  def user_new(requested_user)
    new_user = User.new
    new_user.name = requested_user.name
    new_user.role_id = requested_user.role_id
    new_user.institution_id = requested_user.institution_id

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. [17/10]
Open

  def user_new(requested_user)
    new_user = User.new
    new_user.name = requested_user.name
    new_user.role_id = requested_user.role_id
    new_user.institution_id = requested_user.institution_id

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. [14/10]
Open

  def create_requested_user_record
    requested_user = AccountRequest.new(requested_user_params)
    # An object is created with respect to AccountRequest model inorder to populate the users information when account is requested
    (user_exists = User.find_by(name: requested_user.name)) || User.find_by(name: requested_user.email)
    requested_user_saved = save_requested_user(requested_user, params)

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.

Perceived complexity for create_approved_user is too high. [11/7]
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Cyclomatic complexity for create_approved_user is too high. [8/6]
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'

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 has too many lines. [12/10]
Open

  def action_allowed?
    case params[:action]
    when 'list_pending_requested'
      current_user_has_admin_privileges?
    when 'new'

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 create_approved_user has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'
Severity: Minor
Found in app/controllers/account_request_controller.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

Method create_approved_user has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def create_approved_user
    # If a user isn't selected before approving or denying, they are given an error message
    if params[:selection].nil?
      flash[:error] = 'Please select at least one user before approving or rejecting'
      redirect_to action: 'list_pending_requested'
Severity: Minor
Found in app/controllers/account_request_controller.rb - About 1 hr to fix

    TODO found
    Open

      # TODO create_approved_user name is misleading. The tests are also wrong for this.

    Annotation keywords like TODO should be all upper case, followed by a colon, and a space, then a note describing the problem.
    Open

      # TODO create_approved_user name is misleading. The tests are also wrong for this.

    This cop checks that comment annotation keywords are written according to guidelines.

    Example:

    # bad
    # TODO make better
    
    # good
    # TODO: make better
    
    # bad
    # TODO:make better
    
    # good
    # TODO: make better
    
    # bad
    # fixme: does not work
    
    # good
    # FIXME: does not work
    
    # bad
    # Optimize does not work
    
    # good
    # OPTIMIZE: does not work

    Missing top-level class documentation comment.
    Open

    class AccountRequestController < ApplicationController

    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

    There are no issues that match your filters.

    Category
    Status