nya 1.0.0

//! `nya` is a simple file processor. It's extremely simple, very fast, and super
//! cute, as well. It reads files from a directory, does stuff to them, and then
//! spits them out somewhere else. That's all it does. The "stuff" that's being
//! done to the files is called _middleware_. Middleware is just a function that
//! takes a struct representing a file and then does something to that file.
//! It doesn't even have to return it! That's how easy it is to use `nya`. Can
//! you believe it?
//!
//! In its simplest form, you'd use it somewhat like this:
//!
//! ```
//! extern crate nya;
//!
//! use nya::create_middleware;
//!
//! fn main() {
//!     nya::run(vec![
//!         create_middleware(|files| {
//!             let file = &mut files[0];
//!             file.content = "test hello".to_string();
//!         })
//!     ], Some("fixtures/example"), Some("_site")).unwrap();
//! }
//! ```
//!
//! Don't worry, `nya` also has support for passing around custom metadata per-file
//! via a `HashMap<&str, String>`:
//!
//! ```
//! extern crate nya;
//!
//! use nya::create_middleware;
//!
//! fn main() {
//!     nya::run(vec![
//!         create_middleware(|files| {
//!             let file = &mut files[0];
//!             file.metadata.insert("cool stuff", "test hello".to_string());
//!         })
//!     ], Some("fixtures/example"), Some("_site")).unwrap();
//! }
//! ```
//!
//! And then later on, you could extract it from the same file. Metadata is completely
//! virtual, meaning it doesn't actually affect what's written to disk (unless you make
//! something out of it!)
//!
//! There's no _global_ metadata support in `nya`, because I believe that should be implemented
//! in your application layer, rather than relying on `nya`. It'd also break the perfectly
//! simple library interface that we have going here.
//!
//! ### How does `nya` compare to other software?
//!
//! At some distant point in time, I'd like for `nya` to be used as a static site
//! generator. How would it compare to other existing static site generators, then?
//! Well, it's much simpler than __Jekyll__ or __Hugo__, for example, and it's even
//! simpler than other JavaScript-based SSGs such as __Metalsmith__ or __Wintersmith__.
//! Existing Rust SSGs have all more or less tried to replicate the full feature set
//! of Jekyll or comparable software, so I hope I'll be scratching an itch here.
//!
//! `nya` currently only depends on `walkdir` and `globset`, and I'd like to keep
//! dependencies as light as possible.

extern crate walkdir;
extern crate globset;

use std::collections::HashMap;
use std::ffi::OsString;
use std::fs::DirBuilder;
use std::fs::File;
use std::io::prelude::*;
use std::path::PathBuf;
use walkdir::WalkDir;
use globset::{Glob, GlobSetBuilder};

/// A struct describing a simple file, with only a name, content, path
/// (relative & absolute), and custom metadata.
///
/// # Examples
///
/// ```
/// let file = nya::SimpleFile {
///     name: std::ffi::OsString::from("coolfile.txt"),
///     content: "hello".to_string(),
///     rel_path: std::path::PathBuf::from(r"coolfile.txt"),
///     metadata: std::collections::HashMap::new(),
/// };
/// ```
#[derive(Debug, PartialEq, Clone)]
pub struct SimpleFile {
    /// The filename, as an `OsString`.
    pub name: OsString,
    /// The content of the file, as an owned `String`.
    pub content: String,
    /// The relative path of the file, as a `PathBuf`.
    pub rel_path: PathBuf,
    /// Metadata that's relevant to the file, in a `HashMap`.
    pub metadata: HashMap<&'static str, String>,
}

/// A type describing middleware functions.
pub type MiddlewareFunction = Box<FnMut(&mut Vec<SimpleFile>)>;

/// A convenience function that creates middleware.
///
/// Takes a closure and boxes it so it can be
/// (more or less) safely added to the middleware chain and so that we don't
/// have to worry about lifetimes. This closure itself takes a `files` argument
/// that is a `Vec` of `SimpleFile`s. This Vec can be modified in place and
/// doesn't have to be returned.
///
/// # Example
///
/// ```
/// let func = nya::create_middleware(|files: &mut Vec<nya::SimpleFile>| {
///     let file = &mut files[0];
///     file.content = "haha hello".to_string();
/// });
///
/// nya::run(vec![func], Some("fixtures/example"), None).unwrap();
/// ```
pub fn create_middleware<T>(x: T) -> Box<T> {
    Box::new(x)
}

/// Runs a middleware chain.
///
/// Reads a file from the `source` argument (default is the
/// current directory), runs the collected files through the provided middleware
/// chain, and then writes the result to the `destination` argument (default
/// is `_site`). Both arguments _have_ to be provided, although they accept
/// an `Option`, so you can pass in `None` if you want the defaults to apply.
/// Returns a `Result<Vec<SimpleFile>, std::io::Error>`.
///
/// # Example
///
/// ```
/// let func = nya::create_middleware(|files: &mut Vec<nya::SimpleFile>| {
///     let file = &mut files[0];
///     file.content = "haha hello".to_string();
/// });
///
/// let result = nya::run(vec![func], Some("fixtures/example"), None);
/// if let Ok(r) = result {
///     println!("Success!");
/// }
/// ```

pub fn run(
    middleware: Vec<MiddlewareFunction>,
    source: Option<&str>,
    destination: Option<&str>,
) -> Result<Vec<SimpleFile>, std::io::Error> {
    let f_source = source.unwrap_or(".");
    let f_dest = destination.unwrap_or("_site");
    let mut files = Vec::<SimpleFile>::new();
    read_dir(&mut files, f_source)?;
    for mut function in middleware {
        function(&mut files);
    }
    write_dir(&mut files, f_dest)?;
    Ok(files)
}

/// Included middleware that excludes files from processing based on
/// glob patterns.
///
/// # Example
///
/// ```
/// let result = nya::run(vec![
///     nya::ignore(vec!["**/*.txt".to_owned(), "node_modules/".to_owned()]),
/// ], Some("fixtures/example"), None);
/// if let Ok(r) = result {
///     println!("Success!");
/// }
/// ```

pub fn ignore(list: Vec<String>) -> MiddlewareFunction {
    create_middleware(move |files| {
        let mut builder = GlobSetBuilder::new();
        for item in &list {
            builder.add(Glob::new(item).unwrap());
        }
        let set = builder.build().unwrap();
        files.retain(|f| {
            let path = f.rel_path.to_str().unwrap();
            !set.is_match(path)
        });
    })
}

fn read_dir(files: &mut Vec<SimpleFile>, source: &str) -> Result<(), std::io::Error> {
    let iters = WalkDir::new(source)
                .into_iter()
                .filter_map(|e| e.ok())
                .filter(|e| !e.path().is_dir());                
    for entry in iters {
        let path = entry.path();
        let mut content = String::new();
        File::open(path)?.read_to_string(&mut content)?;
        let file_struct = SimpleFile {
            name: path.file_name().unwrap().to_os_string(),
            content,
            rel_path: path.strip_prefix(source).unwrap().to_owned(),
            metadata: HashMap::new(),
        };
        files.push(file_struct);
    }
    Ok(())
}

fn write_dir(
    files: &mut Vec<SimpleFile>,
    destination: &str,
) -> Result<(), std::io::Error> {
    for file in files {
        let mut tpath;
        match &file.rel_path.strip_prefix("/") {
            Ok(p) => tpath = p.to_owned(),
            Err(_) => tpath = &file.rel_path,
        }
        let destination_path = PathBuf::from(destination).join(tpath);
        let mut dir_path = destination_path.clone();
        dir_path.pop();
        DirBuilder::new().recursive(true).create(&dir_path)?;
        File::create(&destination_path)?.write_all(file.content.as_bytes())?;
    }
    Ok(())
}