Sign upLogin

WikiEducationFoundation/WikiEduDashboard

View on GitHub
Star
lib/wiki_assignment_output.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

  def initialize(course, title, talk_title, assignments, templates)
Severity: Minor
Found in lib/wiki_assignment_output.rb - About 35 mins to fix

    Method build_talk_page_update has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      def build_talk_page_update
    # If a course changed state so that it has no on-wiki course page, don't post.
    return nil if @course_page.nil?

    initial_page_content = WikiApi.new(@wiki).get_page_content(@talk_title)
    Severity: Minor
    Found in lib/wiki_assignment_output.rb - About 35 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 build_assignment_page_content has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      def build_assignment_page_content(new_tag, page_content)
    page_content = page_content.dup.force_encoding('utf-8')
    # Return if tag already exists on page.
    # However, if the tag is empty, that means to blank the prior tag (if any).
    if new_tag.present?
    Severity: Minor
    Found in lib/wiki_assignment_output.rb - About 35 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

    Avoid too many return statements within this method.
    Open

        return nil if @assignments.empty? && initial_page_content.empty?
    Severity: Major
    Found in lib/wiki_assignment_output.rb - About 30 mins to fix

      There are no issues that match your filters.

      Category
      Status