mysociety/alaveteli

View on GitHub
app/controllers/general_controller.rb

Summary

Maintainability
C
1 day
Test Coverage

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 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 get_blog_content has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      def get_blog_content
        @feed_autodetect = []
        @feed_url = AlaveteliConfiguration::blog_feed
        separator = @feed_url.include?('?') ? '&' : '?'
        @feed_url = "#{ @feed_url }#{ separator }lang=" \
    Severity: Minor
    Found in app/controllers/general_controller.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 search_redirect has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

      def search_redirect
        @query = params.delete(:query)
        if @query.nil? || @query.empty?
          @query = nil
          @page = 1
    Severity: Minor
    Found in app/controllers/general_controller.rb - About 25 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 2 locations. Consider refactoring.
    Open

        if @users
          @xapian_users = perform_search([User], @query, @sortby, nil, 5)
          @users_per_page = @per_page
          @xapian_users_hits = @xapian_users.results.size
          @xapian_users_total_hits = @xapian_users.matches_estimated
    Severity: Minor
    Found in app/controllers/general_controller.rb and 1 other location - About 35 mins to fix
    app/controllers/general_controller.rb on lines 187..195

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

    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 @bodies
          @xapian_bodies = perform_search([PublicBody], @query, @sortby, nil, 5)
          @bodies_per_page = @per_page
          @xapian_bodies_hits = @xapian_bodies.results.size
          @xapian_bodies_total_hits = @xapian_bodies.matches_estimated
    Severity: Minor
    Found in app/controllers/general_controller.rb and 1 other location - About 35 mins to fix
    app/controllers/general_controller.rb on lines 196..204

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

    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