smartfile/ts/smartfile.memory.ts

import 'typings-global'

import plugins = require('./smartfile.plugins')
import SmartfileInterpreter = require('./smartfile.interpreter')
let vinyl = require('vinyl')

export interface vinyl {
    contents: Buffer
    base: string
    path: string,
}

let Readable = require('stream').Readable

/**
 * allows you to create a gulp stream
 * from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
 * @param fileArg
 * @returns stream.Readable
 * @TODO: make it async;
 */
export let toGulpStream = function(fileArg: string|string[]|vinyl|vinyl[],baseArg: string = '/'){
    let fileArray = []

    if (typeof fileArg === 'string' || fileArg instanceof vinyl) { // make sure we work with an array later on
        fileArray.push(fileArg)
    } else if (Array.isArray(fileArg)) {
        fileArray = fileArg
    } else {
        throw new Error('fileArg has unknown format')
    }

    let vinylFileArray: vinyl[] = [] // we want to have an array of vinylFiles

    for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
        let file = fileArray[fileIndexArg]
        file instanceof vinyl ?
            vinylFileArray.push(file) :
            vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
    };

    let stream = new Readable({ objectMode: true })
    for (let vinylFileIndexArg in vinylFileArray) {
        let vinylFile = vinylFileArray[vinylFileIndexArg]
        stream.push(vinylFile)
    };
    stream.push(null) // signal end of stream;
    return stream
}

/**
 * converts file to Object
 * @param fileStringArg
 * @param fileTypeArg
 * @returns {any|any}
 */
export let toObject = function(fileStringArg: string,fileTypeArg: string){
    return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
}

/**
 * takes a string and converts it to vinyl file
 * @param fileArg
 * @param optionsArg
 */
export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}) {
    optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
    optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
    optionsArg.base ? void(0) : optionsArg.base = '/'
    optionsArg.relPath ? void('0') : optionsArg.relPath = ''
    let vinylFile = new vinyl({
        base: optionsArg.base,
        path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
        contents: new Buffer(fileArg)
    })
    return vinylFile
}

/**
 * takes a string array and some options and returns a vinylfile array
 * @param arrayArg
 * @param optionsArg
 */
export let toVinylArraySync = function(
    arrayArg: string[],
    optionsArg?: {
        filename?: string,
        base?: string,
        relPath?: string
    }
){
    let vinylArray = []
    for (let stringIndexArg in arrayArg) {
        let myString = arrayArg[stringIndexArg]
        vinylArray.push(toVinylFileSync(myString,optionsArg))
    }
    return vinylArray
}

/**
 * takes a vinylFile object and converts it to String
 */
export let vinylToStringSync = function(fileArg: vinyl){
    return fileArg.contents.toString('utf8')
}

/**
 * writes string or vinyl file to disk.
 * @param fileArg
 * @param fileNameArg
 * @param fileBaseArg
 */
export let toFs = function(fileContentArg: string|vinyl,filePathArg){
    let done = plugins.q.defer()

    // function checks to abort if needed
    if (!fileContentArg || !filePathArg) {
        throw new Error('expected valid arguments')
    }

    // prepare actual write action
    let fileString: string
    let filePath: string = filePathArg
    if (fileContentArg instanceof vinyl) {
        fileString = vinylToStringSync(fileContentArg)
    } else if (typeof fileContentArg === 'string') {
        fileString = fileContentArg
    }
    plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
    return done.promise
}

export let toFsSync = function(fileArg,filePathArg: string){
    // function checks to abort if needed
    if (!fileArg || !filePathArg) {
        throw new Error('expected a valid arguments')
    }

    // prepare actual write action
    let fileString: string
    let filePath: string = filePathArg

    if (typeof fileArg !== 'string') {
        fileString = vinylToStringSync(fileArg)
    } else if (typeof fileArg === 'string') {
        fileString = fileArg
    }
    plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
}