[2024-10-31] Sync fork (#1)

* use OpenSans as fallback font on PRs from forks

* Fix typo

* Update reference from Rustonomicon to Rust Reference

The exercise refers to the "Data layout" section of the Rustonomicon, but now that section claims itself deprecated and redirects to the "Type layout" section of The Rust Reference.

* 05_ticket_v2 outro: correct comment on title (mainmatter#179)

Characters was meant to be bytes, this was missed in a former refactoring

* Change docstring: "when converted to `u8`"

Fixed docstring

* exercises 02_basic_calculator/04_panics: fix comma splice in panic message

* Update 08_overflow.md

if you read threw the profile docs it provides 4 profiles. https://doc.rust-lang.org/cargo/reference/profiles.html

* chore(ci): re-create book artifacts at the beginning of each month

* Update 08_overflow.md

Added some context.

---------

Co-authored-by: Marco Otte-Witte <[email protected]>
Co-authored-by: Simon Morgan <[email protected]>
Co-authored-by: Luca Boschetto <[email protected]>
Co-authored-by: iacri <[email protected]>
Co-authored-by: Henk Oordt <[email protected]>
Co-authored-by: Benjamin Tamasi <[email protected]>
Co-authored-by: Vincent Ging Ho Yim <[email protected]>
Co-authored-by: Manuel Bichler <[email protected]>
Co-authored-by: Bartlomiej Dudzik <[email protected]>

Author: 10 people

.github/workflows/ci.yml

@@ -7,6 +7,10 @@ on:
   pull_request:
     branches:
       - main
+  workflow_dispatch:
+  schedule:
+    # First day of a month
+    - cron: '0 0 1 * *'
 
 jobs:
   build:
@@ -15,17 +19,27 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/checkout@v4
+      - name: Get Core Sans
+        uses: actions/checkout@v4
+        if: "!github.event.pull_request.head.repo.fork"
         with:
           fetch-depth: 0
           repository: mainmatter/core-sans-a-fonts
           ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
           path: core-sans-a-fonts
-      - name: Install Fonts
+      - name: Install Core Sans Font
+        if: "!github.event.pull_request.head.repo.fork"
         run: |
           sudo cp -r core-sans-a-fonts/* /usr/local/share/fonts/
           sudo fc-cache -f -v
           fc-list | grep "Core Sans"
+      - name: Use Fallback font for fork PRs
+        if: "github.event.pull_request.head.repo.fork"
+        run: |
+          sed -i 's/"BoldFont=CoreSansA65.ttf",//g' book/book.toml
+          sed -i 's/"ItalicFont=CoreSansA45It.ttf",//g' book/book.toml
+          sed -i 's/"BoldItalicFont=CoreSansA65It.ttf",//g' book/book.toml
+          sed -i 's/CoreSansA45.ttf/Open Sans:style=Regular/g' book/book.toml
       - uses: actions-rust-lang/setup-rust-toolchain@v1
       - name: Install exercise plugin
         run: cargo install --path helpers/mdbook-exercise-linker
@@ -35,8 +49,8 @@ jobs:
         run: |
           cargo install mdbook-pandoc --locked --version 0.7.1
           sudo apt-get update
-          sudo apt-get install -y fonts-noto calibre pdftk
-          
+          sudo apt-get install -y fonts-noto fonts-open-sans calibre pdftk
+          sudo fc-cache -f -v
           export PANDOC_VERSION=3.3
           curl -LsSf https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | tar zxf -
           echo "$PWD/pandoc-${PANDOC_VERSION}/bin" >> $GITHUB_PATH

book/book.toml

@@ -49,8 +49,8 @@ sansfontoptions = [
 ]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
 monofont = "Noto Sans Mono"
-mainfontfallback = ["Noto Color Emoji:mode=harf"]
-sansfontfallback = ["Noto Color Emoji:mode=harf"]
+mainfontfallback = ["Open Sans"]
+sansfontfallback = ["Open Sans"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]
@@ -90,8 +90,8 @@ sansfontoptions = [
 ]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
 monofont = "Noto Sans Mono"
-mainfontfallback = ["Noto Color Emoji:mode=harf"]
-sansfontfallback = ["Noto Color Emoji:mode=harf"]
+mainfontfallback = ["Open Sans"]
+sansfontfallback = ["Open Sans"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]
@@ -121,8 +121,8 @@ metadata-file = "metadata.yml"
 [output.pandoc.profile.html.variables]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
 monofont = "Noto Sans Mono"
-mainfontfallback = ["Noto Color Emoji:mode=harf"]
-sansfontfallback = ["Noto Color Emoji:mode=harf"]
+mainfontfallback = ["Open Sans"]
+sansfontfallback = ["Open Sans"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]

book/src/02_basic_calculator/08_overflow.md

@@ -69,12 +69,18 @@ You may be wondering—what is a profile setting? Let's get into that!
 A [**profile**](https://doc.rust-lang.org/cargo/reference/profiles.html) is a set of configuration options that can be
 used to customize the way Rust code is compiled.
 
-Cargo provides two built-in profiles: `dev` and `release`.\
+Cargo provides 4 built-in profiles: `dev`, `release`, `test`, and `bench`.\
 The `dev` profile is used every time you run `cargo build`, `cargo run` or `cargo test`. It's aimed at local
 development,
 therefore it sacrifices runtime performance in favor of faster compilation times and a better debugging experience.\
 The `release` profile, instead, is optimized for runtime performance but incurs longer compilation times. You need
 to explicitly request via the `--release` flag—e.g. `cargo build --release` or `cargo run --release`.
+The `test` profile is the default profile used by `cargo test`. The `test` profile inherits the settings form the `dev` profile.
+The `bench` profile is the default profile used by `cargo bench`. The `bench` profile inherits from the `release` profile.
+Use `dev` for iterative development and debugging, `release` for optimized production builds,\
+`test` for correctness testing, and `bench` for performance benchmarking.
+
+
 
 > "Have you built your project in release mode?" is almost a meme in the Rust community.\
 > It refers to developers who are not familiar with Rust and complain about its performance on

exercises/02_basic_calculator/04_panics/src/lib.rs

@@ -19,7 +19,7 @@ mod tests {
     // 👇 With the `#[should_panic]` annotation we can assert that we expect the code
     //    under test to panic. We can also check the panic message by using `expected`.
     //    This is all part of Rust's built-in test framework!
-    #[should_panic(expected = "The journey took no time at all, that's impossible!")]
+    #[should_panic(expected = "The journey took no time at all. That's impossible!")]
     fn by_zero() {
         speed(0, 10, 0);
     }

exercises/02_basic_calculator/10_as_casting/src/lib.rs

@@ -23,7 +23,7 @@ mod tests {
 
         // You could solve this by using exactly the same expression as above,
         // but that would defeat the purpose of the exercise. Instead, use a genuine
-        // `i8` value that is equivalent to `255` when converted from `u8`.
+        // `i8` value that is equivalent to `255` when converted to `u8`.
         let y: i8 = todo!();
 
         assert_eq!(x, y);

exercises/03_ticket_v1/09_heap/src/lib.rs

@@ -21,8 +21,8 @@ mod tests {
         // This is a tricky question!
         // The "intuitive" answer happens to be the correct answer this time,
         // but, in general, the memory layout of structs is a more complex topic.
-        // If you're curious, check out the "Data layout" section of the Rustonomicon
-        // https://doc.rust-lang.org/nomicon/data.html for more information.
+        // If you're curious, check out the "Type layout" section of The Rust Reference
+        // https://doc.rust-lang.org/reference/type-layout.html for more information.
         assert_eq!(size_of::<Ticket>(), todo!());
     }
 }

exercises/05_ticket_v2/15_outro/src/title.rs

@@ -1,5 +1,5 @@
 // TODO: Implement `TryFrom<String>` and `TryFrom<&str>` for the `TicketTitle` type,
-//   enforcing that the title is not empty and is not longer than 50 characters.
+//   enforcing that the title is not empty and is not longer than 50 bytes.
 //   Implement the traits required to make the tests pass too.
 
 pub struct TicketTitle(String);

exercises/07_threads/05_channels/src/lib.rs

@@ -7,7 +7,7 @@ pub enum Command {
     Insert(todo!()),
 }
 
-// Start the system by spawning the server the thread.
+// Start the system by spawning the server thread.
 // It returns a `Sender` instance which can then be used
 // by one or more clients to interact with the server.
 pub fn launch() -> Sender<Command> {