Pull request #7: Added log message to result

Merge in ADGUARD-IOS/safari-converter from feature/result-log to master

* commit '36ba7a486b512591aef0255325235f1fabdb16d6':
  added log message to result

Author: Mizzick

Sources/ContentBlockerConverter/Compiler/CompilationResult.swift

@@ -14,6 +14,11 @@ struct CompilationResult {
      */
     var errorsCount = 0;
 
+    /**
+     * Log message
+     */
+    var message = "";
+    
     // Elemhide rules (##) - wide generic rules
     var cssBlockingWide: [BlockerEntry] = [];
     // Elemhide rules (##) - generic domain sensitive

Sources/ContentBlockerConverter/ContentBlockerConverter.swift

@@ -30,7 +30,9 @@ public class ContentBlockerConverter {
 
             compilationResult.errorsCount = errorsCounter.getCount();
 
-            addLogMessage(compilationResult: compilationResult);
+            let message = createLogMessage(compilationResult: compilationResult);
+            Logger.log("AG: ContentBlockerConverter: " + message);
+            compilationResult.message = message;
 
             return try Distributor(limit: limit, advancedBlocking: advancedBlocking).createConversionResult(data: compilationResult);
         } catch {
@@ -40,7 +42,7 @@ public class ContentBlockerConverter {
         return nil;
     }
 
-    private func addLogMessage(compilationResult: CompilationResult) -> Void {
+    private func createLogMessage(compilationResult: CompilationResult) -> String {
         var message = "Rules converted:  \(compilationResult.rulesCount) (\(compilationResult.errorsCount) errors)";
         message += "\nBasic rules: \(String(describing: compilationResult.urlBlocking.count))";
         message += "\nBasic important rules: \(String(describing: compilationResult.important.count))";
@@ -59,6 +61,6 @@ public class ContentBlockerConverter {
         message += "\nExceptions (jsinject): \(String(describing: compilationResult.scriptJsInjectExceptions.count))";
         message += "\nExceptions (other): \(String(describing: compilationResult.other.count))";
 
-        Logger.log("AG: ContentBlockerConverter: " + message);
+        return message;
     }
 }

Sources/ContentBlockerConverter/ConversionResult.swift

@@ -39,7 +39,12 @@ public struct ConversionResult: Encodable {
      */
     public var advancedBlocking: String? = nil;
 
-    init(entries: [BlockerEntry], advBlockingEntries: [BlockerEntry] = [], limit: Int, errorsCount: Int) throws {
+    /**
+     * Result message
+     */
+    public var message: String;
+    
+    init(entries: [BlockerEntry], advBlockingEntries: [BlockerEntry] = [], limit: Int, errorsCount: Int, message: String) throws {
         self.totalConvertedCount = entries.count;
 
         self.overLimit = (limit > 0 && entries.count > limit);
@@ -59,6 +64,8 @@ public struct ConversionResult: Encodable {
             self.advancedBlockingConvertedCount = advBlockingEntries.count;
             self.advancedBlocking = try ConversionResult.createJSONString(entries: advBlockingEntries);
         }
+        
+        self.message = message;
     }
 
     private static func createJSONString(entries: [BlockerEntry]) throws -> String {

Sources/ContentBlockerConverter/Distributor.swift

@@ -51,8 +51,13 @@ class Distributor {
 
         let errorsCount = data.errorsCount;
 
-        return try ConversionResult(entries: entries, advBlockingEntries: advBlockingEntries, limit: self.limit, errorsCount: errorsCount);
-
+        return try ConversionResult(
+            entries: entries,
+            advBlockingEntries: advBlockingEntries,
+            limit: self.limit,
+            errorsCount: errorsCount,
+            message: data.message
+        );
     }
 
     /**

Tests/ContentBlockerConverterTests/ConversionResultTests.swift

@@ -42,7 +42,7 @@ final class ConversionResultTests: XCTestCase {
 
     func testEmpty() {
 
-        let result = try! ConversionResult(entries: [], limit: 0, errorsCount: 0);
+        let result = try! ConversionResult(entries: [], limit: 0, errorsCount: 0, message: "");
 
         XCTAssertEqual(result.totalConvertedCount, 0);
         XCTAssertEqual(result.convertedCount, 0);
@@ -57,12 +57,13 @@ final class ConversionResultTests: XCTestCase {
             BlockerEntry(trigger: testTrigger, action: testAction)
         ];
 
-        let result = try! ConversionResult(entries: entries, limit: 0, errorsCount: 0);
+        let result = try! ConversionResult(entries: entries, limit: 0, errorsCount: 0, message: "test");
 
         XCTAssertEqual(result.totalConvertedCount, 1);
         XCTAssertEqual(result.convertedCount, 1);
         XCTAssertEqual(result.errorsCount, 0);
         XCTAssertEqual(result.overLimit, false);
+        XCTAssertEqual(result.message, "test");
         XCTAssertEqual(result.converted, correctEntryJSON);
     }
 
@@ -73,12 +74,13 @@ final class ConversionResultTests: XCTestCase {
             BlockerEntry(trigger: testTrigger, action: testAction)
         ];
 
-        let result = try! ConversionResult(entries: entries, limit: 1, errorsCount: 0);
+        let result = try! ConversionResult(entries: entries, limit: 1, errorsCount: 0, message: "test");
 
         XCTAssertEqual(result.totalConvertedCount, 2);
         XCTAssertEqual(result.convertedCount, 1);
         XCTAssertEqual(result.errorsCount, 1);
         XCTAssertEqual(result.overLimit, true);
+        XCTAssertEqual(result.message, "test");
         XCTAssertEqual(result.converted, correctEntryJSON);
     }
 
@@ -88,12 +90,13 @@ final class ConversionResultTests: XCTestCase {
             BlockerEntry(trigger: testTrigger, action: testAction)
         ];
 
-        let result = try! ConversionResult(entries: entries, advBlockingEntries: entries, limit: 1, errorsCount: 0);
+        let result = try! ConversionResult(entries: entries, advBlockingEntries: entries, limit: 1, errorsCount: 0, message: "test");
 
         XCTAssertEqual(result.totalConvertedCount, 1);
         XCTAssertEqual(result.convertedCount, 1);
         XCTAssertEqual(result.errorsCount, 0);
         XCTAssertEqual(result.overLimit, false);
+        XCTAssertEqual(result.message, "test");
         XCTAssertEqual(result.converted, correctEntryJSON);
         XCTAssertEqual(result.advancedBlockingConvertedCount, 1);
         XCTAssertEqual(result.advancedBlocking, correctEntryJSON);