Merge pull request #44 from huri000/feature/view-controller-entry

View Controller Entry

Author: huri000

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 Any notable changes to this project will be documented in this file.
 
+## 0.4.0
+
+### Features
+
+#### [Use UIViewController as an entry #40](https://github.com/huri000/SwiftEntryKit/issues/40)
+Developers can now use a customized view controller as an entry.
+A sample has been added to the custom presets section in example project.
+
 ## 0.3.3
 
 ### Issues Handled:

Example/Podfile.lock

@@ -2,7 +2,7 @@ PODS:
   - Nimble (7.0.2)
   - Quick (1.2.0)
   - QuickLayout (2.0.2)
-  - SwiftEntryKit (0.3.2):
+  - SwiftEntryKit (0.4.0):
     - QuickLayout (= 2.0.2)
 
 DEPENDENCIES:
@@ -24,7 +24,7 @@ SPEC CHECKSUMS:
   Nimble: bfe1f814edabba69ff145cb1283e04ed636a67f2
   Quick: 58d203b1c5e27fff7229c4c1ae445ad7069a7a08
   QuickLayout: a730730b646b231fd4ef7cffaeb1e81fe0e1ca92
-  SwiftEntryKit: e2e36ab4cb060d0ce190b4a399a5bca26dcc2bad
+  SwiftEntryKit: 89fdd4a15ae213d9b9bbcf36a319d2d3696f5f13
 
 PODFILE CHECKSUM: edd6c2af5cc390dbf823427759474ab6c303ec9e
 

Example/Pods/Local Podspecs/SwiftEntryKit.podspec.json

@@ -30,6 +30,8 @@
 		149D0A1220AF1EE7000AA6C4 /* FormFieldPresetFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 149D0A1120AF1EE7000AA6C4 /* FormFieldPresetFactory.swift */; };
 		14A1AB3520930120001CA5B4 /* PresetsDataSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14A1AB3420930120001CA5B4 /* PresetsDataSource.swift */; };
 		14A40C63208B7AA800B79474 /* PlaygroundViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14A40C62208B7AA800B79474 /* PlaygroundViewController.swift */; };
+		14A6AAB220CA5B2C005F3D81 /* SwiftEntryKit+Execution.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14A6AAB120CA5B2C005F3D81 /* SwiftEntryKit+Execution.swift */; };
+		14A6AAC420CA7208005F3D81 /* ExampleViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14A6AAC320CA7208005F3D81 /* ExampleViewController.swift */; };
 		14B3A50720C1198A002306C4 /* EKRatingMessageView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14B3A50620C1198A002306C4 /* EKRatingMessageView.swift */; };
 		14B3A51220C16B64002306C4 /* EKRatingMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14B3A51120C16B64002306C4 /* EKRatingMessage.swift */; };
 		14B3A51420C16BAC002306C4 /* EKAlertMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 14B3A51320C16BAC002306C4 /* EKAlertMessage.swift */; };
@@ -218,6 +220,8 @@
 		149D0A1120AF1EE7000AA6C4 /* FormFieldPresetFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FormFieldPresetFactory.swift; sourceTree = "<group>"; };
 		14A1AB3420930120001CA5B4 /* PresetsDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PresetsDataSource.swift; sourceTree = "<group>"; };
 		14A40C62208B7AA800B79474 /* PlaygroundViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PlaygroundViewController.swift; sourceTree = "<group>"; };
+		14A6AAB120CA5B2C005F3D81 /* SwiftEntryKit+Execution.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SwiftEntryKit+Execution.swift"; sourceTree = "<group>"; };
+		14A6AAC320CA7208005F3D81 /* ExampleViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleViewController.swift; sourceTree = "<group>"; };
 		14B0B95020B7E4FE00D24D8A /* QuickLayout.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = QuickLayout.framework; path = "../../../Library/Developer/Xcode/DerivedData/QuickLayout-aotxzuhsyjyfzgcifoglldyfgnnw/Build/Products/Debug-iphonesimulator/QuickLayout-iOS/QuickLayout.framework"; sourceTree = "<group>"; };
 		14B3A50620C1198A002306C4 /* EKRatingMessageView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EKRatingMessageView.swift; sourceTree = "<group>"; };
 		14B3A51120C16B64002306C4 /* EKRatingMessage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EKRatingMessage.swift; sourceTree = "<group>"; };
@@ -382,6 +386,14 @@
 			path = PresetsData;
 			sourceTree = "<group>";
 		};
+		14A6AABB20CA71D9005F3D81 /* ExampleViewController */ = {
+			isa = PBXGroup;
+			children = (
+				14A6AAC320CA7208005F3D81 /* ExampleViewController.swift */,
+			);
+			path = ExampleViewController;
+			sourceTree = "<group>";
+		};
 		14B48B1720B81C9700CE3EF4 /* Source */ = {
 			isa = PBXGroup;
 			children = (
@@ -424,6 +436,7 @@
 		14B48B2520B81C9700CE3EF4 /* Extensions */ = {
 			isa = PBXGroup;
 			children = (
+				14A6AAB120CA5B2C005F3D81 /* SwiftEntryKit+Execution.swift */,
 				14B48B2620B81C9700CE3EF4 /* UIView+Utils.swift */,
 				14B48B2720B81C9700CE3EF4 /* UIRectCorner+Short.swift */,
 				14B48B2820B81C9700CE3EF4 /* UIEdgeInsets+Utils.swift */,
@@ -514,6 +527,7 @@
 		14C729C6209447CA0060D267 /* Samples */ = {
 			isa = PBXGroup;
 			children = (
+				14A6AABB20CA71D9005F3D81 /* ExampleViewController */,
 				14D18CD0209118950019AE7F /* NibExampleView */,
 			);
 			path = Samples;
@@ -1019,6 +1033,7 @@
 				14B48B6820B81C9700CE3EF4 /* EKProperty.swift in Sources */,
 				14B48B6520B81C9700CE3EF4 /* UIEdgeInsets+Utils.swift in Sources */,
 				14B3A51620C16BC3002306C4 /* EKSimpleMessage.swift in Sources */,
+				14A6AAB220CA5B2C005F3D81 /* SwiftEntryKit+Execution.swift in Sources */,
 				14B48B5D20B81C9700CE3EF4 /* EKWrapperView.swift in Sources */,
 				14B48B6320B81C9700CE3EF4 /* UIView+Utils.swift in Sources */,
 				14B3A51820C16D7A002306C4 /* EKRatingSymbolView.swift in Sources */,
@@ -1048,6 +1063,7 @@
 				1496D956209CC6EF002CBB22 /* Object+ClassName.swift in Sources */,
 				143F3AAE2090B4E2009F3719 /* HapticFeedbackSelectionTableViewCell.swift in Sources */,
 				14C729D5209476A90060D267 /* BorderSelectionTableViewCell.swift in Sources */,
+				14A6AAC420CA7208005F3D81 /* ExampleViewController.swift in Sources */,
 				143F3AA42090A70E009F3719 /* RoundCornersSelectionTableViewCell.swift in Sources */,
 				14C894F8208E70D5003D8CE3 /* SelectionTableViewCell.swift in Sources */,
 				14665621209204A5008FB96D /* AnimationSelectionTableViewCell.swift in Sources */,

Example/Pods/Manifest.lock

@@ -335,6 +335,24 @@ struct PresetsDataSource {
         description = .init(with: attributes, title: "Center Alert View", description: descriptionString, thumb: descriptionThumb)
         presets.append(description)
 
+        // Preset VI
+        attributes = .centerFloat
+        attributes.windowLevel = .alerts
+        attributes.hapticFeedbackType = .success
+        attributes.screenInteraction = .absorbTouches
+        attributes.entryInteraction = .absorbTouches
+        attributes.scroll = .disabled
+        attributes.screenBackground = .color(color: .dimmedLightBackground)
+        attributes.entryBackground = .color(color: UIColor.white.withAlphaComponent(0.98))
+        attributes.entranceAnimation = .init(scale: .init(from: 0.9, to: 1, duration: 0.4, spring: .init(damping: 0.8, initialVelocity: 0)), fade: .init(from: 0, to: 1, duration: 0.3))
+        attributes.exitAnimation = .init(scale: .init(from: 1, to: 0.4, duration: 0.4, spring: .init(damping: 1, initialVelocity: 0)), fade: .init(from: 1, to: 0, duration: 0.2))
+        attributes.displayDuration = .infinity
+        attributes.positionConstraints.maxSize = .init(width: .constant(value: UIScreen.main.minEdge), height: .intrinsic)
+        descriptionString = "Appears in the center. Fun, expressive, and rich with animations"
+        descriptionThumb = ThumbDesc.bottomPopup.rawValue
+        description = .init(with: attributes, title: "Service Rating", description: descriptionString, thumb: descriptionThumb)
+        presets.append(description)
+        
         dataSource.append(("Alerts & Popups", presets))
     }
 
@@ -465,23 +483,34 @@ struct PresetsDataSource {
         presets.append(description)
 
         // Preset II
-        attributes = .centerFloat
-        attributes.windowLevel = .alerts
+        attributes = .bottomFloat
         attributes.hapticFeedbackType = .success
-        attributes.screenInteraction = .absorbTouches
+        attributes.displayDuration = 3
+        attributes.screenBackground = .clear
+        attributes.entryBackground = .clear
+        attributes.screenInteraction = .forward
         attributes.entryInteraction = .absorbTouches
-        attributes.scroll = .disabled
-        attributes.screenBackground = .color(color: .dimmedLightBackground)
-        attributes.entryBackground = .color(color: UIColor.white.withAlphaComponent(0.98))
-        attributes.entranceAnimation = .init(scale: .init(from: 0.9, to: 1, duration: 0.4, spring: .init(damping: 0.8, initialVelocity: 0)), fade: .init(from: 0, to: 1, duration: 0.3))
-        attributes.exitAnimation = .init(scale: .init(from: 1, to: 0.4, duration: 0.4, spring: .init(damping: 1, initialVelocity: 0)), fade: .init(from: 1, to: 0, duration: 0.2))
-        attributes.displayDuration = .infinity
+        attributes.roundCorners = .all(radius: 5)
+        
+        attributes.entranceAnimation = .init(translate: .init(duration: 0.5, spring: .init(damping: 0.9, initialVelocity: 0)),
+                                             scale: .init(from: 0.8, to: 1, duration: 0.5, spring: .init(damping: 0.8, initialVelocity: 0)),
+                                             fade: .init(from: 0.7, to: 1, duration: 0.3))
+        attributes.exitAnimation = .init(translate: .init(duration: 0.5),
+                                         scale: .init(from: 1, to: 0.8, duration: 0.5),
+                                         fade: .init(from: 1, to: 0, duration: 0.5))
+        attributes.popBehavior = .animated(animation: .init(translate: .init(duration: 0.3),
+                                                            scale: .init(from: 1, to: 0.8, duration: 0.3)))
+        attributes.shadow = .active(with: .init(color: .black, opacity: 0.3, radius: 6))
+        attributes.positionConstraints.verticalOffset = 10
+        attributes.positionConstraints.size = .init(width: .offset(value: 20), height: .intrinsic)
         attributes.positionConstraints.maxSize = .init(width: .constant(value: UIScreen.main.minEdge), height: .intrinsic)
-        descriptionString = "Appears in the center. Fun, expressive, and rich with animations"
-        descriptionThumb = ThumbDesc.bottomPopup.rawValue
-        description = .init(with: attributes, title: "Service Rating", description: descriptionString, thumb: descriptionThumb)
+        
+        attributes.statusBar = .dark
+        descriptionString = "Customized UIViewController that is using an injected view"
+        descriptionThumb = ThumbDesc.bottomFloat.rawValue
+        description = .init(with: attributes, title: "View Controller", description: descriptionString, thumb: descriptionThumb)
         presets.append(description)
-    
+        
         dataSource.append(("Custom", presets))
     }
 }

Example/Pods/Pods.xcodeproj/project.pbxproj

@@ -284,11 +284,17 @@ class PresetsViewController: UIViewController {
         SwiftEntryKit.display(entry: contentView, using: attributes)
     }
 
-    // Bumps a custom nib view
+    // Bumps a custom nib originated view
     private func showCustomNibView(attributes: EKAttributes) {
         SwiftEntryKit.display(entry: NibExampleView(), using: attributes)
     }
 
+    // Bumps a custom view controller that is using a view from nib
+    private func showCustomViewController(attributes: EKAttributes) {
+        let viewController = ExampleViewController(with: NibExampleView())
+        SwiftEntryKit.display(entry: viewController, using: attributes)
+    }
+    
     // Sign in form
     private func showSigninForm(attributes: EKAttributes, style: FormStyle) {
         let title = EKProperty.LabelContent(text: "Sign in to your account", style: style.title)
@@ -433,6 +439,8 @@ extension PresetsViewController {
             showButtonBarMessage(attributes: attributes)
         case 4:
             showAlertView(attributes: attributes)
+        case 5:
+            showRatingView(attributes: attributes)
         default:
             break
         }
@@ -456,7 +464,7 @@ extension PresetsViewController {
         case 0:
             showCustomNibView(attributes: attributes)
         case 1:
-            showRatingView(attributes: attributes)
+            showCustomViewController(attributes: attributes)
         default:
             break
         }

Example/Pods/Target Support Files/SwiftEntryKit/Info.plist

@@ -0,0 +1,27 @@
+//
+//  ExampleViewController.swift
+//  SwiftEntryKitDemo
+//
+//  Created by Daniel Huri on 6/8/18.
+//  Copyright © 2018 CocoaPods. All rights reserved.
+//
+
+import UIKit
+
+class ExampleViewController: UIViewController {
+
+    private let injectedView: UIView
+    
+    init(with view: UIView) {
+        injectedView = view
+        super.init(nibName: nil, bundle: nil)
+    }
+    
+    required init?(coder aDecoder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+    
+    override func loadView() {
+        view = injectedView
+    }
+}

Example/SwiftEntryKit.xcodeproj/project.pbxproj

@@ -127,7 +127,7 @@ source 'https://github.com/cocoapods/specs.git'
 platform :ios, '9.0'
 use_frameworks!
 
-pod 'SwiftEntryKit', '0.3.3'
+pod 'SwiftEntryKit', '0.4.0'
 ```
 
 Then, run the following command:
@@ -150,7 +150,7 @@ $ brew install carthage
 To integrate SwiftEntryKit into your Xcode project using Carthage, specify the following in your `Cartfile`:
 
 ```ogdl
-github "huri000/SwiftEntryKit" == 0.3.3
+github "huri000/SwiftEntryKit" == 0.4.0
 ```
 
 ## Usage
@@ -553,6 +553,13 @@ let customView = UIView()
 SwiftEntryKit.display(entry: customView, using: attributes)
 ```
 
+### Displaying a View Controller
+As from version 0.4.0, view controllers are supported as well.
+
+```Swift
+SwiftEntryKit.display(entry: customViewController, using: attributes)
+```
+
 ### Dismissing an Entry
 You can dismiss an entry by simply invoke *dismiss* in the SwiftEntryKit class, likewise:
 ```Swift

Example/SwiftEntryKit/Presets/PresetsData/PresetsDataSource.swift

@@ -0,0 +1,27 @@
+//
+//  EKExecution.swift
+//  SwiftEntryKit
+//
+//  Created by Daniel Huri on 6/8/18.
+//  Copyright (c) 2018 [email protected]. All rights reserved.
+//
+
+import Foundation
+
+extension SwiftEntryKit {
+    
+    /**
+     Executes a UI action on the main thread, thus letting any of the class methods of SwiftEntryKit to be invokes even from a background thread.
+     */
+    static func execute(action: @escaping () -> ()) {
+        if Thread.isMainThread {
+            action()
+        } else {
+            DispatchQueue.main.async {
+                action()
+            }
+        }
+    }
+}
+
+

Example/SwiftEntryKit/Presets/PresetsViewController.swift

@@ -58,10 +58,12 @@ class EKContentView: UIView {
     private var keyboardState = KeyboardState.hidden
 
     // Data source
-    private var attributes: EKAttributes!
+    private var attributes: EKAttributes {
+        return contentView.attributes
+    }
 
     // Content
-    private var contentView: UIView!
+    private var contentView: EKEntryView!
 
     // MARK: Setup
     required init?(coder aDecoder: NSCoder) {
@@ -74,9 +76,8 @@ class EKContentView: UIView {
     }
 
     // Called from outer scope with a presentable view and attributes
-    func setup(with contentView: UIView, attributes: EKAttributes) {
+    func setup(with contentView: EKEntryView) {
 
-        self.attributes = attributes
         self.contentView = contentView
 
         // Setup attributes
@@ -444,15 +445,16 @@ class EKContentView: UIView {
 
     // Remove self from superview
     func removeFromSuperview(keepWindow: Bool) {
-        guard let _ = superview else {
+        guard superview != nil else {
             return
         }
         super.removeFromSuperview()
+        contentView.content.viewController?.removeFromParentViewController()
         if EKAttributes.count > 0 {
             EKAttributes.count -= 1
         }
         if !keepWindow && !EKAttributes.isDisplaying {
-            EKWindowProvider.shared.state = .main
+            EKWindowProvider.shared.displayMainWindow()
         }
     }