fix(Checkbox): Rename CheckBox to Checkbox (#53)

BREAKING CHANGE: Rename CheckBox to Checkbox
Telefonica · Dec 15, 2020 · f66721f · f66721f
1 parent f80fe08
commit f66721f
Show file tree

Hide file tree

Showing 24 changed files with 119 additions and 127 deletions.
diff --git a/Mistica.xcodeproj/project.pbxproj b/Mistica.xcodeproj/project.pbxproj
diff --git a/Mistica/Source/Assets/CheckBoxAssets.swift → Mistica/Source/Assets/CheckboxAssets.swift b/Mistica/Source/Assets/CheckBoxAssets.swift → Mistica/Source/Assets/CheckboxAssets.swift
@@ -1,5 +1,5 @@
 //
-//  CheckBoxAssets.swift
+//  CheckboxAssets.swift
 //
 //  Made with ❤️ by Novum
 //

diff --git a/Mistica/Source/Components/CheckBox/README.md b/Mistica/Source/Components/CheckBox/README.md
diff --git a/...Source/Components/CheckBox/CheckBox.swift → ...Source/Components/Checkbox/Checkbox.swift b/...Source/Components/CheckBox/CheckBox.swift → ...Source/Components/Checkbox/Checkbox.swift
@@ -1,5 +1,5 @@
 //
-//  CheckBox.swift
+//  Checkbox.swift
 //
 //  Made with ❤️ by Novum
 //
@@ -9,21 +9,21 @@
 import CoreGraphics
 import UIKit
 
-public class CheckBox: UIControl {
+public class Checkbox: UIControl {
     private enum Constants {
         static let viewWidth = CGFloat(24)
     }
 
     private let imageView = UIImageView()
 
-    // A Boolean value that determines the off/on state of the CheckBox
+    // A Boolean value that determines the off/on state of the Checkbox
     public var isChecked = false {
         didSet {
             changeIcon(checked: isChecked)
         }
     }
 
-    // Called when the CheckBox changes its value.
+    // Called when the Checkbox changes its value.
     public var onValueChanged: ((Bool) -> Void)?
 
     public convenience init() {
@@ -66,7 +66,7 @@ public class CheckBox: UIControl {
     }
 }
 
-private extension CheckBox {
+private extension Checkbox {
     func commonInit() {
         layoutView()
 

diff --git a/Mistica/Source/Components/Checkbox/README.md b/Mistica/Source/Components/Checkbox/README.md
@@ -0,0 +1,21 @@
+#  Checkbox
+
+The Checkbox offers a binary choice.
+
+## Usage
+
+The **Checkbox** is used as any other view. 
+
+The component has two mechanisms for notify when the value changes. You can use the `onValueChanged` close
+
+```swift
+checkbox.onValueChanged = { checked in
+    // do something
+}
+```
+
+or using the target-action pattern of UIControl. Checkbox only send actions for `UIControl.Event.valueChanged`,
+
+```swift
+checkbox.addTarget(self, action: #selector(checkboxTapped), for: .valueChanged)
+``
diff --git a/...Tests/MisticaTests/UI/CheckBoxTests.swift → ...Tests/MisticaTests/UI/CheckboxTests.swift b/...Tests/MisticaTests/UI/CheckBoxTests.swift → ...Tests/MisticaTests/UI/CheckboxTests.swift
@@ -1,5 +1,5 @@
 //
-//  CheckBoxTests.swift
+//  CheckboxTests.swift
 //
 //  Made with ❤️ by Novum
 //
@@ -10,7 +10,7 @@ import Mistica
 import SnapshotTesting
 import XCTest
 
-final class CheckBoxTests: XCTestCase {
+final class CheckboxTests: XCTestCase {
     override class func setUp() {
         super.setUp()
 
@@ -22,14 +22,14 @@ final class CheckBoxTests: XCTestCase {
     func testCheckboxDefaultState() {
         assertSnapshotForAllBrands(
             as: .image,
-            viewBuilder: makeTemplateWithCheckBoxState(isChecked: false)
+            viewBuilder: makeTemplateWithCheckboxState(isChecked: false)
         )
     }
 
     func testCheckboxActiveCheckedState() {
         assertSnapshotForAllBrands(
             as: .image,
-            viewBuilder: makeTemplateWithCheckBoxState(isChecked: true)
+            viewBuilder: makeTemplateWithCheckboxState(isChecked: true)
         )
     }
 
@@ -38,20 +38,20 @@ final class CheckBoxTests: XCTestCase {
     func testCheckboxIsChecked() {
         MisticaConfig.brandStyle = .o2
 
-        let checkBox = CheckBox()
-        checkBox.isChecked = false
+        let checkbox = Checkbox()
+        checkbox.isChecked = false
 
         assertSnapshot(
-            matching: checkBox,
-            as: .image(size: checkBox.intrinsicContentSize),
+            matching: checkbox,
+            as: .image(size: checkbox.intrinsicContentSize),
             named: "assertInitialState"
         )
 
-        checkBox.isChecked = true
+        checkbox.isChecked = true
 
         assertSnapshot(
-            matching: checkBox,
-            as: .image(size: checkBox.intrinsicContentSize),
+            matching: checkbox,
+            as: .image(size: checkbox.intrinsicContentSize),
             named: "finalState"
         )
     }
@@ -61,7 +61,7 @@ final class CheckBoxTests: XCTestCase {
     func testXIBIntegration() {
         MisticaConfig.brandStyle = .vivo
 
-        let view = CheckBoxXIBIntegration.viewFromNib()
+        let view = CheckboxXIBIntegration.viewFromNib()
 
         assertSnapshot(
             matching: view,
@@ -72,13 +72,13 @@ final class CheckBoxTests: XCTestCase {
 
 // MARK: - Helpers
 
-private func makeTemplateWithCheckBoxState(isChecked: Bool) -> UIView {
-    let checkBox = CheckBox(frame: CGRect(origin: .zero, size: CGSize(width: 24, height: 24)))
-    checkBox.isChecked = isChecked
+private func makeTemplateWithCheckboxState(isChecked: Bool) -> UIView {
+    let checkbox = Checkbox(frame: CGRect(origin: .zero, size: CGSize(width: 24, height: 24)))
+    checkbox.isChecked = isChecked
 
-    let containerView = UIView(frame: CGRect(origin: .zero, size: checkBox.intrinsicContentSize))
+    let containerView = UIView(frame: CGRect(origin: .zero, size: checkbox.intrinsicContentSize))
     containerView.backgroundColor = .white
-    containerView.addSubview(checkBox)
+    containerView.addSubview(checkbox)
 
     return containerView
 }
diff --git a/...BIntegration/CheckBoxXIBIntegration.swift → ...BIntegration/CheckboxXIBIntegration.swift b/...BIntegration/CheckBoxXIBIntegration.swift → ...BIntegration/CheckboxXIBIntegration.swift
@@ -1,5 +1,5 @@
 //
-//  CheckBoxXIBIntegration.swift
+//  CheckboxXIBIntegration.swift
 //
 //  Made with ❤️ by Novum
 //
@@ -9,6 +9,6 @@
 import Mistica
 import UIKit
 
-class CheckBoxXIBIntegration: UIView {
-    @IBOutlet var checkBox: CheckBox!
+class CheckboxXIBIntegration: UIView {
+    @IBOutlet var checkbox: Checkbox!
 }
diff --git a/...XIBIntegration/CheckBoxXIBIntegration.xib → ...XIBIntegration/CheckboxXIBIntegration.xib b/...XIBIntegration/CheckBoxXIBIntegration.xib → ...XIBIntegration/CheckboxXIBIntegration.xib
@@ -11,11 +11,11 @@
     <objects>
         <placeholder placeholderIdentifier="IBFilesOwner" id="-1" userLabel="File's Owner"/>
         <placeholder placeholderIdentifier="IBFirstResponder" id="-2" customClass="UIResponder"/>
-        <view contentMode="scaleToFill" id="iN0-l3-epB" userLabel="CheckBoxXIB Integration" customClass="CheckBoxXIBIntegration" customModule="MisticaTests">
+        <view contentMode="scaleToFill" id="iN0-l3-epB" customClass="CheckboxXIBIntegration" customModule="MisticaTests">
             <rect key="frame" x="0.0" y="0.0" width="414" height="896"/>
             <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
             <subviews>
-                <view contentMode="scaleToFill" translatesAutoresizingMaskIntoConstraints="NO" id="gsx-LH-iVS" userLabel="CheckBox" customClass="CheckBox" customModule="Mistica">
+                <view contentMode="scaleToFill" translatesAutoresizingMaskIntoConstraints="NO" id="gsx-LH-iVS" customClass="Checkbox" customModule="Mistica">
                     <rect key="frame" x="184" y="203" width="46" height="46"/>
                     <color key="backgroundColor" systemColor="systemBackgroundColor"/>
                     <constraints>
@@ -31,7 +31,7 @@
                 <constraint firstItem="gsx-LH-iVS" firstAttribute="top" secondItem="vUN-kp-3ea" secondAttribute="top" constant="159" id="uiF-Bl-ha8"/>
             </constraints>
             <connections>
-                <outlet property="checkBox" destination="gsx-LH-iVS" id="pSl-4L-nYD"/>
+                <outlet property="checkbox" destination="gsx-LH-iVS" id="pSl-4L-nYD"/>
             </connections>
             <point key="canvasLocation" x="137.68115942028987" y="134.59821428571428"/>
         </view>

diff --git a/...ctiveCheckedState.with-movistar-style.png → ...ctiveCheckedState.with-movistar-style.png b/...ctiveCheckedState.with-movistar-style.png → ...ctiveCheckedState.with-movistar-style.png
diff --git a/...ckboxActiveCheckedState.with-o2-style.png → ...ckboxActiveCheckedState.with-o2-style.png b/...ckboxActiveCheckedState.with-o2-style.png → ...ckboxActiveCheckedState.with-o2-style.png
diff --git a/...tiveCheckedState.with-o2Classic-style.png → ...tiveCheckedState.with-o2Classic-style.png b/...tiveCheckedState.with-o2Classic-style.png → ...tiveCheckedState.with-o2Classic-style.png
diff --git a/...boxActiveCheckedState.with-vivo-style.png → ...boxActiveCheckedState.with-vivo-style.png b/...boxActiveCheckedState.with-vivo-style.png → ...boxActiveCheckedState.with-vivo-style.png
diff --git a/...ckboxDefaultState.with-movistar-style.png → ...ckboxDefaultState.with-movistar-style.png b/...ckboxDefaultState.with-movistar-style.png → ...ckboxDefaultState.with-movistar-style.png
diff --git a/...estCheckboxDefaultState.with-o2-style.png → ...estCheckboxDefaultState.with-o2-style.png b/...estCheckboxDefaultState.with-o2-style.png → ...estCheckboxDefaultState.with-o2-style.png
diff --git a/...kboxDefaultState.with-o2Classic-style.png → ...kboxDefaultState.with-o2Classic-style.png b/...kboxDefaultState.with-o2Classic-style.png → ...kboxDefaultState.with-o2Classic-style.png
diff --git a/...tCheckboxDefaultState.with-vivo-style.png → ...tCheckboxDefaultState.with-vivo-style.png b/...tCheckboxDefaultState.with-vivo-style.png → ...tCheckboxDefaultState.with-vivo-style.png
diff --git a/...tCheckboxIsChecked.assertInitialState.png → ...tCheckboxIsChecked.assertInitialState.png b/...tCheckboxIsChecked.assertInitialState.png → ...tCheckboxIsChecked.assertInitialState.png
diff --git a/...ests/testCheckboxIsChecked.finalState.png → ...ests/testCheckboxIsChecked.finalState.png b/...ests/testCheckboxIsChecked.finalState.png → ...ests/testCheckboxIsChecked.finalState.png
diff --git a/...__/CheckBoxTests/testXIBIntegration.1.png → ...__/CheckboxTests/testXIBIntegration.1.png b/...__/CheckBoxTests/testXIBIntegration.1.png → ...__/CheckboxTests/testXIBIntegration.1.png
diff --git a/MisticaCatalog/MisticaCatalog.xcodeproj/project.pbxproj b/MisticaCatalog/MisticaCatalog.xcodeproj/project.pbxproj
@@ -28,7 +28,7 @@
 		B8F9903F2546C98700DFBFE9 /* UICatalogScrollContentIndicatorViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F990172546C98600DFBFE9 /* UICatalogScrollContentIndicatorViewController.swift */; };
 		B8F990402546C98700DFBFE9 /* UICatalogFeedbacksViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F990182546C98600DFBFE9 /* UICatalogFeedbacksViewController.swift */; };
 		B8F990412546C98700DFBFE9 /* UICatalogHighlightedCardViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F990192546C98600DFBFE9 /* UICatalogHighlightedCardViewController.swift */; };
-		B8F990422546C98700DFBFE9 /* UICatalogCheckBoxViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F9901A2546C98600DFBFE9 /* UICatalogCheckBoxViewController.swift */; };
+		B8F990422546C98700DFBFE9 /* UICatalogCheckboxViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F9901A2546C98600DFBFE9 /* UICatalogCheckboxViewController.swift */; };
 		B8F990432546C98700DFBFE9 /* UICatalogButtonsViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F9901B2546C98600DFBFE9 /* UICatalogButtonsViewController.swift */; };
 		B8F990442546C98700DFBFE9 /* UICatalogFormViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F9901C2546C98600DFBFE9 /* UICatalogFormViewController.swift */; };
 		B8F990452546C98700DFBFE9 /* UICatalogFontsViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B8F9901D2546C98600DFBFE9 /* UICatalogFontsViewController.swift */; };
@@ -73,7 +73,7 @@
 		B8F990172546C98600DFBFE9 /* UICatalogScrollContentIndicatorViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogScrollContentIndicatorViewController.swift; sourceTree = "<group>"; };
 		B8F990182546C98600DFBFE9 /* UICatalogFeedbacksViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogFeedbacksViewController.swift; sourceTree = "<group>"; };
 		B8F990192546C98600DFBFE9 /* UICatalogHighlightedCardViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogHighlightedCardViewController.swift; sourceTree = "<group>"; };
-		B8F9901A2546C98600DFBFE9 /* UICatalogCheckBoxViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogCheckBoxViewController.swift; sourceTree = "<group>"; };
+		B8F9901A2546C98600DFBFE9 /* UICatalogCheckboxViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogCheckboxViewController.swift; sourceTree = "<group>"; };
 		B8F9901B2546C98600DFBFE9 /* UICatalogButtonsViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogButtonsViewController.swift; sourceTree = "<group>"; };
 		B8F9901C2546C98600DFBFE9 /* UICatalogFormViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogFormViewController.swift; sourceTree = "<group>"; };
 		B8F9901D2546C98600DFBFE9 /* UICatalogFontsViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICatalogFontsViewController.swift; sourceTree = "<group>"; };
@@ -208,7 +208,7 @@
 				B8F990172546C98600DFBFE9 /* UICatalogScrollContentIndicatorViewController.swift */,
 				B8F990182546C98600DFBFE9 /* UICatalogFeedbacksViewController.swift */,
 				B8F990192546C98600DFBFE9 /* UICatalogHighlightedCardViewController.swift */,
-				B8F9901A2546C98600DFBFE9 /* UICatalogCheckBoxViewController.swift */,
+				B8F9901A2546C98600DFBFE9 /* UICatalogCheckboxViewController.swift */,
 				B8F9901B2546C98600DFBFE9 /* UICatalogButtonsViewController.swift */,
 				B8F9901C2546C98600DFBFE9 /* UICatalogFormViewController.swift */,
 				B8F9901D2546C98600DFBFE9 /* UICatalogFontsViewController.swift */,
@@ -339,7 +339,7 @@
 				B8F990512546C98700DFBFE9 /* UICatalogHeaderViewController.swift in Sources */,
 				B8F990492546C98700DFBFE9 /* UICatalogSegmentSelectorViewController.swift in Sources */,
 				B8F990312546C98700DFBFE9 /* NavigationBarStyles.swift in Sources */,
-				B8F990422546C98700DFBFE9 /* UICatalogCheckBoxViewController.swift in Sources */,
+				B8F990422546C98700DFBFE9 /* UICatalogCheckboxViewController.swift in Sources */,
 				B8F9904D2546C98700DFBFE9 /* UICatalogListsViewController.swift in Sources */,
 				B8F9902D2546C98700DFBFE9 /* CatalogList.swift in Sources */,
 				B8F9904F2546C98700DFBFE9 /* UICatalogCroutonViewController.swift in Sources */,

diff --git a/MisticaCatalog/Source/Catalog/UICatalogViewController.swift b/MisticaCatalog/Source/Catalog/UICatalogViewController.swift
@@ -12,7 +12,7 @@ import UIKit
 private enum UICatalogRow: Int, CaseIterable {
     case badge
     case buttons
-    case checkBox
+    case checkbox
     case controls
     case crouton
     case feedbacks
@@ -172,8 +172,8 @@ extension UICatalogViewController: UITableViewDataSource, UITableViewDelegate {
             show(UICatalogControlsViewController(), sender: self)
         case .highlightedCard:
             show(UICatalogHighlightedCardViewController(), sender: self)
-        case .checkBox:
-            show(UICatalogCheckBoxViewController(), sender: self)
+        case .checkbox:
+            show(UICatalogCheckboxViewController(), sender: self)
         }
     }
 }
@@ -234,8 +234,8 @@ private extension UICatalogRow {
             return "Buttons"
         case .feedbacks:
             return "Feedbacks"
-        case .checkBox:
-            return "CheckBox"
+        case .checkbox:
+            return "Checkbox"
         case .crouton:
             return "Crouton"
         case .segmentSelector:
@@ -279,7 +279,7 @@ private extension UICatalogRow {
             return .feedbacksIcon
         case .crouton:
             return .croutonIcon
-        case .checkBox:
+        case .checkbox:
             return .controlsIcon
         case .segmentSelector:
             return .segmentSelectorIcon

diff --git a/...ogs/UICatalogCheckBoxViewController.swift → ...ogs/UICatalogCheckboxViewController.swift b/...ogs/UICatalogCheckBoxViewController.swift → ...ogs/UICatalogCheckboxViewController.swift
@@ -1,5 +1,5 @@
 //
-//  UICatalogCheckBoxViewController.swift
+//  UICatalogCheckboxViewController.swift
 //
 //  Made with ❤️ by Novum
 //
@@ -11,10 +11,10 @@ import UIKit
 
 private enum Section: Int, CaseIterable {
     case activated
-    case disabld
+    case disabled
 }
 
-class UICatalogCheckBoxViewController: UITableViewController {
+class UICatalogCheckboxViewController: UITableViewController {
     init() {
         if #available(iOS 13.0, *) {
             super.init(style: .insetGrouped)
@@ -30,15 +30,15 @@ class UICatalogCheckBoxViewController: UITableViewController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        title = "CheckBox"
+        title = "Checkbox"
 
         tableView.dataSource = self
         tableView.delegate = self
         tableView.keyboardDismissMode = .interactive
     }
 }
 
-extension UICatalogCheckBoxViewController {
+extension UICatalogCheckboxViewController {
     override func numberOfSections(in _: UITableView) -> Int {
         Section.allCases.count
     }
@@ -52,7 +52,7 @@ extension UICatalogCheckBoxViewController {
     }
 
     override func tableView(_: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
-        let checkBox = CheckBox()
+        let checkBox = Checkbox()
         checkBox.isUserInteractionEnabled = false
 
         if indexPath.section == 0 {
@@ -66,7 +66,7 @@ extension UICatalogCheckBoxViewController {
 }
 
 private class CellView: UITableViewCell {
-    public init(checkBox: CheckBox, reuseIdentifier: String?) {
+    public init(checkBox: Checkbox, reuseIdentifier: String?) {
         super.init(style: .default, reuseIdentifier: reuseIdentifier)
 
         selectionStyle = .none
@@ -91,7 +91,7 @@ private extension Section {
         switch self {
         case .activated:
             return "Activated"
-        case .disabld:
+        case .disabled:
             return "Disabled"
         }
     }

diff --git a/Package.swift b/Package.swift
@@ -30,7 +30,7 @@ let package = Package(
                 "Components/Badge/README.md",
                 "Components/Button/docs",
                 "Components/Button/README.md",
-                "Components/CheckBox/README.md",
+                "Components/Checkbox/README.md",
                 "Components/Controls/README.md",
                 "Components/Crouton/docs",
                 "Components/Crouton/README.md",

diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ func scene(_ scene: UIScene, willConnectTo _: UISceneSession, options _: UIScene
 
 * [Badge](./Mistica/Source/Components/Badge/)
 * [Button](./Mistica/Source/Components/Button/)
-* [CheckBox](./Mistica/Source/Components/CheckBox/)
+* [Checkbox](./Mistica/Source/Components/Checkbox/)
 * [Controls](./Mistica/Source/Components/Controls/)
 * [Crouton](./Mistica/Source/Components/Crouton/)
 * [Feedbacks](./Mistica/Source/Components/Feedback/)