TouchInstinct
/
checkstyle
307
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#241 Allow HeaderCheck definition to be specified as URL

This commit is contained in:
tnarake 2013-07-18 14:58:24 +02:00
parent 795234dba5
commit cb75a3178c
2 changed files with 72 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/AbstractHeaderCheck.java
View File

@ -18,26 +18,30 @@
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.header;
import com.google.common.collect.ImmutableList;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.io.Reader;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.List;
import org.apache.commons.beanutils.ConversionException;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Utils;
import org.apache.commons.beanutils.ConversionException;
/**
* Abstract super class for header checks.
* Provides support for header and headerFile properties.
@ -101,8 +105,9 @@ public abstract class AbstractHeaderCheck extends AbstractFileSetCheck
checkHeaderNotInitialized();
Reader headerReader = null;
try {
final URI uri = resolveHeaderFile();
headerReader = new InputStreamReader(new BufferedInputStream(
new FileInputStream(mFilename)), mCharset);
uri.toURL().openStream()), mCharset);
loadHeader(headerReader);
}
catch (final IOException ex) {
@ -114,6 +119,49 @@ public abstract class AbstractHeaderCheck extends AbstractFileSetCheck
}
}
/**
* Resolve the specified filename param to a URI.
* @return resolved header file URI
* @throws IOException on failure
*/
private URI resolveHeaderFile() throws IOException
{
// figure out if this is a File or a URL
URI uri;
try {
final URL url = new URL(mFilename);
uri = url.toURI();
}
catch (final MalformedURLException ex) {
uri = null;
}
catch (final URISyntaxException ex) {
// URL violating RFC 2396
uri = null;
}
if (uri == null) {
final File file = new File(mFilename);
if (file.exists()) {
uri = file.toURI();
}
else {
// check to see if the file is in the classpath
try {
final URL configUrl = AbstractHeaderCheck.class
.getResource(mFilename);
if (configUrl == null) {
throw new FileNotFoundException(mFilename);
}
uri = configUrl.toURI();
}
catch (final URISyntaxException e) {
throw new FileNotFoundException(mFilename);
}
}
}
return uri;
}
/**
* Called before initializing the header.
* @throws ConversionException if header has already been set

19
src/tests/com/puppycrawl/tools/checkstyle/checks/header/HeaderCheckTest.java
View File

@ -20,10 +20,14 @@ package com.puppycrawl.tools.checkstyle.checks.header;
import static org.junit.Assert.fail;
import java.io.File;
import java.net.URI;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import org.junit.Test;
public class HeaderCheckTest extends BaseFileSetCheckTestSupport
{
@ -52,6 +56,19 @@ public class HeaderCheckTest extends BaseFileSetCheckTestSupport
verify(checkConfig, getPath("InputScopeAnonInner.java"), expected);
}
@Test
public void testRegexpHeaderURL() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(RegexpHeaderCheck.class);
URI uri = (new File(getPath("regexp.header"))).toURI();
checkConfig.addAttribute("headerFile", uri.toString());
final String[] expected = {
"3: Line does not match expected header line of '// Created: 2002'.",
};
verify(checkConfig, getPath("InputScopeAnonInner.java"), expected);
}
@Test
public void testInlineRegexpHeader() throws Exception
{