ece517-p3/expertiza

View on GitHub
app/helpers/penalty_helper.rb

Summary

Maintainability
B
5 hrs
Test Coverage

Module has too many lines. [104/100]
Open

module PenaltyHelper
  def calculate_penalty(participant_id)
    @submission_deadline_type_id = 1
    @review_deadline_type_id = 2
    @meta_review_deadline_type_id = 5
Severity: Minor
Found in app/helpers/penalty_helper.rb by rubocop

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

Assignment Branch Condition size for calculate_penalty is too high. [26.8/15]
Open

  def calculate_penalty(participant_id)
    @submission_deadline_type_id = 1
    @review_deadline_type_id = 2
    @meta_review_deadline_type_id = 5

Severity: Minor
Found in app/helpers/penalty_helper.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 compute_penalty_on_reviews is too high. [20.35/15]
Open

  def compute_penalty_on_reviews(review_mappings, review_due_date, num_of_reviews_required)
    review_map_created_at_list = []
    penalty = 0
    # Calculate the number of reviews that the user has completed so far.
    review_mappings.each do |map|
Severity: Minor
Found in app/helpers/penalty_helper.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 calculate_submission_penalty is too high. [16.43/15]
Open

  def calculate_submission_penalty
    submission_due_date = AssignmentDueDate.where(deadline_type_id: @submission_deadline_type_id,
                                                  parent_id:  @assignment.id).first.due_at
    resubmission_times = @participant.resubmission_times
    if resubmission_times.any?
Severity: Minor
Found in app/helpers/penalty_helper.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

Perceived complexity for compute_penalty_on_reviews is too high. [8/7]
Open

  def compute_penalty_on_reviews(review_mappings, review_due_date, num_of_reviews_required)
    review_map_created_at_list = []
    penalty = 0
    # Calculate the number of reviews that the user has completed so far.
    review_mappings.each do |map|
Severity: Minor
Found in app/helpers/penalty_helper.rb by rubocop

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

Method compute_penalty_on_reviews has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

  def compute_penalty_on_reviews(review_mappings, review_due_date, num_of_reviews_required)
    review_map_created_at_list = []
    penalty = 0
    # Calculate the number of reviews that the user has completed so far.
    review_mappings.each do |map|
Severity: Minor
Found in app/helpers/penalty_helper.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 compute_penalty_on_reviews has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def compute_penalty_on_reviews(review_mappings, review_due_date, num_of_reviews_required)
    review_map_created_at_list = []
    penalty = 0
    # Calculate the number of reviews that the user has completed so far.
    review_mappings.each do |map|
Severity: Minor
Found in app/helpers/penalty_helper.rb - About 1 hr to fix

    Method calculate_submission_penalty has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      def calculate_submission_penalty
        submission_due_date = AssignmentDueDate.where(deadline_type_id: @submission_deadline_type_id,
                                                      parent_id:  @assignment.id).first.due_at
        resubmission_times = @participant.resubmission_times
        if resubmission_times.any?
    Severity: Minor
    Found in app/helpers/penalty_helper.rb - About 45 mins 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

    TODO found
    Open

        # TODO: add calculate_penalty column to the assignment table and
    Severity: Minor
    Found in app/helpers/penalty_helper.rb by fixme

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      def calculate_meta_review_penalty
        penalty = 0
        num_of_meta_reviews_required = @assignment.num_review_of_reviews
        if num_of_meta_reviews_required > 0
          meta_review_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)
    Severity: Minor
    Found in app/helpers/penalty_helper.rb and 1 other location - About 45 mins to fix
    app/helpers/penalty_helper.rb on lines 51..60

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 39.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      def calculate_review_penalty
        penalty = 0
        num_of_reviews_required = @assignment.num_reviews
        if num_of_reviews_required > 0
          review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)
    Severity: Minor
    Found in app/helpers/penalty_helper.rb and 1 other location - About 45 mins to fix
    app/helpers/penalty_helper.rb on lines 63..72

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 39.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Use == if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition.
    Open

            penalty = @max_penalty_for_no_submission
    Severity: Minor
    Found in app/helpers/penalty_helper.rb by rubocop

    This cop checks for assignments in the conditions of if/while/until.

    Example:

    # bad
    
    if some_var = true
      do_something
    end

    Example:

    # good
    
    if some_var == true
      do_something
    end

    Place the condition on the same line as elsif.
    Open

            penalty = @max_penalty_for_no_submission
    Severity: Minor
    Found in app/helpers/penalty_helper.rb by rubocop

    This cop checks for conditions that are not on the same line as if/while/until.

    Example:

    # bad
    
    if
      some_condition
      do_something
    end

    Example:

    # good
    
    if some_condition
      do_something
    end

    There are no issues that match your filters.

    Category
    Status