Reorganize and rename package targets (SwiftDocOrg#15)

* Reorganize and rename package targets * Fix dependencies of GraphVizTests * Update example usage in README * Add changelog entry for SwiftDocOrg#15
Vithanco · Mar 29, 2021 · 7bf6708 · 7bf6708
1 parent 6d438e6
commit 7bf6708
Show file tree

Hide file tree

Showing 42 changed files with 42 additions and 43 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Changed renderer to use `libgraphviz` instead of spawning separate processes.
   #13 by @mattt.
+- Changed package to produce a single library named `GraphViz` so that
+  `Dot`, `Tools`, and `GraphVizBuilder` need not be imported separately anymore.
+  #15 by @mattt.
 
 ## [0.2.0] - 2020-11-17
 

diff --git a/Package.swift b/Package.swift
@@ -9,10 +9,7 @@ let package = Package(
         // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "GraphViz",
-            targets: ["GraphViz", "DOT", "Tools"]),
-        .library(
-            name: "GraphVizBuilder",
-            targets: ["GraphVizBuilder"]),
+            targets: ["GraphViz"]),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -25,21 +22,21 @@ let package = Package(
         ]),
         .target(
             name: "GraphViz",
+            dependencies: ["Core", "DOT", "Builder", "Tools"]),
+        .target(
+            name: "Core",
             dependencies: []),
         .target(
             name: "DOT",
-            dependencies: ["GraphViz"]),
+            dependencies: ["Core"]),
         .target(
-            name: "Tools",
-            dependencies: ["GraphViz", "DOT", "Clibgraphviz"]),
+            name: "Builder",
+            dependencies: ["Core"]),
         .target(
-            name: "GraphVizBuilder",
-            dependencies: ["GraphViz"]),
+            name: "Tools",
+            dependencies: ["Core", "DOT", "Clibgraphviz"]),
         .testTarget(
             name: "GraphVizTests",
-            dependencies: ["GraphViz", "DOT", "Tools"]),
-        .testTarget(
-            name: "GraphVizBuilderTests",
-            dependencies: ["GraphViz", "DOT", "GraphVizBuilder"]),
+            dependencies: ["Core", "DOT", "Builder", "Tools"]),
     ]
 )
diff --git a/README.md b/README.md
@@ -14,7 +14,6 @@ A Swift package for working with [GraphViz][graphviz].
 
 ```swift
 import GraphViz
-import DOT
 
 var graph = Graph(directed: true)
 
@@ -49,12 +48,8 @@ digraph {
 
 ### Using Function Builders, Custom Operators, and Fluent Attribute Setters
 
-To use the following interface,
-add "GraphVizBuilder" to your package's dependencies
-and replace `import GraphViz` with `import GraphVizBuilder` as needed.
-
 ```swift
-import GraphVizBuilder
+import GraphViz
 
 let graph = Graph(directed: true) {
     "a" --> "b"

diff --git a/...zBuilder/Extensions/Edge+Extensions.swift → .../Builder/Extensions/Edge+Extensions.swift b/...zBuilder/Extensions/Edge+Extensions.swift → .../Builder/Extensions/Edge+Extensions.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 extension Edge {
     public subscript<T>(dynamicMember member: WritableKeyPath<Attributes, T>) -> (T) -> Self {

diff --git a/...Builder/Extensions/Graph+Extensions.swift → ...Builder/Extensions/Graph+Extensions.swift b/...Builder/Extensions/Graph+Extensions.swift → ...Builder/Extensions/Graph+Extensions.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 extension Graph {
     typealias Fragment = GraphBuilder.Fragment

diff --git a/...zBuilder/Extensions/Node+Extensions.swift → .../Builder/Extensions/Node+Extensions.swift b/...zBuilder/Extensions/Node+Extensions.swift → .../Builder/Extensions/Node+Extensions.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 extension Node {
     public subscript<T>(dynamicMember member: WritableKeyPath<Attributes, T>) -> (T) -> Self {

diff --git a/...lder/Extensions/Subgraph+Extensions.swift → ...lder/Extensions/Subgraph+Extensions.swift b/...lder/Extensions/Subgraph+Extensions.swift → ...lder/Extensions/Subgraph+Extensions.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 extension Subgraph {
     typealias Fragment = SubgraphBuilder.Fragment

diff --git a/Sources/GraphVizBuilder/GraphBuilder.swift → Sources/Builder/GraphBuilder.swift b/Sources/GraphVizBuilder/GraphBuilder.swift → Sources/Builder/GraphBuilder.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 public protocol GraphMember {}
 

diff --git a/...lder/Operators/BackwardEdgeOperator.swift → ...lder/Operators/BackwardEdgeOperator.swift b/...lder/Operators/BackwardEdgeOperator.swift → ...lder/Operators/BackwardEdgeOperator.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 infix operator <-- : AdditionPrecedence
 

diff --git a/...Operators/BidirectionalEdgeOperator.swift → ...Operators/BidirectionalEdgeOperator.swift b/...Operators/BidirectionalEdgeOperator.swift → ...Operators/BidirectionalEdgeOperator.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 infix operator <-> : AdditionPrecedence
 

diff --git a/...ilder/Operators/ForwardEdgeOperator.swift → ...ilder/Operators/ForwardEdgeOperator.swift b/...ilder/Operators/ForwardEdgeOperator.swift → ...ilder/Operators/ForwardEdgeOperator.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 infix operator --> : AdditionPrecedence
 

diff --git a/...er/Operators/UndirectedEdgeOperator.swift → ...er/Operators/UndirectedEdgeOperator.swift b/...er/Operators/UndirectedEdgeOperator.swift → ...er/Operators/UndirectedEdgeOperator.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 infix operator --- : AdditionPrecedence
 

diff --git a/...ces/GraphVizBuilder/SubgraphBuilder.swift → Sources/Builder/SubgraphBuilder.swift b/...ces/GraphVizBuilder/SubgraphBuilder.swift → Sources/Builder/SubgraphBuilder.swift
@@ -1,4 +1,4 @@
-import GraphViz
+import Core
 
 public protocol SubgraphMember {}
 

diff --git a/Sources/GraphViz/Attribute.swift → Sources/Core/Attribute.swift b/Sources/GraphViz/Attribute.swift → Sources/Core/Attribute.swift
diff --git a/Sources/GraphViz/Edge.swift → Sources/Core/Edge.swift b/Sources/GraphViz/Edge.swift → Sources/Core/Edge.swift
diff --git a/...Extensions/KeyValuePairs+Extensions.swift → ...Extensions/KeyValuePairs+Extensions.swift b/...Extensions/KeyValuePairs+Extensions.swift → ...Extensions/KeyValuePairs+Extensions.swift
diff --git a/Sources/GraphViz/Graph.swift → Sources/Core/Graph.swift b/Sources/GraphViz/Graph.swift → Sources/Core/Graph.swift
diff --git a/Sources/GraphViz/Node.swift → Sources/Core/Node.swift b/Sources/GraphViz/Node.swift → Sources/Core/Node.swift
diff --git a/Sources/GraphViz/Rendering/Format.swift → Sources/Core/Rendering/Format.swift b/Sources/GraphViz/Rendering/Format.swift → Sources/Core/Rendering/Format.swift
diff --git a/.../GraphViz/Rendering/LayoutAlgorithm.swift → Sources/Core/Rendering/LayoutAlgorithm.swift b/.../GraphViz/Rendering/LayoutAlgorithm.swift → Sources/Core/Rendering/LayoutAlgorithm.swift
diff --git a/Sources/GraphViz/Subgraph.swift → Sources/Core/Subgraph.swift b/Sources/GraphViz/Subgraph.swift → Sources/Core/Subgraph.swift
diff --git a/...aphViz/Supporting Types/AspectRatio.swift → ...s/Core/Supporting Types/AspectRatio.swift b/...aphViz/Supporting Types/AspectRatio.swift → ...s/Core/Supporting Types/AspectRatio.swift
diff --git a/...ces/GraphViz/Supporting Types/Color.swift → Sources/Core/Supporting Types/Color.swift b/...ces/GraphViz/Supporting Types/Color.swift → Sources/Core/Supporting Types/Color.swift
diff --git a/.../GraphViz/Supporting Types/Location.swift → Sources/Core/Supporting Types/Location.swift b/.../GraphViz/Supporting Types/Location.swift → Sources/Core/Supporting Types/Location.swift
diff --git a/.../GraphViz/Supporting Types/Ordering.swift → Sources/Core/Supporting Types/Ordering.swift b/.../GraphViz/Supporting Types/Ordering.swift → Sources/Core/Supporting Types/Ordering.swift
diff --git a/...ces/GraphViz/Supporting Types/Point.swift → Sources/Core/Supporting Types/Point.swift b/...ces/GraphViz/Supporting Types/Point.swift → Sources/Core/Supporting Types/Point.swift
diff --git a/.../GraphViz/Supporting Types/Position.swift → Sources/Core/Supporting Types/Position.swift b/.../GraphViz/Supporting Types/Position.swift → Sources/Core/Supporting Types/Position.swift
diff --git a/...GraphViz/Supporting Types/Rectangle.swift → ...ces/Core/Supporting Types/Rectangle.swift b/...GraphViz/Supporting Types/Rectangle.swift → ...ces/Core/Supporting Types/Rectangle.swift
diff --git a/Sources/GraphViz/Supporting Types/Size.swift → Sources/Core/Supporting Types/Size.swift b/Sources/GraphViz/Supporting Types/Size.swift → Sources/Core/Supporting Types/Size.swift
diff --git a/Sources/DOT/DOTEncoder.swift b/Sources/DOT/DOTEncoder.swift
@@ -1,4 +1,4 @@
-@_exported import GraphViz
+import Core
 
 /// Creates DOT language representations of GraphViz graphs.
 ///

diff --git a/Sources/DOT/DOTRepresentable.swift b/Sources/DOT/DOTRepresentable.swift
@@ -1,5 +1,5 @@
-import GraphViz
 import Foundation
+import Core
 
 protocol DOTRepresentable {
     func representation(in graph: Graph) -> String?

diff --git a/Sources/GraphViz/Graphviz.swift b/Sources/GraphViz/Graphviz.swift
@@ -0,0 +1,4 @@
+@_exported import Core
+@_exported import DOT
+@_exported import Builder
+@_exported import Tools
diff --git a/Sources/Tools/Extensions/Graph+Rendering.swift b/Sources/Tools/Extensions/Graph+Rendering.swift
@@ -1,5 +1,5 @@
 import Foundation
-import GraphViz
+import Core
 
 extension Graph {
     /**

diff --git a/Sources/Tools/Renderer.swift b/Sources/Tools/Renderer.swift
@@ -1,5 +1,5 @@
 import Foundation
-import GraphViz
+import Core
 import DOT
 import Clibgraphviz
 

diff --git a/Tests/GraphVizTests/AttributesTest.swift b/Tests/GraphVizTests/AttributesTest.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import GraphViz
+@testable import Core
 
 final class AttributesTests: XCTestCase {
     func testGraphAttributesCompleteness() {

diff --git a/Tests/GraphVizTests/EdgeTests.swift b/Tests/GraphVizTests/EdgeTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-import GraphViz
+import Core
 @testable import DOT
 
 final class EdgeTests: XCTestCase {

diff --git a/...phVizBuilderTests/GraphBuilderTests.swift → Tests/GraphVizTests/GraphBuilderTests.swift b/...phVizBuilderTests/GraphBuilderTests.swift → Tests/GraphVizTests/GraphBuilderTests.swift
@@ -1,7 +1,7 @@
 import XCTest
-import GraphViz
+import Core
 import DOT
-@testable import GraphVizBuilder
+@testable import Builder
 
 // Workaround for "error: ambiguous reference to member '-->'" on Swift 5.1
 #if swift(>=5.2)

diff --git a/Tests/GraphVizTests/GraphTests.swift b/Tests/GraphVizTests/GraphTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-import GraphViz
+import Core
 import DOT
 
 final class GraphTests: XCTestCase {

diff --git a/Tests/GraphVizTests/NodeTests.swift b/Tests/GraphVizTests/NodeTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-import GraphViz
+import Core
 @testable import DOT
 
 final class NodeTests: XCTestCase {

diff --git a/Tests/GraphVizTests/RenderingTests.swift b/Tests/GraphVizTests/RenderingTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import GraphViz
+@testable import Core
 @testable import DOT
 @testable import Tools
 

diff --git a/...izBuilderTests/SubgraphBuilderTests.swift → .../GraphVizTests/SubgraphBuilderTests.swift b/...izBuilderTests/SubgraphBuilderTests.swift → .../GraphVizTests/SubgraphBuilderTests.swift
@@ -1,7 +1,7 @@
 import XCTest
-import GraphViz
+import Core
 @testable import DOT
-@testable import GraphVizBuilder
+@testable import Builder
 
 // Workaround for "error: ambiguous reference to member '-->'" on Swift 5.1
 #if swift(>=5.2)

diff --git a/Tests/GraphVizTests/SubgraphTests.swift b/Tests/GraphVizTests/SubgraphTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-import GraphViz
+import Core
 @testable import DOT
 
 final class SubgraphTests: XCTestCase {