Added some conveniences for generation and detection

Author: dagronf

README.md

@@ -117,7 +117,7 @@ separating these out into two different libraries is because video detection **r
 putting it on the app store - something that you may not want if your app doesn't need it!
 
 * For QR code generation, link against `QRCode`
-* For QR code detection, link against `QRCodeDetector` 
+* For QR code video detection, link against `QRCodeDetector` 
 
 ### In your source
 
@@ -176,6 +176,12 @@ let loadedDoc = try QRCode.Document(jsonData: jsonData)
 
 </details>
 
+There are also some extensions on `CGImage` to help making qr codes even easier
+
+```swift
+let qrCodeImage = CGImage.qrCode("Hi there!", dimension: 800)
+```
+
 ## Settings
 
 ### Set the data content
@@ -260,8 +266,6 @@ square, circle, rounded rectangle, and more.
 |<img src="./Art/images/eye_edges.png" width="60"/>             |"edges"|`QRCode.EyeShape.Edges`| Simple bordered bars with a configurable corner radius |
 |<img src="./Art/images/eye_shield.png" width="60"/>            |"shield"|`QRCode.EyeShape.Shield`| A shield with configurable corners |
 
-
-
 ### Custom Pupil shape (optional)
 
 You can provide an override to the default `EyeShape` pupil shape to change just the shape of the pupil. There are built-in generators for square, circle, rounded rectangle, and more.
@@ -640,6 +644,12 @@ Produces a CGPath representation of the QRCode
 
 The components allow the caller to generate individual paths for the QR code components which can then be individually styled and recombined later on. 
 
+There are also extensions on `CGPath` to make it even easier to generate a `CGPath` from a qr code.
+
+```swift
+let qrcodePath = CGPath.qrCode("This is a test!!!", dimension: 800)
+```
+
 ### Generating a styled image
 
 ```swift
@@ -916,6 +926,13 @@ if let detected = QRCode.DetectQRCodes(in: /*some image*/),
 }
 ```
 
+Even easier, there is an extension on `CGImage` to detect the strings encoded within the image if you only want the string content for each match.
+
+```swift
+let image = CGImage(...)
+let messages = image.qrCodedMessages()
+```
+
 ### From a video stream
 
 In order to allow `QRCode` to be used in App Store or Test Flight targets without having to allow Camera usage,

Sources/QRCode/QRCode+Conveniences.swift

@@ -0,0 +1,101 @@
+//
+//  QRCode+Conveniences.swift
+//
+//  Copyright © 2023 Darren Ford. All rights reserved.
+//
+//  MIT license
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+//  documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+//  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+//  permit persons to whom the Software is furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all copies or substantial
+//  portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+//  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+//  OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+//  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+// Some conveniences for creating and detecting QR codes
+
+import Foundation
+import CoreGraphics
+
+public extension CGImage {
+	/// Create a CGImage containing a qr code
+	/// - Parameters:
+	///   - text: The text to encode in the qr code
+	///   - dimension: The size in pixels of the output image
+	///   - errorCorrection: The error correction
+	///   - shape: The shape to use, or nil for default
+	///   - style: The style to use, or nil for default
+	/// - Returns: The image representation of the qr code, or nil if an error occurred
+	static func qrCode(
+		_ text: String,
+		dimension: Int,
+		errorCorrection: QRCode.ErrorCorrection = .high,
+		shape: QRCode.Shape? = nil,
+		style: QRCode.Style? = nil
+	) -> CGImage? {
+		let doc = QRCode.Document(utf8String: text, errorCorrection: errorCorrection)
+		if let shape = shape { doc.design.shape = shape }
+		if let style = style { doc.design.style = style }
+		return doc.cgImage(dimension: dimension)
+	}
+
+	/// Create a CGImage containing a qr code
+	/// - Parameters:
+	///   - text: The text to encode in the qr code
+	///   - dimension: The size in pixels of the output image
+	///   - foregroundColor: The foreground color
+	///   - foregroundColor: The background color, or nil for default
+	///   - errorCorrection: The error correction
+	/// - Returns: The image representation of the qr code, or nil if an error occurred
+	static func qrCode(
+		_ text: String,
+		dimension: Int,
+		foregroundColor: CGColor,
+		backgroundColor: CGColor? = nil,
+		errorCorrection: QRCode.ErrorCorrection = .high,
+		shape: QRCode.Style? = nil
+	) -> CGImage? {
+		let doc = QRCode.Document(utf8String: text, errorCorrection: errorCorrection)
+		doc.design.foregroundColor(foregroundColor)
+		doc.design.backgroundColor(backgroundColor)
+		return doc.cgImage(dimension: dimension)
+	}
+}
+
+public extension CGPath {
+	/// Simple convenience for creating a CGPath representation of a qr code
+	/// - Parameters:
+	///   - text: The text to encode in the qr code
+	///   - dimension: The size in pixels of the output image
+	///   - errorCorrection: The error correction
+	///   - shape: The shape to use, or nil for default
+	/// - Returns: The path representation of the qr code, or nil if an error occurred
+	static func qrCode(
+		_ text: String,
+		dimension: Int,
+		errorCorrection: QRCode.ErrorCorrection = .high,
+		shape: QRCode.Shape? = nil
+	) -> CGPath? {
+		let doc = QRCode.Document(utf8String: text, errorCorrection: errorCorrection)
+		if let shape = shape { doc.design.shape = shape }
+		return doc.path(dimension: dimension)
+	}
+}
+
+#if !os(watchOS)
+public extension CGImage {
+	/// Returns all qrcode messages that were encoded in this image
+	/// - Returns: An array of detected qr code strings
+	func qrCodedMessages() -> [String] {
+		let features = QRCode.DetectQRCodes(self)
+		return features.compactMap { $0.messageString }
+	}
+}
+#endif

Tests/QRCodeTests/QRCodeTests.swift

@@ -372,4 +372,48 @@ final class QRCodeTests: XCTestCase {
 		XCTAssertEqual(nsi.representations[0].pixelsHigh, 72)
 		#endif
 	}
+
+	func stringsFromQRCode(_ cgImage: CGImage) -> [String] {
+		let features = QRCode.DetectQRCodes(cgImage)
+		return features.compactMap { $0.messageString }
+	}
+
+	func testCGImageQuickGen() throws {
+		do {
+			let image = try XCTUnwrap(CGImage.qrCode("This is a test!!!", dimension: 300))
+			XCTAssertEqual(image.width, 300)
+			XCTAssertEqual(image.height, 300)
+			XCTAssertEqual(image.qrCodedMessages(), ["This is a test!!!"])
+		}
+
+		do {
+			let path = try XCTUnwrap(CGPath.qrCode("This is a test!!!", dimension: 300))
+
+			let bitmapInfo = CGBitmapInfo(rawValue: CGImageAlphaInfo.premultipliedLast.rawValue)
+			let colorSpace = CGColorSpace(name: CGColorSpace.sRGB)!
+			let ctx = try XCTUnwrap(CGContext(
+					data: nil,
+					width: 300,
+					height: 300,
+					bitsPerComponent: 8,
+					bytesPerRow: 300 * 4,
+					space: colorSpace,
+					bitmapInfo: bitmapInfo.rawValue
+				)
+			)
+
+			ctx.scaleBy(x: 1, y: -1)
+			ctx.translateBy(x: 0, y: -300)
+
+			ctx.setFillColor(.white)
+			ctx.fill([CGRect(x: 0, y: 0, width: 300, height: 300)])
+
+			ctx.addPath(path)
+			ctx.setFillColor(.black)
+			ctx.fillPath()
+
+			let image = try XCTUnwrap(ctx.makeImage())
+			XCTAssertEqual(image.qrCodedMessages(), ["This is a test!!!"])
+		}
+	}
 }