Sign upLogin

concord-consortium/rigse

View on GitHub
Star
rails/lib/materials/data_helpers.rb

Summary

Maintainability
F
5 days
Test Coverage

Method materials_data has a Cognitive Complexity of 103 (exceeds 5 allowed). Consider refactoring.
Open

    def materials_data( materials,
                        assigned_to_class       = nil,
                        include_related         = 0,
                        skip_lightbox_reloads   = false )
      data = []
Severity: Minor
Found in rails/lib/materials/data_helpers.rb - About 2 days 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 materials_data has 213 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def materials_data( materials,
                        assigned_to_class       = nil,
                        include_related         = 0,
                        skip_lightbox_reloads   = false )
      data = []
Severity: Major
Found in rails/lib/materials/data_helpers.rb - About 1 day to fix

    Method links_for_material has a Cognitive Complexity of 40 (exceeds 5 allowed). Consider refactoring.
    Open

        def links_for_material( material,
                            skip_lightbox_reloads = false )
      external = false
      if material.is_a? ExternalActivity
        browse_url = browse_external_activity_url(material)
    Severity: Minor
    Found in rails/lib/materials/data_helpers.rb - About 6 hrs 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

    File data_helpers.rb has 375 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    module Materials
  module DataHelpers
    # This module expects to be included into a controller, so that view_context resolves
    # to something that provides all the various view helpers.
    # Note that this module will be dealing only with ExternalActivity instances. In the past, it used to handle
    Severity: Minor
    Found in rails/lib/materials/data_helpers.rb - About 5 hrs to fix

      Method links_for_material has 123 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def links_for_material( material,
                            skip_lightbox_reloads = false )
      external = false
      if material.is_a? ExternalActivity
        browse_url = browse_external_activity_url(material)
      Severity: Major
      Found in rails/lib/materials/data_helpers.rb - About 4 hrs to fix

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

            def external_copyable(material)
      if !(material.is_a? ExternalActivity) || material.author_url.blank?
        return false
      end
        Severity: Minor
        Found in rails/lib/materials/data_helpers.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

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

              if material.respond_to?(:teacher_resources_url) && !material.teacher_resources_url.blank?
        if current_visitor.portal_teacher || current_visitor.has_role?('admin','manager')
          links[:teacher_resources] = {
            text: "Teacher Resources",
            target: "_blank",
        Severity: Minor
        Found in rails/lib/materials/data_helpers.rb and 2 other locations - About 20 mins to fix
        rails/lib/materials/data_helpers.rb on lines 420..428
        rails/lib/materials/data_helpers.rb on lines 430..438

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

        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 3 locations. Consider refactoring.
        Open

              if material.respond_to?(:teacher_guide_url) && !material.teacher_guide_url.blank?
        if current_visitor.portal_teacher || current_visitor.has_role?('admin','manager')
          links[:teacher_guide] = {
            text: "Teacher Guide",
            target: "_blank",
        Severity: Minor
        Found in rails/lib/materials/data_helpers.rb and 2 other locations - About 20 mins to fix
        rails/lib/materials/data_helpers.rb on lines 410..418
        rails/lib/materials/data_helpers.rb on lines 430..438

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

        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 3 locations. Consider refactoring.
        Open

              if material.respond_to?(:rubric_doc_url) && !material.rubric_doc_url.blank?
        if current_visitor.portal_teacher || current_visitor.has_role?('admin','manager')
          links[:rubric_doc] = {
            text: "Rubric",
            target: "_blank",
        Severity: Minor
        Found in rails/lib/materials/data_helpers.rb and 2 other locations - About 20 mins to fix
        rails/lib/materials/data_helpers.rb on lines 410..418
        rails/lib/materials/data_helpers.rb on lines 420..428

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

        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

        There are no issues that match your filters.

        Category
        Status