Merge pull request #30 from perseusrealdeal/1.1.5

Release 1.1.5

Author: PerseusRealDeal

Package.swift

@@ -1,7 +1,7 @@
 // swift-tools-version:4.2
 
 /* Package.swift
- Version: 1.1.4
+ Version: 1.1.5
 
  Created by Mikhail Zhigulin in 7530.
 

PerseusDarkMode.podspec

@@ -1,8 +1,8 @@
 Pod::Spec.new do |p|
 
 p.name           = "PerseusDarkMode"
-p.version        = "1.1.3"
-p.summary        = "It gives an accessible variable of Dark Mode."
+p.version        = "1.1.4"
+p.summary        = "Variable for changing Dark Mode."
 p.description    = "Designed for constructing Dark Mode sensitive features."
 p.homepage       = "https://github.com/perseusrealdeal/PerseusDarkMode"
 

PerseusDarkModeSingle.swift

@@ -1,6 +1,6 @@
 //
 //  PerseusDarkModeSingle.swift
-//  Version: 1.1.4
+//  Version: 1.1.5
 //
 //  Created by Mikhail Zhigulin in 7530.
 //
@@ -196,7 +196,7 @@ public class AppearanceService {
         nCenter.post(name: .MakeAppearanceUpNotification, object: nil)
     }
 
-    internal static func recalculateStyleIfNeeded() {
+    public static func recalculateStyleIfNeeded() {
         let actualStyle = DarkModeDecision.calculate(DarkModeUserChoice, shared.systemStyle)
 
         if shared.hidden_style != actualStyle { shared.hidden_style = actualStyle }

README.md

@@ -1,18 +1,18 @@
 # Perseus Dark Mode
 
 [![Actions Status](https://github.com/perseusrealdeal/DarkMode/actions/workflows/main.yml/badge.svg)](https://github.com/perseusrealdeal/PerseusDarkMode/actions)
-![Version](https://img.shields.io/badge/Version-1.1.4-informational.svg)
-[![Pod](https://img.shields.io/badge/Pod-1.1.3-informational.svg)](/PerseusDarkMode.podspec)
+![Version](https://img.shields.io/badge/Version-1.1.5-informational.svg)
+[![Pod](https://img.shields.io/badge/Pod-1.1.4-informational.svg)](/PerseusDarkMode.podspec)
 ![Platforms](https://img.shields.io/badge/Platforms-iOS%209.3+,%20macOS%2010.9+-orange.svg)
 [![Swift 4.2](https://img.shields.io/badge/Swift-4.2-red.svg)](https://docs.swift.org/swift-book/RevisionHistory/RevisionHistory.html)
 [![License](http://img.shields.io/:License-MIT-blue.svg)](/LICENSE)
 
 ## Integration Capabilities
 
-[![Standalone File](https://img.shields.io/badge/Standalone%20File-available-informational.svg)](/PerseusDarkModeSingle.swift)
+[![Standalone](https://img.shields.io/badge/Standalone-available-informational.svg)](/PerseusDarkModeSingle.swift)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg)](https://github.com/Carthage/Carthage)
-[![CocoaPods manager](https://img.shields.io/badge/CocoaPods-compatible-4BC51D.svg)](https://cocoapods.org)
-[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-4BC51D.svg)](https://github.com/apple/swift-package-manager)
+[![CocoaPods manager](https://img.shields.io/badge/CocoaPods-compatible-4BC51D.svg)](/PerseusDarkMode.podspec)
+[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-4BC51D.svg)](/Package.swift)
 
 ## Demo Apps and Others
 
@@ -23,67 +23,80 @@
 
 # In Brief
 
-> This library lets a developer being awared of Dark Mode via a variable `DarkMode.style`. Also, with this library it is possible to change the value of Dark Mode in runtime easily.
+> This library lets a developer being awared of Dark Mode via a variable `DarkMode.style`. Also, with this library it is possible to change the value of Dark Mode in runtime easily with standalone lib [DarkModeSwitching](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706).
 
-## Reqirements
+```swift
+changeDarkModeManually(.off) // .on or .auto
+```
+Sample screen for changing Dark Mode option [here for macOS](https://github.com/perseusrealdeal/macos.darkmode.discovery) and [here for iOS](https://github.com/perseusrealdeal/ios.darkmode.discovery).
+
+# Reqirements
 
 - Xcode 10.1+
 - Swift 4.2+
 - iOS: 9.3+, UIKit SDK
 - macOS: 10.9+, AppKit SDK
 
-## Third-party software
+# First-party software
+
+- [PerseusLogger](https://gist.github.com/perseusrealdeal/df456a9825fcface44eca738056eb6d5)
+
+# Third-party software
 
 - [SwiftLint Shell Script Runner](/SucceedsPostAction.sh)
+- [SwiftLint](https://github.com/realm/SwiftLint) / [0.31.0: Busy Laundromat](https://github.com/realm/SwiftLint/releases/tag/0.31.0) for macOS High Sierra
+
+# Installation
 
-## Installation
+> ***Using "Exact" with the Version field is strongly recommended.***
 
-### Step 1: Add PerseusDarkMode to a host project tree
+## Step 1: Add PerseusDarkMode to a host project tree
 
-#### Standalone 
+### Standalone 
 
 Make a copy of the file [`PerseusDarkModeSingle.swift`](/PerseusDarkModeSingle.swift) then put it into a place required of a host project.
 
-#### CocoaPods
+### Carthage
+
+Cartfile should contain:
+
+```carthage
+github "perseusrealdeal/PerseusDarkMode" == 1.1.5
+```
+
+Some Carthage usage tips placed [here](https://gist.github.com/perseusrealdeal/8951b10f4330325df6347aaaa79d3cf2).
+
+### CocoaPods
 
 Podfile should contain:
 
 ```ruby
 target "ProjectTarget" do
   use_frameworks!
-  pod 'PerseusDarkMode', '1.1.3'
+  pod 'PerseusDarkMode', '1.1.4'
 end
 ```
-#### Carthage
 
-Cartfile should contain:
-
-```carthage
-github "perseusrealdeal/PerseusDarkMode" == 1.1.4
-```
-
-Some Carthage usage tips placed [here](https://gist.github.com/perseusrealdeal/8951b10f4330325df6347aaaa79d3cf2).
-
-#### Swift Package Manager
+### Swift Package Manager
 
 - As a package dependency so Package.swift should contain the following statements:
 
 ```swift
 dependencies: [
         .package(url: "https://github.com/perseusrealdeal/PerseusDarkMode.git",
-            .exact("1.1.4"))
+            .exact("1.1.5"))
     ],
 ```
 
 - As an Xcode project dependency: 
 
 `Project in the Navigator > Package Dependencies > Add Package Dependency`
 
-Using "Exact" with the Version field is strongly recommended.
+> ***Using "Exact" with the Version field is strongly recommended.***
 
-### Step 2: Make DarkMode ready for using
+## Step 2: Make DarkMode ready for using
 
-#### iOS
+### iOS
 
 Override the following method of the first screen to let Perseus know that system's appearance changed:
 
@@ -118,7 +131,7 @@ extension AppDelegate: UIApplicationDelegate {
 ```
 Used functions are distributed via standalone file [`DarkModeSwitching.swift`](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706).
 
-#### iOS and macOS
+### iOS and macOS
 
 Call the method `AppearanceService.makeUp()` with the app's delegate if appearance changing is going to take place:
 
@@ -142,7 +155,7 @@ extension AppDelegate: UIApplicationDelegate {
 ```
 Copy the file [`DarkModeSwitching.swift`](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706) into a host project for having fun with manual changing Dark Mode value.
 
-## Usage
+# Usage
 
 Each time if Dark Mode changed the mentioned method `#selector(makeUp)` called, but registering is required:
 ```swift
@@ -171,19 +184,21 @@ class MainViewController: UIViewController {
 }
 ```
 
-There is another way to be notified of Dark Mode—KVO. To learn have a look at [sample](https://github.com/perseusrealdeal/macos.darkmode.discovery) directly.
+There is another way to be notified of Dark Mode—KVO. 
+
+> [`DarkModeImageView`](https://github.com/perseusrealdeal/PerseusUISystemKit/blob/master/Sources/PerseusUISystemKit/Classes/DarkModeImageView.swift) class is an expressive sample of Dark Mode KVO usage for both macOS and iOS as well.
 
-## License MIT
+# License MIT
 
 Copyright © 7530 - 7531 Mikhail Zhigulin of Novosibirsk.
 
 - The year starts from the creation of the world according to a Slavic calendar.
 - September, the 1st of Slavic year.
 
-Have a look at [LICENSE](/LICENSE) for details.
+[LICENSE](/LICENSE) for details.
 
-## Author and Acknowledgments
+# Author
 
-`PerseusDarkMode` was written at Novosibirsk by Mikhail Zhigulin i.e. me, mzhigulin@gmail.com.
+> `PerseusDarkMode` was written at Novosibirsk by Mikhail Zhigulin i.e. me, mzhigulin@gmail.com.
 
 > Mostly I'd like thank my lovely parents for supporting me in all my ways.

Sources/PerseusDarkMode/AppearanceService/AppearanceService.swift

@@ -54,6 +54,7 @@ public class AppearanceService {
 
     private(set) static var it = { AppearanceService() }()
     private init() {
+        log.message("[\(type(of: self))].\(#function)")
 #if os(macOS)
         AppearanceService.distributedNCenter.addObserver(
             self,
@@ -206,7 +207,7 @@ public class AppearanceService {
     }
 
     /// Updates the app's appearance style value.
-    internal static func recalculateStyleIfNeeded() {
+    public static func recalculateStyleIfNeeded() {
         let actualStyle = DarkModeDecision.calculate(DarkModeUserChoice, shared.systemStyle)
 
         if shared.hidden_style != actualStyle { shared.hidden_style = actualStyle }

Sources/PerseusDarkMode/PerseusLogger.swift

@@ -0,0 +1,113 @@
+//
+//  PerseusLogger.swift
+//  PerseusRealDeal
+//
+//  Created by Mikhail Zhigulin in 7531.
+//
+//  Copyright © 7531 Mikhail Zhigulin of Novosibirsk.
+//  Copyright © 7531 PerseusRealDeal.
+//  All rights reserved.
+//
+//
+//  MIT License
+//
+//  Copyright © 7531 Mikhail Zhigulin of Novosibirsk
+//  Copyright © 7531 PerseusRealDeal
+//
+//  The year starts from the creation of the world according to a Slavic calendar.
+//  September, the 1st of Slavic year.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notices and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+// DESC: USE LOGGER LIKE A VARIABLE ANYWHERE YOU WANT
+//
+// By default logger is turned on in DEBUG, but it's off in RELEASE.
+//
+// log.message("[\(type(of: self))].\(#function)")
+//
+
+/* To disable debug messaging of the module use the following statements in the start point.
+
+ import class OpenWeatherFreeClient.PerseusLogger
+ typealias FreeClientLogger = OpenWeatherFreeClient.PerseusLogger
+
+ FreeClientLogger.turned = .off
+
+ */
+
+import Foundation
+
+// swiftlint:disable type_name
+typealias log = PerseusLogger
+// swiftlint:enable type_name
+
+public class PerseusLogger {
+
+    public enum Status {
+        case on
+        case off
+    }
+
+    public enum Level: Int, CustomStringConvertible {
+
+        public var description: String {
+            switch self {
+            case .info:
+                return "INFO"
+            case .debug:
+                return "DEBUG"
+            case .error:
+                return "ERROR"
+            }
+        }
+
+        case info  = 3
+        case debug = 2 // Default.
+        case error = 1
+    }
+
+    #if DEBUG
+    public static var turned = Status.on
+    #else
+    public static var turned = Status.off
+    #endif
+
+    public static var level = Level.debug
+    public static var short = true
+
+    public static func message(_ text: @autoclosure () -> String,
+                               _ type: Level = .debug,
+                               _ file: StaticString = #file,
+                               _ line: UInt = #line) {
+
+        guard turned == .on, type.rawValue <= level.rawValue else { return }
+
+        var message = ""
+
+        if short {
+            message = "\(type): \(text())"
+        } else {
+            let fileName = (file.description as NSString).lastPathComponent
+            message = "\(type): \(text()), file: \(fileName), line: \(line)"
+        }
+
+        print(message) // DispatchQueue.main.async { print(message) }
+    }
+}