Merge pull request #3 from PGSSoft/release-new-version

Release new version
PGSSoft · Oct 21, 2018 · 2efa371 · 2efa371
2 parents b82096b + 083f0c7
commit 2efa371
Show file tree

Hide file tree

Showing 42 changed files with 1,183 additions and 443 deletions.
diff --git a/AutoMate-AppBuddy.podspec b/AutoMate-AppBuddy.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "AutoMate-AppBuddy"
-  s.version      = "1.3.0"
+  s.version      = "1.4.0"
   s.summary      = "Helper framework for writing UI automation tests with AutoMate."
   s.homepage     = "https://github.com/PGSSoft/AutoMate-AppBuddy"
   s.license      = { :type => 'MIT', :file => 'LICENSE' }

diff --git a/AutoMate-AppBuddy.xcodeproj/project.pbxproj b/AutoMate-AppBuddy.xcodeproj/project.pbxproj
@@ -505,7 +505,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 1.3.0;
+				CURRENT_PROJECT_VERSION = 1.4.0;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -569,7 +569,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
-				CURRENT_PROJECT_VERSION = 1.3.0;
+				CURRENT_PROJECT_VERSION = 1.4.0;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_NS_ASSERTIONS = NO;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;

diff --git a/AutoMate-AppBuddy/ContactsInterface.swift b/AutoMate-AppBuddy/ContactsInterface.swift
@@ -14,6 +14,9 @@ import Contacts
 /// - seealso: `ContactsInterface`
 /// - seealso: `ContactsHandler`
 public protocol ContactsInterfaceProtocol {
+    /// This closure passes information about a complete asynchronous task.
+    ///
+    /// Depending on the outcome the error may be available, and the success flag changes its value.
     typealias CompletionBlock = (Bool, Error?) -> Void
 
     /// Adds all contacts to the `CNContactStore`.

diff --git a/AutoMate-AppBuddy/EventKitHandler.swift b/AutoMate-AppBuddy/EventKitHandler.swift
@@ -155,6 +155,7 @@ public class EventKitHandler<E: EventParser, R: ReminderParser, I: EventKitInter
 }
 
 // MARK: - Default Event Kit Handler
+/// Type of default `EventKitHandler` with all the generic types filled using implementations in the framework.
 public typealias DefaultEventKitHander = EventKitHandler<EventDictionaryParser, ReminderDictionaryParser, EventKitInterface>
 
 /// Default `EventKitHandler` with default `EventParser`, `ReminderParser` and `EventKitInterfaceProtocol`.

diff --git a/AutoMate-AppBuddy/EventKitInterface.swift b/AutoMate-AppBuddy/EventKitInterface.swift
@@ -14,6 +14,9 @@ import EventKit
 /// - seealso: `EventKitInterface`
 /// - seealso: `EventKitHandler`
 public protocol EventKitInterfaceProtocol {
+    /// This closure passes information about a complete asynchronous task.
+    ///
+    /// Depending on the outcome the error may be available, and the success flag changes its value.
     typealias CompletionBlock = (Bool, Error?) -> Void
 
     /// Adds all calendar items to the `EKEventStore`.

diff --git a/AutoMate-AppBuddy/Info.plist b/AutoMate-AppBuddy/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.3.0</string>
+	<string>1.4.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

diff --git a/AutoMate-AppBuddy/LaunchEnvironmentManager.swift b/AutoMate-AppBuddy/LaunchEnvironmentManager.swift
@@ -87,4 +87,5 @@ public protocol Handler {
 }
 
 // MARK: - Launch Option Key
+/// A type used to represent keys of launch options.
 public typealias LaunchOptionKey = String
diff --git a/AutoMate-AppBuddy/Parser.swift b/AutoMate-AppBuddy/Parser.swift
@@ -27,7 +27,13 @@ public struct ParserError: ErrorWithMessage {
 public protocol Parser {
 
     // MARK: Associatedtypes
+    /// A source type that the parser works with.
+    ///
+    /// A parser takes an instance of type `T` and returns an instance of type `U`.
     associatedtype T
+    /// A result type that the parser works with.
+    ///
+    /// A parser takes an instance of type `T` and returns an instance of type `U`.
     associatedtype U
 
     // MARK: Methods

diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.4.0](https://github.com/PGSSoft/AutoMate-AppBuddy/releases/tag/1.4.0)
+Released on 2018-10-21.
+
+#### Updated
+- Compatibility with Xcode 10, Swift 4.2 and iOS 12
+
 ## [1.3.0](https://github.com/PGSSoft/AutoMate-AppBuddy/releases/tag/1.3.0)
 Released on 2018-01-11.
 

diff --git a/docs/Classes/ContactsInterface.html b/docs/Classes/ContactsInterface.html
@@ -97,13 +97,13 @@
             <a href="../Other Global Variables.html">Other Global Variables</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
-                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy21defaultContactsHanderAA0F7HandlerVyAA23ContactDictionaryParserVAA0F9InterfaceCGv">defaultContactsHander</a>
+                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy21defaultContactsHanderAA0F7HandlerVyAA23ContactDictionaryParserVAA0F9InterfaceCGvp">defaultContactsHander</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy21defaultEventKitHanderAA0fG7HandlerCyAA0F16DictionaryParserVAA08ReminderjK0VAA0fG9InterfaceCGv">defaultEventKitHander</a>
+                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy21defaultEventKitHanderAA0fG7HandlerCyAA0F16DictionaryParserVAA08ReminderjK0VAA0fG9InterfaceCGvp">defaultEventKitHander</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy24defaultIsInUITestHandlerAA0fghI0Cv">defaultIsInUITestHandler</a>
+                <a href="../Other Global Variables.html#/s:17AutoMate_AppBuddy24defaultIsInUITestHandlerAA0fghI0Cvp">defaultIsInUITestHandler</a>
               </li>
             </ul>
           </li>
@@ -140,6 +140,17 @@
               </li>
             </ul>
           </li>
+          <li class="nav-group-name">
+            <a href="../Other Typealiases.html">Other Type Aliases</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="../Other Typealiases.html#/s:17AutoMate_AppBuddy21DefaultEventKitHandera">DefaultEventKitHander</a>
+              </li>
+              <li class="nav-group-task">
+                <a href="../Other Typealiases.html#/s:17AutoMate_AppBuddy15LaunchOptionKeya">LaunchOptionKey</a>
+              </li>
+            </ul>
+          </li>
         </ul>
       </nav>
       <article class="main-content">
@@ -148,7 +159,7 @@
             <h1>ContactsInterface</h1>
               <div class="declaration">
                 <div class="language">
-                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ContactsInterface</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ContactsInterfaceProtocol.html">ContactsInterfaceProtocol</a></span></code></pre>
+                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ContactsInterface</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ContactsInterfaceProtocol.html">ContactsInterfaceProtocol</a></span></code></pre>
 
                 </div>
               </div>
@@ -175,9 +186,9 @@ <h3 class="section-name">Initialization</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceCACSo14CNContactStoreC07contactH0_So0G12FetchRequestCSg05fetchK0tcfc"></a>
+                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC12contactStore12fetchRequestACSo09CNContactH0C_So0k5FetchJ0CSgtcfc"></a>
                     <a name="//apple_ref/swift/Method/init(contactStore:fetchRequest:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceCACSo14CNContactStoreC07contactH0_So0G12FetchRequestCSg05fetchK0tcfc">init(contactStore:fetchRequest:)</a>
+                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC12contactStore12fetchRequestACSo09CNContactH0C_So0k5FetchJ0CSgtcfc">init(contactStore:fetchRequest:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -248,9 +259,9 @@ <h3 class="section-name">Methods</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC6addAllySaySo16CNMutableContactCG_ySb_s5Error_pSgtc10completiontF"></a>
+                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC6addAll_10completionySaySo16CNMutableContactCG_ySb_s5Error_pSgtctF"></a>
                     <a name="//apple_ref/swift/Method/addAll(_:completion:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC6addAllySaySo16CNMutableContactCG_ySb_s5Error_pSgtc10completiontF">addAll(_:completion:)</a>
+                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC6addAll_10completionySaySo16CNMutableContactCG_ySb_s5Error_pSgtctF">addAll(_:completion:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -306,9 +317,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC9removeAllyySb_s5Error_pSgtc10completion_tF"></a>
+                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC9removeAll10completionyySb_s5Error_pSgtc_tF"></a>
                     <a name="//apple_ref/swift/Method/removeAll(completion:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC9removeAllyySb_s5Error_pSgtc10completion_tF">removeAll(completion:)</a>
+                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC9removeAll10completionyySb_s5Error_pSgtc_tF">removeAll(completion:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -352,9 +363,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC13requestAccessyySb_s5Error_pSgtc10completion_tF"></a>
+                    <a name="/s:17AutoMate_AppBuddy17ContactsInterfaceC13requestAccess10completionyySb_s5Error_pSgtc_tF"></a>
                     <a name="//apple_ref/swift/Method/requestAccess(completion:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC13requestAccessyySb_s5Error_pSgtc10completion_tF">requestAccess(completion:)</a>
+                    <a class="token" href="#/s:17AutoMate_AppBuddy17ContactsInterfaceC13requestAccess10completionyySb_s5Error_pSgtc_tF">requestAccess(completion:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -400,8 +411,8 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://github.com/PGSSoft/AutoMate-AppBuddy" target="_blank" rel="external">Joanna Bednarz and Bartosz Janda</a>. All rights reserved. (Last updated: 2018-01-11)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2018 <a class="link" href="https://github.com/PGSSoft/AutoMate-AppBuddy" target="_blank" rel="external">Joanna Bednarz and Bartosz Janda</a>. All rights reserved. (Last updated: 2018-10-21)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>
     </div>