Sign upLogin

concord-consortium/rigse

View on GitHub
Star
rails/app/controllers/api/v1/students_controller.rb

Summary

Maintainability
C
1 day
Test Coverage

Method register has 56 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def register
    result = get_portal_clazz_by_id(params)
    return error(result[:error]) if result[:error]
    portal_clazz = result[:portal_clazz]
Severity: Major
Found in rails/app/controllers/api/v1/students_controller.rb - About 2 hrs to fix

    Method register has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

      def register
    result = get_portal_clazz_by_id(params)
    return error(result[:error]) if result[:error]
    portal_clazz = result[:portal_clazz]
    Severity: Minor
    Found in rails/app/controllers/api/v1/students_controller.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 create has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

      def create
    registration = API::V1::StudentRegistration.new(student_registration_strong_params(params))

    # This was added to allow for registering after logging in the first time with SSO
    # But it also occurs if a user is able to access the registration form while being
    Severity: Minor
    Found in rails/app/controllers/api/v1/students_controller.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 create has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def create
    registration = API::V1::StudentRegistration.new(student_registration_strong_params(params))

    # This was added to allow for registering after logging in the first time with SSO
    # But it also occurs if a user is able to access the registration form while being
    Severity: Minor
    Found in rails/app/controllers/api/v1/students_controller.rb - About 1 hr to fix

      Avoid too many return statements within this method.
      Open

            return error("You must be a teacher of the class to register and add students")
      Severity: Major
      Found in rails/app/controllers/api/v1/students_controller.rb - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

              return error("Unable to create student")
        Severity: Major
        Found in rails/app/controllers/api/v1/students_controller.rb - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                return error("Unable to add student to class")
          Severity: Major
          Found in rails/app/controllers/api/v1/students_controller.rb - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                  return error(user.errors.full_messages.uniq.join(". ").gsub("..", "."))
            Severity: Major
            Found in rails/app/controllers/api/v1/students_controller.rb - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                    return error("Unable to save newly created user")
              Severity: Major
              Found in rails/app/controllers/api/v1/students_controller.rb - About 30 mins to fix

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

                    if current_user
      # If the user has a portal_teacher or portal_student, we don't want them re-registering
      # The errors in this case will be passed down to the registration form.
      # The use of class_word is so the error message is shown in the form.
      if current_user.portal_teacher
                Severity: Minor
                Found in rails/app/controllers/api/v1/students_controller.rb and 1 other location - About 15 mins to fix
                rails/app/controllers/api/v1/teachers_controller.rb on lines 12..22

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

                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