fgrehm/letter_opener_web

View on GitHub

Showing 2 of 2 total issues

Class Letter has 22 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Letter
    attr_reader :id, :sent_at

    def self.letters_location
      @letters_location ||= LetterOpenerWeb.config.letters_location
Severity: Minor
Found in app/models/letter_opener_web/letter.rb - About 2 hrs to fix

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

        def adjust_link_targets(contents)
          # We cannot feed the whole file to a XML parser as some mails are
          # "complete" (as in they have the whole <html> structure) and letter_opener
          # prepends some information about the mail being sent, making REXML
          # complain about it
    Severity: Minor
    Found in app/models/letter_opener_web/letter.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

    Severity
    Category
    Status
    Source
    Language