Merge pull request #215 from techprimate/release/2.1.2

Release/2.1.2

Author: Philip Niedertscheider

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Change Log
 
 ## [Unreleased](https://github.com/techprimate/TPPDF/tree/HEAD) (2020-??-??)
-[Full Changelog](https://github.com/techprimate/TPPDF/compare/2.1.1...HEAD)
+[Full Changelog](https://github.com/techprimate/TPPDF/compare/2.1.2...HEAD)
 
 **Implemented enhancements:**
 
@@ -11,6 +11,22 @@
 
 **Merged pull requests:**
 
+## [2.1.2](https://github.com/techprimate/TPPDF/tree/2.1.2) (2020-06-23)
+[Full Changelog](https://github.com/techprimate/TPPDF/compare/2.1.1...2.1.2)
+
+**Fixed bugs:**
+
+- Height of image captions are now calcuated correctly (Issue #208)
+
+**Closed issues:**
+
+- Issue #208
+
+**Merged pull requests:**
+
+- PR #214 [by chrisgonzgonz]
+
+
 ## [2.1.1](https://github.com/techprimate/TPPDF/tree/2.1.1) (2020-06-16)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/2.1.0...2.1.1)
 
@@ -40,18 +56,18 @@
 
 **Closed issues:**
 
-- #73
-- #122
-- #204
-- #197
-- #189
-- #186
-- #184
-- #183
+- Issue #73
+- Issue #122
+- Issue #204
+- Issue #197
+- Issue #189
+- Issue #186
+- Issue #184
+- Issue #183
 
 **Merged pull requests:**
 
-- #211
+- Issue #211
 
 ## [2.0.1](https://github.com/techprimate/TPPDF/tree/2.0.1) (2020-05-31)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/2.0.0...2.0.1)
@@ -67,7 +83,7 @@
 
 **Closed issues:**
 
-- #204
+- Issue #204
 
 ## [2.0.0](https://github.com/techprimate/TPPDF/tree/2.0.0) (2020-05-19)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.6.0...2.0.0)
@@ -84,22 +100,22 @@
 
 **Closed issues:**
 
-- #41
-- #86
-- #148
-- #178
-- #179
-- #182
-- #183
-- #184
-- #185
-- #186
-- #196
-- #197
+- Issue #41
+- Issue #86
+- Issue #148
+- Issue #178
+- Issue #179
+- Issue #182
+- Issue #183
+- Issue #184
+- Issue #185
+- Issue #186
+- Issue #196
+- Issue #197
 
 **Merged pull requests:**
 
-- #181
+- Issue #181
 
 ## [1.6.0](https://github.com/techprimate/TPPDF/tree/1.6.0) (2020-03-23)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.5.4...1.6.0)
@@ -119,17 +135,17 @@
 
 **Closed issues:**
 
-- #155
-- #31
-- #170
-- #71
+- Issue #155
+- Issue #31
+- Issue #170
+- Issue #71
 
 **Merged pull requests:**
 
-- #171
-- #172
-- #174
-- #177
+- Issue #171
+- Issue #172
+- Issue #174
+- Issue #177
 
 ## [1.5.4](https://github.com/techprimate/TPPDF/tree/1.5.4) (2019-06-06)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.5.3...1.5.4)
@@ -161,7 +177,7 @@
 
 **Closed issues:**
 
-- #67
+- Issue #67
 
 ## [1.5.0](https://github.com/techprimate/TPPDF/tree/1.5.0) (2019-06-05)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.4.1...1.5.0)
@@ -182,17 +198,17 @@
 
 **Closed issues:**
 
-- #9
-- #57
-- #58
-- #88
-- #113
-- #118
-- #127
-- #132
-- #136
-- #137
-- #138
+- Issue #9
+- Issue #57
+- Issue #58
+- Issue #88
+- Issue #113
+- Issue #118
+- Issue #127
+- Issue #132
+- Issue #136
+- Issue #137
+- Issue #138
 
 ## [1.4.1](https://github.com/techprimate/TPPDF/tree/1.4.1) (2019-05-19)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.4.0...1.4.1)
@@ -219,9 +235,9 @@
 
 **Closed issues:**
 
-- #123
-- #125
-- #128
+- Issue #123
+- Issue #125
+- Issue #128
 
 ## [1.3.3](https://github.com/techprimate/TPPDF/tree/1.3.3) (2019-03-13)
 [Full Changelog](https://github.com/techprimate/TPPDF/compare/1.3.2...1.3.3)
@@ -232,14 +248,13 @@
 
 **Closed issues:**
 
-- #101
-- #103
-- #108
-- #109
-- #111
-- #113
-- #114
-
+- Issue #101
+- Issue #103
+- Issue #108
+- Issue #109
+- Issue #111
+- Issue #113
+- Issue #114
 
 **Merged pull requests:**
 

Shared/Examples/ImageExampleFactory.swift

@@ -81,6 +81,19 @@ class ImageExampleFactory: ExampleFactory {
         document.add(imagesInRow: images[1], spacing: 10)
         document.add(imagesInRow: images[1], spacing: 10)
 
+        // Image and caption should be on same page
+        let tallImage = PDFImage(image: UIImage(named: "Image-4.jpg")!,
+                                 size: CGSize(width: 150, height: 800))
+        tallImage.caption = PDFSimpleText(text: "Awesome Caption\nLine 2 of awesome Caption")
+
+        // Height should fit
+        tallImage.sizeFit = .height
+
+        document.add(.contentCenter, image: tallImage)
+
+        // Just add some text to see page break
+        document.add(text: LoremIpsum.get(words: 50))
+
         return [document]
     }
 }

Source/Internal/Utils/PDFCalculations.swift

@@ -436,9 +436,15 @@ internal enum PDFCalculations {
                                                    sizeFit: PDFImageSizeFit) -> (CGSize, CGSize) {
         /* calculate the aspect size of image */
         let size = (size == CGSize.zero) ? image.size : size
+        
+        /* calculate caption height if a caption exists */
+        let captionHeight: CGFloat =
+            (image.caption as? PDFAttributedText).map({ $0.text.size().height })
+        ?? (image.caption as? PDFSimpleText).map({ $0.text.size().height })
+        ?? 0
 
         let maxWidth = min(size.width, calculateAvailableFrameWidth(for: generator, in: container))
-        let maxHeight = min(size.height, calculateAvailableFrameHeight(for: generator, in: container))
+        let maxHeight = min(size.height, calculateAvailableFrameHeight(for: generator, in: container) - captionHeight)
 
         let wFactor = image.size.width / maxWidth
         let hFactor = image.size.height / maxHeight
@@ -454,11 +460,8 @@ internal enum PDFCalculations {
             }
         }()
 
-        let imageSize = CGSize(width: image.size.width / factor, height: image.size.height / factor)
-        let captionHeight: CGFloat = 0
-        // if let _ = image.caption {
-        // TODO: Fix caption height calculations
-        // }
+        let imageSize = CGSize(width: image.size.width / factor, height: (image.size.height / factor) - captionHeight)
+        
         return (imageSize, CGSize(width: imageSize.width, height: captionHeight))
     }
 

TPPDF.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'TPPDF'
-  s.version          = '2.1.1'
+  s.version          = '2.1.2'
   s.summary          = 'TPPDF is a simple-to-use PDF builder for iOS'
   s.description      = <<-DESC
     TPPDF is an object-based PDF builder, completely built in Swift.