ashirahattia/cs169-pgm

View on GitHub

Showing 55 of 55 total issues

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

  def path_to(page_name)
    case page_name

      when /^the home\s?page$/
        '/'
Severity: Minor
Found in features/support/paths.rb by rubocop

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. [32/30]
Open

    def update
        @group = Group.find(params[:id])
        @projects = Project.all
        
        if params[:force_choice] == "None"

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

    def choice_num some_match
        project_id = some_match.project.id
        group = some_match.group
        case project_id
        when group[:first_choice]
Severity: Minor
Found in app/helpers/matches_helper.rb by rubocop

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

    def update
        @group = Group.find(params[:id])
        @projects = Project.all
        
        if params[:force_choice] == "None"
Severity: Minor
Found in app/controllers/groups_controller.rb - About 1 hr to fix

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

        def update
            @group = Group.find(params[:id])
            @projects = Project.all
            
            if params[:force_choice] == "None"
    Severity: Minor
    Found in app/controllers/groups_controller.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

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

    def create_settings
      Setting.create(:spreadsheet_id => '1kPwI0T6PnmVT9TF7QqDa1TWsKlnNRG2sXGBsnhWv7AI',
                     :group_tab => 'Groups!A1:Y1000',
                     :group_username_col => '1',
                     :group_id_col => '2',
    Severity: Minor
    Found in features/step_definitions/pgm_steps.rb and 1 other location - About 35 mins to fix
    spec/google_controller_spec.rb on lines 67..82

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

    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

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

      def create_settings
        Setting.create(:spreadsheet_id => '1kPwI0T6PnmVT9TF7QqDa1TWsKlnNRG2sXGBsnhWv7AI',
                       :group_tab => 'Groups!A1:Y1000',
                       :group_username_col => '1',
                       :group_id_col => '2',
    Severity: Minor
    Found in spec/google_controller_spec.rb and 1 other location - About 35 mins to fix
    features/step_definitions/pgm_steps.rb on lines 96..111

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

    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

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

      def create_groups(response)
        response.values.each do |row|
          if row[@@SETTINGS.group_id_col.to_i].nil?
            return
          end
    Severity: Minor
    Found in app/controllers/google_controller.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

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )uncheck "([^"]*)"$/ do |field|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )go to (.+)$/ do |page_name|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Useless assignment to variable - params.
    Open

        params = {:loss_function => "power", :x => "1"}
    Severity: Minor
    Found in spec/matches_controller_spec.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 - fake_project5. Did you mean fake_project1?
    Open

            fake_project5 = Project.create(:project_name => "Project5", :id => 5)
    Severity: Minor
    Found in spec/matches_helper_spec.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

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )press "([^"]*)"$/ do |button|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )check "([^"]*)"$/ do |field|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )choose "([^"]*)"$/ do |field|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)

    Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
    Open

    Then /^show me the page$/ do

    This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

    Example:

    # bad
    
    # This is interpreted as a method invocation with a regexp literal,
    # but it could possibly be `/` method invocations.
    # (i.e. `do_something./(pattern)./(i)`)
    do_something /pattern/i

    Example:

    # good
    
    # With parentheses, there's no ambiguity.
    do_something(/pattern/i)
    Severity
    Category
    Status
    Source
    Language