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: --manifest-path=piet-cairo/Cargo.toml --example=test-picture -- --all --out=cairo_samples --compare=./samples/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: --manifest-path=piet-coregraphics/Cargo.toml --example=test-picture -- --all --out=coregraphics_samples --compare=./samples/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: --manifest-path=piet-direct2d/Cargo.toml --example=test-picture -- --all --out=d2d_samples --compare=./samples/snapshots/d2d
         if: contains(matrix.os, 'windows')
 
       - name: upload failures (d2d)

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "snapshots"]
-	path = piet/snapshots
+	path = samples/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 [`samples`] library, 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
+[`samples`]: https://github.com/linebender/piet/tree/master/samples
 [`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",
+    "samples"
 ]

piet-cairo/Cargo.toml

@@ -1,12 +1,12 @@
 [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"]
 
@@ -20,7 +20,7 @@ unicode-segmentation = "1.3.0"
 xi-unicode = "0.3.0"
 
 [dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
+samples = { path = "../samples" }
 cairo-rs = { version = "0.15.1", default-features = false, features = ["png"] }
 criterion = "0.3"
 

piet-cairo/examples/test-picture.rs

@@ -6,7 +6,7 @@ use std::process::Command;
 
 use cairo::{Context, Format, ImageSurface};
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_cairo::CairoRenderContext;
 
 const HIDPI: f64 = 2.0;

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,12 +1,12 @@
 [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"]
 
@@ -21,5 +21,5 @@ core-foundation-sys = "0.8"
 associative-cache = "1.0"
 
 [dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
 png = "0.17"
+samples = { path = "../samples" }

piet-coregraphics/examples/test-picture.rs

@@ -8,7 +8,7 @@ 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;
 
 const SCALE: f64 = 2.0;

piet-direct2d/Cargo.toml

@@ -1,17 +1,18 @@
 [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"
 
@@ -20,5 +21,5 @@ winapi = { version = "0.3.8", features = ["d2d1", "d2d1_1", "d2d1effects", "d2db
 dwrote = { version = "0.11.0", default_features = false }
 
 [dev-dependencies]
-piet = { version = "=0.5.0", path = "../piet", features = ["samples"] }
 image = "0.24.0"
+samples = { path = "../samples" }

piet-direct2d/examples/test-picture.rs

@@ -4,7 +4,7 @@ use std::path::Path;
 
 use winapi::shared::dxgi::DXGI_MAP_READ;
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_direct2d::{D2DRenderContext, D2DText};
 
 const HIDPI: f32 = 2.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"] }
+samples = { path = "../samples" }

piet-svg/examples/basic-svg.rs

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

piet-web/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "piet-web"
 version = "0.5.0"
+edition = "2018"
 authors = ["Raph Levien <[email protected]>"]
 description = "Web canvas backend for piet 2D graphics abstraction."
 license = "MIT/Apache-2.0"
 repository = "https://github.com/linebender/piet"
 readme = "../README.md"
-edition = "2018"
 keywords = ["graphics", "2d"]
 categories = ["rendering::graphics-api", "wasm"]
 

piet-web/examples/basic/Cargo.toml

@@ -11,12 +11,21 @@ crate-type = ["cdylib"]
 default = ["console_error_panic_hook"]
 
 [dependencies]
-piet = { path = "../../../piet", features = ["samples"] }
+piet = { path = "../../../piet" }
 piet-web = { path = "../.." }
+samples = { path = "../../../samples" }
 
 wasm-bindgen = "0.2.30"
 console_error_panic_hook = { version = "0.1.6", optional = true }
 
 [dependencies.web-sys]
 version = "0.3.10"
-features = ["console", "CanvasRenderingContext2d", "Window", "Document", "Element", "HtmlElement", "HtmlCanvasElement"]
+features = [
+    "console",
+    "CanvasRenderingContext2d",
+    "Window",
+    "Document",
+    "Element",
+    "HtmlElement",
+    "HtmlCanvasElement"
+]

piet-web/examples/basic/src/lib.rs

@@ -4,7 +4,7 @@ use wasm_bindgen::prelude::*;
 use wasm_bindgen::JsCast;
 use web_sys::{window, HtmlCanvasElement};
 
-use piet::{samples, RenderContext};
+use piet::RenderContext;
 use piet_web::WebRenderContext;
 
 //TODO: figure out how to dynamically select the sample?

piet/Cargo.toml

@@ -1,26 +1,22 @@
 [package]
 name = "piet"
+edition = "2018"
 version = "0.5.0"
 authors = ["Raph Levien <[email protected]>"]
 description = "An abstraction for 2D graphics."
+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"]
-include = ["src/**/*", "Cargo.toml", "snapshots/resources/*"]
+include = ["src/**/*", "Cargo.toml"]
 
 [dependencies]
 image = { version = "0.24.0", optional = true, default-features = false }
 kurbo = "0.8.2"
-pico-args = { version = "0.4.0", optional = true }
-png = { version = "0.17", optional = true }
-os_info = { version = "3.0.0", optional = true, default-features = false }
 unic-bidi = "0.9"
 
 [features]
-samples = ["pico-args", "png", "os_info"]
 
 # passing on all the image features. AVIF is not supported because it does not
 # support decoding, and thats al we use `Image` for.

piet/snapshots

@@ -22,9 +22,6 @@ pub enum Error {
     MissingFont,
     /// Font data could not be loaded.
     FontLoadingFailed,
-    /// The arguments provided to the CLI were invalid.
-    #[cfg(feature = "samples")]
-    InvalidSampleArgs,
 }
 
 impl fmt::Display for Error {
@@ -44,8 +41,6 @@ impl fmt::Display for Error {
                 write!(f, "Backend error: ")?;
                 e.fmt(f)
             }
-            #[cfg(feature = "samples")]
-            Error::InvalidSampleArgs => write!(f, "Must pass either --all or a number"),
         }
     }
 }

piet/src/error.rs

@@ -40,9 +40,6 @@ mod render_context;
 mod shapes;
 mod text;
 
-#[cfg(feature = "samples")]
-pub mod samples;
-
 pub use crate::color::*;
 pub use crate::conv::*;
 pub use crate::error::*;

piet/src/lib.rs

@@ -0,0 +1,12 @@
+[package]
+name = "samples"
+version = "0.0.0"
+edition = "2018"
+publish = false
+
+[dependencies]
+piet = { path = "../piet" }
+
+png = "0.17"
+pico-args = "0.4.0"
+os_info = { version = "3.0.0", default-features = false }

samples/Cargo.toml

@@ -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;
@@ -181,7 +181,7 @@ impl Args {
         };
 
         if !(args.help || args.all || args.number.is_some() || args.compare_dir.is_some()) {
-            Err(Box::new(Error::InvalidSampleArgs))
+            Err("invalid sample args".into())
         } else {
             Ok(args)
         }

samples/snapshots

@@ -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,
 };

piet/src/samples/mod.rs renamed to samples/src/lib.rs

@@ -1,7 +1,7 @@
 //! Rendering a cubic Bézier curve with its control points and handles
 
-use crate::kurbo::{BezPath, Line, Point, Size};
-use crate::{Color, Error, RenderContext};
+use piet::kurbo::{BezPath, Line, Point, Size};
+use piet::{Color, Error, RenderContext};
 
 pub const SIZE: Size = Size::new(400., 200.);
 

piet/src/samples/picture_0.rs renamed to samples/src/picture_0.rs

@@ -1,7 +1,7 @@
 //! Show the relationship between the layout rect and the inking/image rect.
 
-use crate::kurbo::{Size, Vec2};
-use crate::{Color, Error, RenderContext, Text, TextAttribute, TextLayout, TextLayoutBuilder};
+use piet::kurbo::{Size, Vec2};
+use piet::{Color, Error, RenderContext, Text, TextAttribute, TextLayout, TextLayoutBuilder};
 
 pub const SIZE: Size = Size::new(400., 400.);