chore: initial commit

Author: LeoBorai

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Builds on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-latest,
+          windows-latest,
+          macOS-latest
+        ]
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+
+      - name: Build
+        run: cargo build --release --locked

.github/workflows/clippy.yml

@@ -0,0 +1,45 @@
+name: clippy
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  clippy:
+    name: Runs "cargo clippy" on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-latest,
+          windows-latest,
+          macOS-latest
+        ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: clippy
+
+      - name: Cache .cargo and target
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo
+            ./target
+          key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.lock') }}
+            ${{ runner.os }}-cargo-clippy
+
+      - name: cargo clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: -- -D warnings

.github/workflows/fmt.yml

@@ -0,0 +1,46 @@
+name: fmt
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  fmt:
+    name: Runs "cargo fmt" on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-latest,
+          windows-latest,
+          macOS-latest
+        ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt
+
+      - name: Cache .cargo and target
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo
+            ./target
+          key: ${{ runner.os }}-cargo-fmt-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-fmt-${{ hashFiles('**/Cargo.lock') }}
+            ${{ runner.os }}-cargo-fmt
+
+      - name: Run fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check

.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish-dry-run:
+    name: "Runs cargo publish --dry-run"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+
+      - name: publish crate
+        run: cargo publish --dry-run
+
+  create-release:
+    name: Create Release
+    needs: publish-dry-run
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Create Release with Notes
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            await github.request(`POST /repos/${{ github.repository }}/releases`, {
+              tag_name: "${{ github.ref }}",
+              generate_release_notes: true
+            });
+
+  publish-crate:
+    name: Publish to crates.io
+    needs: create-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+      - run: cargo login ${CRATES_IO_TOKEN}
+        env:
+          CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+
+      - name: publish crate
+        run: cargo publish

.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: test
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Runs "cargo test" on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-latest,
+          windows-latest,
+          macOS-latest
+        ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Cache .cargo and target
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo
+            ./target
+          key: ${{ runner.os }}-cargo-fmt-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-fmt-${{ hashFiles('**/Cargo.lock') }}
+            ${{ runner.os }}-cargo-fmt
+
+      - name: Run tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -- --nocapture

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+
+/target
+/Cargo.lock

Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "favicon"
+description = "Build favicons for your website"
+authors = ["Esteban Borai <estebanborai@gmail.com>"]
+version = "0.1.0-draft-1"
+edition = "2021"
+repository = "https://github.com/EstebanBorai/favicon"
+categories = ["web-programming"]
+homepage = "https://github.com/EstebanBorai/favicon"
+keywords = ["favicon", "images", "web", "website"]
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+image = "0.24.2"

README.md

@@ -0,0 +1,16 @@
+<div>
+  <h1 align="center">favicon</h1>
+  <h4 align="center">
+    Build favicons for your website
+  </h4>
+</div>
+
+<div align="center">
+
+  [![Crates.io](https://img.shields.io/crates/v/favicon.svg)](https://crates.io/crates/favicon)
+  [![Documentation](https://docs.rs/favicon/badge.svg)](https://docs.rs/favicon)
+  ![Build](https://github.com/EstebanBorai/favicon/workflows/build/badge.svg)
+  ![Clippy](https://github.com/EstebanBorai/favicon/workflows/clippy/badge.svg)
+  ![Formatter](https://github.com/EstebanBorai/favicon/workflows/fmt/badge.svg)
+
+</div>

fixtures/dice.png

@@ -0,0 +1,110 @@
+use image::imageops::FilterType;
+use image::{DynamicImage, ImageFormat};
+use std::fs::File;
+use std::path::Path;
+
+pub const APPLE_TOUCH_ICON_57: Preset<'static> =
+    Preset::new("apple_touch_icon-57.png", Format::Png, 57, 57);
+pub const APPLE_TOUCH_ICON_60: Preset<'static> =
+    Preset::new("apple_touch_icon-60.png", Format::Png, 60, 60);
+pub const APPLE_TOUCH_ICON_72: Preset<'static> =
+    Preset::new("apple_touch_icon-72.png", Format::Png, 70, 70);
+pub const APPLE_TOUCH_ICON_76: Preset<'static> =
+    Preset::new("apple_touch_icon-76.png", Format::Png, 76, 76);
+pub const APPLE_TOUCH_ICON_114: Preset<'static> =
+    Preset::new("apple_touch_icon-114.png", Format::Png, 114, 114);
+pub const APPLE_TOUCH_ICON_120: Preset<'static> =
+    Preset::new("apple_touch_icon-120.png", Format::Png, 120, 120);
+pub const APPLE_TOUCH_ICON_144: Preset<'static> =
+    Preset::new("apple_touch_icon-144.png", Format::Png, 144, 144);
+pub const APPLE_TOUCH_ICON_152: Preset<'static> =
+    Preset::new("apple_touch_icon-152.png", Format::Png, 152, 152);
+
+pub const FAVICON: Preset<'static> = Preset::new("favicon.ico", Format::Ico, 64, 64);
+pub const FAVICON_16: Preset<'static> = Preset::new("favicon-16.png", Format::Png, 16, 16);
+pub const FAVICON_32: Preset<'static> = Preset::new("favicon-32.png", Format::Png, 32, 32);
+pub const FAVICON_96: Preset<'static> = Preset::new("favicon-96.png", Format::Png, 96, 96);
+pub const FAVICON_128: Preset<'static> = Preset::new("favicon-128.png", Format::Png, 128, 128);
+pub const FAVICON_196: Preset<'static> = Preset::new("favicon-32.png", Format::Png, 196, 196);
+
+pub const MS_TILE_70: Preset<'static> = Preset::new("mstile-70.png", Format::Png, 70, 70);
+pub const MS_TILE_144: Preset<'static> = Preset::new("mstile-144.png", Format::Png, 144, 144);
+pub const MS_TILE_150: Preset<'static> = Preset::new("mstile-150.png", Format::Png, 150, 150);
+pub const MS_TILE_310X150: Preset<'static> =
+    Preset::new("mstile-310x150.png", Format::Png, 310, 150);
+pub const MS_TILE_310: Preset<'static> = Preset::new("mstile-310.png", Format::Png, 310, 310);
+
+pub enum Format {
+    Ico,
+    Png,
+}
+
+pub struct Preset<'a> {
+    pub(crate) name: &'a str,
+    pub(crate) format: Format,
+    pub(crate) height: u32,
+    pub(crate) width: u32,
+}
+
+impl<'a> Preset<'a> {
+    pub const fn new(name: &'a str, format: Format, height: u32, width: u32) -> Self {
+        Self {
+            name,
+            format,
+            height,
+            width,
+        }
+    }
+}
+
+pub struct Favicon<'a, P: AsRef<Path>> {
+    pub(crate) image: DynamicImage,
+    pub(crate) out_dir: P,
+    pub(crate) presets: Vec<Preset<'a>>,
+}
+
+impl<'a, P: AsRef<Path>> Favicon<'a, P> {
+    pub fn new(file: P, out_dir: P, presets: Vec<Preset<'a>>) -> Self
+    where
+        P: AsRef<Path>,
+    {
+        let image = image::open(file).unwrap();
+
+        Self {
+            image,
+            out_dir,
+            presets,
+        }
+    }
+
+    pub fn empty(file: P, out_dir: P) -> Self {
+        let image = image::open(file).unwrap();
+
+        Self {
+            image,
+            out_dir,
+            presets: Vec::default(),
+        }
+    }
+
+    pub fn scale_down(&self, preset: Preset<'a>) {
+        let scaled = self
+            .image
+            .resize(preset.width, preset.height, FilterType::Nearest);
+        let mut output = File::create(preset.name).unwrap();
+
+        scaled.write_to(&mut output, ImageFormat::Png).unwrap();
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn it_works() {
+        let favicon = Favicon::empty("fixtures/dice.png", "output.png");
+
+        favicon.scale_down(APPLE_TOUCH_ICON_57);
+    }
+}