org.codenarc.ruleset.GroovyDslRuleSet.groovy Maven / Gradle / Ivy

Go to download

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

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * Copyright 2009 the original author or authors.
 * 
 * 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 org.codenarc.ruleset

import org.slf4j.LoggerFactory
import org.codehaus.groovy.control.MultipleCompilationErrorsException
import org.codenarc.util.io.DefaultResourceFactory
import org.codenarc.util.io.ResourceFactory

/**
 * A RuleSet implementation that parses a Groovy DSL of RuleSet definitions.
 * The filename passed into the constructor is interpreted relative to the classpath.
 * Note that this class attempts to read the file and parse the Groovy from within the constructor.
 *
 * @author Chris Mair
  */
class GroovyDslRuleSet implements RuleSet {

    private static final LOG = LoggerFactory.getLogger(GroovyDslRuleSet)
    private final ResourceFactory resourceFactory = new DefaultResourceFactory()
    private final RuleSetBuilder ruleSetBuilder = new RuleSetBuilder()
    private final String path
    private final rules

    /**
     * Construct a new instance on the specified Groovy DSL RuleSet file path
     * @param path - the path to the Groovy DSL RuleSet definition file, relative to the classpath; must not be empty or null
     */
    GroovyDslRuleSet(String path) {
        assert path
        this.path = path
        LOG.info("Loading ruleset from [$path]")
        GroovyShell shell = createGroovyShell()
        evaluateDsl(shell)
        rules = ruleSetBuilder.ruleSet.rules
    }

    private GroovyShell createGroovyShell() {
        def callRuleSet = { Closure closure ->
            closure.resolveStrategy = Closure.DELEGATE_ONLY    // fail if access non-existent properties
            ruleSetBuilder.ruleset(closure)
        }
        Binding binding = new Binding(ruleset:callRuleSet)

        return new GroovyShell(this.class.classLoader, binding)
    }

    private void evaluateDsl(GroovyShell shell) {
        def inputStream = resourceFactory.getResource(path).inputStream
        inputStream.withReader { reader ->
            try {
                shell.evaluate(reader)
            } catch (MultipleCompilationErrorsException compileError) {
                LOG.error("An error occurred compiling the configuration file $path", compileError)
                throw new IllegalStateException("An error occurred compiling the configuration file $path\n${compileError.message}")
            }
        }
    }

    /**
     * @return a List of Rule objects
     */
    List getRules() {
        rules
    }
}