Code Clean up

Author: Phillip Krall

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/ui/properties/UpdateProjectPropertiesCmdTest.java

@@ -7,18 +7,18 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import name.herlin.command.CommandException;
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetFactory;
+import net.sourceforge.pmd.RuleSets;
 import net.sourceforge.pmd.eclipse.EclipseUtils;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectPropertiesManager;
 import net.sourceforge.pmd.eclipse.runtime.properties.PropertiesException;
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
 
-import name.herlin.command.CommandException;
-
 public class UpdateProjectPropertiesCmdTest {
     private IProject testProject;
 
@@ -71,7 +71,8 @@ public void testBug() throws CommandException, PropertiesException {
         final UpdateProjectPropertiesCmd cmd = new UpdateProjectPropertiesCmd();
         cmd.setPmdEnabled(true);
         cmd.setProject(this.testProject);
-        cmd.setProjectRuleSet(newRuleSet);
+        RuleSets ruleSets = new RuleSets(newRuleSet);
+        cmd.setProjectRuleSets(ruleSets);
         cmd.setProjectWorkingSet(null);
         cmd.setRuleSetStoredInProject(false);
         cmd.execute();

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/BaseVisitor.java

@@ -56,6 +56,7 @@
 import net.sourceforge.pmd.Report.ProcessingError;
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleContext;
+import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetFactory;
 import net.sourceforge.pmd.RuleSetNotFoundException;
 import net.sourceforge.pmd.RuleSets;
@@ -218,6 +219,24 @@ public RuleSets getRuleSets() {
         return this.ruleSets;
     }
 
+    /**
+     * This returns the first ruleset file.
+     * @return
+     */
+    public RuleSet getRuleSet() {
+      return this.ruleSets.getAllRuleSets()[0];
+    }
+    
+    /**
+     * This removes all the Rulesets from the rulesets
+     * and sets the only ruleset to the one passed in.
+     * 
+     * @param ruleSet
+     */
+    public void setRuleSet(RuleSet ruleSet) {
+      this.ruleSets = new RuleSets(ruleSet);
+    }
+    
     /**
      * @param ruleSet
      *            The ruleSet to set.

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCodeCmd.java

@@ -614,7 +614,6 @@ private void processResourceDelta() throws CommandException {
             logInfo("ReviewCodeCmd started on resource delta " + resource.getName() + " in project " + project.getName());
 
             RuleSets ruleSets = properties.getProjectRuleSets();
-          //  RuleSet ruleSet = rulesetFromResourceDelta(); // properties.getProjectRuleSet();
 
               // PMDEngine pmdEngine = getPmdEngineForProject(project);
               int targetCount = countDeltaElement(resourceDelta);

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesManagerImpl.java

@@ -639,15 +639,17 @@ private void updateConfiguredProjects(RuleSet updatedRuleSet) {
                 try {
                     IProjectProperties properties = PMDPlugin.getDefault().loadProjectProperties(project);
                     RuleSets projectRuleSet = properties.getProjectRuleSets();
+                    RuleSets newProjectRuleSet = new RuleSets();
                     if (projectRuleSet != null) {
                       projectRuleSet.getAllRules().addAll(getNewRules(updatedRuleSet));
                       for(RuleSet rs : projectRuleSet.getAllRuleSets()) {
                         rs = RuleSetUtil.setExcludePatterns(rs,
                           updatedRuleSet.getExcludePatterns());
                         rs = RuleSetUtil.setIncludePatterns(rs,
                           updatedRuleSet.getIncludePatterns());
+                        newProjectRuleSet.addRuleSet(rs);
                       }
-                      properties.setProjectRuleSets(projectRuleSet);
+                      properties.setProjectRuleSets(newProjectRuleSet);
                       properties.sync();
                     }
                 } catch (PropertiesException e) {
@@ -668,9 +670,7 @@ private void storeRuleSetInStateLocation(RuleSet ruleSet) {
             IPath ruleSetLocation = plugin.getStateLocation().append(PREFERENCE_RULESET_FILE);
             out = new FileOutputStream(ruleSetLocation.toOSString());
             IRuleSetWriter writer = plugin.getRuleSetWriter();
-            RuleSets ruleSets = new RuleSets();
-            ruleSets.addRuleSet(ruleSet);
-            writer.write(out, ruleSets);
+            writer.write(out, ruleSet);
             out.flush();
 
         } catch (IOException e) {

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/IProjectProperties.java

@@ -43,6 +43,7 @@
 import org.eclipse.core.resources.IProject;
 import org.eclipse.ui.IWorkingSet;
 
+import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSets;
 
 /**
@@ -73,6 +74,11 @@ public interface IProjectProperties {
      * @return Returns the project Rule Set.
      */
     RuleSets getProjectRuleSets() throws PropertiesException;
+    
+    /**
+     * @return Returns the first rule set in the project rulesets
+     */
+    RuleSet getProjectRuleSet() throws PropertiesException;
 
     /**
      * @param projectRuleSet

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesImpl.java

@@ -57,6 +57,7 @@
 import org.eclipse.ui.IWorkingSet;
 
 import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSets;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.cmd.JavaProjectClassLoader;
@@ -177,6 +178,13 @@ public void setPmdEnabled(final boolean pmdEnabled) {
   public RuleSets getProjectRuleSets() throws PropertiesException {
     return projectRuleSets;
   }
+  
+  /**
+   * @see net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties#getProjectRuleSet()
+   */
+  public RuleSet getProjectRuleSet() throws PropertiesException {
+    return projectRuleSets.getAllRuleSets()[0];
+  }
 
   /**
    * @see net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties#setProjectRuleSet(net.sourceforge.pmd.RuleSet)
@@ -374,7 +382,9 @@ public void createDefaultRuleSetFile() throws PropertiesException {
     try {
       IRuleSetWriter writer = PMDPlugin.getDefault().getRuleSetWriter();
       baos = new ByteArrayOutputStream();
-      writer.write(baos, projectRuleSets);
+      for(RuleSet rs: projectRuleSets.getAllRuleSets()) {
+        writer.write(baos, rs);
+      }
 
       final IFile file = project.getFile(PROJECT_RULESET_FILE);
       if (file.exists() && file.isAccessible()) {

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesManagerImpl.java

@@ -180,38 +180,6 @@ private void loadRuleSetFromProject(IProjectProperties projectProperties)
         for (final File ruleSetFile : projectProperties.getResolvedRuleSetFile()) {
           RuleSet ruleSet = factory.createRuleSets(ruleSetFile.getPath()).getAllRuleSets()[0];
           allRulesets.addRuleSet(ruleSet);
-          // This is the old rule stuff used to combine all the rulesets into one file.
-          // if (allRuleSets == null) {
-          // /* The first ruleset file */
-          // allRuleSets = rs;
-          // } else {
-          // /*
-          // * Loop through all the rules in an additional ruleset file. If a previous file
-          // * has defined the rule, then remove it. If it is not found, then add the new
-          // * rule.
-          // */
-          // List<Rule> rules = new ArrayList<Rule>(allRuleSets.getRules());
-          // for (Rule rule2 : rs.getRules()) {
-          // boolean processed = false;
-          // for (Rule rule1 : allRuleSets.getRules()) {
-          // if (rule2.getName().equals(rule1.getName())) {
-          // for (Iterator<Rule> iter = rules.listIterator(); iter.hasNext();) {
-          // Rule r = iter.next();
-          // if (r.getName().equals(rule1.getName())) {
-          // iter.remove();
-          // }
-          // }
-          // rules.add(rule2);
-          // processed = true;
-          // }
-          // if (!processed) {
-          // rules.add(rule2);
-          // }
-          // }
-          // }
-          // allRuleSets.getRules().removeAll(allRuleSets.getRules());
-          // allRuleSets.getRules().addAll(rules);
-          // }
         }
         projectProperties.setProjectRuleSets(allRulesets);
         projectProperties.setNeedRebuild(false);

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/writer/IRuleSetWriter.java

@@ -25,7 +25,7 @@
 
 import java.io.OutputStream;
 
-import net.sourceforge.pmd.RuleSets;
+import net.sourceforge.pmd.RuleSet;
 
 /**
  * Interface for a rule set writer. A rule set writer is an object used to
@@ -44,5 +44,5 @@ public interface IRuleSetWriter {
      * @param ruleSet
      *            the ruleset to serialize
      */
-    void write(OutputStream outputStream, RuleSets ruleSet) throws WriterException;
+    void write(OutputStream outputStream, RuleSet ruleSet) throws WriterException;
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/writer/impl/RuleSetWriterImpl.java

@@ -6,7 +6,6 @@
 
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetWriter;
-import net.sourceforge.pmd.RuleSets;
 import net.sourceforge.pmd.eclipse.runtime.writer.IRuleSetWriter;
 import net.sourceforge.pmd.eclipse.runtime.writer.WriterException;
 
@@ -27,12 +26,10 @@ class RuleSetWriterImpl implements IRuleSetWriter {
    * @param ruleSet
    *          the ruleset to serialize
    */
-  public void write(OutputStream outputStream, RuleSets ruleSets) throws WriterException {
+  public void write(OutputStream outputStream, RuleSet ruleSet) throws WriterException {
     try {
       RuleSetWriter ruleSetWriter = new RuleSetWriter(outputStream);
-      for (RuleSet ruleSet : ruleSets.getAllRuleSets()) {
-        ruleSetWriter.write(ruleSet);
-      }
+      ruleSetWriter.write(ruleSet);
       outputStream.flush();
     } catch (RuntimeException e) {
       throw new WriterException(e);

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/PMDPreferencePage.java

@@ -46,7 +46,6 @@
 
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleSet;
-import net.sourceforge.pmd.RuleSets;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.plugin.UISettings;
 import net.sourceforge.pmd.eclipse.runtime.writer.IRuleSetWriter;
@@ -580,9 +579,7 @@ public void widgetSelected(SelectionEvent event) {
                                     getFileNameWithoutExtension(file.getName()), input.getValue());
                             OutputStream out = new FileOutputStream(fileName);
                             IRuleSetWriter writer = PMDPlugin.getDefault().getRuleSetWriter();
-                            RuleSets ruleSets = new RuleSets();
-                            ruleSets.addRuleSet(ruleSet);
-                            writer.write(out, ruleSets);
+                            writer.write(out, ruleSet);
                             out.close();
                             MessageDialog.openInformation(getShell(), getMessage(StringKeys.INFORMATION_TITLE),
                                     getMessage(StringKeys.INFORMATION_RULESET_EXPORTED));