Release 0.3.0

Author: broadwaylamb

.codebeatignore

@@ -1,7 +1,5 @@
 #!/usr/bin/env bash
 
-echo "Swift 3 Continuous Integration";
-
 # Determine OS
 UNAME=`uname`;
 if [[ $UNAME == "Darwin" ]];

.codebeatsettings

@@ -14,14 +14,14 @@ fi
 echo "🖥  Operating System: $OS";
 
 PROJ_NAME="SwiftyHaru"
-SCHEME_NAME="${PROJ_NAME}"
+SCHEME_NAME="${PROJ_NAME}-Package"
 
 echo "🚀  Testing: $SCHEME_NAME";
 
 rvm install 2.2.3
 gem install xcpretty
 make generate-xcodeproj
-WORKING_DIRECTORY=$(PWD) xcodebuild -project $PROJ_NAME.xcodeproj -scheme $SCHEME_NAME -sdk macosx10.12 -destination arch=x86_64 -configuration Debug -enableCodeCoverage YES test | xcpretty
+WORKING_DIRECTORY=$(PWD) xcodebuild -project $PROJ_NAME.xcodeproj -scheme $SCHEME_NAME -destination arch=x86_64 -configuration Debug -enableCodeCoverage YES test | xcpretty
 bash <(curl -s https://codecov.io/bash)
 
 echo "✅  Done";

.scripts/ci.sh

@@ -2,22 +2,25 @@ language: generic
 
 matrix:
   include:
-    - os: osx
-      osx_image: xcode8.3
-      env: SWIFT_VERSION="3.1" RUN_TESTS="NO" POD_LINT="YES"
-    - os: osx
-      osx_image: xcode8.3
-      env: SWIFT_VERSION="3.1" RUN_TESTS="YES" POD_LINT="NO"
-    - os: linux
+    - name: "pod lib lint"
+      os: osx
+      osx_image: xcode10.1
+      env: SWIFT_VERSION="4.2" RUN_TESTS="NO" POD_LINT="YES"
+    - name: "Running tests (macOS)"
+      os: osx
+      osx_image: xcode10.1
+      env: SWIFT_VERSION="4.2" RUN_TESTS="YES" POD_LINT="NO"
+    - name: "Running tests (Ubuntu 18.04)"
+      os: linux
       sudo: required
-      dist: trusty
-      env: SWIFT_VERSION="3.1" RUN_TESTS="YES" POD_LINT="NO"
+      dist: xenial
+      env: SWIFT_VERSION="4.2" RUN_TESTS="YES" POD_LINT="NO"
 
 script:
   - if [[ $POD_LINT == "YES" ]]; then
-      gem install cocoapods;
+      gem install cocoapods --pre;
       pod repo update --silent;
-      pod lib lint --swift-version=$SWIFT_VERSION --allow-warnings;
+      pod lib lint --allow-warnings --verbose;
     fi
   - if [[ $RUN_TESTS == "YES" ]]; then
       eval .scripts/ci.sh;

.scripts/coverage.sh

@@ -1,5 +1,30 @@
 # Change Log
 
+## [0.3.0](https://github.com/WeirdMath/SwiftyHaru/tree/0.3.0) (2018-12-24)
+
+Please note that this version requires Swift 4.2.
+
+**Breaking changes:**
+
+(Those are a bit massive, sorry.)
+
+- `PDFPage.draw(_:)` is removed. The closure for drawing can now be passed to the `PDFDocument.addPage(_:)` family of methods. This is because multiple calls of `PDFPage.draw(_:)` resulted in redundant drawing operations (when resetting the context to the default state before each call). To migrate, merge your multiple calls of `PDFPage.draw(_:)` to one call of `PDFDocument.addPage(_:)`. Pay attention that because of this the `DrawingContext.textLeading` property is initially set to 0 (not 11 like before), so you may want to change its value before doing any text operations. Also, if you need to access the `PDFPage`'s properties from the drawing closure, use the `DrawingContext.page` property.
+- `PDFPage.draw(object:position:)` and `PDFPage.draw(object:x:y:)` are removed. Use the `DrawingContext.draw(_:position:)` and `DrawingContext.draw(_:x:y:)` methods instead.
+- `DashStyle.pattern` and `DashStyle.phase` are now `let`, since changing those values wasn't in any way validated.
+- `Vector` is now a separate type, not a typealias for `Point`. Its intefrace has slightly changed: the fields have been renamed from `x` and `y` to `dx` and `dy`. This new type includes some arithmetic operators that make its use simpler.
+- The required method `draw(in:position:)` of the `Drawable` protocol is marked `throws`.
+- `PDFDocument.setEncryptionMode(to:)` and `PDFDocument.setPermissions(to:)` are removed. Use the `PDFDocument.setPassword(owner:user:permissions:encryptionMode:)` method  instead.
+- `DrawingContext.withNewGState(_:)` doesn't throw if its argument doesn't. Same for `DrawingContext.clip(to:rule:_:)`. If the graphics state stack depth exceeds `static DrawingContext.maxGraphicsStateDepth`, a precondition failure occures.
+- `static PDFError.exceedGStateLimit` is removed.
+
+**Implemented features:**
+
+- `AffineTransform` struct that helps you easily apply transforms like rotation, scaling and translation to a document's coordinate system.
+- Concatenating the transformation matrix of a page + convenience methods for translation, scaling and rotation.
+- Getting the current transformation matrix of a page.
+- Added conformance to `Hashable` for many types.
+- Improved debug descriptions for `Color` and the geometric types.
+
 ## [0.2.0](https://github.com/WeirdMath/SwiftyHaru/tree/0.2.0) (2017-06-25)
 
 Please note that this version requires Swift 3.1.

.travis.yml

@@ -8,75 +8,74 @@
     import SwiftyHaru
 
     let document = PDFDocument()
-    let page = document.addPage(width: 200, height: 220)
+    try document.addPage(width: 200, height: 220) { context in
 /*:
  Let's draw the grid for convenience.
  */
-
-    let horizontalLabels = stride(from: 50, through: 150, by: 50).map(String.init)
-    let verticalLabels = stride(from: 10, through: 210, by: 10).map(String.init)
-
-    let labels = Grid.Labels(top: Grid.LabelParameters(sequence: "" + horizontalLabels,
-                                                       offset: Vector(x: 0, y: -6)),
-                             bottom: Grid.LabelParameters(sequence: "" + horizontalLabels,
-                                                          offset: Vector(x: 0, y: 6)),
-                             left: Grid.LabelParameters(sequence: "" + verticalLabels,
-                                                        frequency: 1,
-                                                        offset: Vector(x: 6, y: 0)))
-
-    let serifs = Grid.Serifs(top: .default,
-                             bottom: .default,
-                             left: Grid.SerifParameters(frequency: 1),
-                             right: nil)
-
-    let grid = Grid(width: page.width, height: page.height, labels: labels, serifs: serifs)
-    page.draw(object: grid, position: .zero)
+        let horizontalLabels = stride(from: 50, through: 150, by: 50).map(String.init)
+        let verticalLabels = stride(from: 10, through: 210, by: 10).map(String.init)
+
+        let labels = Grid.Labels(top: Grid.LabelParameters(sequence: "" + horizontalLabels,
+                                                           offset: Vector(dx: 0, dy: -6)),
+                                 bottom: Grid.LabelParameters(sequence: "" + horizontalLabels,
+                                                              offset: Vector(dx: 0, dy: 6)),
+                                 left: Grid.LabelParameters(sequence: "" + verticalLabels,
+                                                            frequency: 1,
+                                                            offset: Vector(dx: 6, dy: 0)))
+
+        let serifs = Grid.Serifs(top: .default,
+                                 bottom: .default,
+                                 left: Grid.SerifParameters(frequency: 1),
+                                 right: nil)
+
+        let grid = Grid(width: context.page.width,
+                        height: context.page.height,
+                        labels: labels,
+                        serifs: serifs)
+        try context.draw(grid, position: .zero)
 /*:
  Then draw a pie chart.
  - a: 45% red
  - b: 25% blue
  - c: 15% green
  - d: other yellow
  */
-
-    let center = Point(x: 100, y: 100)
-
-    var temporaryPosition: Point
-
-    var a = Path()
-        .moving(to: center)
-        .appendingLine(toX: 100, y: 180)
-        .appendingArc(center: center,
-                      radius: 80,
-                      beginningAngle: 0,
-                      endAngle: 360 * 0.45)
-    temporaryPosition = a.currentPosition
-    a.appendLine(to: center)
-
-    var b = Path()
-        .moving(to: center)
-        .appendingLine(to: temporaryPosition)
-        .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.45, endAngle: 360 * 0.7)
-    temporaryPosition = b.currentPosition
-    b.appendLine(to: center)
-
-    var c = Path()
-        .moving(to: center)
-        .appendingLine(to: temporaryPosition)
-        .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.7, endAngle: 360 * 0.85)
-    temporaryPosition = c.currentPosition
-    c.appendLine(to: center)
-
-    var d = Path()
-        .moving(to: center)
-        .appendingLine(to: temporaryPosition)
-        .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.85, endAngle: 360)
-        .appendingLine(to: center)
-
-    // Draw center circle
-    let centerCircle = Path().appendingCircle(center: center, radius: 30)
-
-    page.draw { context in
+        let center = Point(x: 100, y: 100)
+
+        var temporaryPosition: Point
+
+        var a = Path()
+            .moving(to: center)
+            .appendingLine(toX: 100, y: 180)
+            .appendingArc(center: center,
+                          radius: 80,
+                          beginningAngle: 0,
+                          endAngle: 360 * 0.45)
+        temporaryPosition = a.currentPosition
+        a.appendLine(to: center)
+
+        var b = Path()
+            .moving(to: center)
+            .appendingLine(to: temporaryPosition)
+            .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.45, endAngle: 360 * 0.7)
+        temporaryPosition = b.currentPosition
+        b.appendLine(to: center)
+
+        var c = Path()
+            .moving(to: center)
+            .appendingLine(to: temporaryPosition)
+            .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.7, endAngle: 360 * 0.85)
+        temporaryPosition = c.currentPosition
+        c.appendLine(to: center)
+
+        var d = Path()
+            .moving(to: center)
+            .appendingLine(to: temporaryPosition)
+            .appendingArc(center: center, radius: 80, beginningAngle: 360 * 0.85, endAngle: 360)
+            .appendingLine(to: center)
+
+        // Draw center circle
+        let centerCircle = Path().appendingCircle(center: center, radius: 30)
 
         context.fillColor = #colorLiteral(red: 0.9254902005, green: 0.2352941185, blue: 0.1019607857, alpha: 1)
         context.fill(a)
@@ -99,4 +98,4 @@
     document.display()
 /*:
   [Previous page](@previous) • **[Table of contents](Table%20of%20contents)** • [Next page](@next)
- */
+ */

CHANGELOG.md

@@ -6,7 +6,6 @@
  ([Original example that uses LibHaru](https://github.com/libharu/libharu/wiki/Examples#font_democ))
  */
     import SwiftyHaru
-
 /*:
  Define our list of fonts:
  */
@@ -30,58 +29,51 @@
  Setup our document:
  */
     let document = PDFDocument()
-    let page = document.addPage()
     let pageTitle = "Font Demo"
 
+    try document.addPage { context in
 /*:
  Print the lines and the title of the page:
  */
-    page.draw { context in
-
         let rectangle = Path()
             .appendingRectangle(x: 50,
                                 y: 50,
-                                width: page.width - 100,
-                                height: page.height - 110)
+                                width: context.page.width - 100,
+                                height: context.page.height - 110)
 
         context.stroke(rectangle)
 
+        context.textLeading = 11
         context.fontSize = 24
         let textWidth = context.textWidth(for: pageTitle)
-        context.show(text: pageTitle,
-                     atX: (page.width - textWidth) / 2,
-                     y: page.height - 50)
-    }
+        try context.show(text: pageTitle,
+                         atX: (context.page.width - textWidth) / 2,
+                         y: context.page.height - 50)
 /*:
  Output subtitle:
  */
-    page.draw { context in
-
         context.fontSize = 16
-        context.show(text: "<Standerd Type1 fonts samples>",
-                     atX: 60,
-                     y: page.height - 80)
-}
+        try context.show(text: "<Standerd Type1 fonts samples>",
+                         atX: 60,
+                         y: context.page.height - 80)
 /*:
  And finally let's test each font:
  */
-    page.draw { context in
-
-        var textPosition = Point(x: 60, y: page.height - 105)
+        var textPosition = Point(x: 60, y: context.page.height - 105)
 
         let sampleText = "abcdefgABCDEFG12345!#$%&+-@?"
 
         for font in fontList {
 
             context.fontSize = 9
             context.font = .helvetica
-            context.show(text: font.name, atPosition: textPosition)
-            textPosition = textPosition + Vector(x: 0, y: -18)
+            try context.show(text: font.name, atPosition: textPosition)
+            textPosition = textPosition + Vector(dx: 0, dy: -18)
 
             context.fontSize = 20
             context.font = font
-            context.show(text: sampleText, atPosition: textPosition)
-            textPosition = textPosition + Vector(x: 0, y: -20)
+            try context.show(text: sampleText, atPosition: textPosition)
+            textPosition = textPosition + Vector(dx: 0, dy: -20)
         }
     }
 /*:

Demo/Demo.playground/Pages/Arcs.xcplaygroundpage/Contents.swift

@@ -20,24 +20,23 @@
  Let's setup our document.
  */
     let document = PDFDocument()
-    let page = document.addPage(width: 400, height: 600)
 /*:
  And set some parameters
  */
     let topLabelParameters =
         Grid.LabelParameters(sequence: createLabelSequence(stride: 50),
                              frequency: 5,
-                             offset: Vector(x: 0, y: -6))
+                             offset: Vector(dx: 0, dy: -6))
 
     let bottomLabelParameters =
         Grid.LabelParameters(sequence: createLabelSequence(stride: 50),
                              frequency: 5,
-                             offset: Vector(x: 0, y: 6))
+                             offset: Vector(dx: 0, dy: 6))
 
     let leftLabelParameters =
         Grid.LabelParameters(sequence: createLabelSequence(stride: 10),
                              frequency: 1,
-                             offset: Vector(x: 6, y: 0))
+                             offset: Vector(dx: 6, dy: 0))
 
     let labels = Grid.Labels(top: topLabelParameters,
                              bottom: bottomLabelParameters,
@@ -54,12 +53,13 @@
 /*:
  Finally, assemble everything:
  */
-    let grid = Grid(width: page.width,
-                    height: page.height,
-                    labels: labels,
-                    serifs: serifs)
-
-    page.draw(object: grid, position: .zero)
+    try document.addPage(width: 400, height: 600) { context in
+        let grid = Grid(width: context.page.width,
+                        height: context.page.height,
+                        labels: labels,
+                        serifs: serifs)
+        try context.draw(grid, position: .zero)
+    }
 /*:
  Yep, it's that simple.