Merge pull request #81 from prolificinteractive/release/3.0.0

Chore - Update documentation and bump the version to 3.0.0
prolificinteractive · Jan 11, 2019 · 1172ccd · 1172ccd
2 parents fa8aa69 + a81da5b
commit 1172ccd
Show file tree

Hide file tree

Showing 19 changed files with 53 additions and 37 deletions.
diff --git a/Example/Podfile.lock b/Example/Podfile.lock
@@ -1,7 +1,7 @@
 PODS:
   - Instabug (5.2.4)
-  - Yoshi/Core (3.0.0-beta.2)
-  - Yoshi/QAKit (3.0.0-beta.2):
+  - Yoshi/Core (3.0.0)
+  - Yoshi/QAKit (3.0.0):
     - Yoshi/Core
 
 DEPENDENCIES:
@@ -18,7 +18,7 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Instabug: 6fa40a5e2a4620f0589dfc8e4e01b1018c8c42b1
-  Yoshi: 1e0f101768c6f2d0cc289f64b065f54bc732d60a
+  Yoshi: f681e9474a3d0aa8ec7ec935c579f52c2d00a360
 
 PODFILE CHECKSUM: 6937f5f3704e17fb013434d20f6bd261b2e48f51
 

diff --git a/Example/YoshiExample.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/Example/YoshiExample.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>
diff --git a/Example/YoshiExample/Custom Menus/CustomUIMenu/CustomUIMenu.swift b/Example/YoshiExample/Custom Menus/CustomUIMenu/CustomUIMenu.swift
@@ -9,7 +9,7 @@
 import Yoshi
 
 /// A menu with custom UI.
-internal struct CustomUIMenu: YoshiGenericMenu {
+struct CustomUIMenu: YoshiGenericMenu {
 
     var cellSource: YoshiReusableCellDataSource {
         return CustomMenuCellDataSource()
@@ -21,7 +21,7 @@ internal struct CustomUIMenu: YoshiGenericMenu {
 }
 
 /// UI data source for CustomUIMenu that uses a custom xib file.
-internal final class CustomMenuCellDataSource: YoshiReusableCellDataSource {
+final class CustomMenuCellDataSource: YoshiReusableCellDataSource {
 
     static var nib: UINib? {
         return UINib(nibName: "CustomCell", bundle: nil)
@@ -38,7 +38,7 @@ internal final class CustomMenuCellDataSource: YoshiReusableCellDataSource {
 }
 
 /// A custom UITableViewCell.
-internal final class CustomCell: UITableViewCell {
+final class CustomCell: UITableViewCell {
 
     /// Label outlet from storyboard
     @IBOutlet weak var label: UILabel!

diff --git a/Example/YoshiExample/Custom Menus/DateSelectorMenu.swift b/Example/YoshiExample/Custom Menus/DateSelectorMenu.swift
@@ -9,7 +9,7 @@
 import Yoshi
 
 /// A date selector menu item to be displayed in Yoshi.
-internal final class DateSelectorMenu: YoshiDateSelectorMenu {
+final class DateSelectorMenu: YoshiDateSelectorMenu {
 
     var title: String
     var subtitle: String?

diff --git a/Example/YoshiExample/Cutstom Class/YoshiBaseEnvironment.swift b/Example/YoshiExample/Cutstom Class/YoshiBaseEnvironment.swift
@@ -9,7 +9,7 @@
 import Yoshi
 
 /// Default basic implementation of YoshiEnvironment protocol.
-internal enum YoshiBaseEnvironment: String, YoshiEnvironment, Codable {
+enum YoshiBaseEnvironment: String, YoshiEnvironment, Codable {
 
     case qa, production
 

diff --git a/Example/YoshiExample/ViewController.swift b/Example/YoshiExample/ViewController.swift
@@ -8,7 +8,7 @@
 
 import UIKit
 
-internal final class ViewController: UIViewController {
+final class ViewController: UIViewController {
 
     @IBOutlet private weak var environment: UILabel! {
         didSet {

diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ Yoshi is a convenient wrapper around the UI code that is often needed for displa
 Yoshi is available through [CocoaPods](http://cocoapods.org). To install
 it, simply add the following line to your `Podfile`:
 
-###### Swift 4.0
+###### Swift 4.2
 
 ```ruby
 pod 'Yoshi'
@@ -122,17 +122,17 @@ Yoshi will take care of managing selections and call back the convenient closure
 To present a date selector menu, create a type that conforms to `YoshiDateSelectorMenu` protocol
 
 ```swift
-internal final class DateSelector: YoshiDateSelectorMenu {
+final class DateSelectorMenu: YoshiDateSelectorMenu {
 
     var title: String
     var subtitle: String?
-    var selectedDate: NSDate
-    var didUpdateDate: (dateSelected: NSDate) -> ()
+    var selectedDate: Date
+    var didUpdateDate: (dateSelected: Date) -> ()
 
     init(title: String,
          subtitle: String? = nil,
-         selectedDate: NSDate = NSDate(),
-         didUpdateDate: (NSDate) -> ()) {
+         selectedDate: Date = Date(),
+         didUpdateDate: (Date) -> ()) {
         self.title = title
         self.subtitle = subtitle
         self.selectedDate = selectedDate
@@ -143,7 +143,7 @@ internal final class DateSelector: YoshiDateSelectorMenu {
 ```
 
 ```swift
-let dateSelectorMenu = DateSelector(title: "Environment Date",
+let dateSelectorMenu = DateSelectorMenu(title: "Environment Date",
     subtitle: nil,
     didUpdateDate: { (dateSelected) in
       // Do something with the selected date here
@@ -156,18 +156,18 @@ If you find your debug menu getting out of hand, you can organize it into submen
 
 
 ```swift
-internal final class Submenu: YoshiSubmenu {
-    
+final class Submenu: YoshiSubmenu {
+
     let title: String
-    
+
     let subtitle: String?
-    
+
     let options: [YoshiGenericMenu] {
-    
+
 }
 ```
 
-```swift 
+```swift
 let integrationsSubmenu = Submenu(title: "Third Party Integrations",
     subtitle: nil,
     options: [
@@ -269,7 +269,7 @@ private final class CustomMenuCellDataSource: YoshiResuableCellDataSource {
 Then, provide the menu that conforms to `YoshiGenericMenu` referencing to the data source.
 
 ```swift
-internal struct MenuWithCustomUI: YoshiGenericMenu {
+struct MenuWithCustomUI: YoshiGenericMenu {
 
     var cellSource: YoshiResuableCellDataSource {
         return CustomMenuCellDataSource()

diff --git a/Yoshi.podspec b/Yoshi.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = "Yoshi"
-  s.version          = "3.0.0-beta.2"
+  s.version          = "3.0.0"
   s.summary          = "A helpful companion for your iOS app."
 
 # This description is used to generate tags and improve search results.
@@ -23,7 +23,7 @@ Pod::Spec.new do |s|
   s.homepage         = "https://github.com/prolificinteractive/Yoshi"
   s.screenshots     = "https://raw.githubusercontent.com/prolificinteractive/Yoshi/a6e85e87cbd67f2bb3bfe60157e7b13281d80f20/Images/Yoshi.png", "https://raw.githubusercontent.com/prolificinteractive/Yoshi/c66cdf8dc2ab643fe57996d20d3cd37b8b70ceff/Images/Yoshi_iPad.png"
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
-  s.author           = { "Michael Campbell" => "Michael@prolificinteractive.com" , "Quentin Ribierre" => "quentin@prolificinteractive.com" , "Kanglei Fang" => "kanglei@prolificinteractive.com" }
+  s.author           = { "Michael Campbell" => "Michael@prolificinteractive.com" , "Luna An" => "luna@prolificinteractive.com"}
   s.source           = { :git => "https://github.com/prolificinteractive/Yoshi.git", :tag => s.version.to_s }
 
   s.platform     = :ios, '8.0'
@@ -50,5 +50,5 @@ Pod::Spec.new do |s|
       sp.dependency "Yoshi/Core"
     end
   end
-  
+
 end
diff --git a/Yoshi/QAKit/EnvironmentMenu/YoshiEnvironment.swift b/Yoshi/QAKit/EnvironmentMenu/YoshiEnvironment.swift
@@ -8,7 +8,7 @@
 
 import Foundation
 
-internal func == (left: YoshiEnvironment, right: YoshiEnvironment) -> Bool {
+func == (left: YoshiEnvironment, right: YoshiEnvironment) -> Bool {
     return left.baseURL == right.baseURL
 }
 

diff --git a/Yoshi/QAKit/EnvironmentMenu/YoshiPersistentEnvironment.swift b/Yoshi/QAKit/EnvironmentMenu/YoshiPersistentEnvironment.swift
@@ -9,7 +9,7 @@
 import Foundation
 
 /// An class container used to help enum YoshiEnvironment encoding since enum encoding is not supported.
-internal class YoshiPersistentEnvironment<T: YoshiEnvironment & Codable>: Codable {
+class YoshiPersistentEnvironment<T: YoshiEnvironment & Codable>: Codable {
 
     /// Persisted Environment.
     private(set) var persistedEnvironment: T

diff --git a/Yoshi/Yoshi.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/Yoshi/Yoshi.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>
diff --git a/Yoshi/Yoshi/Menus/YoshiDateSelectorMenu/YoshiDateSelectorMenuCellDataSource.swift b/Yoshi/Yoshi/Menus/YoshiDateSelectorMenu/YoshiDateSelectorMenuCellDataSource.swift
@@ -7,7 +7,7 @@
 //
 
 /// Cell data source defining the layout for YoshiDateSelectorMenu's cell
-internal struct YoshiDateSelectorMenuCellDataSource: YoshiReusableCellDataSource {
+struct YoshiDateSelectorMenuCellDataSource: YoshiReusableCellDataSource {
 
     private let title: String
 

diff --git a/Yoshi/Yoshi/Menus/YoshiSingleSelectionMenu/YoshiSingleSelectionMenuItem.swift b/Yoshi/Yoshi/Menus/YoshiSingleSelectionMenu/YoshiSingleSelectionMenuItem.swift
@@ -7,7 +7,7 @@
 //
 
 /// Internal YoshiGenericMenu used for single selection menu.
-internal final class YoshiSingleSelectionMenuItem: YoshiGenericMenu {
+final class YoshiSingleSelectionMenuItem: YoshiGenericMenu {
 
     var title: String {
         return selection.title

diff --git a/Yoshi/Yoshi/Menus/YoshiTableViewMenu/YoshiTableViewSubmenuItem.swift b/Yoshi/Yoshi/Menus/YoshiTableViewMenu/YoshiTableViewSubmenuItem.swift
@@ -8,7 +8,7 @@
 
 /// Internal struct that map the YoshiTableViewMenuItem to a YoshiGenericMenu.
 /// This menu is interannly used to support YoshiTableViewMenu.
-internal struct YoshiTableViewSubmenuItem: YoshiGenericMenu {
+struct YoshiTableViewSubmenuItem: YoshiGenericMenu {
 
     let name: String
     let subtitle: String?

diff --git a/Yoshi/Yoshi/Utility/AppBundleUtility.swift b/Yoshi/Yoshi/Utility/AppBundleUtility.swift
@@ -7,7 +7,7 @@
 //
 
 /// Utility for retrieving items from the App Bundle
-internal class AppBundleUtility: NSObject {
+class AppBundleUtility: NSObject {
 
     /**
      The application version + build number text.

diff --git a/Yoshi/Yoshi/Utility/Color.swift b/Yoshi/Yoshi/Utility/Color.swift
@@ -9,7 +9,7 @@
 /**
  A color object
  */
-internal struct Color {
+struct Color {
 
     /// The red value.
     let red: UInt8

diff --git a/...hi/View Controllers/Debug Date Picker View Controller/DebugDatePickerViewController.swift b/...hi/View Controllers/Debug Date Picker View Controller/DebugDatePickerViewController.swift
@@ -7,7 +7,7 @@
 //
 
 /// The date picker view controller.
-internal class DebugDatePickerViewController: UIViewController {
+class DebugDatePickerViewController: UIViewController {
 
     private var selectorMenu: YoshiDateSelectorMenu?
 

diff --git a/Yoshi/Yoshi/View Controllers/Debug View Controller/DebugViewController.swift b/Yoshi/Yoshi/View Controllers/Debug View Controller/DebugViewController.swift
@@ -6,10 +6,10 @@
 //  Copyright © 2016 Prolific Interactive. All rights reserved.
 //
 
-internal typealias VoidCompletionBlock = () -> Void
+typealias VoidCompletionBlock = () -> Void
 
 /// A debug menu.
-internal final class DebugViewController: UIViewController {
+final class DebugViewController: UIViewController {
 
     var completionHandler: ((_ completed: VoidCompletionBlock? ) -> Void)?
 

diff --git a/Yoshi/Yoshi/YoshiConfigurationManager.swift b/Yoshi/Yoshi/YoshiConfigurationManager.swift
@@ -7,7 +7,7 @@
 //
 
 /// The configuration manager for the debug menu.
-internal final class YoshiConfigurationManager {
+final class YoshiConfigurationManager {
 
     /// The default instance.
     static let sharedInstance = YoshiConfigurationManager()