Bloombox/Swift

View on GitHub

Showing 103 of 106 total issues

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

    return try self.service(try resolveContext(apiKey)).keyResolve(ResolveKey.Request.with { builder in
      // we support SHA1 and MD5 here, for now
      switch algorithm {
      case .sha1: builder.sha1 = subject
      case .md5: builder.md5 = subject
Severity: Minor
Found in Sources/Client/IdentityClient.swift and 1 other location - About 45 mins to fix
Sources/Client/IdentityClient.swift on lines 198..205

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

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

Function getOrder has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

  public func getOrder(id: OrderID,
                       isLocal: Bool = false,
                       partner: PartnerCode? = nil,
                       location: LocationCode? = nil,
                       apiKey: APIKey? = nil) throws -> GetOrder.Response {
Severity: Minor
Found in Sources/Client/ShopClient.swift - About 35 mins to fix

    Function verifyMember has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

      public func verifyMember(phone: PhoneNumber,
                               partner: PartnerCode? = nil,
                               location: LocationCode? = nil,
                               apiKey: APIKey? = nil,
                               callback: @escaping VerifyMemberCallback) throws -> VerifyMemberCall {
    Severity: Minor
    Found in Sources/Client/ShopClient.swift - About 35 mins to fix

      Function activate has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

        public func activate(deviceSerial name: DeviceSerial,
                             withFingerprint fingerprint: DeviceFingerprint? = nil,
                             withPublicKey publicKey: DevicePublicKey? = nil,
                             authorizedBy apiKey: APIKey? = nil,
                             _ callback: @escaping DeviceActivateCallback) throws -> DeviceActivateCall {
      Severity: Minor
      Found in Sources/Client/DevicesClient.swift - About 35 mins to fix

        Function retrieve has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

          public func retrieve(partner: PartnerCode? = nil,
                               location: LocationCode? = nil,
                               keysOnly: Bool = false,
                               apiKey: APIKey? = nil,
                               callback: @escaping MenuRetrieveCallback) throws -> GetMenuCall {
        Severity: Minor
        Found in Sources/Client/MenuClient.swift - About 35 mins to fix

          Function submitOrder has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            public func submitOrder(order: Order,
                                    partner: PartnerCode? = nil,
                                    location: LocationCode? = nil,
                                    deviceName: DeviceCode? = nil,
                                    apiKey: APIKey? = nil) throws -> SubmitOrder.Response {
          Severity: Minor
          Found in Sources/Client/ShopClient.swift - About 35 mins to fix

            Function verifyMember has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

              public func verifyMember(email: String,
                                       partner: PartnerCode? = nil,
                                       location: LocationCode? = nil,
                                       apiKey: APIKey? = nil,
                                       callback: @escaping VerifyMemberCallback) throws -> VerifyMemberCall {
            Severity: Minor
            Found in Sources/Client/ShopClient.swift - About 35 mins to fix

              Function checkZipcode has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                public func checkZipcode(zipcode: String,
                                         partner: PartnerCode? = nil,
                                         location: LocationCode? = nil,
                                         apiKey: APIKey? = nil,
                                         callback: @escaping CheckZipcodeCallback) throws -> CheckZipcodeCall {
              Severity: Minor
              Found in Sources/Client/ShopClient.swift - About 35 mins to fix

                Single-line comment should start with whitespace
                Open

                //// Identity Service
                Severity: Minor
                Found in Sources/Client/Bindings.swift by tailor

                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 */

                Multiline comment should end with whitespace
                Open

                **/

                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 */

                Multiline comment should end with whitespace
                Open

                **/
                Severity: Minor
                Found in Sources/Client/TelemetryClient.swift by tailor

                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 */

                Function should have at least one blank line after it
                Open

                  }
                Severity: Minor
                Found in Sources/Client/TelemetryClient.swift by tailor

                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

                **/
                Severity: Minor
                Found in Sources/Client/IdentityClient.swift by tailor

                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 */

                Multiline comment should end with whitespace
                Open

                **/
                Severity: Minor
                Found in Sources/Client/Labelled.swift by tailor

                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 */

                Single-line comment should start with whitespace
                Open

                //// Auth Service
                Severity: Minor
                Found in Sources/Client/Bindings.swift by tailor

                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 */

                Single-line comment should start with whitespace
                Open

                //// Platform Service
                Severity: Minor
                Found in Sources/Client/Bindings.swift by tailor

                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 */

                Global Constant should be either lowerCamelCase or UpperCamelCase
                Open

                internal let __BLOOMBOX_VARIANT__ = "full"
                Severity: Minor
                Found in Sources/Client/Bloombox.swift by tailor

                constant-naming

                Global constants should follow either UpperCamelCase or lowerCamelCase naming conventions. Local constants should follow lowerCamelCase naming conventions.

                Preferred

                let MaxHeight = 42
                let maxHeight = 42

                Not Preferred

                let max_height = 42

                Multiline comment should end with whitespace
                Open

                **/

                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 */

                Multiline comment should end with whitespace
                Open

                **/
                Severity: Minor
                Found in Sources/Client/MenuClient.swift by tailor

                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 */

                Multiline comment should end with whitespace
                Open

                **/
                Severity: Minor
                Found in Sources/Client/Bloombox.swift by tailor

                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 */
                Severity
                Category
                Status
                Source
                Language