ece517-p3/expertiza

View on GitHub
app/helpers/assignment_helper.rb

Summary

Maintainability
A
3 hrs
Test Coverage

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

module AssignmentHelper
  def course_options(instructor)
    if session[:user].role.name == 'Teaching Assistant'
      courses = []
      ta = Ta.find(session[:user].id)
Severity: Minor
Found in app/helpers/assignment_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 course_options is too high. [56.58/15]
Open

  def course_options(instructor)
    if session[:user].role.name == 'Teaching Assistant'
      courses = []
      ta = Ta.find(session[:user].id)
      ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
Severity: Minor
Found in app/helpers/assignment_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 assignment_questionnaire is too high. [24.74/15]
Open

  def assignment_questionnaire(assignment, type, number)
    questionnaire = assignment.questionnaires.find_by(type: type)

    if questionnaire.nil?
      default_weight = {}
Severity: Minor
Found in app/helpers/assignment_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 get_data_for_list_submissions is too high. [20.25/15]
Open

  def get_data_for_list_submissions(team)
    teams_users = TeamsUser.where(team_id: team.id)
    topic = SignedUpTeam.where(team_id: team.id).first.try :topic
    topic_identifier = topic.try :topic_identifier
    topic_name = topic.try :topic_name
Severity: Minor
Found in app/helpers/assignment_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 due_date is too high. [19.08/15]
Open

  def due_date(assignment, type, round = 0)
    due_dates = assignment.find_due_dates(type)

    due_dates.delete_if {|due_date| due_date.due_at.nil? }
    due_dates.sort! {|x, y| x.due_at <=> y.due_at }
Severity: Minor
Found in app/helpers/assignment_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 assignment_questionnaire is too high. [9/7]
Open

  def assignment_questionnaire(assignment, type, number)
    questionnaire = assignment.questionnaires.find_by(type: type)

    if questionnaire.nil?
      default_weight = {}
Severity: Minor
Found in app/helpers/assignment_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 assignment_questionnaire has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def assignment_questionnaire(assignment, type, number)
    questionnaire = assignment.questionnaires.find_by(type: type)

    if questionnaire.nil?
      default_weight = {}
Severity: Minor
Found in app/helpers/assignment_helper.rb - About 1 hr to fix

    Method assignment_questionnaire has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

      def assignment_questionnaire(assignment, type, number)
        questionnaire = assignment.questionnaires.find_by(type: type)
    
        if questionnaire.nil?
          default_weight = {}
    Severity: Minor
    Found in app/helpers/assignment_helper.rb - About 55 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

    Method questionnaire has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

      def questionnaire(assignment, type, round_number)
        # E1450 changes
        if round_number.nil?
          questionnaire = assignment.questionnaires.find_by(type: type)
        else
    Severity: Minor
    Found in app/helpers/assignment_helper.rb - About 25 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 code to assign default permission to the newly created due_date according to the due_date type
    Severity: Minor
    Found in app/helpers/assignment_helper.rb by fixme

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

      def questionnaire_options(assignment, type, _round = 0)
        questionnaires = Questionnaire.where(['private = 0 or instructor_id = ?', assignment.instructor_id]).order('name')
        options = []
        questionnaires.select {|x| x.type == type }.each do |questionnaire|
          options << [questionnaire.name, questionnaire.id]
    Severity: Minor
    Found in app/helpers/assignment_helper.rb and 1 other location - About 35 mins to fix
    spec/features/assignment_creation_spec.rb on lines 1..7

    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 34.

    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

    Useless assignment to variable - topic_name.
    Open

        [topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
    Severity: Minor
    Found in app/helpers/assignment_helper.rb by rubocop

    This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

    assigned but unused variable - foo

    Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

    Example:

    # bad
    
    def some_method
      some_var = 1
      do_something
    end

    Example:

    # good
    
    def some_method
      some_var = 1
      do_something(some_var)
    end

    Useless assignment to variable - topic_identifier.
    Open

        [topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
    Severity: Minor
    Found in app/helpers/assignment_helper.rb by rubocop

    This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

    assigned but unused variable - foo

    Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

    Example:

    # bad
    
    def some_method
      some_var = 1
      do_something
    end

    Example:

    # good
    
    def some_method
      some_var = 1
      do_something(some_var)
    end

    Convert if nested inside else to elsif.
    Open

          if number.nil?
    Severity: Minor
    Found in app/helpers/assignment_helper.rb by rubocop

    If the else branch of a conditional consists solely of an if node, it can be combined with the else to become an elsif. This helps to keep the nesting level from getting too deep.

    Example:

    # bad
    if condition_a
      action_a
    else
      if condition_b
        action_b
      else
        action_c
      end
    end
    
    # good
    if condition_a
      action_a
    elsif condition_b
      action_b
    else
      action_c
    end

    There are no issues that match your filters.

    Category
    Status