pboling/exception_notification

View on GitHub

Showing 28 of 28 total issues

Method rescue_with_handler has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def rescue_with_handler(exception)
      to_return = super
      # Not sure how to do this. We aren't supposed to rely on the return value of the super handler.
      #if to_return
        verbose = self.class.exception_notifiable_verbose && respond_to?(:logger) && !logger.nil?
Severity: Minor
Found in lib/exception_notification/exception_notifiable.rb - About 35 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 should_notify_on_exception? has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  def should_notify_on_exception?(exception, status_cd = nil, verbose = false)
    # don't notify (email or web hooks) on exceptions raised locally
    verbose && ExceptionNotification::Notifier.config[:skip_local_notification] && is_local? ?
      puts("[NOTIFY LOCALLY] NO") :
      nil
Severity: Minor
Found in lib/exception_notification/notifiable_helper.rb - About 35 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 sections_for_email has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  def self.sections_for_email(rejected_sections, request)
    rejected_sections = rejected_sections.nil? ? request.nil? ? %w(request session) : [] : rejected_sections
    rejected_sections.empty? ? config[:sections] : config[:sections].reject{|s| rejected_sections.include?(s) }
  end
Severity: Minor
Found in lib/exception_notification/notifier.rb - About 35 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 rescue_with_hooks has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  def rescue_with_hooks(exception)
    verbose = self.class.notifiable_verbose && respond_to?(:logger) && !logger.nil?
    logger.info("[RESCUE STYLE] rescue_with_hooks") if verbose
    data = get_exception_data
    # With ExceptionNotifiable you have an inherent request, and using a status code makes sense.
Severity: Minor
Found in lib/exception_notification/notifiable.rb - About 35 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

Avoid too many return statements within this method.
Open

    return ExceptionNotification::Notifier.config[:notify_other_errors]
Severity: Major
Found in lib/exception_notification/notifiable_helper.rb - About 30 mins to fix

    Method build_web_hook_params has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

      def self.build_web_hook_params(config, exception, controller, request, data={}, the_blamed = nil)
        host = (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"])
        p = {
          'environment'              => (defined?(Rails) ? Rails.env : RAILS_ENV),
          'exceptions'               => [{
    Severity: Minor
    Found in lib/exception_notification/hooks_notifier.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

          logger.info("[FOUND FILE:B] #{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html.erb") if verbose
          "#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html.erb"
    Severity: Minor
    Found in lib/exception_notification/notifier.rb and 1 other location - About 25 mins to fix
    lib/exception_notification/notifier.rb on lines 103..104

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

    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

          logger.info("[FOUND FILE:C] #{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html") if verbose
          "#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html"
    Severity: Minor
    Found in lib/exception_notification/notifier.rb and 1 other location - About 25 mins to fix
    lib/exception_notification/notifier.rb on lines 100..101

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

    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

    Severity
    Category
    Status
    Source
    Language