cache_bust 0.2.0

A library for compile-time "cache busting", including hashes in file names in order to optimize for caching.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# cache_bust

A library for compile-time "cache busting", including hashes in file names in order to optimize for caching.

## Why cache busting?

Cache busting is primarily applicable in web applications, optimizing the usage of the browser's cache.
By including a hash of the contents of a file in its name, it's made possible to [declare said file
as immutable in the `Cache-Control` HTTP-Header][`Cache-Control-immutable`] without losing the ability
to push updates to the file out to the browser. As long as the file isn't changed, it can remain cached.
As soon as it's changed, the browser will simply look it up under its new name.

## How to use cache_bust

### The `asset!` macro

To include an asset in source code, use the `asset!` macro:
```rs
use cache_bust::asset;

let img_src = asset!("images/circle.png");
assert_eq!(img_src, "images/circle.f04a632bf7de8a58d730988671a9139d6f7b3b197bbc78b6c74a4542eaa4878d.png");
```

By default this will look for assets in the `assets` directory inside your crate.
To use a different directory set the `CACHE_BUST_ASSETS_DIR` environment variable.
If the file doesn't exist, the macro will produce an error.

The hashing of the file name can also be disabled, for example for debug builds
where cache busting isn't being used, by setting the `CACHE_BUST_SKIP_HASHING`
environment variable to `1`. In this case the macro will act as an identity function,
while still erroring if the file doesn't exist.

### Build time

The next step is to rename the files on disk to include their hashes.
This can occur either in-place, or the renamed files can be copied to
a new location, depending on where your runtime expects the assets.

There are two ways to achieve this: using a Rust API, or using a CLI-tool.

#### Rust API

The Rust API can be called from a `build.rs` build script:
```rs
use cache_bust::CacheBust;

let cache_bust = CacheBust::builder()
	.out_dir("hashed_assets".to_owned())
	.build();

cache_bust.hash_dir()?;
assert_eq!(
	std::fs::read("assets/images/circle.png")?,
	std::fs::read("hashed_assets/images/circle.f04a632bf7de8a58d730988671a9139d6f7b3b197bbc78b6c74a4542eaa4878d.png")?
);
```

#### CLI-tool

Alternatively **cache_bust_cli** can be used from some other build tool
to hash and rename the files:
```sh
cachebust assets --out hashed_assets
```

### Dynamic files

Some files might be dynamically generated during build time and thus not
possible to include using the `asset!` macro. It's possible to
individually hash these files and obtain their hashed names at build time.
How to pass those names to the runtime is left to you.

#### Rust API

```rs
use cache_bust::CacheBust;

let cache_bust = CacheBust::builder()
	.out_dir("hashed_assets".to_owned())
	.build();

let path = cache_bust.hash_file("generated/script.js")?;
assert_eq!(
	std::fs::read_to_string(path)?,
	"alert('Hello world');\n"
);
```

#### CLI-tool

```sh
cachebust assets --file generated/script.js --out hashed_assets --print-file-name
cachebust assets --file generated/script.js --out hashed_assets --print-file-path
```

## Features

#### default

Enables all features.

#### macro

Enables the `asset!` procedural macro.

#### build

Enables the `CacheBust` and `CacheBustBuilder` structs for hashing files at build time.

[`Cache-Control-immutable`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control##caching_static_assets_with_cache_busting