mysociety/alaveteli

View on GitHub
app/mailers/request_mailer.rb

Summary

Maintainability
D
3 days
Test Coverage

File request_mailer.rb has 390 lines of code (exceeds 250 allowed). Consider refactoring.
Open

class RequestMailer < ApplicationMailer
  include AlaveteliFeatures::Helpers

  # Used when an FOI officer uploads a response from their web browser - this is
  # the "fake" email used to store in the same format in the database as if they
Severity: Minor
Found in app/mailers/request_mailer.rb - About 5 hrs to fix

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

      def self.alert_comment_on_request
    
        # We only check comments made in the last month - this means if the
        # cron jobs broke for more than a month events would be lost, but no
        # matter. I suspect the performance gain will be needed (with an index on updated_at)
    Severity: Minor
    Found in app/mailers/request_mailer.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 alert_overdue_requests has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

      def self.alert_overdue_requests
        info_requests = InfoRequest.where("described_state = 'waiting_response'
                    AND awaiting_description = ?
                    AND user_id is not null
                    AND use_notifications = ?
    Severity: Minor
    Found in app/mailers/request_mailer.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 alert_overdue_requests has 65 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def self.alert_overdue_requests
        info_requests = InfoRequest.where("described_state = 'waiting_response'
                    AND awaiting_description = ?
                    AND user_id is not null
                    AND use_notifications = ?
    Severity: Major
    Found in app/mailers/request_mailer.rb - About 2 hrs to fix

      Method alert_comment_on_request has 58 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def self.alert_comment_on_request
      
          # We only check comments made in the last month - this means if the
          # cron jobs broke for more than a month events would be lost, but no
          # matter. I suspect the performance gain will be needed (with an index on updated_at)
      Severity: Major
      Found in app/mailers/request_mailer.rb - About 2 hrs to fix

        Method alert_not_clarified_request has 41 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          def self.alert_not_clarified_request
            info_requests = InfoRequest.
                              where("awaiting_description = ?
                                     AND described_state = 'waiting_clarification'
                                     AND info_requests.updated_at < ?
        Severity: Minor
        Found in app/mailers/request_mailer.rb - About 1 hr to fix

          Method alert_new_response_reminders_internal has 36 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            def self.alert_new_response_reminders_internal(days_since, type_code)
              info_requests = InfoRequest.
                where_old_unclassified(days_since).
                  where(use_notifications: false).
                    order('info_requests.id').
          Severity: Minor
          Found in app/mailers/request_mailer.rb - About 1 hr to fix

            Method receive has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

              def receive(email, raw_email, source = :mailin)
                opts = { :source => source }
                # Find which info requests the email is for
                reply_info_requests = self.requests_matching_email(email)
                # Nothing found, so save in holding pen
            Severity: Minor
            Found in app/mailers/request_mailer.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

            Avoid deeply nested control flow statements.
            Open

                        if calculated_status == 'waiting_response_overdue'
                          RequestMailer.
                            overdue_alert(
                              info_request,
                              info_request.user
            Severity: Major
            Found in app/mailers/request_mailer.rb - About 45 mins to fix

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

                def self.alert_not_clarified_request
                  info_requests = InfoRequest.
                                    where("awaiting_description = ?
                                           AND described_state = 'waiting_clarification'
                                           AND info_requests.updated_at < ?
              Severity: Minor
              Found in app/mailers/request_mailer.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

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

                def fake_response(info_request, from_user, message_body, attachment_name, attachment_content)
              Severity: Minor
              Found in app/mailers/request_mailer.rb - About 35 mins to fix

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

                  def comment_on_alert(info_request, comment)
                    @comment, @info_request = comment, info_request
                    @url = comment_url(comment)
                
                    set_reply_to_headers(info_request.user)
                Severity: Minor
                Found in app/mailers/request_mailer.rb and 1 other location - About 15 mins to fix
                app/mailers/request_mailer.rb on lines 184..193

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

                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

                  def comment_on_alert_plural(info_request, count, earliest_unalerted_comment)
                    @count, @info_request = count, info_request
                    @url = comment_url(earliest_unalerted_comment)
                
                    set_reply_to_headers(info_request.user)
                Severity: Minor
                Found in app/mailers/request_mailer.rb and 1 other location - About 15 mins to fix
                app/mailers/request_mailer.rb on lines 169..178

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

                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