mysociety/alaveteli

View on GitHub

Showing 409 of 413 total issues

File user_controller.rb has 413 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'set'

class UserController < ApplicationController
  include UserSpamCheck

Severity: Minor
Found in app/controllers/user_controller.rb - About 5 hrs to fix

    File info_request_event.rb has 411 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'yaml_compatibility'
    
    class InfoRequestEvent < ApplicationRecord
      include AdminColumn
      extend XapianQueries
    Severity: Minor
    Found in app/models/info_request_event.rb - About 5 hrs to fix

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

      class RequestMailer < ApplicationMailer
        include AlaveteliFeatures::Helpers
      
        before_action :set_footer_template,
                      :only => [
      Severity: Minor
      Found in app/mailers/request_mailer.rb - About 5 hrs to fix

        File outgoing_message.rb has 393 lines of code (exceeds 250 allowed). Consider refactoring.
        Open

        class OutgoingMessage < ApplicationRecord
          include AdminColumn
          include MessageProminence
          include Rails.application.routes.url_helpers
          include LinkToHelper
        Severity: Minor
        Found in app/models/outgoing_message.rb - About 5 hrs to fix

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

            BatchAuthoritySearch.bindXHR = function bindXHR() {
              BatchAuthoritySearch.currentXHR.done(function(data) {
                $el.trigger(Events.loadingSuccess, {html: data});
              });
              BatchAuthoritySearch.currentXHR.fail(function(xhr, textStatus) {
          app/assets/javascripts/alaveteli_pro/draft_batch_summary/initialise.js on lines 33..43

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

          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

            DraftBatchSummary.bindXHR = function bindXHR() {
              DraftBatchSummary.currentXHR.done(function(data) {
                $el.trigger(Events.loadingSuccess, {html: data});
              });
              DraftBatchSummary.currentXHR.fail(function(xhr, textStatus) {
          app/assets/javascripts/alaveteli_pro/batch_authority_search/initialise.js on lines 31..41

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

          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

          Class IncomingMessage has 40 methods (exceeds 20 allowed). Consider refactoring.
          Open

          class IncomingMessage < ApplicationRecord
            include AdminColumn
            include MessageProminence
          
            MAX_ATTACHMENT_TEXT_CLIPPED = 1000000 # 1Mb ish
          Severity: Minor
          Found in app/models/incoming_message.rb - About 5 hrs to fix

            Method new has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
            Open

              def new
                # All new requests are of normal_sort
                if !params[:outgoing_message].nil?
                  params[:outgoing_message][:what_doing] = 'normal_sort'
                end
            Severity: Minor
            Found in app/controllers/request_controller.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

            Method initialize_query has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
            Open

                def initialize_query(options)
                  #raise options.to_yaml
            
                  self.runtime += Benchmark::realtime {
                    offset = options[:offset] || 0; offset = offset.to_i
            Severity: Minor
            Found in lib/acts_as_xapian/acts_as_xapian.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

            Method search has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
            Open

              def search
                # TODO: Why is this so complicated with arrays and stuff? Look at the route
                # in config/routes.rb for comments.
            
                # 404 if the request is a format we don't support (e.g:.json)
            Severity: Minor
            Found in app/controllers/general_controller.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 world_foi_websites has 119 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              def self.world_foi_websites
                world_foi_websites = [
                  { :name => "WhatDoTheyKnow",
                    :country_name => "United Kingdom",
                    :country_iso_code => "GB",
            Severity: Major
            Found in lib/world_foi_websites.rb - About 4 hrs to fix

              Method permanently_failed_addresses has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
              Open

                  def self.permanently_failed_addresses(message)
                    if MailHandler.empty_return_path?(message)
                      # Some sort of auto-response
              
                      # Check for Exim’s X-Failed-Recipients header
              Severity: Minor
              Found in lib/mail_handler/reply_handler.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

              Class ApplicationController has 35 methods (exceeds 20 allowed). Consider refactoring.
              Open

              class ApplicationController < ActionController::Base
                class PermissionDenied < StandardError
                end
                class RouteNotFound < StandardError
                end
              Severity: Minor
              Found in app/controllers/application_controller.rb - About 4 hrs to fix

                Class RequestController has 35 methods (exceeds 20 allowed). Consider refactoring.
                Open

                class RequestController < ApplicationController
                  before_action :check_read_only, only: [:new, :upload_response]
                  before_action :check_batch_requests_and_user_allowed, :only => [ :select_authorities, :new_batch ]
                  before_action :set_render_recaptcha, :only => [ :new ]
                  before_action :redirect_numeric_id_to_url_title, :only => [:show]
                Severity: Minor
                Found in app/controllers/request_controller.rb - About 4 hrs to fix

                  File application_controller.rb has 349 lines of code (exceeds 250 allowed). Consider refactoring.
                  Open

                  require 'open-uri'
                  
                  class ApplicationController < ActionController::Base
                    class PermissionDenied < StandardError
                    end
                  Severity: Minor
                  Found in app/controllers/application_controller.rb - About 4 hrs to fix

                    Class InfoRequest has 33 methods (exceeds 20 allowed). Consider refactoring.
                    Open

                    class InfoRequest
                      module State
                        module Transitions
                          # Returns a label for the given state, suitable for using in a form to
                          # update the status of a request.
                    Severity: Minor
                    Found in app/models/info_request/state/transitions.rb - About 4 hrs to fix

                      Method initialize has 103 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                        def initialize(user, project: nil)
                          # Define abilities for the passed in user here. For example:
                          #
                          #   user ||= User.new # guest user (not logged in)
                          #   if user.is_admin?
                      Severity: Major
                      Found in app/models/ability.rb - About 4 hrs to fix

                        Method new has 102 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                          def new
                            # All new requests are of normal_sort
                            if !params[:outgoing_message].nil?
                              params[:outgoing_message][:what_doing] = 'normal_sort'
                            end
                        Severity: Major
                        Found in app/controllers/request_controller.rb - About 4 hrs to fix

                          Method search has 100 lines of code (exceeds 25 allowed). Consider refactoring.
                          Open

                            def search
                              # TODO: Why is this so complicated with arrays and stuff? Look at the route
                              # in config/routes.rb for comments.
                          
                              # 404 if the request is a format we don't support (e.g:.json)
                          Severity: Major
                          Found in app/controllers/general_controller.rb - About 4 hrs to fix

                            Method clean_po has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
                            Open

                                def clean_po(input)
                                  lines = input.split("\n")
                            
                                  lines.each_with_index do |line, index|
                                    match = /^msgid "(.*)"/.match(line)
                            Severity: Minor
                            Found in lib/alaveteli_gettext/fuzzy_cleaner.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

                            Severity
                            Category
                            Status
                            Source
                            Language