Merge pull request #29 from temoki/develop

temoki · web-flow · commit 418b164d2ae9 · 2017-12-31T01:24:05.000+09:00
Added canvas color feature
diff --git a/InstallationTests/README.md b/InstallationTests/README.md
@@ -31,5 +31,6 @@ open Cocoapods-macOS.xcworkspace
 
 ```shell
 cd ./SwiftPM
+swift package update
 swift build
 ```
diff --git a/InstallationTests/SwiftPM/.gitignore b/InstallationTests/SwiftPM/.gitignore
@@ -3,4 +3,5 @@
 /Packages
 /*.xcodeproj
 Package.pins
-output.png
+Package.resolved
+output.png
diff --git a/InstallationTests/SwiftPM/Package.swift b/InstallationTests/SwiftPM/Package.swift
@@ -1,10 +1,13 @@
-// swift-tools-version:3.1
+// swift-tools-version:4.0.0
 
 import PackageDescription
 
 let package = Package(
     name: "SwiftPM",
     dependencies: [
-        .Package(url: "https://github.com/temoki/TortoiseGraphics.git", majorVersion: 0)
+        .package(url: "https://github.com/temoki/TortoiseGraphics.git", .branch("develop")),
+    ],
+    targets: [
+        .target(name: "SwiftPM", dependencies: ["TortoiseGraphics"], path: "Sources"),
     ]
 )
diff --git a/InstallationTests/SwiftPM/Sources/main.swift b/InstallationTests/SwiftPM/Sources/main.swift
@@ -1,5 +1,10 @@
 import Foundation
 import TortoiseGraphics
-let 🐢 = Tortoise()
-🐢.fd(100)
-🐢.writePNG(of: CGSize(width: 300, height: 300), to: URL(fileURLWithPath: "./output.png"))
+
+let canvas = ImageCanvas(size: CGSize(width: 300, height: 300))
+canvas.color = .white
+canvas.drawing { 🐢 in
+    🐢.right(90)
+    🐢.forward(100)
+}
+canvas.writePNG(to: URL(fileURLWithPath: "./output.png"))
diff --git a/OutputExamples/example1.gif b/OutputExamples/example1.gif
diff --git a/OutputExamples/example1.png b/OutputExamples/example1.png
diff --git a/OutputExamples/example2.gif b/OutputExamples/example2.gif
diff --git a/OutputExamples/example2.png b/OutputExamples/example2.png
diff --git a/Playground/Playground.playground/Pages/With 2 tortoises.xcplaygroundpage/Contents.swift b/Playground/Playground.playground/Pages/With 2 tortoises.xcplaygroundpage/Contents.swift
@@ -6,6 +6,7 @@ import CoreGraphics
 
 let canvas = PlaygroundCanvas(frame: CGRect(x: 0, y: 0, width: 300, height: 300))
 canvas.frameRate = 30
+canvas.color = .white
 PlaygroundPage.current.liveView = canvas
 
 canvas.drawingWithTortoises(count: 2) { tortoises in
diff --git a/Playground/Playground.playground/Pages/With a tortoise.xcplaygroundpage/Contents.swift b/Playground/Playground.playground/Pages/With a tortoise.xcplaygroundpage/Contents.swift
@@ -6,6 +6,7 @@ import CoreGraphics
 
 let canvas = PlaygroundCanvas(frame: CGRect(x: 0, y: 0, width: 300, height: 300))
 canvas.frameRate = 30
+canvas.color = .white
 PlaygroundPage.current.liveView = canvas
 
 canvas.drawing { 🐢 in
diff --git a/Playground/PlaygroundCanvas.swift b/Playground/PlaygroundCanvas.swift
@@ -6,7 +6,7 @@ import UIKit
 public typealias View = UIView
 #endif
 
-public class PlaygroundCanvas: View {
+public class PlaygroundCanvas: View, Canvas {
 
     public var frameRate: Int = 30
 
@@ -16,14 +16,20 @@ public class PlaygroundCanvas: View {
     public override func draw(_ dirtyRect: NSRect) {
         super.draw(dirtyRect)
         guard let cgContext = NSGraphicsContext.current?.cgContext else { return }
-        let context = GraphicsContext(size: self.frame.size, cgContext: cgContext, isUIViewContext: false)
+        let context = GraphicsContext(size: self.frame.size,
+                                      cgContext: cgContext,
+                                      backgroundColor: color?.cgColor,
+                                      isUIViewContext: false)
         draw(with: context)
     }
     #elseif os(iOS)
     public override func draw(_ rect: CGRect) {
         super.draw(rect)
         guard let cgContext = UIGraphicsGetCurrentContext() else { return }
-        let context = GraphicsContext(size: self.frame.size, cgContext: cgContext, isUIViewContext: true)
+        let context = GraphicsContext(size: self.frame.size,
+                                      cgContext: cgContext,
+                                      backgroundColor: color?.cgColor,
+                                      isUIViewContext: true)
         draw(with: context)
     }
     #endif
@@ -61,6 +67,8 @@ public class PlaygroundCanvas: View {
             tortoiseCharmer.commandedHandler = nil
         }
     }
+    
+    public var color: Color?
 
     // MARK: - Private
 
diff --git a/Playground/PlaygroundLiveViewController.swift b/Playground/PlaygroundLiveViewController.swift
@@ -22,7 +22,7 @@ public class PlaygroundLiveViewController: UIViewController {
             ])
         
         canvas = PlaygroundCanvas(frame: view.bounds)
-        canvas.backgroundColor = .clear
+        canvas.color = .white
         view.addSubview(canvas)
         canvas.translatesAutoresizingMaskIntoConstraints = false
         NSLayoutConstraint.activate([
diff --git a/PlaygroundBook/template/Contents/Manifest.plist b/PlaygroundBook/template/Contents/Manifest.plist
@@ -11,7 +11,7 @@
 	<key>ContentIdentifier</key>
 	<string>com.temoki.playgroundbook.TortoiseGraphics</string>
 	<key>ContentVersion</key>
-	<string>0.11.0</string>
+	<string>0.12.0</string>
 	<key>ImageReference</key>
 	<string>icon.png</string>
 	<key>DeploymentTarget</key>
diff --git a/Sources/Canvas.swift b/Sources/Canvas.swift
@@ -4,4 +4,6 @@ public protocol Canvas {
 
     func drawingWithTortoises(count: Int, drawingBlock: @escaping ([Tortoise]) -> Void)
 
+    var color: Color? {get set}
+
 }
diff --git a/Sources/Color+CGColor.swift b/Sources/Color+CGColor.swift
@@ -19,12 +19,16 @@ extension Color {
 
 extension CGColor {
 
-    static func rgb(_ red: CGFloat, _ green: CGFloat, _ blue: CGFloat) -> CGColor {
+    static var clear: CGColor {
+        return rgb(1, 1, 1, 0)
+    }
+
+    static func rgb(_ red: CGFloat, _ green: CGFloat, _ blue: CGFloat, _ alpha: CGFloat = 1) -> CGColor {
         #if os(iOS)
         // swiftlint:disable:next force_unwrapping
-        return CGColor(colorSpace: CGColorSpaceCreateDeviceRGB(), components: [red, green, blue, 1])!
+        return CGColor(colorSpace: CGColorSpaceCreateDeviceRGB(), components: [red, green, blue, alpha])!
         #elseif os(macOS)
-        return CGColor(red: red, green: green, blue: blue, alpha: 1)
+        return CGColor(red: red, green: green, blue: blue, alpha: alpha)
         #endif
     }
 
diff --git a/Sources/GraphicsCanvas.swift b/Sources/GraphicsCanvas.swift
@@ -1,6 +1,6 @@
 import CoreGraphics
 
-public class GraphicsCanvas {
+public class GraphicsCanvas: Canvas {
 
     private var tortoiseCharmer = TortoiseCharmer(tortoiseCount: 0)
     private let graphicsContext: GraphicsContext
@@ -13,6 +13,7 @@ public class GraphicsCanvas {
         #endif
         self.graphicsContext = GraphicsContext(size: size,
                                                cgContext: context,
+                                               backgroundColor: color?.cgColor,
                                                isUIViewContext: isUIViewContext)
     }
 
@@ -30,4 +31,6 @@ public class GraphicsCanvas {
         tortoiseCharmer.charm(with: graphicsContext, toFrame: nil)
     }
 
+    public var color: Color?
+
 }
diff --git a/Sources/GraphicsContext.swift b/Sources/GraphicsContext.swift
@@ -4,17 +4,25 @@ class GraphicsContext {
 
     let size: CGSize
     let cgContext: CGContext
+    let backgroundColor: CGColor
     let isUIViewContext: Bool
 
-    init(size: CGSize, cgContext: CGContext, isUIViewContext: Bool = false) {
+    init(size: CGSize, cgContext: CGContext, backgroundColor: CGColor?, isUIViewContext: Bool = false) {
         self.size = size
         self.cgContext = cgContext
+        self.backgroundColor = backgroundColor ?? .clear
         self.isUIViewContext = isUIViewContext
     }
 
     func setup() {
         cgContext.saveGState()
 
+        // Fill background
+        cgContext.saveGState()
+        cgContext.setFillColor(backgroundColor)
+        cgContext.fill((CGRect(x: 0, y: 0, width: size.width, height: size.height)))
+        cgContext.restoreGState()
+
         // Setup coordinate
         if isUIViewContext {
             // https://developer.apple.com/library/content/documentation/General/Conceptual/Devpedia-CocoaApp/CoordinateSystem.html
@@ -30,7 +38,7 @@ class GraphicsContext {
         cgContext.restoreGState()
     }
 
-    static func createBitmapContext(size: CGSize, scale: CGFloat) -> GraphicsContext {
+    static func createBitmapContext(size: CGSize, scale: CGFloat, backgroundColor: CGColor?) -> GraphicsContext {
         let cgContext = CGContext(data: nil,
                                   width: Int(size.width * scale),
                                   height: Int(size.height * scale),
@@ -40,7 +48,7 @@ class GraphicsContext {
                                   bitmapInfo: CGImageAlphaInfo.premultipliedFirst.rawValue)!
         // swiftlint:disable:previous force_unwrapping
         cgContext.scaleBy(x: scale, y: scale)
-        return GraphicsContext(size: size, cgContext: cgContext, isUIViewContext: false)
+        return GraphicsContext(size: size, cgContext: cgContext, backgroundColor: backgroundColor, isUIViewContext: false)
     }
 
 }
diff --git a/Sources/ImageCanvas.swift b/Sources/ImageCanvas.swift
@@ -7,13 +7,13 @@ import MobileCoreServices
 public typealias Image = UIImage
 #endif
 
-public class ImageCanvas {
+public class ImageCanvas: Canvas {
 
     private var tortoiseCharmer = TortoiseCharmer(tortoiseCount: 1)
     private let size: CGSize
     private let scale: CGFloat
 
-    init(size: CGSize, scale: CGFloat = 1) {
+    public init(size: CGSize, scale: CGFloat = 1) {
         self.size = size
         self.scale = scale
     }
@@ -30,10 +30,14 @@ public class ImageCanvas {
         drawingBlock(tortoiseCharmer.tortoises)
     }
 
+    public var color: Color?
+
     // MARK: - Make Image
 
     public var cgImage: CGImage? {
-        let context = GraphicsContext.createBitmapContext(size: size, scale: scale)
+        let context = GraphicsContext.createBitmapContext(size: size,
+                                                          scale: scale,
+                                                          backgroundColor: color?.cgColor)
         tortoiseCharmer.charm(with: context, toFrame: nil)
         return context.cgContext.makeImage()
     }
@@ -81,7 +85,9 @@ public class ImageCanvas {
             fileURL as CFURL, type, tortoiseCharmer.commandHistories.count - 1, nil) else { return false }
 
         for frameIndex in 0 ..< tortoiseCharmer.commandHistories.count {
-            let context = GraphicsContext.createBitmapContext(size: size, scale: scale)
+            let context = GraphicsContext.createBitmapContext(size: size,
+                                                              scale: scale,
+                                                              backgroundColor: color?.cgColor)
             tortoiseCharmer.charm(with: context, toFrame: frameIndex)
             guard let cgImage = context.cgContext.makeImage() else { return false }
 
diff --git a/Tests/TortoiseGraphicsTests/TortoiseGraphicsTests.swift b/Tests/TortoiseGraphicsTests/TortoiseGraphicsTests.swift
@@ -8,6 +8,7 @@ class TortoiseGraphicsTests: XCTestCase {
         let size = CGSize(width: 300, height: 300)
         let scale = NSScreen.main()?.backingScaleFactor ?? 1
         let canvas = ImageCanvas(size: size, scale: scale)
+        canvas.color = .white
 
         canvas.drawing { 🐢 in
             🐢.penColor(.red)
@@ -34,6 +35,7 @@ class TortoiseGraphicsTests: XCTestCase {
         let size = CGSize(width: 300, height: 300)
         let scale = NSScreen.main()?.backingScaleFactor ?? 1
         let canvas = ImageCanvas(size: size, scale: scale)
+        canvas.color = .white
 
         canvas.drawingWithTortoises(count: 2) { tortoises in
             let 🐢 = tortoises[0]
diff --git a/TortoiseGraphics.podspec b/TortoiseGraphics.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'TortoiseGraphics'
-  s.version          = '0.11.0'
+  s.version          = '0.12.0'
   s.summary          = 'A turtle graphics (a key feature of the Logo) engine written in Swift.'
   s.description      = 'A turtle graphics (a key feature of the Logo) engine written in Swift. The commands were implemented with reference to the turtle in Python 3 standard libraries.'
   s.homepage         = 'https://github.com/temoki/TortoiseGraphics'
diff --git a/TortoiseGraphics.xcodeproj/TortoiseGraphics_Info.plist b/TortoiseGraphics.xcodeproj/TortoiseGraphics_Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.11.0</string>
+	<string>0.12.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,13 @@`
`1`		`-// swift-tools-version:3.1`
	`1`	`+// swift-tools-version:4.0.0`
`2`	`2`
`3`	`3`	`import PackageDescription`
`4`	`4`
`5`	`5`	`let package = Package(`
`6`	`6`	`name: "SwiftPM",`
`7`	`7`	`dependencies: [`
`8`		`- .Package(url: "https://github.com/temoki/TortoiseGraphics.git", majorVersion: 0)`
	`8`	`+ .package(url: "https://github.com/temoki/TortoiseGraphics.git", .branch("develop")),`
	`9`	`+ ],`
	`10`	`+ targets: [`
	`11`	`+ .target(name: "SwiftPM", dependencies: ["TortoiseGraphics"], path: "Sources"),`
`9`	`12`	`]`
`10`	`13`	`)`