otwcode/otwarchive

View on GitHub
app/models/comment.rb

Summary

Maintainability
F
4 days
Test Coverage

Class Comment has 47 methods (exceeds 20 allowed). Consider refactoring.
Open

class Comment < ApplicationRecord
  include HtmlCleaner
  include AfterCommitEverywhere

  belongs_to :pseud
Severity: Minor
Found in app/models/comment.rb - About 6 hrs to fix

    Method after_update has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
    Open

      def after_update
        users = []
        admins = []
    
        if self.saved_change_to_edited_at? || (self.saved_change_to_unreviewed? && !self.unreviewed?)
    Severity: Minor
    Found in app/models/comment.rb - About 5 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 comment.rb has 377 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    class Comment < ApplicationRecord
      include HtmlCleaner
      include AfterCommitEverywhere
    
      belongs_to :pseud
    Severity: Minor
    Found in app/models/comment.rb - About 5 hrs to fix

      Method notify_parent_comment_owner has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
      Open

          def notify_parent_comment_owner
            if self.reply_comment? && !self.unreviewed?
              parent_comment = self.commentable
              parent_comment_owner = parent_comment.comment_owner # will be nil if not a user, including if an admin
      
      
      Severity: Minor
      Found in app/models/comment.rb - About 4 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

      Method after_create has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
      Open

        def after_create
          self.reload
          # eventually we will set the locale to the user's stored language of choice
          #Locale.set ArchiveConfig.SUPPORTED_LOCALES[ArchiveConfig.DEFAULT_LOCALE]
          users = []
      Severity: Minor
      Found in app/models/comment.rb - About 3 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

      Method after_update has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def after_update
          users = []
          admins = []
      
          if self.saved_change_to_edited_at? || (self.saved_change_to_unreviewed? && !self.unreviewed?)
      Severity: Minor
      Found in app/models/comment.rb - About 1 hr to fix

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

            def content_too_different?(new_content, old_content)
              # we added more than the threshold # of chars, just return
              return true if new_content.length > (old_content.length + ArchiveConfig.COMMENT_MODERATION_THRESHOLD)
        
              # quick and dirty iteration to compare the two strings
        Severity: Minor
        Found in app/models/comment.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 after_create has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          def after_create
            self.reload
            # eventually we will set the locale to the user's stored language of choice
            #Locale.set ArchiveConfig.SUPPORTED_LOCALES[ArchiveConfig.DEFAULT_LOCALE]
            users = []
        Severity: Minor
        Found in app/models/comment.rb - About 1 hr to fix

          Method notify_parent_comment_owner has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              def notify_parent_comment_owner
                if self.reply_comment? && !self.unreviewed?
                  parent_comment = self.commentable
                  parent_comment_owner = parent_comment.comment_owner # will be nil if not a user, including if an admin
          
          
          Severity: Minor
          Found in app/models/comment.rb - About 1 hr to fix

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

                if self.ultimate_parent.is_a?(AdminPost)
                  AdminMailer.comment_notification(self.id).deliver_after_commit
                else
                  # at this point, users contains those who've already been notified
                  if users.empty?
            Severity: Major
            Found in app/models/comment.rb and 1 other location - About 1 hr to fix
            app/models/comment.rb on lines 169..187

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

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

                  if self.ultimate_parent.is_a?(AdminPost)
                    AdminMailer.edited_comment_notification(self.id).deliver_after_commit
                  else
                    # at this point, users contains those who've already been notified
                    if users.empty?
            Severity: Major
            Found in app/models/comment.rb and 1 other location - About 1 hr to fix
            app/models/comment.rb on lines 220..238

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

            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