IBM-Swift/Kitura

View on GitHub
Sources/Kitura/bodyParser/MultiPartBodyParser.swift

Summary

Maintainability
C
7 hrs
Test Coverage

Function handleHeaderLine has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private func handleHeaderLine(_ line: String, part: inout Part) {
        if let labelRange = getLabelRange(of: "content-type:", in: line) {
            part.type = String(line[line.index(after: labelRange.upperBound)...])
            part.headers[.type] = line
            return
Severity: Minor
Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift - About 1 hr to fix

    Function getPart has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private func getPart(_ componentPart: Data) -> Part? {
            guard let found = componentPart.range(of: endHeaderData, in: 0 ..< componentPart.count) else {
                return nil
            }
    
    
    Severity: Minor
    Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift - About 1 hr to fix

      Function getPart has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          private func getPart(_ componentPart: Data) -> Part? {
              guard let found = componentPart.range(of: endHeaderData, in: 0 ..< componentPart.count) else {
                  return nil
              }
      
      
      Severity: Minor
      Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift - About 55 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

      Function handleHeaderLine has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          private func handleHeaderLine(_ line: String, part: inout Part) {
              if let labelRange = getLabelRange(of: "content-type:", in: line) {
                  part.type = String(line[line.index(after: labelRange.upperBound)...])
                  part.headers[.type] = line
                  return
      Severity: Minor
      Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift - 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

      Function parse has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          func parse(_ data: Data) -> ParsedBody? {
              var parts: [Part] = []
              // split the body into component parts separated by the boundary, drop the preamble part
              let componentParts = data.components(separatedBy: boundaryData).dropFirst()
      
      
      Severity: Minor
      Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift - 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

      TODO found
      Open

                  //TODO: Deal with this

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

                  if let nameRange = line.range(of: "name=", options: caseInsensitiveSearch, range: labelRange.upperBound..<line.endIndex) {
                      let valueStartIndex = line.index(after: nameRange.upperBound)
                      let valueEndIndex = line.range(of: "\"", range: valueStartIndex..<line.endIndex)
                      part.name = String(line[valueStartIndex..<(valueEndIndex?.lowerBound ?? line.endIndex)])
                  }
      Severity: Major
      Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift and 1 other location - About 1 hr to fix
      Sources/Kitura/bodyParser/MultiPartBodyParser.swift on lines 99..103

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

      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 let filenameRange = line.range(of: "filename=", options: caseInsensitiveSearch, range: labelRange.upperBound..<line.endIndex) {
                      let valueStartIndex = line.index(after: filenameRange.upperBound)
                      let valueEndIndex = line.range(of: "\"", range: valueStartIndex..<line.endIndex)
                      part.filename = String(line[valueStartIndex..<(valueEndIndex?.lowerBound ?? line.endIndex)])
                  }
      Severity: Major
      Found in Sources/Kitura/bodyParser/MultiPartBodyParser.swift and 1 other location - About 1 hr to fix
      Sources/Kitura/bodyParser/MultiPartBodyParser.swift on lines 94..98

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

      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

      TODO comments should be formatted either as <todo: description> or <todo description></todo></todo:>
      Open

                  // swiftlint:disable todo

      todo-syntax

      TODO comments should be defined separately using non-nested single line comments. They should adhere to the <TODO: description> or <TODO(developer-name): description> syntax. Empty TODO comments will be flagged.

      Preferred

      // TODO: <insert mandatory todo comment>
      // TODO(dev-name): <insert mandatory todo comment></insert></insert>

      Not Preferred

      // TODO:
      
      /// TODO: Documentation comments should not have TODOs
      
      //// TODO: Nested comments should not have TODOs
      
      // //TODO: Nested comments should not have TODOs
      
      // TODO: Nested comments should not have TODOs // some comment
      
      //// TODO: Nested comments should not have TODOs

      TODO comments should be formatted either as <todo: description> or <todo description></todo></todo:>
      Open

                  // swiftlint:enable todo

      todo-syntax

      TODO comments should be defined separately using non-nested single line comments. They should adhere to the <TODO: description> or <TODO(developer-name): description> syntax. Empty TODO comments will be flagged.

      Preferred

      // TODO: <insert mandatory todo comment>
      // TODO(dev-name): <insert mandatory todo comment></insert></insert>

      Not Preferred

      // TODO:
      
      /// TODO: Documentation comments should not have TODOs
      
      //// TODO: Nested comments should not have TODOs
      
      // //TODO: Nested comments should not have TODOs
      
      // TODO: Nested comments should not have TODOs // some comment
      
      //// TODO: Nested comments should not have TODOs

      TODO comments should be formatted either as <todo: description> or <todo description></todo></todo:>
      Open

                  //TODO: Deal with this

      todo-syntax

      TODO comments should be defined separately using non-nested single line comments. They should adhere to the <TODO: description> or <TODO(developer-name): description> syntax. Empty TODO comments will be flagged.

      Preferred

      // TODO: <insert mandatory todo comment>
      // TODO(dev-name): <insert mandatory todo comment></insert></insert>

      Not Preferred

      // TODO:
      
      /// TODO: Documentation comments should not have TODOs
      
      //// TODO: Nested comments should not have TODOs
      
      // //TODO: Nested comments should not have TODOs
      
      // TODO: Nested comments should not have TODOs // some comment
      
      //// TODO: Nested comments should not have TODOs

      There are no issues that match your filters.

      Category
      Status