Merge pull request #19 from sgr-ksmt/update_podspec

Author: sgr-ksmt

.jazzy.yaml

@@ -63,4 +63,7 @@ custom_categories:
       - ConfigDecodableBridge
       - ConfigCodableBridge
       - ConfigArrayBridge
-      - ConfigRawRepresentableArrayBridge
+      - ConfigRawRepresentableArrayBridge
+  - name: Combine Extension
+    children:
+      - ConbineLobster

Demo/Demo.xcodeproj/project.pbxproj

@@ -19,7 +19,7 @@
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
-		162860D41FAA4852003D85A6 /* Demo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Demo.app; sourceTree = BUILT_PRODUCTS_DIR; };
+		162860D41FAA4852003D85A6 /* Lobster Demo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "Lobster Demo.app"; sourceTree = BUILT_PRODUCTS_DIR; };
 		162860D71FAA4852003D85A6 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
 		162860D91FAA4852003D85A6 /* ViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = "<group>"; };
 		162860DC1FAA4852003D85A6 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
@@ -59,7 +59,7 @@
 		162860D51FAA4852003D85A6 /* Products */ = {
 			isa = PBXGroup;
 			children = (
-				162860D41FAA4852003D85A6 /* Demo.app */,
+				162860D41FAA4852003D85A6 /* Lobster Demo.app */,
 			);
 			name = Products;
 			sourceTree = "<group>";
@@ -116,7 +116,7 @@
 			);
 			name = Demo;
 			productName = Demo;
-			productReference = 162860D41FAA4852003D85A6 /* Demo.app */;
+			productReference = 162860D41FAA4852003D85A6 /* Lobster Demo.app */;
 			productType = "com.apple.product-type.application";
 		};
 /* End PBXNativeTarget section */
@@ -361,7 +361,7 @@
 				INFOPLIST_FILE = Demo/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = demo.lobster;
-				PRODUCT_NAME = "$(TARGET_NAME)";
+				PRODUCT_NAME = "Lobster Demo";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -376,7 +376,7 @@
 				INFOPLIST_FILE = Demo/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = demo.lobster;
-				PRODUCT_NAME = "$(TARGET_NAME)";
+				PRODUCT_NAME = "Lobster Demo";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};

Demo/Podfile.lock

@@ -35,8 +35,11 @@ PODS:
   - "GoogleUtilities/NSData+zlib (6.7.1)"
   - GoogleUtilities/UserDefaults (6.7.1):
     - GoogleUtilities/Logger
-  - Lobster (2.2):
-    - Firebase/RemoteConfig (~> 6.0)
+  - Lobster (3.0.0):
+    - Firebase/RemoteConfig (~> 6.29)
+    - Lobster/Core (= 3.0.0)
+  - Lobster/Core (3.0.0):
+    - Firebase/RemoteConfig (~> 6.29)
   - nanopb (1.30905.0):
     - nanopb/decode (= 1.30905.0)
     - nanopb/encode (= 1.30905.0)
@@ -48,7 +51,7 @@ DEPENDENCIES:
   - Lobster (from `../`)
 
 SPEC REPOS:
-  https://cdn.cocoapods.org/:
+  trunk:
     - Firebase
     - FirebaseABTesting
     - FirebaseCore
@@ -73,10 +76,10 @@ SPEC CHECKSUMS:
   FirebaseRemoteConfig: 521ff38593bed36fcb6f466fb6fffa99a753d783
   GoogleDataTransport: af0c79193dc59acd37630b4833d0dc6912ae6bd5
   GoogleUtilities: e121a3867449ce16b0e35ddf1797ea7a389ffdf2
-  Lobster: b7c48cf6ff48e80f269715ce80cdc3e087c7b501
+  Lobster: 07e4f45919483efa3b5d68ba74f424dd462a5de7
   nanopb: c43f40fadfe79e8b8db116583945847910cbabc9
   PromisesObjC: b48e0338dbbac2207e611750777895f7a5811b75
 
 PODFILE CHECKSUM: c6efd56fba58da5968399c93e6f38bb7f1692d81
 
-COCOAPODS: 1.9.1
+COCOAPODS: 1.9.3

Demo/README.md

@@ -1,9 +1,14 @@
-## Demo
+# Lobster example app with Swift
+
+## Setup
 
 ```bash
 $ cd path/to/Lobster
 $ make
 $ cd ./Demo
 $ bundle exec pod install
 $ open Demo.xcworkspace
-```
+```
+
+You need to place `GoogleService-Info.plist` into `Lobster/Demo/Demo`.  
+Also, You have to set bundle identifiher `demo.lobster`.

Lobster.podspec

@@ -5,16 +5,27 @@ Pod::Spec.new do |spec|
   spec.summary          = 'The Type-safe Firebase-RemoteConfig helper library'
   spec.homepage         = 'https://github.com/sgr-ksmt/Lobster'
   spec.license          = { :type => 'MIT', :file => 'LICENSE' }
-
   spec.source           = { :git => 'https://github.com/sgr-ksmt/Lobster.git', :tag => spec.version.to_s }
 
   spec.ios.deployment_target = '11.0'
-
   spec.swift_versions    = ['4.2', '5.0']
 
   spec.requires_arc     = true
   spec.static_framework = true
-  spec.source_files     = 'Sources/**/*'
 
   spec.dependency 'Firebase/RemoteConfig', '~> 6.29'
+
+  spec.default_subspecs = 'Core'
+
+  spec.subspec 'Core' do |subspec|
+    subspec.source_files = 'Sources/Core/**/*.swift'
+  end
+
+  spec.subspec 'Combine' do |subspec|
+    subspec.dependency 'Lobster/Core'
+    subspec.source_files = 'Sources/Combine/**/*.swift'
+
+    subspec.ios.deployment_target = '13.0'
+    subspec.ios.frameworks = 'Combine'
+  end
 end

Makefile

@@ -10,4 +10,7 @@ pod-install:
 	bundle exec pod install || bundle exec pod install --repo-update
 
 gen-docs:
-	bundle exec jazzy --config .jazzy.yaml
+	bundle exec jazzy --config .jazzy.yaml
+
+pod-lib-lint:
+	bundle exec pod lib lint --allow-warnings

README.md

@@ -1,4 +1,5 @@
 # Lobster
+
 Type-safe Firebase-RemoteConfig helper library.
 
 
@@ -9,19 +10,23 @@ Type-safe Firebase-RemoteConfig helper library.
 [![CocoaPods](https://img.shields.io/badge/Cocoa%20Pods-compatible-4BC51D.svg?style=for-the-badge)](https://cocoapods.org/pods/Lobster)
 
 ## Feature
+
 - Can get a value from RemoteConfig / set a value to RemoteConfig to type-safe.
 - Easy to set default value to RemoteConfig by using key-value subscripting.
 - Custom type available ✨
   - `String`/`Int` enum
   - `Decodable`(read-only) and `Codable`.
 - Can manage expiration duration of config values.
+- Combine framwork support.
 
 ---
 
 ## Getting Started
 
 - [API Documentation](https://sgr-ksmt.github.io/Lobster/index.html)
-- [Example Apps](https://github.com/sgr-ksmt/Lobster/tree/master/Demo)
+- Example Apps
+  - [Swift Demo](https://github.com/sgr-ksmt/Lobster/tree/master/Demo)
+  - [SwiftUI + Combine Demo](https://github.com/sgr-ksmt/Lobster/tree/master/SwiftUI-Demo)
 
 ## Basic Usage
 
@@ -63,20 +68,38 @@ Lobster.shared.fetch { _ in
 }
 ```
 
-
 ## Tips for you
 
-### Fetch latest value from remote.
+### Combine
+
+You can get values from Lobster with Combine's stream.  
+Here is a sampl viewmodel class.
 
 ```swift
-Lobster.shared.fetch { [weak self] error in
-    if let error = error {
-        print(error)
+import Lobster
+import Combine
+
+extension ConfigKeys {
+    static let title = ConfigKey<String>("title")
+}
+
+final class ViewModel: ObservableObject {
+    @Published var title: String
+    private var cancellables: Set<AnyCancellable> = []
+
+    init() {
+        title = Lobster.shared[.titleText]
+
+        Lobster.shared.combine.fetched(.title)
+            .receive(on: RunLoop.main)
+            .assign(to: \.title, on: self)
+            .store(in: &cancellables)
     }
-    self?.titleLabel.text = Lobster.shared[.titleText]
 }
 ```
 
+NOTE: You need to install `Lobster/Combine` before using it.
+
 ### Get value with subscripting syntax.
 
 Use subscripting syntax.
@@ -333,6 +356,9 @@ it, simply add the following line to your Podfile:
 
 ```ruby
 pod 'Lobster', '~> 3.0.0'
+
+# If you want to use extensions of Combine, please install below:
+pod 'Lobster/Combine'
 ```
 
 and run `pod install`

Sources/Combine/Lobster+Combine.swift

@@ -4,14 +4,16 @@
 import Foundation
 import Combine
 
+/// CombineLobster is a extension class with Combine.
+///
+/// It allows you handle Lobster with Combine
 @available(iOS 13.0, *)
 public struct CombineLobster {
     fileprivate let lobster: Lobster
 }
 
 @available(iOS 13.0, *)
-public extension CombineLobster {
-
+extension CombineLobster {
     class Subscription<S: Subscriber> {
         var subscriber: S?
         var cancellable: AnyCancellable?
@@ -38,7 +40,7 @@ public extension CombineLobster {
         }
     }
 
-    final class ConfigValueSubscription<S: Subscriber, T: ConfigSerializable>: Subscription<S>, Combine.Subscription where S.Input == T.Value, S.Failure == Error {
+    final class ConfigValueSubscription<S: Subscriber, T: ConfigSerializable>: Subscription<S>, Combine.Subscription where S.Input == T.Value, S.Failure == Never {
         private let key: ConfigKey<T>
         init(subscriber: S, lobster: Lobster, key: ConfigKey<T>) {
             self.key = key
@@ -58,7 +60,7 @@ public extension CombineLobster {
 
     struct ConfigValuePublisher<T: ConfigSerializable>: Combine.Publisher {
         public typealias Output = T.Value
-        public typealias Failure = Error
+        public typealias Failure = Never
 
         private let lobster: Lobster
         private let key: ConfigKey<T>
@@ -77,7 +79,7 @@ public extension CombineLobster {
         }
     }
 
-    final class ConfigValueOptionalSubscription<S: Subscriber, T: ConfigSerializable>: Subscription<S>, Combine.Subscription where S.Input == T.Value?, S.Failure == Error {
+    final class ConfigValueOptionalSubscription<S: Subscriber, T: ConfigSerializable>: Subscription<S>, Combine.Subscription where S.Input == T.Value?, S.Failure == Never {
         private let key: ConfigKey<T?>
         init(subscriber: S, lobster: Lobster, key: ConfigKey<T?>) {
             self.key = key
@@ -97,7 +99,7 @@ public extension CombineLobster {
 
     struct ConfigValueOptionalPublisher<T: ConfigSerializable>: Combine.Publisher {
         public typealias Output = T.Value?
-        public typealias Failure = Error
+        public typealias Failure = Never
 
         private let lobster: Lobster
         private let key: ConfigKey<T?>
@@ -118,15 +120,21 @@ public extension CombineLobster {
 
 }
 
+/// Extensions for Lobster
 @available(iOS 13.0, *)
 public extension Lobster {
+    /// Returns `CombineLobster`.
     var combine: CombineLobster {
         CombineLobster(lobster: self)
     }
 }
 
+/// Extensions for CombineLobster
 @available(iOS 13.0, *)
 public extension CombineLobster {
+    /// Returns Publisher that tells you that Lobster has fetched latest valeus from RemoteConfig.
+    ///
+    /// - Returns: A publisher `<Void, Error>`
     func fetched() -> AnyPublisher<Void, Error> {
         return NotificationCenter.default.publisher(for: Lobster.didFetchConfig)
             .tryMap { (notification) in
@@ -138,12 +146,18 @@ public extension CombineLobster {
             .eraseToAnyPublisher()
     }
 
-    func fetched<T: ConfigSerializable>(_ key: ConfigKey<T>) -> AnyPublisher<T.Value, Error> {
+    /// Returns Publisher that gives you a value matched a config key after fetching from RemoteConfig.
+    ///
+    /// - Returns: A publisher `<T.Value, Error>`
+    func fetched<T: ConfigSerializable>(_ key: ConfigKey<T>) -> AnyPublisher<T.Value, Never> {
         return ConfigValuePublisher(lobster: lobster, key: key)
             .eraseToAnyPublisher()
     }
 
-    func fetched<T: ConfigSerializable>(_ key: ConfigKey<T?>) -> AnyPublisher<T.Value?, Error> {
+    /// Returns Publisher that gives you an optional value matched a config key after fetching from RemoteConfig.
+    ///
+    /// - Returns: A publisher `<T.Value?, Error>`
+    func fetched<T: ConfigSerializable>(_ key: ConfigKey<T?>) -> AnyPublisher<T.Value?, Never> {
         return ConfigValueOptionalPublisher(lobster: lobster, key: key)
             .eraseToAnyPublisher()
     }

Sources/Core/Extensions/UIColor+Ex.swift

@@ -6,9 +6,9 @@ import UIKit
 extension String {
     var hexColor: UIColor {
         let hex = trimmingCharacters(in: CharacterSet.alphanumerics.inverted)
-        var int = UInt32()
-        Scanner(string: hex).scanHexInt32(&int)
-        let a, r, g, b: UInt32
+        var int = UInt64()
+        Scanner(string: hex).scanHexInt64(&int)
+        let a, r, g, b: UInt64
         switch hex.count {
         case 3:
             (r, g, b, a) = ((int >> 8) * 17, (int >> 4 & 0xF) * 17, (int & 0xF) * 17, 255)

SwiftUI-Demo/Podfile

@@ -0,0 +1,9 @@
+platform :ios, '13.0'
+
+inhibit_all_warnings!
+use_frameworks!
+
+target 'SwiftUI-Demo' do
+  pod 'Lobster', :path => '../'
+  pod 'Lobster/Combine', :path => '../'
+end