com.sysgears.grain.registry.YAMLHeaderParser.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grain Show documentation

Grain is a static web site building framework for Groovy that makes demanding static web site implementation an intuitive and enjoyable task to do.

There is a newer version: 0.7.3

Show newest version

/*
 * Copyright (c) 2013 SysGears, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.sysgears.grain.registry

import org.yaml.snakeyaml.Yaml

import javax.inject.Inject
import javax.inject.Provider

/**
 * Resource YAML header parser. 
 */
@javax.inject.Singleton
class YAMLHeaderParser implements HeaderParser {

    /** YAML parser factory */
    @Inject
    private Provider yamlProvider

    /**
     * Parses resource YAML header
     *
     * @param resourceFile resource file to parse
     *
     * @return header key -> value map
     *
     * @throws HeaderParseException in case of header parse error 
     */
    Map parse(File resourceFile) throws HeaderParseException {
        parse(resourceFile, new ResourceParser(resourceFile).header)
    }

    /**
     * Parses resource YAML header
     *
     * @param resourceFile resource file to parse
     * @param header contents of the resource file header
     *
     * @return header key -> value map
     *
     * @throws HeaderParseException in case of header parse error 
     */
    Map parse(File resourceFile, String header) throws HeaderParseException {
        try {
            yamlProvider.get().load(header) as Map ?: [:]
        } catch (t) {
            throw new HeaderParseException("Error parsing header of resource at ${resourceFile}", t)
        }
    }
}