File TelemetryClient+Commercial.swift has 303 lines of code (exceeds 250 allowed). Consider refactoring. Open
import Foundation
/// Enumerates errors that may be thrown during operations related to commercial events.
public enum CommercialEventError: Error {Function sectionAction has 11 arguments (exceeds 4 allowed). Consider refactoring. Open
public func sectionAction(section: MenuSection,
action: SectionActionType,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,Function productAction has 11 arguments (exceeds 4 allowed). Consider refactoring. Open
public func productAction(product: ProductKey,
action: ProductActionType,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,Function resolveCommercialContext has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
fileprivate func resolveCommercialContext(type: CommercialEvent,
section: MenuSection? = nil,
product: ProductKey? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,Function productView has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
public func productView(product: ProductKey,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,
partner: PartnerCode? = nil,Function sectionImpression has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
public func sectionImpression(section: MenuSection,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,
partner: PartnerCode? = nil,Function productImpression has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
public func productImpression(product: ProductKey,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,
partner: PartnerCode? = nil,Function orderAction has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
public func orderAction(order: Order,
action: OrderActionType,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
partner: PartnerCode? = nil,Function sectionView has 10 arguments (exceeds 4 allowed). Consider refactoring. Open
public func sectionView(section: MenuSection,
uuid: UUID? = nil,
activeUser: UserKey? = nil,
activeOrder: OrderID? = nil,
partner: PartnerCode? = nil,Identical blocks of code found in 3 locations. Consider refactoring. Open
if let c = context {
var exported = c.export()
let globalContext = settings.export()
let serialized = try globalContext.serializedData()
try exported.merge(serializedData: serialized)- Read upRead up
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 73.
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
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Function should have at least one blank line before it Open
fileprivate func resolveCommercialContext(type: CommercialEvent,- Read upRead up
- Exclude checks
function-whitespace
Every function and method declaration should have one blank line before and after itself. An exception to this rule are functions that are declared at the start of a file (only need one blank line after their declaration) or at the end of a file (only need one blank line before their declaration). Comments immediately before a function declaration (no blank lines between them and the function) are considered to be part of the declaration.
Preferred
func function1() {
var text = 1
var text = 2
}
function1()
// a comment
func function2() {
// something goes here
}
struct SomeStruct {
func function3() {
// something goes here
}
func function4() {
// something else goes here
};
}
func function5() {
// something goes here
}Not Preferred
func function1() {
var text = 1
var text = 2
}
function1()
// a comment
func function2() {
// something goes here
}
struct SomeStruct {
func function3() {
// something goes here
}
func function4() {
// something else goes here
};
}
func function5() {
// something goes here
}Multiline comment should end with whitespace Open
**/- Read upRead up
- Exclude checks
comment-whitespace
Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).
Preferred
// This is a comment
/// This is a documentation comment
/* This is a
multi-line comment */
/* This is a
multi-line comment
*/
/** This is a
documentation multi-line
comment
*/Not Preferred
//This is a comment
///This is a documentation comment
/*This is a
multi-line comment*/
/**This is a multi-line
documentation comment */