|
1 | | - |
2 | | -package org.scijava.maven.plugin.enforcer; |
3 | | - |
4 | | -import java.io.File; |
5 | | -import java.io.IOException; |
6 | | -import java.util.ArrayList; |
7 | | -import java.util.List; |
8 | | - |
9 | | -import org.apache.maven.enforcer.rule.api.EnforcerRule; |
10 | | -import org.apache.maven.enforcer.rule.api.EnforcerRuleException; |
11 | | -import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; |
12 | | -import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; |
13 | | - |
14 | | -import jdepend.framework.JDepend; |
15 | | -import jdepend.framework.PackageFilter; |
16 | | - |
17 | | -/** |
18 | | - * Common functionality for writing an {@link EnforcerRule} dealing with the |
19 | | - * package hierarchy. |
20 | | - * |
21 | | - * @author Ben Romberg |
22 | | - * @author David Burkhart |
23 | | - * @author Gabriel Selzer |
24 | | - */ |
25 | | -public abstract class AbstractPackageEnforcementRule implements EnforcerRule { |
26 | | - |
27 | | - private List<String> excludedPackages = new ArrayList<>(); |
28 | | - private List<String> includedPackages = new ArrayList<>(); |
29 | | - private boolean includeTests = true; |
30 | | - |
31 | | - @Override |
32 | | - public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { |
33 | | - try { |
34 | | - executePackageCycleCheckIfNecessary(helper); |
35 | | - } |
36 | | - catch (ExpressionEvaluationException e) { |
37 | | - throw new EnforcerRuleException("Unable to lookup an expression " + e |
38 | | - .getLocalizedMessage(), e); |
39 | | - } |
40 | | - catch (IOException e) { |
41 | | - throw new EnforcerRuleException("Unable to access target directory " + e |
42 | | - .getLocalizedMessage(), e); |
43 | | - } |
44 | | - } |
45 | | - |
46 | | - @Override |
47 | | - public String getCacheId() { |
48 | | - return ""; |
49 | | - } |
50 | | - |
51 | | - @Override |
52 | | - public boolean isCacheable() { |
53 | | - return false; |
54 | | - } |
55 | | - |
56 | | - @Override |
57 | | - public boolean isResultValid(EnforcerRule arg0) { |
58 | | - return false; |
59 | | - } |
60 | | - |
61 | | - public void setExcludedPackages(List<String> excludedPackages) { |
62 | | - this.excludedPackages = excludedPackages; |
63 | | - } |
64 | | - |
65 | | - public void setIncludedPackages(List<String> includedPackages) { |
66 | | - this.includedPackages = includedPackages; |
67 | | - } |
68 | | - |
69 | | - public void setIncludeTests(boolean includeTests) { |
70 | | - this.includeTests = includeTests; |
71 | | - } |
72 | | - |
73 | | - private void executePackageCheck(EnforcerRuleHelper helper, |
74 | | - Iterable<File> directories) throws IOException, EnforcerRuleException |
75 | | - { |
76 | | - JDepend jdepend = createJDepend(helper); |
77 | | - for (File directory : directories) { |
78 | | - jdepend.addDirectory(directory.getAbsolutePath()); |
79 | | - } |
80 | | - jdepend.analyze(); |
81 | | - |
82 | | - enforceRule(jdepend); |
83 | | - } |
84 | | - |
85 | | - private void executePackageCycleCheckIfNecessary(EnforcerRuleHelper helper) |
86 | | - throws ExpressionEvaluationException, IOException, EnforcerRuleException |
87 | | - { |
88 | | - DirectoriesWithClasses directories = new DirectoriesWithClasses(helper, |
89 | | - "package cycles", includeTests); |
90 | | - if (directories.directoriesWithClassesFound()) { |
91 | | - executePackageCheck(helper, directories); |
92 | | - } |
93 | | - else { |
94 | | - helper.getLog().info( |
95 | | - "No directories with classes to check for cycles found."); |
96 | | - } |
97 | | - } |
98 | | - |
99 | | - protected JDepend createJDepend(EnforcerRuleHelper helper) { |
100 | | - if (!includedPackages.isEmpty()) { |
101 | | - helper.getLog().warn( |
102 | | - "Package cycles rule check is restricted to check only these packages: " + |
103 | | - includedPackages); |
104 | | - } |
105 | | - if (!excludedPackages.isEmpty()) { |
106 | | - helper.getLog().warn( |
107 | | - "These packages were excluded from package cycle rule check: " + |
108 | | - excludedPackages); |
109 | | - } |
110 | | - return new JDepend(PackageFilter.all().including(includedPackages) |
111 | | - .excluding(excludedPackages)); |
112 | | - } |
113 | | - |
114 | | - /** |
115 | | - * Enforces the rule |
116 | | - * |
117 | | - * @param jdepend a {@link JDepend} containing relevant package information |
118 | | - * @throws EnforcerRuleException iff the rule is invalid for the packages |
119 | | - * described by {@code jdepend} |
120 | | - */ |
121 | | - abstract void enforceRule(JDepend jdepend) throws EnforcerRuleException; |
122 | | - |
123 | | -} |
| 1 | + |
| 2 | +package org.scijava.maven.plugin.enforcer; |
| 3 | + |
| 4 | +import java.io.File; |
| 5 | +import java.io.IOException; |
| 6 | +import java.util.ArrayList; |
| 7 | +import java.util.List; |
| 8 | + |
| 9 | +import org.apache.maven.enforcer.rule.api.EnforcerRule; |
| 10 | +import org.apache.maven.enforcer.rule.api.EnforcerRuleException; |
| 11 | +import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; |
| 12 | +import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; |
| 13 | + |
| 14 | +import jdepend.framework.JDepend; |
| 15 | +import jdepend.framework.PackageFilter; |
| 16 | + |
| 17 | +/** |
| 18 | + * Common functionality for writing an {@link EnforcerRule} dealing with the |
| 19 | + * package hierarchy. |
| 20 | + * |
| 21 | + * @author Ben Romberg |
| 22 | + * @author David Burkhart |
| 23 | + * @author Gabriel Selzer |
| 24 | + */ |
| 25 | +public abstract class AbstractPackageEnforcementRule implements EnforcerRule { |
| 26 | + |
| 27 | + private List<String> excludedPackages = new ArrayList<>(); |
| 28 | + private List<String> includedPackages = new ArrayList<>(); |
| 29 | + private boolean includeTests = true; |
| 30 | + |
| 31 | + @Override |
| 32 | + public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { |
| 33 | + try { |
| 34 | + executePackageCycleCheckIfNecessary(helper); |
| 35 | + } |
| 36 | + catch (ExpressionEvaluationException e) { |
| 37 | + throw new EnforcerRuleException("Unable to lookup an expression " + e |
| 38 | + .getLocalizedMessage(), e); |
| 39 | + } |
| 40 | + catch (IOException e) { |
| 41 | + throw new EnforcerRuleException("Unable to access target directory " + e |
| 42 | + .getLocalizedMessage(), e); |
| 43 | + } |
| 44 | + } |
| 45 | + |
| 46 | + @Override |
| 47 | + public String getCacheId() { |
| 48 | + return ""; |
| 49 | + } |
| 50 | + |
| 51 | + @Override |
| 52 | + public boolean isCacheable() { |
| 53 | + return false; |
| 54 | + } |
| 55 | + |
| 56 | + @Override |
| 57 | + public boolean isResultValid(EnforcerRule arg0) { |
| 58 | + return false; |
| 59 | + } |
| 60 | + |
| 61 | + public void setExcludedPackages(List<String> excludedPackages) { |
| 62 | + this.excludedPackages = excludedPackages; |
| 63 | + } |
| 64 | + |
| 65 | + public void setIncludedPackages(List<String> includedPackages) { |
| 66 | + this.includedPackages = includedPackages; |
| 67 | + } |
| 68 | + |
| 69 | + public void setIncludeTests(boolean includeTests) { |
| 70 | + this.includeTests = includeTests; |
| 71 | + } |
| 72 | + |
| 73 | + private void executePackageCheck(EnforcerRuleHelper helper, |
| 74 | + Iterable<File> directories) throws IOException, EnforcerRuleException |
| 75 | + { |
| 76 | + JDepend jdepend = createJDepend(helper); |
| 77 | + for (File directory : directories) { |
| 78 | + jdepend.addDirectory(directory.getAbsolutePath()); |
| 79 | + } |
| 80 | + jdepend.analyze(); |
| 81 | + |
| 82 | + enforceRule(jdepend); |
| 83 | + } |
| 84 | + |
| 85 | + private void executePackageCycleCheckIfNecessary(EnforcerRuleHelper helper) |
| 86 | + throws ExpressionEvaluationException, IOException, EnforcerRuleException |
| 87 | + { |
| 88 | + DirectoriesWithClasses directories = new DirectoriesWithClasses(helper, |
| 89 | + "package cycles", includeTests); |
| 90 | + if (directories.directoriesWithClassesFound()) { |
| 91 | + executePackageCheck(helper, directories); |
| 92 | + } |
| 93 | + else { |
| 94 | + helper.getLog().info( |
| 95 | + "No directories with classes to check for cycles found."); |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + protected JDepend createJDepend(EnforcerRuleHelper helper) { |
| 100 | + if (!includedPackages.isEmpty()) { |
| 101 | + helper.getLog().warn( |
| 102 | + "Package cycles rule check is restricted to check only these packages: " + |
| 103 | + includedPackages); |
| 104 | + } |
| 105 | + if (!excludedPackages.isEmpty()) { |
| 106 | + helper.getLog().warn( |
| 107 | + "These packages were excluded from package cycle rule check: " + |
| 108 | + excludedPackages); |
| 109 | + } |
| 110 | + return new JDepend(PackageFilter.all().including(includedPackages) |
| 111 | + .excluding(excludedPackages)); |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Enforces the rule |
| 116 | + * |
| 117 | + * @param jdepend a {@link JDepend} containing relevant package information |
| 118 | + * @throws EnforcerRuleException iff the rule is invalid for the packages |
| 119 | + * described by {@code jdepend} |
| 120 | + */ |
| 121 | + abstract void enforceRule(JDepend jdepend) throws EnforcerRuleException; |
| 122 | + |
| 123 | +} |
0 commit comments