chore: prepare 2.0.0 release (SDKCF-4382)

imaginaris · web-flow · commit cb90afe24327 · 2021-10-14T14:02:55.000+02:00
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -0,0 +1,14 @@
+clean: true
+author: Rakuten Group, Inc.
+github_url: https://github.com/rakutentech/ios-sdkutils
+module_version: 2.0.0
+module: RSDKUtils
+xcodebuild_arguments:
+  - -workspace
+  - RSDKUtils.xcworkspace
+  - -scheme
+  - Tests
+podspec: RSDKUtils.podspec
+readme: README.md
+documentation: "*.md"
+hide_documentation_coverage: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,19 @@
+# **Changelog**
+
+#### 2.0.0 (2021-10-14)
+**Breaking change:** Removed obsolete utilities, separated source files into subspecs. Minimum supported iOS version is now 11.0
+- Features:
+    - Added a lot of new utilities (including RLogger)
+    - Added SPM support
+    - Added Jazzy documentation (available at https://rakutentech.github.io/ios-sdkutils/)
+- Improvements:
+    - Divided RSDKUtils into 4 subspecs and 4 SPM products - Main, TestHelpers, Nimble and RLogger
+    - Added Bitrise CI
+
+#### 1.1.0
+
+- Add `KeyStore` class for securely storing values in the device KeyChain.
+
+#### 1.0.0
+
+- Initial release
diff --git a/Gemfile b/Gemfile
@@ -5,3 +5,4 @@ gem "xcov", ">= 1.7.3", "< 2.0.0"
 gem "danger"
 gem "danger-xcov"
 gem "xcode-install"
+gem "jazzy"
diff --git a/Podfile.lock b/Podfile.lock
@@ -1,16 +1,17 @@
 PODS:
   - Nimble (9.2.1)
   - Quick (4.0.0)
-  - RSDKUtils (1.1.0):
-    - RSDKUtils/Main (= 1.1.0)
-  - RSDKUtils/Main (1.1.0):
+  - RSDKUtils (2.0.0):
+    - RSDKUtils/Main (= 2.0.0)
+  - RSDKUtils/Main (2.0.0):
     - RSDKUtils/RLogger
-  - RSDKUtils/Nimble (1.1.0):
+  - RSDKUtils/Nimble (2.0.0):
     - Nimble
     - RSDKUtils/Main
-  - RSDKUtils/RLogger (1.1.0)
-  - RSDKUtils/TestHelpers (1.1.0):
+  - RSDKUtils/RLogger (2.0.0)
+  - RSDKUtils/TestHelpers (2.0.0):
     - RSDKUtils/Main
+  - SwiftLint (0.44.0)
 
 DEPENDENCIES:
   - Nimble
@@ -19,11 +20,13 @@ DEPENDENCIES:
   - RSDKUtils/Nimble (from `./RSDKUtils.podspec`)
   - RSDKUtils/RLogger (from `./RSDKUtils.podspec`)
   - RSDKUtils/TestHelpers (from `./RSDKUtils.podspec`)
+  - SwiftLint
 
 SPEC REPOS:
   trunk:
     - Nimble
     - Quick
+    - SwiftLint
 
 EXTERNAL SOURCES:
   RSDKUtils:
@@ -32,8 +35,9 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   Nimble: e7e615c0335ee4bf5b0d786685451e62746117d5
   Quick: 6473349e43b9271a8d43839d9ba1c442ed1b7ac4
-  RSDKUtils: 12929d76961f9c32b4d804e1c48b1ad043dc29fc
+  RSDKUtils: 0b3f04097bffc8c95912e62aa5e009f26b03a4fb
+  SwiftLint: e96c0a8c770c7ebbc4d36c55baf9096bb65c4584
 
-PODFILE CHECKSUM: 3c322fcedad25411e0795e09b339e970a4256d9a
+PODFILE CHECKSUM: a764aa703c4858c50bdac374e7ffb09622de0025
 
-COCOAPODS: 1.11.0
+COCOAPODS: 1.11.2
diff --git a/README.md b/README.md
@@ -1,18 +1,78 @@
+![Build Status](https://app.bitrise.io/app/7bb2e98294cf2d27/status.svg?token=ISfEDlJWKck83OBeX4XaEQ&branch=master)
+
+# RSDKUtils
 ## Rakuten's SDK Team internal utilities module
 
-#### Test SPM
-**WARNING:** Use RSDKUtils.xcworkspace to test this package. The following method is not available because of bug https://bugs.swift.org/browse/SR-13773
+RSDKUtils module contains useful utilities, extensions, and common classes used in SDK development.
+
+RSDKUtils consists of 4 sub-modules:
+* *Main* - Contains the most common utilities for various purposes like networking, data storage, and standard class extensions.
+* *TestHelpers* - Contains useful mocks and XCTest extensions.
+* *Nimble* - Adds additional Nimble expectations like `toAfterTimeout`.
+* *RLogger* - A tool for managing your log messages.
+
+This module supports iOS 11.0 and above. It has been tested with iOS 11.1 and above.
+
+# **How to install**
+
+## Installing with CocoaPods
+To use the module in its basic configuration your `Podfile` should contain:
+
+```ruby
+# Defined also as 'RSDKUtils/Main'
+pod 'RSDKUtils', :git => '~> 2.0'
 ```
-swift package clean
-swift test -Xswiftc "-sdk" -Xswiftc `xcrun --sdk iphonesimulator --show-sdk-path` -Xswiftc "-target" -Xswiftc "x86_64-apple-ios14.5-simulator"
+
+To use other functionalities, add their respective subspec to your `Podfile`:
+```ruby
+pod 'RSDKUtils/TestHelpers', '~> 2.0'
+pod 'RSDKUtils/Nimble', '~> 2.0'
+pod 'RSDKUtils/RLogger', '~> 2.0'
 ```
 
-### Changelog
+Run `pod install` to install the module.<br>
+More information on installing pods: [https://guides.cocoapods.org/using/getting-started.html](https://guides.cocoapods.org/using/getting-started.html)
 
-#### 1.1.0
+## Installing with Swift Package Manager
+Open your project settings in Xcode and add a new package in 'Swift Packages' tab:
+* Repository URL: `https://github.com/rakutentech/ios-sdkutils.git`
+* Version settings: branch `master` or 2.0.0 "Up to Next Major" 
 
-- Add `KeyStore` class for securely storing values in the device KeyChain.
+Choose one of the following products for your target:
+* RSDKUtilsMain
+* RSDKUtilsTestHelpers
+* RSDKUtilsNimble
+* RLogger
 
-#### 1.0.0
+# **Using the SDK**
+In order to use available utilities you need to add `import` statement in your source file:
+
+### Installed with Cocoapods
+```swift
+import RSDKUtils
+```
 
-- Initial release
+### Installed with SPM
+Depending on which product(s) you want to use, add one or more `import`:
+```swift
+import RSDKUtilsMain
+import RSDKUtilsNimble
+import RSDKUtilsTestHelpers
+import RLogger
+```
+
+# **Testing the module**
+
+You can test the module as a Swift Package and as a Cocoapod.
+
+### Test Cococapod
+Run `pod install` then open RSDKUtils.xcworkspace and run `Tests` target.
+
+### Test Swift Package
+Open `Package.swift` in Xcode, choose iOS Simulator and run `Tests` target. 
+
+⚠️ **WARNING:** Command-line testing is not available at the moment because of bug https://bugs.swift.org/browse/SR-13773
+```
+swift package clean
+swift test -Xswiftc "-sdk" -Xswiftc `xcrun --sdk iphonesimulator --show-sdk-path` -Xswiftc "-target" -Xswiftc "x86_64-apple-ios14.5-simulator"
+```
diff --git a/RSDKUtils.modulemap b/RSDKUtils.modulemap
@@ -4,3 +4,4 @@ framework module RSDKUtils {
   export *
   module * { export * }
 }
+
diff --git a/RSDKUtils.podspec b/RSDKUtils.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "RSDKUtils"
-  s.version      = "1.1.0"
+  s.version      = "2.0.0"
   s.authors      = "Rakuten Ecosystem Mobile"
   s.summary      = "Rakuten's SDK Team internal utilities module."
   s.homepage     = "https://github.com/rakutentech/ios-sdkutils"
@@ -28,27 +28,28 @@ Pod::Spec.new do |s|
   s.default_subspec = 'Main'
 
   s.subspec 'Main' do |ss|
-    ss.source_files = "Sources/RSDKUtilsMain/**/*.{swift,m,h}"
-    ss.public_header_files = "Sources/RSDKUtilsMain/*.h"
+    ss.public_header_files = 'Sources/*.h'
+    ss.source_files = 'Sources/RSDKUtilsMain/**/*.swift', 'Sources/*.h'
     ss.dependency 'RSDKUtils/RLogger'
   end
 
   s.subspec 'TestHelpers' do |ss|
-    ss.source_files = "Sources/RSDKUtilsTestHelpers/**/*.swift"
+    ss.source_files = 'Sources/RSDKUtilsTestHelpers/**/*.swift'
     ss.weak_frameworks = [
       'XCTest'
     ]
     ss.dependency 'RSDKUtils/Main'
   end
 
   s.subspec 'Nimble' do |ss|
-    ss.source_files = "Sources/RSDKUtilsNimble/**/*.swift"
+    ss.source_files = 'Sources/RSDKUtilsNimble/**/*.swift'
     ss.dependency 'Nimble'
     ss.dependency 'RSDKUtils/Main'
   end
 
   s.subspec 'RLogger' do |ss|
-    ss.source_files = "Sources/RLogger/**/*.swift"
+    ss.source_files = 'Sources/RLogger/**/*.swift', 'Sources/*.h'
+    ss.public_header_files = 'Sources/*.h'
   end
 end
 # vim:syntax=ruby:et:sts=2:sw=2:ts=2:ff=unix:
diff --git a/Sources/RSDKUtils.h b/Sources/RSDKUtils.h
diff --git a/Tests/Tests/StandardHeaderSpec.swift b/Tests/Tests/StandardHeaderSpec.swift
@@ -1,3 +1,4 @@
+import Foundation
 import Quick
 import Nimble
 #if canImport(RSDKUtils)
diff --git a/Tests/Tests/UIColorExtensionsSpec.swift b/Tests/Tests/UIColorExtensionsSpec.swift
@@ -1,5 +1,6 @@
 import Quick
 import Nimble
+import UIKit
 #if canImport(RSDKUtils)
 @testable import RSDKUtils // Cocoapods version
 #else
diff --git a/bitrise.yml b/bitrise.yml
@@ -8,6 +8,7 @@ trigger_map:
 - pull_request_source_branch: "*"
   workflow: primary
 workflows:
+
   primary:
     before_run:
     - _setup
@@ -19,9 +20,12 @@ workflows:
         - update_fastlane: 'false'
         - lane: ci
         title: Build & Test
+
   deploy:
     before_run:
     - _setup
+    after_run:
+    - _deploy_docs_worker 
     steps:
     - script@1:
         title: Lint and push Cocoapods trunk
@@ -32,6 +36,12 @@ workflows:
 
             bundle exec pod spec lint --allow-warnings
             bundle exec pod trunk push --allow-warnings --verbose
+
+  deploy_docs:
+    before_run:
+    - _setup
+    - _deploy_docs_worker
+
   _setup:
     steps:
     - git-clone@6:
@@ -58,6 +68,7 @@ workflows:
         - cache_enabled: 'yes'
         - upgrade: 'no'
         - packages: swiftlint
+        
   _report:
     steps:
     - danger@2:
@@ -86,6 +97,20 @@ workflows:
             done
 
             bash codecov -J '^RSDKUtils$' -X gcov
+
+  _deploy_docs_worker:
+    steps:
+    - brew-install@0:
+        title: Install svn
+        inputs:
+        - cache_enabled: 'yes'
+        - upgrade: 'no'
+        - packages: svn
+    - fastlane@2:
+        title: Generate and deploy Docs to Github Pages
+        inputs:
+        - update_fastlane: 'false'
+        - lane: deploy_ghpages ghpages_url:$GIT_REPOSITORY_URL github_token:$PUBLISHER_GITHUB_API_TOKEN
 app:
   envs:
   - opts:

Original file line number	Diff line number	Diff line change
`@@ -4,3 +4,4 @@ framework module RSDKUtils {`
`4`	`4`	`export *`
`5`	`5`	`module * { export * }`
`6`	`6`	`}`
	`7`	`+`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import Foundation`
`1`	`2`	`import Quick`
`2`	`3`	`import Nimble`
`3`	`4`	`#if canImport(RSDKUtils)`