Merge branch 'master' into patch-2

Author: nrbrook

Artwork/linked-frameworks.png

@@ -1,53 +1,42 @@
-#### Installing with Cocoapods
+## Installing with Cocoapods
 
 SimulatorStatusMagic is available through [CocoaPods](http://cocoapods.org). To install, simply add the following line to your Podfile:
 
 ```ruby
 pod 'SimulatorStatusMagic', :configurations => ['Debug']
 ```
 
-#### Installing with Carthage
+## Installing with Carthage
 
-SimlatorStatusMagic is also available through [Carthage](https://github.com/Carthage/Carthage). Carthage will not make any modifications to your project, so installation is more involved than with CocoaPods. To get started, ensure that you have installed Carthage and then create a Cartfile with the following content:
+SimlatorStatusMagic is also available through [Carthage](https://github.com/Carthage/Carthage). Carthage will not make any modifications to your project, so installation is more involved than with CocoaPods. This describes a way of adding `SimulatorStatusMagic` so that it is only imported for `DEBUG` build configurations.
 
-```ruby
-github "shinydevelopment/SimulatorStatusMagic"
-```
-
-Next bootstrap your environment by executing carthage update:
-
-```sh
-$ carthage update
+1. Add `SimulatorStatusMagic` to your `Cartfile`:
 ```
-
-Next drag SimulatorStatusMagiciOS.framework from Carthage/Build/iOS and onto your project and link it with your application target. Then select your application target within Xcode, navigate to the Build Phases panel and click the + icon and select New Run Script Phase. Set the content to:
-
-```sh
-/usr/local/bin/carthage copy-frameworks
+github "shinydevelopment/SimulatorStatusMagic"
 ```
+2. Run `carthage update SimulatorStatusMagic --platform iOS`
+3. Add the framework file directly from `Carthage/Build/iOS/` to `Linked Frameworks and Libraries`, **NOT** Embedded Libraries. Ensure that the file is reference at this location so that future `carthage update` builds will be embedded correctly.
 
-In the Input Files section add:
-
-- `$(SRCROOT)/Carthage/Build/iOS/SimulatorStatusMagiciOS.framework`
+![Linked Frameworks and Libraries](Artwork/linked-frameworks.png)
 
-Now build your application target and everything should be set.
+4. Add the `embed-debug-only-framework.sh` script found [here](https://gist.github.com/kenthumphries/cf04683184217c7331f9c213c556c65a) and discussed [here](https://github.com/shinydevelopment/SimulatorStatusMagic/blob/master/INSTALLATION.md).
 
-#### Installing without a dependency manager
+![Embed run script phase](Artwork/run-script-phase.png)
 
-SimulatorStatusMagic can also be included as a dynamic framework by following steps:
+5. Add code referencing `SimulatorStatusMagiciOS` inside `#if canImport ... #endif` blocks in your `AppDelegate`:
+```swift
+#if DEBUG
+  import SimulatorStatusMagiciOS
+#endif
 
-* Download the source code and open the XCode project
-* Run the target `SimulatorStatusMagicUniversalFramework` which generates a universal framework for both device and simulator.
-* Drag and drop the generated framework into your project.
-
-Note that SimulatorStatusMagic calls non-public APIs and should not be submitted to the app store. If you wish to add SimulatorStatusMagic for Debug configuration only, follow these steps:
-
-* Ensure that SimulatorStatusMagiciOS.framework is within your project folder, but not added to any project target
-* In app target Build Settings, expand the Framework Search Paths and add the framework's containing folder in the Debug configuration. For example, `$(SRCROOT)/ThirdPartyFrameworks/`
-* Now you should be able to import and compile with SimulatorStatusMagiciOS, but app will crash with error:
-`dyld: Library not loaded: @rpath/SimulatorStatusMagiciOS.framework/SimulatorStatusMagiciOS`
-* To solve this, open app target's Build Phases and click the + icon then select New Run Script Phase
-* Configure Run Script phase to embed SimulatorStatusMagiciOS.framework only when Debug configuration is used
- * Use the script `embed-debug-only-framework.sh` that is [available here](https://gist.github.com/kenthumphries/cf04683184217c7331f9c213c556c65a)
+@UIApplicationMain
+final class AppDelegate: UIResponder, UIApplicationDelegate {
+  func application(_ application: UIApplication, didFinishLaunchingWithOptions options: [UIApplication.LaunchOptionsKey: Any]? ) -> Bool {
+    #if DEBUG
+      SDStatusBarManager.sharedInstance()?.enableOverrides()
+    #endif
+  }
+}
+```
 
-Now that SimilatorStatusMagic is added only for Debug configuration, you must ensure that any imports or calls to SDStatusBarManager are made between `#if DEBUG` and `#endif`.
+6. Run your app in `DEBUG` to see the status bar changes in effect.

Artwork/run-script-phase.png

@@ -1,17 +1,11 @@
-# :boom: Important Note on iOS 12 Compatibility :boom:
-
-The latest version is mostly working with iOS 12 thanks to [@cysp](https://github.com/cysp)'s kind pull request, however the new date status bar functionality on the iPad is not yet supported. It is being discussed in [#68](https://github.com/shinydevelopment/SimulatorStatusMagic/issues/68) and [#72](https://github.com/shinydevelopment/SimulatorStatusMagic/issues/72), and of course pull requests with support for this are very welcome.
-
----
-
 ## Simulator Status Magic
 
 Modify the iOS Simulator so that it has a perfect status bar, then run your app and take perfect screenshots every time. The modifications made are designed to match the images you see on the Apple site and are as follows:
 
 * 9:41 AM is displayed for the time.
 * The battery is full and shows 100%.
-* On iPhone: The carrier text is removed, 5 bars of cellular signal and full WiFi bars are displayed.
-* On iPad: The carrier text is set to "iPad" and full WiFi bars are displayed.
+* 5 bars of cellular signal and full WiFi bars are displayed.
+* Tue Jan 9 is displayed for the date (iPad only)
 
 ### How do I use it?
 
@@ -27,9 +21,9 @@ Run the app again and click "Restore Default Status Bar". Resetting the iOS Simu
 
 ### I have a script to take my screenshots, can I automate this?
 
-Yes! SimulatorStatusMagic is available via [CocoaPods](http://cocoapods.org), [Carthage](https://github.com/Carthage/Carthage) and as a standalone source release. [Installation instructions](https://github.com/shinydevelopment/SimulatorStatusMagic/blob/master/INSTALLATION.md) are available for each method.
+Yes! SimulatorStatusMagic is available via [CocoaPods](http://cocoapods.org), [Carthage](https://github.com/Carthage/Carthage) and as a standalone source release. [Installation instructions](https://github.com/shinydevelopment/SimulatorStatusMagic/blob/master/INSTALLATION.md) are available.
 
-It is recommended to only include `SDStatusBarManager` in your debug configuration so that the code is never included in release builds. Then, when you want to apply a perfect status bar, call `[[SDStatusBarManager sharedInstance] enableOverrides]`. To restore the standard status bar, call `[[SDStatusBarManager sharedInstance] disableOverrides]`.
+It is recommended to **only** include `SDStatusBarManager` in your debug configuration so that the code is **never** included in release builds. When you want to apply a perfect status bar, call `[[SDStatusBarManager sharedInstance] enableOverrides]`. To restore the standard status bar, call `[[SDStatusBarManager sharedInstance] disableOverrides]`.
 
 ### What about automation of the sample app?
 

INSTALLATION.md

@@ -45,6 +45,7 @@ typedef NS_ENUM(NSInteger, SDStatusBarManagerNetworkType)
 
 @property (copy, nonatomic) NSString *carrierName;
 @property (copy, nonatomic) NSString *timeString;
+@property (copy, nonatomic) NSString *dateString;
 @property (assign, nonatomic, readonly) BOOL usingOverrides;
 @property (assign, nonatomic) SDStatusBarManagerBluetoothState bluetoothState;
 @property (assign, nonatomic) SDStatusBarManagerNetworkType networkType;

README.md

@@ -38,6 +38,7 @@
 static NSString * const SDStatusBarManagerNetworkTypeKey = @"network_type";
 static NSString * const SDStatusBarManagerCarrierNameKey = @"carrier_name";
 static NSString * const SDStatusBarManagerTimeStringKey = @"time_string";
+static NSString * const SDStatusBarManagerDateStringKey = @"date_string";
 
 @interface SDStatusBarManager ()
 
@@ -54,7 +55,7 @@ - (instancetype)init
   if (self) {
     // Set any defaults for the status bar
     self.batteryDetailEnabled = YES;
-    self.iPadDateEnabled = NO;
+    self.iPadDateEnabled = YES;
     self.iPadGsmSignalEnabled = NO;
   }
   return self;
@@ -65,6 +66,7 @@ - (void)enableOverrides
   self.usingOverrides = YES;
 
   self.overrider.timeString = [self localizedTimeString];
+  self.overrider.dateString = [self localizedDateString];
   self.overrider.carrierName = self.carrierName;
   self.overrider.bluetoothEnabled = self.bluetoothState != SDStatusBarManagerBluetoothHidden;
   self.overrider.bluetoothConnected = self.bluetoothState == SDStatusBarManagerBluetoothVisibleConnected;
@@ -158,6 +160,21 @@ - (NSString *)timeString
   return [self.userDefaults valueForKey:SDStatusBarManagerTimeStringKey];
 }
 
+- (void)setDateString:(NSString *)dateString {
+  if ([self.dateString isEqualToString:dateString]) return;
+  
+  [self.userDefaults setObject:dateString forKey:SDStatusBarManagerDateStringKey];
+  
+  if (self.usingOverrides) {
+    [self enableOverrides];
+  }
+}
+
+- (NSString *)dateString
+{
+  return [self.userDefaults valueForKey:SDStatusBarManagerDateStringKey];
+}
+
 - (NSUserDefaults *)userDefaults
 {
   if (!_userDefaults) {
@@ -217,6 +234,23 @@ - (NSString *)localizedTimeString
   return [formatter stringFromDate:[[NSCalendar currentCalendar] dateFromComponents:components]];
 }
 
+- (NSString *)localizedDateString
+{
+  if (self.dateString.length > 0) {
+    return self.dateString;
+  }
+  
+  NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
+  formatter.dateFormat = [[NSDateFormatter dateFormatFromTemplate:@"EEE MMM d" options:0 locale:NSLocale.currentLocale] stringByReplacingOccurrencesOfString:@"," withString:@""];
+  
+  NSDateComponents *components = [[NSCalendar currentCalendar] components:  NSCalendarUnitHour | NSCalendarUnitMinute | NSCalendarUnitSecond fromDate:[NSDate date]];
+  components.day = 9;
+  components.month = 1;
+  components.year = 2007;
+  
+  return [formatter stringFromDate:[[NSCalendar currentCalendar] dateFromComponents:components]];
+}
+
 #pragma mark Singleton instance
 + (SDStatusBarManager *)sharedInstance
 {

SDStatusBarManager/SDStatusBarManager.h

@@ -29,6 +29,7 @@
 @protocol SDStatusBarOverrider <NSObject>
 
 @property (copy, nonatomic) NSString *timeString;
+@property (copy, nonatomic) NSString *dateString;
 @property (copy, nonatomic) NSString* carrierName;
 
 @property (assign, nonatomic) BOOL bluetoothEnabled;

SDStatusBarManager/SDStatusBarManager.m

@@ -169,6 +169,7 @@ + (StatusBarOverrideData *)getStatusBarOverrideData;
 @implementation SDStatusBarOverriderPost10_0
 
 @synthesize timeString;
+@synthesize dateString;
 @synthesize carrierName;
 @synthesize bluetoothConnected;
 @synthesize bluetoothEnabled;

SDStatusBarManager/SDStatusBarOverrider.h

@@ -147,6 +147,7 @@ + (StatusBarOverrideData *)getStatusBarOverrideData;
 @implementation SDStatusBarOverriderPost10_3
 
 @synthesize timeString;
+@synthesize dateString;
 @synthesize carrierName;
 @synthesize bluetoothConnected;
 @synthesize bluetoothEnabled;

SDStatusBarManager/SDStatusBarOverriderPost10_0.m

@@ -150,6 +150,7 @@ + (StatusBarOverrideData *)getStatusBarOverrideData;
 @implementation SDStatusBarOverriderPost11_0
 
 @synthesize timeString;
+@synthesize dateString;
 @synthesize carrierName;
 @synthesize bluetoothConnected;
 @synthesize bluetoothEnabled;