initials-revamped 0.1.2

//! Avatar module helps to generate avatars according to the initial names.
use color::RgbColor;
use error::Error;
use image::{imageops, DynamicImage, ImageBuffer, Rgba};
use rusttype::{point, Font, Scale};
use std::cmp;
use std::fs::File;
use std::io::prelude::*;

/// Avatar builder that stores the metrics of the image.
#[derive(Debug)]
pub struct AvatarBuilder {
    /// Initials name string
    pub name: String,
    /// Vectorized font data
    font_data: Vec<u8>,
    /// Scale of the font
    font_scale: Scale,
    /// RGB color of the font
    font_color: RgbColor,
    /// RGB color of the background
    background_color: RgbColor,
    /// Size of the inner-text
    pub length: usize,
    /// Width of the avatar
    width: u32,
    /// Height of the avatar
    height: u32,
    /// Contrast ratio for the colors
    contrast_ratio: f32,
    /// Private property to hold if colors should be randomly generated
    randomized_colors: (bool, bool),
    /// Gaussian blur of the image
    blur: Option<f32>,
}

/// Result type for the avatar generator
pub type AvatarResult = Result<AvatarBuilder, Error>;

impl AvatarBuilder {
    /// Construct new AvatarBuilder.
    pub fn new(name: &str) -> AvatarBuilder {
        // unwrap first chars for the each word and store them
        // inside the <String>
        let mut text = String::new();
        for word in name.split_whitespace() {
            text.push(word.chars().next().unwrap());
        }

        // default Avatar settings
        AvatarBuilder {
            name: text.to_uppercase(),
            font_data: include_bytes!("fonts/Roboto.ttf").to_vec(),
            font_scale: Scale::uniform(150.0),
            length: 2,
            width: 300,
            height: 300,
            randomized_colors: (true, true),
            contrast_ratio: 4.5,
            font_color: RgbColor::new(255, 255, 255), // default white color
            background_color: RgbColor::new(224, 143, 112), // default background
            blur: None,
        }
    }

    /// Change the font of the avatar text. You need to include `.ttf` file.
    /// Default style is `Roboto Regular`.
    pub fn with_font(mut self, font: &str) -> AvatarResult {
        let mut file = File::open(font)?;
        let mut font_data = Vec::new();
        file.read_to_end(&mut font_data)
            .expect("unable to read data");
        self.font_data = font_data;
        Ok(self)
    }

    /// Change the font of the avatar text using the font's raw binary.
    /// Useful when embedding the font data into the binary
    pub fn with_font_data(mut self, font_data: Vec<u8>) -> AvatarResult {
        self.font_data = font_data;
        Ok(self)
    }

    /// Change the font color. You need to specify hex color code.
    pub fn with_font_color(mut self, color: &str) -> AvatarResult {
        self.font_color = color.parse()?;
        self.randomized_colors.0 = false;
        Ok(self)
    }

    /// Change the uniform scale of font.
    /// Default to `150.0`.
    pub fn with_font_scale(mut self, scale: f32) -> AvatarResult {
        self.font_scale = Scale::uniform(scale);
        Ok(self)
    }

    /// Change the background color of the avatar. You need to specify hex color code.
    pub fn with_background_color(mut self, color: &str) -> AvatarResult {
        self.background_color = color.parse()?;
        self.randomized_colors.1 = false;
        Ok(self)
    }

    /// Change the length of initials characters taken from the name.
    /// Default to `2`.
    pub fn with_length(mut self, length: usize) -> AvatarResult {
        self.length = length;
        Ok(self)
    }

    /// Change the width of the avatar.
    /// Default to `300`.
    pub fn with_width(mut self, width: u32) -> AvatarResult {
        self.width = width;
        Ok(self)
    }

    /// Change the height of the avatar.
    /// Default to `300`.
    pub fn with_height(mut self, height: u32) -> AvatarResult {
        self.height = height;
        Ok(self)
    }

    /// Change the contrast ratio for the randomly generated avatar.
    /// Default to `4.5`. Increase the ratio for more clear avatar.
    pub fn with_contrast_ratio(mut self, ratio: f32) -> AvatarResult {
        self.contrast_ratio = ratio;
        Ok(self)
    }

    /// Apply gaussian blur to the avatar.
    pub fn with_blur(mut self, blur: f32) -> AvatarResult {
        self.blur = Some(blur);
        Ok(self)
    }

    /// Draw the image according to the metrics given.
    pub fn draw(self) -> ImageBuffer<Rgba<u8>, Vec<u8>> {
        // convert font-data vector to rusttype::Font
        let font = Font::try_from_bytes(&self.font_data as &[u8]).expect("Error constructing Font");

        // substract metrics from the font according to the font scale
        let v_metrics = font.v_metrics(self.font_scale);

        // get the number of characters from the given name
        let text: String = self
            .name
            .chars()
            .take(cmp::min(self.length, self.name.len()))
            .collect();

        // layout the glyphs
        let glyphs: Vec<_> = font
            .layout(&text, self.font_scale, point(0.0, v_metrics.ascent))
            .collect();

        // substract height/width from the glyphs
        let glyphs_height = (v_metrics.ascent - v_metrics.descent).ceil() as u32;
        let glyphs_width = glyphs
            .iter()
            .rev()
            .map(|g| g.position().x as f32 + g.unpositioned().h_metrics().advance_width)
            .next()
            .unwrap_or(0.0)
            .ceil() as u32;

        // calculate padding for glyphs
        let left_padding = (self.width - glyphs_width) / 2;
        let top_padding = (self.height - glyphs_height) / 2;

        // create dynamic RGBA image
        let mut image = DynamicImage::new_rgba8(self.width, self.height).into_rgba8();

        // randomize colors if not being settled
        let mut colors = self.randomized_colors;
        let mut background_color = self.background_color;
        let mut font_color = self.font_color;
        loop {
            match colors {
                (false, false) => break,
                (_, _) => {
                    if colors.0 {
                        font_color = RgbColor::random();
                    }

                    if colors.1 {
                        background_color = RgbColor::random();
                    }

                    colors = match font_color.find_ratio(&background_color) {
                        // match if contrast ratio between colors is as expected
                        r if r > self.contrast_ratio || r < 1. / self.contrast_ratio => {
                            (false, false)
                        }
                        _ => {
                            if colors.0 | colors.1 {
                                colors
                            } else {
                                (false, true)
                            }
                        }
                    }
                }
            }
        }

        for glyph in glyphs {
            if let Some(bounding_box) = glyph.pixel_bounding_box() {
                // draw the glyph into the image according to font color
                glyph.draw(|x, y, v| {
                    image.put_pixel(
                        x + bounding_box.min.x as u32 + left_padding,
                        y + bounding_box.min.y as u32 + top_padding,
                        font_color.to_rgba((v * 255.0) as u8),
                    )
                });
            }
        }

        for (_, _, pixel) in image.enumerate_pixels_mut() {
            // put background pixels for the uncovered alpha channels
            if pixel[3] == 0 {
                *pixel = background_color.to_rgba(255)
            }
        }

        // apply gaussian blur to the image if specified
        if let Some(b) = self.blur {
            imageops::blur(&image, b)
        } else {
            image
        }
    }
}