Merge pull request #137 from WideSpectrumComputing/RCLJ-module

New SDK module for integration with CocoaLumberjack logging library
rollbar · Apr 19, 2022 · d1250c8 · d1250c8
2 parents eeed750 + 6d7be23
commit d1250c8
Show file tree

Hide file tree

Showing 67 changed files with 1,606 additions and 416 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ The change log has moved to this repo's [GitHub Releases Page](https://github.co
 
 ## Release Notes Tagging Conventions
 
-1.  Every entry within the PackageReleaseNotes element is expected to be started with
+1. Every entry within the PackageReleaseNotes element is expected to be started with
     at least one of the tags listed:
 
     feat:     A new feature
@@ -16,81 +16,112 @@ The change log has moved to this repo's [GitHub Releases Page](https://github.co
     test:     Adding or modifying unit test code
     chore:    Changes to the build process or auxiliary tools and libraries such as documentation generation, etc.
 
-2.  Every entry within the PackageReleaseNotes element is expected to be tagged with 
-    EITHER 
+2. Every entry within the PackageReleaseNotes element is expected to be tagged with
+    EITHER
     "resolve #GITHUB_ISSUE_NUMBER:" - meaning completely addresses the GitHub issue
-    OR 
+    OR
     "ref #GITHUB_ISSUE_NUMBER:" - meaning relevant to the GitHub issue
     depending on what is more appropriate in each case.
 
 ## Release Notes
 
-**2.0.3
-- docs: resolve #122 - Update RollbarCommon public API doc comments so they are properly rendered by Xcode Quick Help
-- docs: resolve #124 - Update RollbarDeploys public API doc comments so they are properly rendered by Xcode Quick Help
-- docs: resolve #126 - Update RollbarSwift, RollbarAUL, RollbarPLCrashReporter, and RollbarKSCrash public API doc comments so they are properly rendered by Xcode Quick Help
-- docs: resolve #127 - Update RollbarNotifier public API doc comments so they are properly rendered by Xcode Quick Help
+### 2.1.0
+
+- feat:  resolve #141 - Apply developer options of the persisted payload when sending the payload 
+- feat:  resolve #133 - Implement RollbarCocoaLumberjack module
+- test:  resolve #134 - Implement unit tests for RollbarCocoaLumberjack
+- fix:   resolve #136 - RollbarPLCrashReporter.init() no longer available
+- test:  resolve #140 - Factor out common SDK unit testing API
+- chore: resolve #112 - Upgrade to the latest PLCrashReporter 1.0.1
+- docs:  resolve #138 - Move current SDK documentation from readme.io to the repo
+- docs:  resolve #139 - Document new RollbarCocoaLumberjack module
+
+### 2.0.3
+
+- docs:  resolve #122 - Update RollbarCommon public API doc comments so they are properly rendered by Xcode Quick Help
+- docs:  resolve #124 - Update RollbarDeploys public API doc comments so they are properly rendered by Xcode Quick Help
+- docs:  resolve #126 - Update RollbarSwift, RollbarAUL, RollbarPLCrashReporter, and RollbarKSCrash public API doc comments so they are properly rendered by Xcode Quick Help
+- docs:  resolve #127 - Update RollbarNotifier public API doc comments so they are properly rendered by Xcode Quick Help
 - chore: resolve #114 - Consolidate destination parameters for samples
 - chore: resolve #113 - Consolidate destination parameters for unit tests
 
-**2.0.2
+### 2.0.2
+
 - fix: resolve #110 - Xcode autocomplete for Swift expects person.id, but codebase expects person.ID
 - chore: resolve #118 - Remove source file header comments from RollbarCommon
 
-**2.0.1
+### 2.0.1
+
 - moving from Beta to GA
 
-**2.0.0-beta.23**
+### 2.0.0-beta.23
+
 - refactor: upgraded KSCRash to v1.15.25
 - refactor: upgraded PLCrashReporter to v1.10.0
 - chore: updated macosAppObjC Xcode scheme
 - chore: update SonarCloud build wrapper
 - chore: update SonarCloud scanner
 
-**2.0.0-beta.22**
-**2.0.0-beta.21**
+### 2.0.0-beta.22
+
+### 2.0.0-beta.21
+
 - feat: new RollbarAUL module is code complete
 
-**2.0.0-beta.15**
+### 2.0.0-beta.15
+
 - fix: resolve #81 - SPM - Resolving Package Graph Failed
 
-**2.0.0-beta.14**
+### 2.0.0-beta.14
+
 - feat: allocated new RollbarAUL module project
-- fix: resolve #72 - Rollbar* pods 2.0.0-beta.10 not all published
+- fix: resolve #72 - Rollbar pods 2.0.0-beta.10 not all published
+
+### 2.0.0-beta.13
 
-**2.0.0-beta.13**
-**2.0.0-beta.12**
-**2.0.0-beta.11**
-- fix: resolve #72 - Rollbar* pods 2.0.0-beta.10 not all published
+### 2.0.0-beta.12
+
+### 2.0.0-beta.11
+
+- fix: resolve #72 - Rollbar pods 2.0.0-beta.10 not all published
+
+### 2.0.0-beta.10
 
-**2.0.0-beta.10**
 - fix: resolve #66 - App terminated due to signal 5 instantiating RollbarPLCrashCollector
 
-**2.0.0-beta8**
+### 2.0.0-beta8
+
 - fix: point all the Cocoapods podspecs to proper documentation site.
 
-**2.0.0-beta7**
-**2.0.0-beta6**
-**2.0.0-beta5**
-**2.0.0-beta4**
+### 2.0.0-beta7
+
+### 2.0.0-beta6
+
+### 2.0.0-beta5
+
+### 2.0.0-beta4
+
 - fix: RollbarSwift.podspec
 
-**2.0.0-beta3**
+### 2.0.0-beta3
+
 - feat: added RollbarSwift
 
-**2.0.0-beta2**
+### 2.0.0-beta2
+
 - feat: added new developer option: suppressSdkInfoLogging
 
-**2.0.0-beta1** - comparing to Rollbar-iOS
+### 2.0.0-beta1 - comparing to Rollbar-iOS
+
 - feat: added RollbarPLCrashReporter module
 - feat: added RollbarKSCrash module
-- feat: added explicit reporting of NSErrors 
+- feat: added explicit reporting of NSErrors
 - feat: defined default scrub fields
 - refactor: split out RollbarCommon, RollbarNotifier, RollbarDeploys
 - refactor: added use of lightweight generics
 - refactor: added use of nullability attributes
 - refactor: removed RollbarConfiguration and replaced it with RollbarConfig
 - refactor: changed WhitelistFields into SafeListFields when it comes to the RollbarScrubbingOptions
-- refactor: removed all the deprecated API 
+- refactor: removed all the deprecated API
 - refactor: replaced NSString-like log level parameters in RollbarLogger interface with RollbarLevel enum
 - refactor: replaced sync-all log methods of Rollbar and RolbarLogger with ones dedicated to each type of payload: string-message, NSException, NSError, etc.
diff --git a/Package.swift b/Package.swift
@@ -35,6 +35,9 @@ let package = Package(
         .library(
             name: "RollbarSwift",
             targets: ["RollbarSwift"]),
+        .library(
+            name: "RollbarCocoaLumberjack",
+            targets: ["RollbarCocoaLumberjack"]),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -45,15 +48,20 @@ let package = Package(
         ),
         .package(name:"PLCrashReporter",
                  url: "https://github.com/microsoft/plcrashreporter.git",
-                 from: "1.10.0" //Package.Dependency.Requirement.branch("master")
+                 from: "1.10.1" //Package.Dependency.Requirement.branch("master")
         ),
+        .package(name:"CocoaLumberjack",
+                 url: "https://github.com/CocoaLumberjack/CocoaLumberjack.git",
+                 from: "3.7.4" //Package.Dependency.Requirement.branch("master")
+                ),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .target(
             name: "RollbarCommon",
-            dependencies: [],
+            dependencies: [
+            ],
             path: "RollbarCommon/Sources/RollbarCommon",
             publicHeadersPath: "include",
             cSettings: [
@@ -63,7 +71,9 @@ let package = Package(
 
         .target(
             name: "RollbarDeploys",
-            dependencies: ["RollbarCommon",],
+            dependencies: [
+                "RollbarCommon",
+            ],
             path: "RollbarDeploys/Sources/RollbarDeploys",
             publicHeadersPath: "include",
             cSettings: [
@@ -73,7 +83,9 @@ let package = Package(
 
          .target(
              name: "RollbarNotifier",
-             dependencies: ["RollbarCommon",],
+             dependencies: [
+                "RollbarCommon",
+             ],
              path: "RollbarNotifier/Sources/RollbarNotifier",
              publicHeadersPath: "include",
              cSettings: [
@@ -83,7 +95,10 @@ let package = Package(
 
         .target(
             name: "RollbarKSCrash",
-            dependencies: ["RollbarCommon", "KSCrash"],
+            dependencies: [
+                "RollbarCommon",
+                "KSCrash",
+            ],
             path: "RollbarKSCrash/Sources/RollbarKSCrash",
             publicHeadersPath: "include",
             cSettings: [
@@ -93,7 +108,10 @@ let package = Package(
 
         .target(
             name: "RollbarPLCrashReporter",
-            dependencies: ["RollbarCommon", .product(name: "CrashReporter", package: "PLCrashReporter")],
+            dependencies: [
+                "RollbarCommon",
+                .product(name: "CrashReporter", package: "PLCrashReporter"),
+            ],
             path: "RollbarPLCrashReporter/Sources/RollbarPLCrashReporter",
             publicHeadersPath: "include",
             cSettings: [
@@ -103,7 +121,10 @@ let package = Package(
 
         .target(
             name: "RollbarAUL",
-            dependencies: ["RollbarCommon", "RollbarNotifier"],
+            dependencies: [
+                "RollbarCommon",
+                "RollbarNotifier",
+            ],
             path: "RollbarAUL/Sources/RollbarAUL",
             publicHeadersPath: "include",
             cSettings: [
@@ -113,14 +134,31 @@ let package = Package(
 
         .target(
             name: "RollbarSwift",
-            dependencies: ["RollbarCommon", "RollbarNotifier"],
+            dependencies: [
+                "RollbarCommon",
+                "RollbarNotifier",
+            ],
             path: "RollbarSwift/Sources/RollbarSwift",
             publicHeadersPath: "include",
             cSettings: [
                 .headerSearchPath("RollbarSwift/Sources/RollbarSwift/**"),
             ]
         ),
 
+        .target(
+            name: "RollbarCocoaLumberjack",
+            dependencies: [
+                "RollbarCommon",
+                "RollbarNotifier",
+                "CocoaLumberjack",
+            ],
+            path: "RollbarCocoaLumberjack/Sources/RollbarCocoaLumberjack",
+            publicHeadersPath: "include",
+            cSettings: [
+                .headerSearchPath("RollbarCocoaLumberjack/Sources/RollbarCocoaLumberjack/**"),
+            ]
+        ),
+
     ],
     swiftLanguageVersions: [
         SwiftVersion.v4,

diff --git a/README.md b/README.md
@@ -83,4 +83,9 @@ See our [Releases](https://github.com/rollbar/rollbar-apple/releases) page for a
 
 ## Help / Support
 
-If you run into any problems, please email us at `[email protected]` or [file a bug report](https://github.com/rollbar/rollbar-apple/issues/new).
+- [Gitter Community](https://gitter.im/rollbar/SDK-Apple)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/rollbar)
+- [GitHub Issues](https://github.com/rollbar/rollbar-apple/issues)
+- [GitHub Discussions](https://github.com/rollbar/rollbar-apple/discussions)
+- [File a bug report](https://github.com/rollbar/rollbar-apple/issues/new)
+- Rollbar Support: `[email protected]`
diff --git a/RollbarAUL.podspec b/RollbarAUL.podspec
@@ -7,7 +7,7 @@
 
 Pod::Spec.new do |s|
 
-    s.version      = "2.0.3"
+    s.version      = "2.1.0"
     s.name         = "RollbarAUL"
     s.summary      = "Application or client side SDK for interacting with the Rollbar API Server."
     s.description  = <<-DESC

diff --git a/RollbarAUL/Package.swift b/RollbarAUL/Package.swift
@@ -23,9 +23,7 @@ let package = Package(
         // .package(url: /* package url */, from: "1.0.0"),
         .package(path: "../RollbarCommon"),
         .package(path: "../RollbarNotifier"),
-        .package(name: "UnitTesting",
-                 path: "../UnitTesting"
-                ),
+        .package(path: "../UnitTesting"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -36,8 +34,6 @@ let package = Package(
             publicHeadersPath: "include",
             cSettings: [
                 .headerSearchPath("Sources/RollbarAUL/**"),
-//                .headerSearchPath("Sources/RollbarAUL"),
-//                .headerSearchPath("Sources/RollbarAUL/include"),
 //                .headerSearchPath("Sources/RollbarAUL/DTOs"),
 
 //                .define("DEFINES_MODULE"),
@@ -52,11 +48,12 @@ let package = Package(
         ),
         .testTarget(
             name: "RollbarAULTests-ObjC",
-            dependencies: ["RollbarAUL"],
+            dependencies: [
+                "UnitTesting",
+                "RollbarAUL"
+            ],
             cSettings: [
                 .headerSearchPath("Tests/RollbarAULTests-ObjC/**"),
-//                .headerSearchPath("Sources/RollbarNotifier"),
-//                .headerSearchPath("Sources/RollbarNotifier/include"),
 //                .headerSearchPath("Sources/RollbarNotifier/DTOs"),
 
 //                .define("DEFINES_MODULE"),

diff --git a/RollbarAUL/Tests/RollbarAULTests-ObjC/RollbarAulStoreMonitorTest.m b/RollbarAUL/Tests/RollbarAULTests-ObjC/RollbarAulStoreMonitorTest.m
@@ -15,8 +15,8 @@
 
 #if !TARGET_OS_WATCH
 #import <XCTest/XCTest.h>
-#import "../../../UnitTests/RollbarUnitTestSettings.h"
 
+@import UnitTesting;
 @import RollbarNotifier;
 @import RollbarAUL;
 

diff --git a/RollbarCocoaLumberjack/.gitignore b/RollbarCocoaLumberjack/.gitignore
@@ -0,0 +1,7 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata