Move samples out of piet and into local crate

- Cargo manifests have been cleaned up a bit
- `piet` now no longer includes fonts within the crate published, making it smaller
- `piet::Error::InvalidSampleArgs` is removed, which is specific to samples

Author: avitex

.github/workflows/snapshot.yml

@@ -31,7 +31,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --manifest-path=piet-cairo/Cargo.toml --example=test-picture -- --all --out=cairo_samples --compare=./piet/snapshots/cairo
+          args: --bin samples-cairo --features cairo -- --all --out=cairo_samples --compare=./piet-test/snapshots/cairo
         if: contains(matrix.os, 'ubuntu')
 
       - name: upload failures (ubuntu+cairo)
@@ -45,7 +45,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --manifest-path=piet-coregraphics/Cargo.toml --example=test-picture -- --all --out=coregraphics_samples --compare=./piet/snapshots/coregraphics
+          args: --bin samples-coregraphics --features coregraphics -- --all --out=coregraphics_samples --compare=./piet-test/snapshots/coregraphics
         if: contains(matrix.os, 'macOS')
 
       - name: upload failures (macOS)
@@ -59,7 +59,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --manifest-path=piet-direct2d/Cargo.toml --example=test-picture -- --all --out=d2d_samples --compare=./piet/snapshots/d2d
+          args: --bin samples-direct2d --features direct2d -- --all --out=d2d_samples --compare=./piet-test/snapshots/d2d
         if: contains(matrix.os, 'windows')
 
       - name: upload failures (d2d)

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "snapshots"]
-	path = piet/snapshots
+	path = piet-test/snapshots
 	url = https://github.com/linebender/piet-snapshots.git

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Piet uses 'snapshot testing' to verify that changes do not unexpectedly modify
 behaviour. During CI, sample pictures are generated by the various `picture_{}`
-files in `piet`'s [`samples`] module, and the results are compared against
+files in the [`piet-test`] crate, and the results are compared against
 previously generated versions.
 
 The previously generated versions are stored in a separate repository,
@@ -29,6 +29,6 @@ or @raphlinus (or another administrator) to set it up for you.
 `piet-snapshots`. Rebasing would cause the revision to be rewritten, which would
 mean that the commit referenced by the submodule would no longer exist.
 
-[`samples`]: https://github.com/linebender/piet/tree/master/piet/src/samples
+[`piet-test`]: https://github.com/linebender/piet/tree/master/piet-test
 [`piet-snapshots`]: https://github.com/linebender/piet-snapshots
 [persisting workflow data using artifacts]: https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts

Cargo.toml

@@ -16,5 +16,6 @@ default-members = [
     "piet-common",
     "piet-web",
     "piet-web/examples/basic",
-    "piet-svg"
+    "piet-svg",
+    "piet-test"
 ]

piet-cairo/Cargo.toml

@@ -1,27 +1,26 @@
 [package]
 name = "piet-cairo"
 version = "0.5.0"
+edition = "2018"
 authors = ["Raph Levien <[email protected]>"]
 description = "Cairo backend for piet 2D graphics abstraction."
+readme = "../README.md"
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
-readme = "../README.md"
-edition = "2018"
 keywords = ["graphics", "2d"]
 categories = ["rendering::graphics-api"]
 
 [dependencies]
 piet = { version = "=0.5.0", path = "../piet" }
 
+xi-unicode = "0.3.0"
+unicode-segmentation = "1.3.0"
+
 cairo-rs = { version = "0.15.1", default-features = false } # We don't need glib
 pango = { version = "0.15.2", features = ["v1_44"] }
 pangocairo = "0.15.1"
-unicode-segmentation = "1.3.0"
-xi-unicode = "0.3.0"
 
 [dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
-cairo-rs = { version = "0.15.1", default-features = false, features = ["png"] }
 criterion = "0.3"
 
 [[bench]]

piet-common/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "piet-common"
 version = "0.5.0"
+edition = "2018"
 authors = ["Raph Levien <[email protected]>"]
 description = "Selection of a single preferred back-end for piet"
+readme = "README.md"
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
-readme = "README.md"
-edition = "2018"
 keywords = ["graphics", "2d"]
 
 [features]
@@ -35,6 +35,7 @@ serde = ["piet/serde"]
 [dependencies]
 piet = { version = "=0.5.0", path = "../piet" }
 piet-web = { version = "=0.5.0", path = "../piet-web", optional = true }
+
 cfg-if = "1.0"
 png = { version = "0.17", optional = true }
 

piet-coregraphics/Cargo.toml

@@ -1,25 +1,22 @@
 [package]
 name = "piet-coregraphics"
 version = "0.5.0"
+edition = "2018"
 authors = ["Jeff Muizelaar <[email protected]>, Raph Levien <[email protected]>, Colin Rofls <[email protected]>"]
 description = "CoreGraphics backend for piet 2D graphics abstraction."
+readme = "../README.md"
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
-readme = "../README.md"
-edition = "2018"
 keywords = ["graphics", "2d"]
 categories = ["rendering::graphics-api"]
 
 [dependencies]
 piet = { version = "=0.5.0", path = "../piet" }
 
+associative-cache = "1.0"
+
 foreign-types = "0.3.2"
 core-graphics = "0.22.2"
 core-text = "19.0.0"
 core-foundation = "0.9"
 core-foundation-sys = "0.8"
-associative-cache = "1.0"
-
-[dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
-png = "0.17"

piet-direct2d/Cargo.toml

@@ -1,24 +1,21 @@
 [package]
 name = "piet-direct2d"
 version = "0.5.0"
+edition = "2018"
 authors = ["Raph Levien <[email protected]>"]
 description = "Direct2D backend for piet 2D graphics abstraction."
+readme = "../README.md"
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
-readme = "../README.md"
-edition = "2018"
 keywords = ["graphics", "2d"]
 categories = ["rendering::graphics-api"]
 
 [dependencies]
 piet = { version = "=0.5.0", path = "../piet" }
+
 utf16_lit = "2.0"
 associative-cache = "1.0"
 
 wio = "0.2.2"
 winapi = { version = "0.3.8", features = ["d2d1", "d2d1_1", "d2d1effects", "d2dbasetypes", "dcommon", "d3d11", "dxgi", "winnls"] }
 dwrote = { version = "0.11.0", default_features = false }
-
-[dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
-image = "0.24.0"

piet-svg/Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "piet-svg"
 version = "0.5.0"
+edition = "2018"
 authors = ["Benjamin Saunders <[email protected]>"]
 description = "SVG backend for piet 2D graphics abstraction."
-edition = "2018"
+readme = "../README.md"
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
 keywords = ["graphics", "2d"]
@@ -14,13 +15,14 @@ default = []
 evcxr = ["evcxr_runtime"]
 
 [dependencies]
+piet = { version = "=0.5.0", path = "../piet" }
+
+svg = "0.10.0"
 base64 = "0.13.0"
-evcxr_runtime = { version = "1.1.0", optional = true }
 font-kit = "0.10.1"
-image = { version = "0.24.0", default-features = false, features = ["png"] }
-piet = { version = "=0.5.0", path = "../piet" }
 rustybuzz = "0.4.0"
-svg = "0.10.0"
+evcxr_runtime = { version = "1.1.0", optional = true }
+image = { version = "0.24.0", default-features = false, features = ["png"] }
 
 [dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
+piet-test = { path = "../piet-test" }

piet-svg/examples/basic-svg.rs

@@ -2,7 +2,8 @@
 
 use std::io;
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
+use piet_test::samples;
 
 fn main() {
     let test_picture_number = std::env::args()

piet-test/Cargo.toml

@@ -0,0 +1,36 @@
+[package]
+name = "piet-test"
+version = "0.0.0"
+edition = "2018"
+publish = false
+
+[[bin]]
+name = "samples-cairo"
+required-features = ["cairo"]
+
+[[bin]]
+name = "samples-direct2d"
+required-features = ["direct2d"]
+
+[[bin]]
+name = "samples-coregraphics"
+required-features = ["coregraphics"]
+
+[features]
+cairo = ["piet-cairo", "cairo-rs"]
+direct2d = ["piet-direct2d", "winapi"]
+coregraphics = ["piet-coregraphics", "core-graphics"]
+
+[dependencies]
+piet = { path = "../piet" }
+piet-cairo = { path = "../piet-cairo", optional = true }
+piet-direct2d = { path = "../piet-direct2d", optional = true }
+piet-coregraphics = { path = "../piet-coregraphics", optional = true }
+
+png = "0.17"
+pico-args = "0.4.0"
+os_info = { version = "3.0.0", default-features = false }
+
+core-graphics = { version = "0.22.2", optional = true }
+winapi = { version = "0.3.8", features = ["dxgi"], optional = true  }
+cairo-rs = { version = "0.15.1", default-features = false, features = ["png"], optional = true }

piet-test/README.md

@@ -0,0 +1,3 @@
+# piet-test: Sample images and common tests
+
+See [CONTRIBUTING.md](../CONTRIBUTING.md) on instructions on updating the reference snapshots.

piet-test/snapshots

@@ -6,15 +6,16 @@ use std::process::Command;
 
 use cairo::{Context, Format, ImageSurface};
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_cairo::CairoRenderContext;
+use piet_test::samples;
 
 const HIDPI: f64 = 2.0;
 const FILE_PREFIX: &str = "cairo-test-";
 
 fn main() {
     let sys_info = additional_system_info();
-    samples::samples_main(run_sample, FILE_PREFIX, Some(&sys_info));
+    samples::samples_main("samples-cairo", run_sample, FILE_PREFIX, Some(&sys_info));
 }
 
 fn run_sample(idx: usize, base_dir: &Path) -> Result<(), Box<dyn std::error::Error>> {

piet-cairo/examples/test-picture.rs renamed to piet-test/src/bin/samples-cairo.rs

@@ -8,14 +8,15 @@ use core_graphics::color_space::CGColorSpace;
 use core_graphics::context::CGContext;
 
 use piet::kurbo::Size;
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_coregraphics::CoreGraphicsContext;
+use piet_test::samples;
 
 const SCALE: f64 = 2.0;
 const FILE_PREFIX: &str = "coregraphics-test-";
 
 fn main() {
-    samples::samples_main(run_sample, FILE_PREFIX, None);
+    samples::samples_main("samples-coregraphics", run_sample, FILE_PREFIX, None);
 }
 
 fn run_sample(idx: usize, base_dir: &Path) -> Result<(), Box<dyn std::error::Error>> {

piet-coregraphics/examples/test-picture.rs renamed to piet-test/src/bin/samples-coregraphics.rs

@@ -4,14 +4,15 @@ use std::path::Path;
 
 use winapi::shared::dxgi::DXGI_MAP_READ;
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_direct2d::{D2DRenderContext, D2DText};
+use piet_test::samples;
 
 const HIDPI: f32 = 2.0;
 const FILE_PREFIX: &str = "d2d-test-";
 
 fn main() {
-    samples::samples_main(run_sample, FILE_PREFIX, None);
+    samples::samples_main("samples-direct2d", run_sample, FILE_PREFIX, None);
 }
 
 fn run_sample(number: usize, base_dir: &Path) -> Result<(), Box<dyn std::error::Error>> {

piet-direct2d/examples/test-picture.rs renamed to piet-test/src/bin/samples-direct2d.rs

@@ -0,0 +1 @@
+pub mod samples;

piet-test/src/lib.rs

@@ -7,8 +7,8 @@ use std::fs::File;
 use std::io::BufWriter;
 use std::path::{Path, PathBuf};
 
-use crate::kurbo::Size;
-use crate::{Error, RenderContext};
+use piet::kurbo::Size;
+use piet::{Error, RenderContext};
 
 mod picture_0;
 mod picture_1;
@@ -85,6 +85,7 @@ struct Args {
 ///   testing environment, such as the versions of various dependencies; this
 ///   will be appended to the GENERATED_BY file.
 pub fn samples_main(
+    binary: &str,
     f: fn(usize, &Path) -> Result<(), BoxErr>,
     prefix: &str,
     env_info: Option<&str>,
@@ -94,7 +95,7 @@ pub fn samples_main(
 
         if args.help {
             eprintln!("Piet Sample Image Generator\n");
-            print_help_text();
+            print_help_text(binary);
             std::process::exit(1);
         }
 
@@ -144,7 +145,7 @@ pub fn samples_main(
             eprintln!("caused by: {}", err);
             e = err;
         }
-        print_help_text();
+        print_help_text(binary);
         std::process::exit(1);
     } else {
         std::process::exit(0);
@@ -181,7 +182,7 @@ impl Args {
         };
 
         if !(args.help || args.all || args.number.is_some() || args.compare_dir.is_some()) {
-            Err(Box::new(Error::InvalidSampleArgs))
+            Err("Must pass either --all or a number".into())
         } else {
             Ok(args)
         }
@@ -411,16 +412,16 @@ impl std::fmt::Display for FailureReason {
     }
 }
 
-fn print_help_text() {
+fn print_help_text(binary: &str) {
     eprintln!(
         "Options:
 
-$ ./test_picture {{<number> | --all}} [--out=<dir>] [--compare=<dir>] [--help]
+$ ./{binary} {{<number> | --all}} [--out=<dir>] [--compare=<dir>] [--help]
 
 Required Args
     --all | <number> If 'all', generate all the example pictures. If a number,
                      then generate that number picture (number must be between
-                     0 and {}
+                     0 and {sample_idx_max}
 
 Optional Args
     --out=<dir>      Save the results to the directory 'dir'. Defaults to the
@@ -432,6 +433,7 @@ Optional Args
 Flags
     --help           Print this help message and exit.
     ",
-        SAMPLE_COUNT - 1
+        binary = binary,
+        sample_idx_max = SAMPLE_COUNT - 1
     );
 }

piet/src/samples/mod.rs renamed to piet-test/src/samples/mod.rs

@@ -1,7 +1,7 @@
 //! A wide assortment of graphics meant to show off many different uses of piet
 
-use crate::kurbo::{Affine, BezPath, Line, Point, Rect, RoundedRect, Size, Vec2};
-use crate::{
+use piet::kurbo::{Affine, BezPath, Line, Point, Rect, RoundedRect, Size, Vec2};
+use piet::{
     Color, Error, FontFamily, ImageFormat, InterpolationMode, RenderContext, Text, TextAttribute,
     TextLayout, TextLayoutBuilder,
 };