release: 0.2.1

Author: joshstoik1

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+
+
+## [0.2.1](https://github.com/Blobfolio/brunch/releases/tag/v0.2.1) - 2021-12-02
+
+### Added
+
+- A demo benchmark (`fn_fib`).
+
+### Changed
+
+- The list passed to the `brunch::benches!` macro may now include a trailing comma.
+
+
+
 ## [0.2.0](https://github.com/Blobfolio/brunch/releases/tag/v0.2.0) - 2021-10-21
 
 ### Added

CREDITS.md

@@ -4,19 +4,15 @@ License details for project dependencies are listed below.
 
 ## Overview of Licenses:
 
-* Apache License 2.0 (2)
+* Apache License 2.0 (3)
 * Do What The F*ck You Want To Public License (1)
-
-
 ## Complete Licenses:
 
 ### Apache License 2.0
 
 **Used By:**
 
-* [ryu 1.0.5](https://github.com/dtolnay/ryu)
-
-
+* [ryu 1.0.6](https://github.com/dtolnay/ryu)
 ```
                                  Apache License
                            Version 2.0, January 2004
@@ -226,18 +222,15 @@ License details for project dependencies are listed below.
 
 **Used By:**
 
-* [itoa 0.4.7](https://github.com/dtolnay/itoa)
-* [num-integer 0.1.44](https://github.com/rust-num/num-integer)
+* [itoa 0.4.8](https://github.com/dtolnay/itoa)
 * [num-traits 0.2.14](https://github.com/rust-num/num-traits)
-* [proc-macro2 1.0.24](https://github.com/alexcrichton/proc-macro2)
-* [quote 1.0.9](https://github.com/dtolnay/quote)
-* [serde 1.0.123](https://github.com/serde-rs/serde)
-* [serde_derive 1.0.123](https://github.com/serde-rs/serde)
-* [serde_json 1.0.64](https://github.com/serde-rs/json)
-* [syn 1.0.60](https://github.com/dtolnay/syn)
-* [unicode-xid 0.2.1](https://github.com/unicode-rs/unicode-xid)
-
-
+* [proc-macro2 1.0.32](https://github.com/dtolnay/proc-macro2)
+* [quote 1.0.10](https://github.com/dtolnay/quote)
+* [serde 1.0.130](https://github.com/serde-rs/serde)
+* [serde_derive 1.0.130](https://github.com/serde-rs/serde)
+* [serde_json 1.0.72](https://github.com/serde-rs/json)
+* [syn 1.0.82](https://github.com/dtolnay/syn)
+* [unicode-xid 0.2.2](https://github.com/unicode-rs/unicode-xid)
 ```
                               Apache License
                         Version 2.0, January 2004
@@ -443,14 +436,28 @@ limitations under the License.
 
 ```
 
-### Do What The F*ck You Want To Public License
+### Apache License 2.0
 
 **Used By:**
 
-* [brunch 0.1.2](https://github.com/Blobfolio/brunch)
-* [dactyl 0.1.5](https://github.com/Blobfolio/dactyl)
+* [unicode-xid 0.2.2](https://github.com/unicode-rs/unicode-xid)
+```
+Licensed under the Apache License, Version 2.0
+<LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT
+license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+at your option. All files in the project carrying such
+notice may not be copied, modified, or distributed except
+according to those terms.
+
+```
 
+### Do What The F*ck You Want To Public License
 
+**Used By:**
+
+* [brunch 0.2.1](https://github.com/Blobfolio/brunch)
+* [dactyl 0.2.0](https://github.com/Blobfolio/dactyl)
 ```
 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 Version 2, December 2004
@@ -469,4 +476,3 @@ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 ```
 
 
-

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "brunch"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Blobfolio, LLC. <hello@blobfolio.com>"]
 edition = "2021"
 rust-version = "1.56"
@@ -29,3 +29,7 @@ serde_json = "1.0.*"
 [dependencies.serde]
 version = "1.0.*"
 features = [ "derive" ]
+
+[[bench]]
+name = "fn_fib"
+harness = false

README.md

@@ -3,6 +3,7 @@
 [![Documentation](https://docs.rs/brunch/badge.svg)](https://docs.rs/brunch/)
 [![crates.io](https://img.shields.io/crates/v/brunch.svg)](https://crates.io/crates/brunch)
 [![Build Status](https://github.com/Blobfolio/brunch/workflows/Build/badge.svg)](https://github.com/Blobfolio/brunch/actions)
+[![Dependency Status](https://deps.rs/repo/github/blobfolio/brunch/status.svg)](https://deps.rs/repo/github/blobfolio/brunch
 
 `Brunch` is a very simple Rust micro-benchmark runner inspired by [`easybench`](https://crates.io/crates/easybench). It has roughly a million times fewer dependencies than [`criterion`](https://crates.io/crates/criterion), does not require nightly, and maintains a "last run" state so can show relative changes benchmark-to-benchmark. The formatting is also quite pretty.
 
@@ -24,7 +25,7 @@ Add `brunch` to your `dev-dependencies` in `Cargo.toml`, like:
 
 ```
 [dev-dependencies]
-brunch = "0.1.*"
+brunch = "0.2.*"
 ```
 
 Benchemarks are also defined in `Cargo.toml` the usual way. Just be sure to set `harness = false`:

benches/fn_fib.rs

@@ -0,0 +1,57 @@
+/*!
+# Benchmark Demo
+*/
+
+use brunch::{
+	Bench,
+	benches,
+};
+use std::time::Duration;
+
+
+
+fn fibonacci_recursive(len: usize) -> Vec<u32> {
+	assert!(len > 0, "Length must be non-zero.");
+
+	fn fibonacci_idx(n: usize) -> u32 {
+		if n == 0 { 0 }
+		else if n < 3 { 1 }
+		else {
+			fibonacci_idx(n - 1) + fibonacci_idx(n - 2)
+		}
+	}
+
+	let mut out = Vec::with_capacity(len);
+	for n in 0..len {
+		out.push(fibonacci_idx(n));
+	}
+
+	out
+}
+
+fn fibonacci_loop(len: usize) -> Vec<u32> {
+	assert!(len > 0, "Length must be non-zero.");
+
+	let mut out = Vec::with_capacity(len);
+	if len == 1 { out.push(0); }
+	else {
+		out.push(0);
+		out.push(1);
+
+		for n in 2..len {
+			out.push(out[n - 1] + out[n - 2]);
+		}
+	}
+
+	out
+}
+
+benches!(
+	Bench::new("fibonacci_recursive", "(30)")
+		.timed(Duration::from_secs(1))
+		.with(|| fibonacci_recursive(30_usize)),
+
+	Bench::new("fibonacci_loop", "(30)")
+		.timed(Duration::from_secs(1))
+		.with(|| fibonacci_loop(30_usize)),
+);

justfile

@@ -84,8 +84,8 @@ bench BENCH="":
 @credits:
 	# Update CREDITS.html.
 	cargo about \
-		-m "{{ justfile_directory() }}/Cargo.toml" \
 		generate \
+		-m "{{ justfile_directory() }}/Cargo.toml" \
 		"{{ release_dir }}/credits/about.hbs" > "{{ justfile_directory() }}/CREDITS.md"
 
 	just _fix-chown "{{ justfile_directory() }}/CREDITS.md"

src/lib.rs

@@ -15,25 +15,6 @@ This crate is still under heavy development. It is ~~subject to~~ going to chang
 
 
 
-## Installation
-
-Add `brunch` to your `dev-dependencies` in `Cargo.toml`, like:
-
-```ignore
-[dev-dependencies]
-brunch = "0.1.*"
-```
-
-Benchemarks are also defined in `Cargo.toml` the usual way. Just be sure to set `harness = false`:
-
-```ignore
-[[bench]]
-name = "encode"
-harness = false
-```
-
-
-
 ## Usage
 
 Setup is currently simple if primitive, requiring you drop a call to the [`benches`] macro in the benchmark file. It will generate a `main()` method, run the supplied benchmarks, and give you the results.
@@ -101,7 +82,6 @@ There are currently three styles of callback:
 #![allow(clippy::module_name_repetitions)]
 
 
-
 mod bench;
 #[macro_use]
 mod macros;

src/macros.rs

@@ -29,7 +29,7 @@
 /// );
 /// ```
 macro_rules! benches {
-	($($benches:expr),+) => {
+	($($benches:expr),+ $(,)?) => {
 		/// # Benchmarks!
 		fn main() {
 			// This can take a while; give 'em a message of hope.