From c9f623ca7b84157b9437fb6d7d17f46c9cc0681b Mon Sep 17 00:00:00 2001
From: Andreas Dangel <adangel@users.sourceforge.net>
Date: Sun, 4 Oct 2015 11:12:16 +0200
Subject: [PATCH] Remove deprecated rules

---
 .../main/resources/rulesets/java/basic.xml    | 21 --------
 .../resources/rulesets/java/controversial.xml | 37 --------------
 .../main/resources/rulesets/java/design.xml   |  1 -
 .../controversial/ControversialRulesTest.java |  1 -
 .../controversial/xml/BooleanInversion.xml    | 48 -------------------
 src/site/markdown/overview/changelog.md       | 18 +++++++
 6 files changed, 18 insertions(+), 108 deletions(-)
 delete mode 100644 pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/controversial/xml/BooleanInversion.xml

diff --git a/pmd-java/src/main/resources/rulesets/java/basic.xml b/pmd-java/src/main/resources/rulesets/java/basic.xml
index 8a90bc7922..42fd5e65a1 100644
--- a/pmd-java/src/main/resources/rulesets/java/basic.xml
+++ b/pmd-java/src/main/resources/rulesets/java/basic.xml
@@ -847,25 +847,4 @@ public class Foo {
         ]]>
     </example>
   </rule>
-
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyCatchBlock" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyIfStmt" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyWhileStmt" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyTryBlock" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyFinallyBlock" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptySwitchStatements" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptySynchronizedBlock" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyStatementNotInLoop" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyInitializer" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyStatementBlock" />
-    <rule deprecated="true" ref="rulesets/java/empty.xml/EmptyStaticInitializer" />
-
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UnnecessaryConversionTemporary" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UnnecessaryReturn" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UnnecessaryFinalModifier" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UselessOverridingMethod" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UselessOperationOnImmutable" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UnusedNullCheckInEquals" />
-    <rule deprecated="true" ref="rulesets/java/unnecessary.xml/UselessParentheses" />
-
 </ruleset>
diff --git a/pmd-java/src/main/resources/rulesets/java/controversial.xml b/pmd-java/src/main/resources/rulesets/java/controversial.xml
index 1627cc401d..822bdeed3d 100644
--- a/pmd-java/src/main/resources/rulesets/java/controversial.xml
+++ b/pmd-java/src/main/resources/rulesets/java/controversial.xml
@@ -297,43 +297,6 @@ or MethodDeclaration[@PackagePrivate='true']
         </properties>
     </rule>
 
-    <rule deprecated="true"
-          name="BooleanInversion"
-          language="java"
-          since="3.5"
-          message="Use bitwise inversion to invert boolean values"
-          class="net.sourceforge.pmd.lang.rule.XPathRule"
-          externalInfoUrl="${pmd.website.baseurl}/rules/java/controversial.html#BooleanInversion">
-      <description>
-<![CDATA[
-**Note:** This rule is deprecated as nowadays the JVMs JIT compilers will optimize away the differences.
-While the bytecode generated by the java compiler is indeed different, at runtime the instructions
-are optimized to the fastest way automatically.
-See [#1277](https://sourceforge.net/p/pmd/bugs/1277/) for more details.
-
-Use bitwise inversion to invert boolean values - it's the fastest way to do this.
-See [Java Specialists - Issue 042](http://www.javaspecialists.eu/archive/Issue042.html) for specific details.
-]]>
-      </description>
-      <priority>3</priority>
-      <properties>
-          <property name="xpath">
-              <value>
-    <![CDATA[
-//AssignmentOperator[@Image="="]/../Expression/UnaryExpressionNotPlusMinus[@Image="!"]
-]]>
-             </value>
-          </property>
-      </properties>
-      <example>
-  <![CDATA[
-boolean b = true;
-b = !b;		// slow
-b ^= true;	// fast
-]]>
-      </example>
-    </rule>
-
     <rule name="DataflowAnomalyAnalysis"
           since="3.9"
               message="Found ''{0}''-anomaly for variable ''{1}'' (lines ''{2}''-''{3}'')."
diff --git a/pmd-java/src/main/resources/rulesets/java/design.xml b/pmd-java/src/main/resources/rulesets/java/design.xml
index 0725c6837b..5e2ad28751 100644
--- a/pmd-java/src/main/resources/rulesets/java/design.xml
+++ b/pmd-java/src/main/resources/rulesets/java/design.xml
@@ -1353,7 +1353,6 @@ class Singleton {
 </example>
 </rule>
 
-    <rule deprecated="true" name="UncommentedEmptyMethod" ref="UncommentedEmptyMethodBody" />
     <rule name="UncommentedEmptyMethodBody"
           language="java"
           since="3.4"
diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/controversial/ControversialRulesTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/controversial/ControversialRulesTest.java
index eed55bc013..ff27e4d46d 100644
--- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/controversial/ControversialRulesTest.java
+++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/controversial/ControversialRulesTest.java
@@ -19,7 +19,6 @@ public class ControversialRulesTest extends SimpleAggregatorTst {
         addRule(RULESET, "AvoidUsingVolatile");
         addRule(RULESET, "AtLeastOneConstructor");
         addRule(RULESET, "AvoidFinalLocalVariable");
-        addRule(RULESET, "BooleanInversion");
         addRule(RULESET, "CallSuperInConstructor");
         addRule(RULESET, "DataflowAnomalyAnalysis");
         addRule(RULESET, "DefaultPackage");
diff --git a/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/controversial/xml/BooleanInversion.xml b/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/controversial/xml/BooleanInversion.xml
deleted file mode 100644
index a61a9d915d..0000000000
--- a/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/controversial/xml/BooleanInversion.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<test-data>
-    <test-code>
-        <description><![CDATA[
-failure, unary assignment
-     ]]></description>
-        <expected-problems>1</expected-problems>
-        <code><![CDATA[
-public class Foo {
- public void bar() {
-   boolean b = false;
-   boolean c = false;
-   b = !c;
- }
-}
-     ]]></code>
-    </test-code>
-    <test-code>
-        <description><![CDATA[
-pass, bitwise assignment
-     ]]></description>
-        <expected-problems>0</expected-problems>
-        <code><![CDATA[
-public class Foo {
- public void bar() {
-   boolean b = false;
-   boolean c = false;
-   b ^= c;
- }
-}
-     ]]></code>
-    </test-code>
-    <test-code>
-        <description><![CDATA[
-pass, not a straight unary inversion
-     ]]></description>
-        <expected-problems>0</expected-problems>
-        <code><![CDATA[
-public class Foo {
- public void bar() {
-   boolean b = false;
-   boolean c = false;
-   b &= !c;
- }
-}
-     ]]></code>
-    </test-code>
-</test-data>
diff --git a/src/site/markdown/overview/changelog.md b/src/site/markdown/overview/changelog.md
index a6eaeb7f27..7075b297f7 100644
--- a/src/site/markdown/overview/changelog.md
+++ b/src/site/markdown/overview/changelog.md
@@ -131,6 +131,24 @@ Ruleset snippet to activate the new rules:
         The rule "UseSingleton" *has been renamed* to "UseUtilityClass".
         See also bugs [#1059](https://sourceforge.net/p/pmd/bugs/1059) and [#1339](https://sourceforge.net/p/pmd/bugs/1339/).
 
+**Removed Rules:**
+
+*   Java
+    *   Basic: The following rules of ruleset "Basic" were marked as deprecated and are removed with this release now:
+
+        EmptyCatchBlock, EmptyIfStatement, EmptyWhileStmt, EmptyTryBlock, EmptyFinallyBlock, EmptySwitchStatements, EmptySynchronizedBlock, EmptyStatementNotInLoop, EmptyInitializer, EmptyStatementBlock, EmptyStaticInitializer
+
+        UnnecessaryConversionTemporary, UnnecessaryReturn, UnnecessaryFinalModifier, UselessOverridingMethod, UselessOperationOnImmutable, UnusedNullCheckInEquals, UselessParentheses
+
+        These rules are still available in the rulesets "Empty" (rulesets/java/empty.xml) and
+        "Unnecessary" (rulesets/java/unnecessary.xml) respectively.
+
+    *   Design: The rule "UncommentedEmptyMethod" has been renamed last release to "UncommentedEmptyMethodBody". The
+        old rule name reference has been removed with this release now.
+
+    *   Controversial: The rule "BooleanInversion" has been deprecated last release
+        and has been removed with this release completely.
+
 **Pull Requests:**
 
 *   [#21](https://github.com/adangel/pmd/pull/21): Added PMD Rules for Singleton pattern violations.