Refactor demo into individual examples and update gallery (#179)

Demo gallery has been updated to show example thumbnail and source code.
Examples have been split to be separately in `examples/` directory, with
metadata provided by `PlotExample` trait that are consumed by the demo
gallery.

Author: michalsustr

.github/workflows/rust.yml

@@ -137,10 +137,10 @@ jobs:
         uses: Swatinem/rust-cache@v2
 
       - name: Run tests
-        run: cargo test --all-features
+        run: RUST_BACKTRACE=1 cargo test --all-features
 
       - name: Run doc-tests
-        run: cargo test --all-features --doc
+        run: RUST_BACKTRACE=1 cargo test --all-features --doc
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4

CONTRIBUTING.md

@@ -121,3 +121,9 @@ let Some(first) = vec.first() else {
     return;
 };
 ```
+
+### Example Screenshots
+
+- Each crate under `examples/` has a  screenshot test generated by the `examples_utils::make_main!` macro.
+- Update a screenshot locally with `UPDATE_SNAPSHOTS=1 cargo test -p <example_name>`.
+- The refreshed image is written to `examples/<example_name>/screenshot.png`; `.diff.png` / `.new.png` helpers stay untracked for local review.

Cargo.lock

@@ -588,6 +588,17 @@ dependencies = [
  "eframe",
  "egui_plot",
  "env_logger",
+ "examples_utils",
+]
+
+[[package]]
+name = "box_plot"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
 ]
 
 [[package]]
@@ -855,26 +866,51 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f27ae1dd37df86211c42e150270f82743308803d90a6f6e6651cd730d5e1732f"
 
+[[package]]
+name = "custom_axes"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "custom_plot_manipulation"
 version = "0.1.0"
 dependencies = [
  "eframe",
  "egui_plot",
  "env_logger",
+ "examples_utils",
 ]
 
 [[package]]
 name = "demo"
 version = "0.34.0"
 dependencies = [
+ "borrow_points",
+ "box_plot",
+ "custom_axes",
+ "custom_plot_manipulation",
  "eframe",
  "egui",
- "egui_kittest",
- "egui_plot",
+ "egui_chip",
  "env_logger",
+ "examples_utils",
+ "histogram",
+ "image",
+ "interaction",
+ "items",
+ "legend",
+ "legend_sort",
+ "lines",
+ "linked_axes",
  "log",
- "serde",
+ "markers",
+ "save_plot",
+ "stacked_bar",
  "wasm-bindgen-futures",
  "web-sys",
 ]
@@ -1065,6 +1101,18 @@ dependencies = [
  "winit",
 ]
 
+[[package]]
+name = "egui_chip"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17e35f20a867cf197c0ccbd0618aa54808ac882173d9ffac7950199e0d5445af"
+dependencies = [
+ "egui",
+ "serde",
+ "wasm-bindgen-futures",
+ "web-sys",
+]
+
 [[package]]
 name = "egui_glow"
 version = "0.33.0"
@@ -1255,6 +1303,15 @@ dependencies = [
  "pin-project-lite",
 ]
 
+[[package]]
+name = "examples_utils"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui",
+ "egui_kittest",
+]
+
 [[package]]
 name = "fastrand"
 version = "2.3.0"
@@ -1639,6 +1696,16 @@ version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "dfa686283ad6dd069f105e5ab091b04c62850d3e4cf5d67debad1933f55023df"
 
+[[package]]
+name = "histogram"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "home"
 version = "0.5.11"
@@ -1779,6 +1846,16 @@ dependencies = [
  "hashbrown 0.15.5",
 ]
 
+[[package]]
+name = "interaction"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "is-docker"
 version = "0.2.0"
@@ -1804,6 +1881,16 @@ version = "1.70.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
 
+[[package]]
+name = "items"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "jiff"
 version = "0.2.15"
@@ -1904,13 +1991,24 @@ version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
+[[package]]
+name = "legend"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "legend_sort"
 version = "0.1.0"
 dependencies = [
  "eframe",
  "egui_plot",
  "env_logger",
+ "examples_utils",
 ]
 
 [[package]]
@@ -1946,6 +2044,26 @@ dependencies = [
  "redox_syscall 0.5.17",
 ]
 
+[[package]]
+name = "lines"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
+[[package]]
+name = "linked_axes"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "linux-raw-sys"
 version = "0.4.15"
@@ -1994,6 +2112,16 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "markers"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "memchr"
 version = "2.7.5"
@@ -2924,6 +3052,7 @@ dependencies = [
  "eframe",
  "egui_plot",
  "env_logger",
+ "examples_utils",
  "image",
  "rfd",
 ]
@@ -3096,6 +3225,16 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3"
 
+[[package]]
+name = "stacked_bar"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "static_assertions"
 version = "1.1.0"

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["egui_plot", "demo", "examples/*"]
+members = ["egui_plot", "demo", "examples/*", "examples_utils"]
 
 
 [workspace.package]
@@ -20,6 +20,22 @@ opt-level = 2
 
 [workspace.dependencies]
 egui_plot = { version = "0.34.0", path = "egui_plot", default-features = false }
+examples_utils = { version = "0.1.0", path = "examples_utils" }
+
+borrow_points = { version = "0.1.0", path = "examples/borrow_points" }
+box_plot = { version = "0.1.0", path = "examples/box_plot" }
+custom_axes = { version = "0.1.0", path = "examples/custom_axes" }
+custom_plot_manipulation = { version = "0.1.0", path = "examples/custom_plot_manipulation" }
+histogram = { version = "0.1.0", path = "examples/histogram" }
+interaction = { version = "0.1.0", path = "examples/interaction" }
+items = { version = "0.1.0", path = "examples/items" }
+legend = { version = "0.1.0", path = "examples/legend" }
+legend_sort = { version = "0.1.0", path = "examples/legend_sort" }
+lines = { version = "0.1.0", path = "examples/lines" }
+linked_axes = { version = "0.1.0", path = "examples/linked_axes" }
+markers = { version = "0.1.0", path = "examples/markers" }
+save_plot = { version = "0.1.0", path = "examples/save_plot" }
+stacked_bar = { version = "0.1.0", path = "examples/stacked_bar" }
 
 ahash = { version = "0.8.11", default-features = false, features = [
     "no-rng", # we don't need DOS-protection, so we let users opt-in to it instead

Makefile

@@ -2,7 +2,7 @@
 THREADS ?= $(shell nproc)
 BROWSER ?= firefox
 TRUNK_OPTS ?=
-CARGO_OPTS ?= --verbose -j $(THREADS)
+CARGO_OPTS ?= -j $(THREADS)
 
 export RUST_LOG ?= debug
 export CARGO_TERM_COLOR ?= always
@@ -25,6 +25,7 @@ CARGO_TOOLS = \
 	[email protected] \
 	[email protected] \
 	[email protected] \
+	[email protected] \
 	[email protected] \
 	[email protected]
 
@@ -61,6 +62,7 @@ dry_push: check_branch_name \
 		build \
 		run_checks \
 		test \
+		trunk \
 		check_git_clean_status
 	echo "All checks passed, ready to push."
 
@@ -79,7 +81,6 @@ build_linux:
 build_wasm:
 	cargo build -p egui_plot -p demo --all-features --lib --tests --bins --examples --target $(TARGET_WASM) $(CARGO_OPTS) $(BUILD_PROFILE)
 
-# Builds the frontend using trunk.
 trunk:
 	trunk build $(TRUNK_OPTS)
 
@@ -116,6 +117,8 @@ run_checks: check_no_commented_out_code \
 			check_license \
 			check_cycles \
 			checks_no_unfinished \
+			check_shear \
+			check_deny \
 			check_pub_change_intentional
 
 # Performs a compilation check of all crates in the workspace, without building.
@@ -133,9 +136,9 @@ check_newlines:
 # Runs clippy on all crates in the workspace.
 check_clippy: check_clippy_linux check_clippy_wasm
 check_clippy_linux:
-	cargo clippy --workspace --no-deps --examples --target $(TARGET_LINUX) -j $(THREADS) $(BUILD_PROFILE) -- -D warnings
+	cargo clippy --workspace --no-deps --examples --lib --target $(TARGET_LINUX) -j $(THREADS) $(BUILD_PROFILE) -- -D warnings
 check_clippy_wasm:
-	cargo clippy -p demo -p egui_plot --no-deps --examples --target $(TARGET_WASM) -j $(THREADS) $(BUILD_PROFILE) -- -D warnings
+	cargo clippy -p demo -p egui_plot --no-deps --examples --lib --target $(TARGET_WASM) -j $(THREADS) $(BUILD_PROFILE) -- -D warnings
 check_clippy_docs: check_clippy_docs_linux check_clippy_docs_wasm
 check_clippy_docs_linux:
 	cargo clippy --workspace --no-deps --message-format=short --target $(TARGET_LINUX) -j $(THREADS) $(BUILD_PROFILE) -- -D missing-docs 2>&1 | grep -P 'mod.rs|lib.rs' | grep -vP 'crate|module' && exit 1 || exit 0
@@ -148,7 +151,7 @@ check_license:
 
 # Checks for dependency cycles between modules.
 check_cycles:
-	cargo-cycles --verbose
+	cargo-cycles
 
 check_pub_change_intentional:
 	if [ "$$(cargo public-api diff latest -p egui_plot -sss --deny all)" != "" ]; then \
@@ -200,6 +203,12 @@ check_no_commented_out_code:
 	# There should not be commented out code
 	git ls-files | grep -P '\.rs$$' | xargs grep -Pi '^\s*//(?!/|\!)\S' || exit 0; exit 1
 
+check_shear:
+	cargo shear
+
+check_deny:
+	cargo deny check
+
 clean:
 	cargo clean
 	trunk clean