Added macOS compatibility to tests (#224)

techprimate · Jul 19, 2020 · d0fc688 · d0fc688
1 parent b46be9e
commit d0fc688
Show file tree

Hide file tree

Showing 66 changed files with 896 additions and 595 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ stages:
 jobs:
   include:
   - stage: Tests
-    name: "Unit Tests"
+    name: "iOS Unit Tests"
     language: objective-c
     env:
     - TEST_FRAMEWORK_SCHEME="TPPDF-Package"
@@ -43,6 +43,25 @@ jobs:
     after_success:
     - bundle exec slather coverage -t --build-directory ${TRAVIS_BUILD_DIR}/derived_data
     - bash <(curl -s https://codecov.io/bash) -f cobertura.xml -X coveragepy -X gco
+  - stage: Tests
+    name: "macOS Unit Tests"
+    language: objective-c
+    env:
+    - TEST_FRAMEWORK_SCHEME="TPPDF-Package"
+    - PROJECT="TPPDF.xcodeproj"
+    script:
+    - set -o pipefail
+    - swift package resolve
+    - set -o pipefail
+    - xcodebuild -project ${PROJECT}
+                 -scheme ${TEST_FRAMEWORK_SCHEME}
+                 -clonedSourcePackagesDirPath .
+                 -derivedDataPath ${TRAVIS_BUILD_DIR}/derived_data
+                 -sdk macosx
+                 -destination "platform=macOS"
+                 -configuration Debug
+                 ONLY_ACTIVE_ARCH=YES
+                 test | xcpretty
 
   - stage: Examples
     name: "Example iOS - Cocoapods"

diff --git a/Example macOS/Example.xcodeproj/project.pbxproj b/Example macOS/Example.xcodeproj/project.pbxproj
@@ -266,7 +266,7 @@
 			isa = PBXProject;
 			attributes = {
 				LastSwiftUpdateCheck = 1150;
-				LastUpgradeCheck = 1150;
+				LastUpgradeCheck = 1160;
 				ORGANIZATIONNAME = "techprimate GmbH & Co. KG";
 				TargetAttributes = {
 					D48C538424A269F400D7A3DD = {
@@ -478,6 +478,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = Example/Example.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Manual;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_ASSET_PATHS = "\"Example/Preview Content\"";
@@ -502,6 +503,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = Example/Example.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Manual;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_ASSET_PATHS = "\"Example/Preview Content\"";

diff --git a/Example macOS/Example.xcodeproj/xcshareddata/xcschemes/Example.xcscheme b/Example macOS/Example.xcodeproj/xcshareddata/xcschemes/Example.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1150"
+   LastUpgradeVersion = "1160"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/Example macOS/Example/AppDelegate.swift b/Example macOS/Example/AppDelegate.swift
@@ -27,6 +27,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         window.setFrameAutosaveName("Main Window")
         window.contentView = NSHostingView(rootView: contentView)
         window.makeKeyAndOrderFront(nil)
+        window.setFrameAutosaveName("main")
     }
 
     func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool {

diff --git a/Example macOS/Example/UI/ContentView.swift b/Example macOS/Example/UI/ContentView.swift
@@ -13,7 +13,7 @@ import TPPDF
 class ContentViewModel: ObservableObject {
 
     @Published var url: URL?
-    @State var selectedFactory = Examples.factories.first?.examples.first
+    @State var selectedFactory = Examples.defaultFactory
 
 }
 
@@ -37,7 +37,7 @@ struct ContentView: View {
                    alignment: .topLeading)
             .listStyle(SidebarListStyle())
 
-            DetailView(example: viewModel.selectedFactory!)
+            DetailView(example: viewModel.selectedFactory)
                 .frame(minWidth: 0, maxWidth: .infinity,
                        minHeight: 0, maxHeight: .infinity,
                        alignment: .topLeading)

diff --git a/Shared/Examples/Examples.swift b/Shared/Examples/Examples.swift
@@ -48,5 +48,9 @@ enum Examples {
             ])
         ]
     }
+
+    static var defaultFactory: Example {
+        return factories[1].examples[0]
+    }
 }
 
diff --git a/Shared/Examples/TableExampleFactory.swift b/Shared/Examples/TableExampleFactory.swift
@@ -20,7 +20,7 @@ class TableExampleFactory: ExampleFactory {
         let document = PDFDocument(format: .a4)
 
         // Create a table
-        let table = PDFTable(rows: 10, columns: 4)
+        var table = PDFTable(rows: 10, columns: 4)
 
         // Tables can contain Strings, Numbers, Images or nil, in case you need an empty cell.
         // If you add a unknown content type, an assertion will be thrown and the rendering will stop.
@@ -85,6 +85,40 @@ class TableExampleFactory: ExampleFactory {
 
         document.add(table: table)
 
+        // Another table:
+
+        table = PDFTable(rows: 50, columns: 4)
+        table.widths = [0.1, 0.3, 0.3, 0.3]
+        table.margin = 10
+        table.padding = 10
+        table.showHeadersOnEveryPage = false
+        table.style.columnHeaderCount = 3
+
+        for row in 0..<table.size.rows {
+            table[row, 0].content = "\(row)".asTableContent
+            for column in 1..<table.size.columns {
+                table[row, column].content = "\(row),\(column)".asTableContent
+            }
+        }
+
+        for i in stride(from: 3, to: 48, by: 3) {
+            table[rows: i...(i + 2), column: 1].merge(with: PDFTableCell(content: Array(repeating: "\(i),1", count: 3).joined(separator: "\n").asTableContent,
+                                                           alignment: .center))
+        }
+        for i in stride(from: 4, to: 47, by: 3) {
+            table[rows: i...(i + 2), column: 2].merge(with: PDFTableCell(content: Array(repeating: "\(i),2", count: 3).joined(separator: "\n").asTableContent,
+                                                           alignment: .center))
+        }
+        for i in stride(from: 5, to: 48, by: 3) {
+            table[rows: i...(i + 2), column: 3].merge(with: PDFTableCell(content: Array(repeating: "\(i),3", count: 3).joined(separator: "\n").asTableContent,
+                                                           alignment: .center))
+        }
+
+        table[rows: 0..<2, column: 2].merge()
+        table[rows: 1..<3, column: 3].merge()
+
+        document.add(table: table)
+
         return [document]
     }
 }
diff --git a/Source/API/Groups/PDFGroup+Objects.swift b/Source/API/Groups/PDFGroup+Objects.swift
@@ -126,7 +126,7 @@ public extension PDFGroup {
      - parameter container: Container whose text color will be reset, defaults to `PDFGroupContainer.left`
      */
     func resetFont(_ container: PDFGroupContainer = PDFGroupContainer.left) {
-        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: Font.systemFontSize)))]
+        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: PDFConstants.defaultFontSize)))]
     }
 
     /**

diff --git a/Source/API/PDFDocument.swift b/Source/API/PDFDocument.swift
@@ -180,7 +180,7 @@ public class PDFDocument: CustomStringConvertible {
      - parameter container: Container whose text color will be reset, defaults to `PDFContainer.contentLeft`
      */
     public func resetFont(_ container: PDFContainer = PDFContainer.contentLeft) {
-        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: Font.systemFontSize)))]
+        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: PDFConstants.defaultFontSize)))]
     }
 
     /**

diff --git a/Source/API/PDFGenerator.swift b/Source/API/PDFGenerator.swift
@@ -68,7 +68,7 @@ public class PDFGenerator: PDFGeneratorProtocol, CustomStringConvertible {
      These values are used for simple text objects
      */
     internal lazy var fonts: [PDFContainer: Font] = .init(uniqueKeysWithValues: PDFContainer.allCases.map({ container in
-        (container, Font.systemFont(ofSize: Font.systemFontSize))
+        (container, Font.systemFont(ofSize: PDFConstants.defaultFontSize))
     }))
 
     /**
@@ -107,7 +107,7 @@ public class PDFGenerator: PDFGeneratorProtocol, CustomStringConvertible {
         columnState.reset()
         currentPage = 1
         fonts = fonts.mapValues { _ in
-            Font.systemFont(ofSize: Font.systemFontSize)
+            Font.systemFont(ofSize: PDFConstants.defaultFontSize)
         }
         textColor = textColor.mapValues { _ in
             Color.black

diff --git a/Source/API/Section/PDFSectionColumn.swift b/Source/API/Section/PDFSectionColumn.swift
@@ -161,7 +161,7 @@ public class PDFSectionColumn: PDFDocumentObject {
     - parameter container: Container whose text color will be reset, defaults to `PDFSectionColumnContainer.left`
     */
     public func resetFont(_ container: PDFSectionColumnContainer = PDFSectionColumnContainer.left) {
-        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: Font.systemFontSize)))]
+        objects += [(container, PDFFontObject(font: Font.systemFont(ofSize: PDFConstants.defaultFontSize)))]
     }
 
     /**

diff --git a/Source/API/Table/Content/PDFTableContent.swift b/Source/API/Table/Content/PDFTableContent.swift
@@ -14,7 +14,7 @@ import AppKit
 /**
  TODO: Documentation
  */
-public class PDFTableContent {
+public class PDFTableContent: CustomStringConvertible {
 
     /**
      TODO: Documentation

diff --git a/Source/API/Table/PDFTable.swift b/Source/API/Table/PDFTable.swift
@@ -47,6 +47,11 @@ public class PDFTable: PDFDocumentObject {
      */
     public var showHeadersOnEveryPage: Bool = false
 
+    /**
+     Cells should split when overlapping page
+     */
+    public var shouldSplitCellsOnPageBeak = false
+
     /**
      Count of rows and columns in this table
      */

diff --git a/Source/API/Table/Style/PDFTableCellStyle.swift b/Source/API/Table/Style/PDFTableCellStyle.swift
@@ -36,7 +36,7 @@ public struct PDFTableCellStyle {
      */
     public init(colors: (fill: Color, text: Color) = (Color.clear, Color.black),
                 borders: PDFTableCellBorders = PDFTableCellBorders(),
-                font: Font = Font.systemFont(ofSize: Font.systemFontSize)) {
+                font: Font = Font.systemFont(ofSize: PDFConstants.defaultFontSize)) {
         self.colors = colors
         self.borders = borders
         self.font = font
@@ -47,5 +47,5 @@ extension PDFTableCellStyle {
 
     public static let none = PDFTableCellStyle(colors: (fill: Color.clear, text: Color.black),
                                                borders: .none,
-                                               font: Font.systemFont(ofSize: Font.systemFontSize))
+                                               font: Font.systemFont(ofSize: PDFConstants.defaultFontSize))
 }
diff --git a/Source/API/Utils/PDFConstants.swift b/Source/API/Utils/PDFConstants.swift
@@ -0,0 +1,10 @@
+import CoreGraphics
+
+/// Constants used throught the framework
+public class PDFConstants {
+
+    /// Default font size for objects
+    ///
+    /// In earlier versions the default `UIFont.systemFontSize` was used, but during implementation of macOS support, findings showed that it `NSFont.systemFontSize` differs. Therefore the new default fontSize is declared here
+    public static let defaultFontSize: CGFloat = 17
+}
diff --git a/Source/API/Utils/PDFError.swift b/Source/API/Utils/PDFError.swift
@@ -37,6 +37,9 @@ public enum PDFError: Error {
      */
     case tableCellWeakReferenceBroken
 
+    /// Indicates that the cell is too big to be rendered onto a single page
+    case tableCellTooBig(cell: PDFTableCell)
+
     /**
      TODO: Documentation
      */
@@ -87,6 +90,8 @@ public enum PDFError: Error {
             return "Table index out of bounds: <index: \(index), length: \(length)>"
         case .tableCellWeakReferenceBroken:
             return "Weak reference in table cell is broken"
+        case .tableCellTooBig(let cell):
+            return "Table cell is too big to be rendered: \(cell)"
         case .textObjectIsNil:
             return "No text object has been set"
         case .textObjectNotCalculated:

diff --git a/Source/Internal/Graphics/PDFContextGraphics.swift b/Source/Internal/Graphics/PDFContextGraphics.swift
@@ -11,6 +11,32 @@ import CoreGraphics
 
 internal enum PDFContextGraphics {
 
+    internal static func createBitmapContext(size: CGSize) -> CGContext? {
+        let colorSpace = CGColorSpaceCreateDeviceRGB()
+        let bytesPerPixel = 4
+        let bytesPerRow = bytesPerPixel * Int(size.width)
+        let rawData = malloc(Int(size.height) * bytesPerRow)
+        let bitsPerComponent = 8
+        return CGContext(data: rawData,
+                         width: Int(size.width),
+                         height: Int(size.height),
+                         bitsPerComponent: bitsPerComponent,
+                         bytesPerRow: bytesPerRow,
+                         space: colorSpace,
+                         bitmapInfo: CGImageAlphaInfo.premultipliedLast.rawValue)
+    }
+
+    internal static func getImage(from context: CGContext, size: CGSize) -> Image? {
+        guard let cgImage = context.makeImage() else {
+            return nil
+        }
+        #if os(macOS)
+        return Image(cgImage: cgImage, size: size)
+        #elseif os(iOS)
+        return Image(cgImage: cgImage)
+        #endif
+    }
+
     internal static func createPDFContext(url: URL, bounds: CGRect, info: PDFInfo) -> CGContext {
         var mediaBox = bounds
         guard let context = CGContext(url as CFURL, mediaBox: &mediaBox, info.generate() as CFDictionary) else {

diff --git a/Source/Internal/Graphics/PDFGraphics.swift b/Source/Internal/Graphics/PDFGraphics.swift
@@ -178,8 +178,9 @@ internal enum PDFGraphics {
         let factor: CGFloat = min(3 * quality, 1)
         let resizeFactor = factor.isZero ? 0.2 : factor
 
-        let size = CGSize(width: frame.width * resizeFactor,
-                          height: frame.height * resizeFactor)
+        // If there is a floating point error, e.g. 24.000000000000004, then UIKit will use the next higher integer value, but AppKit does not
+        let size = CGSize(width: floor(frame.width * resizeFactor),
+                          height: floor(frame.height * resizeFactor))
 
         #if os(iOS)
         UIGraphicsBeginImageContext(size)

diff --git a/Source/Internal/Table/PDFTableObject.swift b/Source/Internal/Table/PDFTableObject.swift
@@ -365,7 +365,7 @@ internal class PDFTableObject: PDFRenderObject {
                     .reduce([], +)
                     .map(\.1)
                 cellElements += outline
-                
+
                 let sliceObject = createSliceObject(frame: cellFrame,
                                                     elements: cellElements,
                                                     minOffset: minOffset,