version 1.6.0

SAP · Oct 2, 2023 · caf7c17 · caf7c17
1 parent cdde071
commit caf7c17
Show file tree

Hide file tree

Showing 20 changed files with 53 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ and **configure** options and thresholds for these rules.
 Your team may align on a common configuration and create a **team profile** from it.
 
 
-## Demo
+## Demo of ABAP Cleaner
 
 For a demo of what ABAP cleaner offers, how it is installed, used and configured, you can watch this session on YouTube: 
 [How to clean your ABAP code in seconds with ABAP cleaner](https://www.youtube.com/watch?v=0mp0FuJV5_k).
@@ -61,8 +61,11 @@ Using ABAP cleaner from ADT, the cleanup can be done
 - or **interactively** by opening the ABAP cleaner UI (***Ctrl + Shift + 4*** or menu 'Source Code / Clean Up With Interactive ABAP Cleaner...') 
   which allows you to check the changes, revert those that you don't like with a single mouse click, 
   and finally apply (or discard) the result. 
-
-![ABAP cleaner integration into ABAP Development Tools (ADT)](docs/images/adt-integration.png "ABAP cleaner integration into ABAP Development Tools (ADT)")
+- A third option shows a **read-only preview** of the cleanup result without locking or changing the code, 
+  e.g. if you don't have development authorization in the current system 
+  (***Ctrl + Shift + 5*** or menu 'Source Code / Show Read-Only Preview With ABAP Cleaner...')
+
+  ![ABAP cleaner integration into ABAP Development Tools (ADT)](docs/images/adt-integration.png "ABAP cleaner integration into ABAP Development Tools (ADT)")
 
 ### Using the Stand-alone App with SAP GUI
 
@@ -79,7 +82,7 @@ both with a "broadband" approach (simultaneously applying 60+ different rules)
 and a focused approach (cleaning with a limited selection of rules). 
 
 ABAP cleaner was implemented with object-oriented ABAP in mind, but it may also be used for code in reports and functions. 
-SQL statements are NOT the focus of ABAP cleaner (meaning that most cleanup rules leave them unchanged).
+ABAP SQL and EML statements are not yet supported (meaning that most cleanup rules simply leave them unchanged). 
 
 
 ## Requirements and Installation

diff --git a/com.sap.adt.abapcleaner.app/abapcleaner.product b/com.sap.adt.abapcleaner.app/abapcleaner.product
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?pde version="3.5"?>
 
-<product name="ABAP cleaner" uid="com.sap.adt.abapcleaner.app" application="com.sap.adt.abapcleaner.standalone.app" version="1.5.6.qualifier" useFeatures="true" includeLaunchers="true">
+<product name="ABAP cleaner" uid="com.sap.adt.abapcleaner.app" application="com.sap.adt.abapcleaner.standalone.app" version="1.6.0" useFeatures="true" includeLaunchers="true">
 
    <configIni use="default">
    </configIni>

diff --git a/com.sap.adt.abapcleaner.app/pom.xml b/com.sap.adt.abapcleaner.app/pom.xml
@@ -3,14 +3,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>com.sap.adt.abapcleaner.app</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>com.sap.adt.abapcleaner.app</name>
   <packaging>eclipse-repository</packaging>
 
   <parent>
     <artifactId>parent</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/com.sap.adt.abapcleaner.feature/feature.xml b/com.sap.adt.abapcleaner.feature/feature.xml
@@ -2,7 +2,7 @@
 <feature
       id="com.sap.adt.abapcleaner.feature"
       label="ABAP cleaner"
-      version="1.5.6.qualifier">
+      version="1.6.0">
 
    <description>
       ABAP cleaner plug-in for ABAP Development Tools

diff --git a/com.sap.adt.abapcleaner.feature/pom.xml b/com.sap.adt.abapcleaner.feature/pom.xml
@@ -3,14 +3,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
   <modelVersion>4.0.0</modelVersion>
   <artifactId>com.sap.adt.abapcleaner.feature</artifactId>
   <groupId>com.sap.adt.abapcleaner</groupId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>com.sap.adt.abapcleaner.feature</name>
   <packaging>eclipse-feature</packaging>
 
   <parent>
     <artifactId>parent</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/com.sap.adt.abapcleaner.gui/META-INF/MANIFEST.MF b/com.sap.adt.abapcleaner.gui/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-SymbolicName: com.sap.adt.abapcleaner.gui;singleton:=true
-Bundle-Version: 1.5.6.qualifier
+Bundle-Version: 1.6.0
 Bundle-Vendor: %Provider-Name
 Bundle-Localization: plugin
 Bundle-RequiredExecutionEnvironment: JavaSE-11

diff --git a/com.sap.adt.abapcleaner.gui/pom.xml b/com.sap.adt.abapcleaner.gui/pom.xml
@@ -3,14 +3,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>com.sap.adt.abapcleaner.gui</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>com.sap.adt.abapcleaner.gui</name>
   <packaging>eclipse-plugin</packaging>
 
   <parent>
     <artifactId>parent</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/com.sap.adt.abapcleaner.gui/src/com/sap/adt/abapcleaner/gui/FrmInputBox.java b/com.sap.adt.abapcleaner.gui/src/com/sap/adt/abapcleaner/gui/FrmInputBox.java
@@ -55,9 +55,9 @@ public final String open(String defaultText, String title, boolean restrictToVal
    }
 
 	protected void createContents() {
-		shell = new Shell(SWT.APPLICATION_MODAL | SWT.BORDER | SWT.TITLE | SWT.CLOSE);
-		shell.setMinimumSize(new Point(450, 130));
-		shell.setSize(450, 130);
+		shell = new Shell(SWT.APPLICATION_MODAL | SWT.BORDER | SWT.CLOSE | SWT.RESIZE | SWT.TITLE);
+		shell.setMinimumSize(new Point(450, 140));
+		shell.setSize(450, 140);
 		shell.setImage(SWTResourceManager.getImage(FrmInputBox.class, "/ShellImage.png"));
 		shell.setText("Input Box");
 		GridLayout gl_shell = new GridLayout(1, false);

diff --git a/com.sap.adt.abapcleaner.updatesite/pom.xml b/com.sap.adt.abapcleaner.updatesite/pom.xml
@@ -2,14 +2,14 @@
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0">
   <modelVersion>4.0.0</modelVersion>
   <artifactId>com.sap.adt.abapcleaner.updatesite</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>ABAP Cleaner for ABAP Development Tools (ADT)</name>
   <packaging>eclipse-repository</packaging>
 
   <parent>
     <artifactId>parent</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/com.sap.adt.abapcleaner/META-INF/MANIFEST.MF b/com.sap.adt.abapcleaner/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-SymbolicName: com.sap.adt.abapcleaner;singleton:=true
-Bundle-Version: 1.5.6.qualifier
+Bundle-Version: 1.6.0
 Bundle-Vendor: %Provider-Name
 Bundle-Localization: plugin
 Bundle-RequiredExecutionEnvironment: JavaSE-11

diff --git a/com.sap.adt.abapcleaner/pom.xml b/com.sap.adt.abapcleaner/pom.xml
@@ -3,14 +3,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>com.sap.adt.abapcleaner</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>com.sap.adt.abapcleaner</name>
   <packaging>eclipse-plugin</packaging>
 
   <parent>
     <artifactId>parent</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/com.sap.adt.abapcleaner/src/com/sap/adt/abapcleaner/base/PersistencyBase.java b/com.sap.adt.abapcleaner/src/com/sap/adt/abapcleaner/base/PersistencyBase.java
@@ -3,8 +3,6 @@
 import java.io.File;
 import java.nio.charset.Charset;
 
-import com.sap.adt.abapcleaner.programbase.Persistency;
-
 /**
  * Provides methods to persist data on the local file system, encapsulating java.io.File.
  */

diff --git a/com.sap.adt.abapcleaner/src/com/sap/adt/abapcleaner/programbase/Program.java b/com.sap.adt.abapcleaner/src/com/sap/adt/abapcleaner/programbase/Program.java
@@ -55,6 +55,7 @@ public static String getVersion() {
 
 	public static Release[] getReleases() {
 		return new Release[] { 
+				Release.create("1.6.0", 2023, 10, 2), 
 				Release.create("1.5.0", 2023, 7, 5), 
 				Release.create("1.4.0", 2023, 6, 12), 
 				Release.create("1.3.0", 2023, 6, 6), 

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -6,6 +6,24 @@ as well as bugfixes of reported issues, i.e. anything that enhances or changes t
 For a complete list of changes (including documentation, tests, refactoring etc.), please refer to 
 the list of [commits](../../../commits/main).
 
+## 2023-10-02 (version 1.6.0)
+
+**Great thanks** to [**stockbal**](https://github.com/stockbal) for the first Open-Source code contribution to ABAP cleaner!, 
+as well as [**ZEAL-IT**](https://github.com/ZEAL-IT), [**oscardelama**](https://github.com/oscardelama), 
+[**b4loghpeter**](https://github.com/b4loghpeter), [**DirkBor**](https://github.com/DirkBor), 
+[**m-badura**](https://github.com/m-badura) and [**vonglan**](https://github.com/vonglan) 
+for their ideas and bug reports!
+
+* Added new **command line options** for cleaning **multiple files** from one ```--sourcedir``` ([#118](../../../issues/118))
+* Added menu item to '**Show Read-Only Preview** With ABAP Cleaner...' without locking ([#114](../../../issues/114))
+* Added **documentation** on why ABAP cleaner has no **pragmas and pseudo-comments** ([#121](../../../issues/121))
+* Added info on **ABAP release** of current system in **window title** of interactive UI
+* Fixed **command line** cleanup adding **LF at end** of file ([#124](../../../issues/124))
+* Fixed rule '**Replace obsolete MOVE ... TO with =**' for **chains** of one and late chains ([#120](../../../issues/120))
+* Fixed rule '**Replace CREATE OBJECT with NEW constructor**' to require ABAP release **7.40** ([#119](../../../issues/119))
+* Fixed rule '**Use FINAL for immutable variables**' for MODIFY ENTITY with **fields tables** ([#117](../../../issues/117))
+* Fixed **parser** for escape char ! with composed identifiers ([#115](../../../issues/115))
+
 ## 2023-09-26 (version 1.5.5)
 
 **Thanks a lot**, [**bnichell**](https://github.com/bnichell) for reporting the bug behind this release!

diff --git a/docs/rules/CreateObjectRule.md b/docs/rules/CreateObjectRule.md
@@ -4,6 +4,8 @@
 
 Transforms CREATE OBJECT statements into functional style using NEW.
 
+This rule requires a NetWeaver version >= 7.40.
+
 ## References
 
 * [Clean ABAP Styleguide: Prefer NEW to CREATE OBJECT](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object)

diff --git a/docs/rules/RaiseTypeRule.md b/docs/rules/RaiseTypeRule.md
@@ -4,6 +4,8 @@
 
 Replaces the TYPE section of RAISE EXCEPTION TYPE ... and RAISE SHORTDUMP TYPE ... with a NEW constructor call.
 
+This rule requires a NetWeaver version >= 7.52.
+
 ## References
 
 * [Clean ABAP Styleguide: Prefer RAISE EXCEPTION NEW to RAISE EXCEPTION TYPE](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-raise-exception-new-to-raise-exception-type)

diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>parent</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>ABAP cleaner</name>
   <packaging>pom</packaging>
   <modules>

diff --git a/test/com.sap.adt.abapcleaner.test/META-INF/MANIFEST.MF b/test/com.sap.adt.abapcleaner.test/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: Unit Tests for com.sap.adt.abapcleaner
 Bundle-SymbolicName: com.sap.adt.abapcleaner.test;singleton:=true
-Bundle-Version: 1.5.6.qualifier
+Bundle-Version: 1.6.0
 Bundle-Vendor: abap-dev
 Fragment-Host: com.sap.adt.abapcleaner
 Bundle-RequiredExecutionEnvironment: JavaSE-11

diff --git a/test/com.sap.adt.abapcleaner.test/pom.xml b/test/com.sap.adt.abapcleaner.test/pom.xml
@@ -3,14 +3,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>com.sap.adt.abapcleaner.test</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>com.sap.adt.abapcleaner.test</name>
   <packaging>eclipse-test-plugin</packaging>
 
   <parent>
     <artifactId>tests</artifactId>
     <groupId>com.sap.adt.abapcleaner</groupId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/test/pom.xml b/test/pom.xml
@@ -4,14 +4,14 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sap.adt.abapcleaner</groupId>
   <artifactId>tests</artifactId>
-  <version>1.5.6-SNAPSHOT</version>
+  <version>1.6.0</version>
   <name>Test Fragments</name>
   <packaging>pom</packaging>
 
   <parent>
     <groupId>com.sap.adt.abapcleaner</groupId>
     <artifactId>parent</artifactId>
-    <version>1.5.6-SNAPSHOT</version>
+    <version>1.6.0</version>
     <relativePath>../</relativePath>
   </parent>