Sign upLogin

ephread/Instructions

View on GitHub
Star

Showing 63 of 63 total issues

File CoachMarksViewController.swift has 298 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import UIKit

// TODO: ❗️ Find a good way to refactor this growing controller
// swiftlint:disable file_length
// MARK: - Main Class
Severity: Minor
Found in Sources/Instructions/Core/Internal/CoachMarksViewController.swift - About 3 hrs to fix

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

        public func convert(rect: CGRect, from superview: UIView?) -> CGRect {
        // No superview, assuming frame in `instructionsRootView`'s coordinate system.
        guard let superview = superview else {
            print(ErrorMessage.Warning.anchorViewIsNotInTheViewHierarchy)
            return rect
    Severity: Major
    Found in Sources/Instructions/Helpers/Public/CoachMarkCoordinateConverter.swift and 1 other location - About 2 hrs to fix
    Sources/Instructions/Helpers/Public/CoachMarkCoordinateConverter.swift on lines 63..97

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

    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

        public func convert(point: CGPoint, from superview: UIView?) -> CGPoint {
        // No superview, assuming frame in `instructionsRootView`'s coordinate system.
        guard let superview = superview else {
            print(ErrorMessage.Warning.anchorViewIsNotInTheViewHierarchy)
            return point
    Severity: Major
    Found in Sources/Instructions/Helpers/Public/CoachMarkCoordinateConverter.swift and 1 other location - About 2 hrs to fix
    Sources/Instructions/Helpers/Public/CoachMarkCoordinateConverter.swift on lines 20..54

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

    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 initializeViewHierarchy has 65 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        func initializeViewHierarchy() {
        backgroundColor = .clear
        translatesAutoresizingMaskIntoConstraints = false

        initializeAccessibilityIdentifier()
    Severity: Major
    Found in Sources/Instructions/Extra/Default Views/CoachMarkBodyDefaultView.swift - About 2 hrs to fix

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

          private func leadingConstraints(for coachMarkView: CoachMarkView,
                                    withCoachMark coachMark: CoachMark,
                                    inParentView parentView: UIView
    ) -> [NSLayoutConstraint] {
      Severity: Major
      Found in Sources/Instructions/Helpers/Internal/CoachMarkLayoutHelper.swift and 1 other location - About 2 hrs to fix
      Sources/Instructions/Helpers/Internal/CoachMarkLayoutHelper.swift on lines 121..150

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

      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

          private func trailingConstraints(for coachMarkView: CoachMarkView,
                                     withCoachMark coachMark: CoachMark,
                                     inParentView parentView: UIView
    ) -> [NSLayoutConstraint] {
        if #available(iOS 11.0, *) {
      Severity: Major
      Found in Sources/Instructions/Helpers/Internal/CoachMarkLayoutHelper.swift and 1 other location - About 2 hrs to fix
      Sources/Instructions/Helpers/Internal/CoachMarkLayoutHelper.swift on lines 55..85

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

      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 showNew has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          func showNew(coachMarkView: CoachMarkView, from coachMark: CoachMark,
                 at index: Int, animated: Bool = true, completion: (() -> Void)? = nil) {
        guard let overlay = overlayManager else { return }

        prepare(coachMarkView: coachMarkView, forDisplayIn: overlay.overlayView.superview!,
      Severity: Minor
      Found in Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift - About 1 hr to fix

        Function hide has 44 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            func hide(coachMarkView: UIView, from coachMark: CoachMark, at index: Int,
              animated: Bool, beforeTransition: Bool, completion: (() -> Void)? = nil) {
        guard let overlay = overlayManager else { return }

        guard animated else {
        Severity: Minor
        Found in Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift - About 1 hr to fix

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

              private func topOrientationConstraints(for coachMarkViews: CoachMarkViews,
                                           in parentView: UIView, verticalArrowOffset: CGFloat)
    -> [NSLayoutConstraint] {

        let offset = adaptedOffset(for: .top, offset: verticalArrowOffset)
          Severity: Major
          Found in Sources/Instructions/Helpers/Internal/CoachMarkInnerLayoutHelper.swift and 1 other location - About 1 hr to fix
          Sources/Instructions/Helpers/Internal/CoachMarkInnerLayoutHelper.swift on lines 50..62

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

          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

              private func bottomOrientationConstraints(for coachMarkViews: CoachMarkViews,
                                              in parentView: UIView, verticalArrowOffset: CGFloat)
    -> [NSLayoutConstraint] {
            let offset = adaptedOffset(for: .bottom, offset: verticalArrowOffset)
          Severity: Major
          Found in Sources/Instructions/Helpers/Internal/CoachMarkInnerLayoutHelper.swift and 1 other location - About 1 hr to fix
          Sources/Instructions/Helpers/Internal/CoachMarkInnerLayoutHelper.swift on lines 35..48

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

          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 defaultConstraints has 39 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private func defaultConstraints(for skipView: (UIView & CoachMarkSkipView), in parentView: UIView)
    -> [NSLayoutConstraint] {
        var constraints = [NSLayoutConstraint]()

        let trailingAnchor: NSLayoutXAxisAnchor
          Severity: Minor
          Found in Sources/Instructions/Managers/Internal/SkipViewDisplayManager.swift - About 1 hr to fix

            Function defaultConstraints has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

                private func defaultConstraints(for skipView: (UIView & CoachMarkSkipView), in parentView: UIView)
    -> [NSLayoutConstraint] {
        var constraints = [NSLayoutConstraint]()

        let trailingAnchor: NSLayoutXAxisAnchor
            Severity: Minor
            Found in Sources/Instructions/Managers/Internal/SkipViewDisplayManager.swift - About 1 hr 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 constraints has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                func constraints(
        for coachMarkView: CoachMarkView,
        coachMark: CoachMark,
        parentView: UIView,
        layoutDirection: UIUserInterfaceLayoutDirection? = nil,
            Severity: Minor
            Found in Sources/Instructions/Helpers/Internal/CoachMarkLayoutHelper.swift - About 1 hr to fix

              Function showNextCoachMark has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
              Open

                  internal func showNextCoachMark(hidePrevious: Bool = true) {
        if disableFlow || isPaused || !canShowCoachMark { return }

        let previousIndex = currentIndex
              Severity: Minor
              Found in Sources/Instructions/Managers/Public/FlowManager.swift - About 1 hr 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 showOverlay has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
              Open

                  func showOverlay(_ show: Bool, withDuration duration: TimeInterval,
                     completion: ((Bool) -> Void)?) {
        sizeTransitionOverlay?.isHidden = true
        let subviews = overlayView?.holder.subviews
              Severity: Minor
              Found in Sources/Instructions/Managers/Internal/OverlayStyleManager/BlurringOverlayStyleManager.swift - About 1 hr 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 start has 31 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  func start(in presentationContext: PresentationContext) {
        guard let dataSource = self.dataSource else {
            print(ErrorMessage.Warning.nilDataSource)
            return
        }
              Severity: Minor
              Found in Sources/Instructions/Core/Public/CoachMarksController.swift - About 1 hr to fix

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

                        if transitionManager.animationType == .regular {
            UIView.animate(withDuration: transitionManager.parameters.duration,
                           delay: transitionManager.parameters.delay,
                           options: transitionManager.parameters.options,
                           animations: animationBlock, completion: completionBlock)
                Severity: Major
                Found in Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift and 1 other location - About 1 hr to fix
                Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift on lines 180..190

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

                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

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

                        if transitionManager.animationType == .regular {
            UIView.animate(withDuration: transitionManager.parameters.duration,
                           delay: transitionManager.parameters.delay,
                           options: transitionManager.parameters.options,
                           animations: animationBlock, completion: completionBlock)
                Severity: Major
                Found in Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift and 1 other location - About 1 hr to fix
                Sources/Instructions/Managers/Internal/CoachMarkDisplayManager.swift on lines 106..116

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

                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

                    static let coachMarkOuter: UIColor = {
        let defaultColor = #colorLiteral(red: 0.8901960784, green: 0.8901960784, blue: 0.8901960784, alpha: 1)

        if #available(iOS 13.0, *) {
            return UIColor { (traits) -> UIColor in
                Severity: Major
                Found in Sources/Instructions/Instructions.swift and 1 other location - About 1 hr to fix
                Sources/Instructions/Instructions.swift on lines 76..90

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

                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

                    static let coachMarkLabel: UIColor = {
        let defaultColor = #colorLiteral(red: 0.1333333333, green: 0.1333333333, blue: 0.1333333333, alpha: 1)

        if #available(iOS 13.0, *) {
            return UIColor { (traits) -> UIColor in
                Severity: Major
                Found in Sources/Instructions/Instructions.swift and 1 other location - About 1 hr to fix
                Sources/Instructions/Instructions.swift on lines 60..74

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

                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