Changelog and Information of the jSparrow Eclipse Plugin
23030
page-template,page-template-blog-large-image-whole-post,page-template-blog-large-image-whole-post-php,page,page-id-23030,ajax_fade,page_not_loaded,,select-theme-ver-3.8.1,menu-animation-underline,popup-menu-fade,wpb-js-composer js-comp-ver-5.1.1,vc_responsive

Changelog

changelog of jSparrow

OUR RELEASE POLICY IS AS FOLLOWS:

Two major releases per year

  • 21st June – Midsummer Release
  • 21st December – Release of the longest night

Monthly Rule releases

If we developed new rules, they will be released on the 21st of each month

(if the 21st isn’t an Austrian working day- the release will be postponed one month)

Weekly Bugfix releases 

Bugfixes will be released each Tuesday

Hotfix Releases  

Hotfix Releases can be deployed any time (hopefully not necessary)

Release Notes 2.4.4

CHANGE

  • Updated the way demo licenses work.

DETAILED INFORMATION

Free licenses have been reworked to no longer require a connection to the licensing server. When using older versions of jSparrow this might start to see warnings. However, jSparrow functionality should not be adversely impacted.
Any warnings should be able to be removed by upgrading to the latest version of jSparrow. If you experience errors that persist after the upgrade please contact us at bugreport@jsparrow.eu.

Release Notes 2.4.3

BUGFIX

  • Further improvements on the comment preservation
  • Minor improvements on the rule execution counting
  • Duplicate profiles where possible if “x” was used to cancel the operation
    • Using the “x” to abort the operation now behaves as expected
  • jSparrow was executable on sub-elements of a class but was not executed because the types are not suitable for refactoring
    • The visual display of jSparrow was removed from sub-elements of a class

Release Notes 2.4.1

BUGFIXES

  • Fixed a bug where the number of times a rule was applied was displayed incorrectly.
  • Fixed an issue that prevented some rules from counting the number of times they were applied correctly.
  • Fixed a bug where changes made by the “Use Try-With-Resource” rule were not displayed under certain circumstances.
  • Fixed a bug where no license warning was displayed if a license was already in use by another user.

Release Notes 2.4.0

RENAME FIELDS RULE

This release adds a new semi-automatic rule called “Rename Fields Rule”.

This new rule can be used for finding and renaming the fields that do not comply with the Naming Conventions.

A configuration wizards provides different refactoring options. The user can select fields to be renamed based on the access modifier key (screenshot of the configuration wizard is given below). As soon as a field which doesn’t comply with the naming conventions is found, the rule will search for its references and compute a renaming. The search scope can be set by the user, either to the current project or to the workspace that eclipse is currently using.

The new name is computed based on the existing field’ name and the configuration options that the user can provide on the rule wizard. On the default configuration, the existing field name is converted to camelCase. Furthermore the occurrences of underscores ‘_’ and dollar-signs ‘$’ are removed and the first letter which is following them (if any) is converted to uppercase. Note however, that the user has the possibility to choose in the configuration wizard whether or not to change the first letter after ‘_’/’$’ to uppercase.

Before the renaming is applied to the original sources, a preview wizard will show the changes related to the renaming of each field. Since a non-private field may be accessed in multiple classes,  a single renaming may affect more than one file. A tree-style view in the preview wizard will show the the changes to all of the affected files for each renaming. The user has the possibility to ignore a renaming by unchecking the corresponding element in the tree view.

Limitations

The renaming cannot be performed automatically if:

  • The newly computed name is not a valid java variable name.
  • The newly computed name clashes with an existing variable name within the same class.

BUGFIXES

  • Logging Rule:
    • Fixed a bug where tooltips for checkboxes would not show up at the right position.

Release Notes 2.3.1

BUGFIXES

  • Fixed a bug where controls on the Summary Page could be duplicated under certain circumstances.
  • Fixed a bug where alphabetical sorting of files in the Summary page was disabled.

Release Notes 2.3.0

STATISTICS

jSparrow now estimates the time it takes to fix issues. All rules in jSparrow get an individual estimation time to fix the corresponding issue. On each run of jSparrow, the time for each rule is multiplied by the number of occurrences of each corresponding rule, resulting in an estimation of saved time.

The statistics are added as follows:

  • (Updated) Preview Wizard: now additionally displays the following information for each rule individually:
    • (New) Issues Fixed: The number of issues fixed for the current rule in all selected classes
    • (New) Time Saved: The amount of time saved for the current rule in all selected classes
  • (Updated) Summary Page: now displays the following information for all rules:
    • (New) Run Duration: The time it took jSparrow to get and calculate all changes (i.e., the time between clicking “Finish” in the “Select Rules” Wizard and the appearance of the Preview Wizard).
    • (New) Issues Fixed: The overall number of fixed issues (i.e., how often rules were applied) for the current run of jSparrow.
    • (New) Time Saved: The total time saved by applying all rules displayed.
    • (New) Rules: A list of rules that were applied in the current run of jSparrow, including the number of times they were applied and the amount of time saved per rule.
    • Files and Diff View: The complete list of files where jSparrow found potential changes and a diff view that displays changes for each file.

LOGGING RULE

The Logging Rule has been updated in major ways to support more cases and provide greater customizability. The changes are focused on Exception logging.

  • (New) Logging Exceptions: A new grouping of Exception related logging options.
    • (Updated) “Replace printStackTrace by a logger statement with selected level”
      • Option to replace all occurrences of printStackStrace with the selected severity level
    • (New) “Insert a logger statement with the selected level for unlogged exceptions”
      • Option to add a logger statement to catch-clauses that do not log an Exception in any way
    • (New) “Always add the exceptions as a parameter in logger statements”
      • Option to always log an Exception if there is one present. For example, if only the message of an Exception is logged but not the Exception itself, the Exception will be added as additional argument to the log statement.
    • (New) “Always use this severity level for logging exceptions”
      • Option to always use the selected severity of “Logging Exceptions” when an Exception is logged, even though “System.out.orint” or “System.err.print” might specify a different severity level.
    • (New) Tooltips: Added examples for the checkboxes to illustrate the functionality

PROFILE SETTINGS

The profiles settings have been improved and jSparrow is now capable of importing and exporting rule profiles. Exported profiles are saved in YAML format.

  • (New) Import Profile(s)…
    • Adds the functionality to import YAML formatted jSparrow profiles
  • (New) Export Profile(s)…
    • Adds the functionality to export the selected profile(s) into a YAML formatted file

NEW RULE: USEPUTIFABSENT

This Java 8 rule updates the following old language construct and improves readability:

  • If map.put(..) is wrapped with a condition verifying the existence of an element one can use map.putIfAbsent(…) instead.

USABILITY IMPROVEMENTS

  • Various usability improvements
    • Option to switch between flat and recursive package resolving
    • Re-selecting the same profile has the intended behavior of resetting the selected profiles
    • Rule descriptions are now shown even on the right side of the Select Rules Wizard

BUGFIXES

  • Use Functional Interfaces:
    • Fixed a NullPointerException that could occur under very specific circumstances
    • Fixed an issue where a very specific case of an anonymous class containing wildcards in the body should not have been converted
  • Replace Nested Loops with flatMap:
    • Fixed an issue where more than two nested streams could not be converted to a flatMap
  • Use Multi-Catch:
    • Fixed an issue where catch clauses were shifted below more generic Exceptions
  • Replace Expression Lambda with Method Reference:
    • Fixed an issue where method references were incorrectly used for inner types
    • Fixed an issue where jSparrow would not distinguish between Integer.toString() and Integer.toString(Integer)
  • Remove Explicit Type Argument:
    • Fixed an issue where a Type Argument could not safely be inferred
  • Replace static final Collections with Collections.unmodifiable…():
    • Fixed an issue where unused imports where added
  • Use StringUtils Methods:
    • Fixed an issue where not all changes were added on the first run if a paramter of a method invocation was a method invocation that could also be transformed
  • Rule tags:
    • Fixed an issue where tags and “Remove disabled rules” would not work together

Release Notes 2.2.2

Bugfixes

  • Fixed a bug where Eclipse would report “Save Problems” when manually editing and saving files right after running jSparrow.

Release Notes 2.2.1

Bugfixes

  • An Issue was resolved if the project used Java 9 as language level.
        • Replace For-Loop with Enhanced-For-Loop
          • In cases the iterable was named after an primitive type with “s” as postfix the derived loop variable was translated to the corresponding primitive type. The behavior was changed so that an “a/an” is added as prefix to the created variable.

Release Notes 2.2.0

Twelve new Rules and more

This release is shipped with twelve new rules and other improvements to the user interface and the logic behind. In order to improve our possibility to track down bugs and other errors the OSGi bundle names have been changed. This has been necessary for jSparrow to work correctly with Eclipse Error Reporting. We have also added a new Summary Screen, where all changes can be reviewed before applying them. To make the selection of rules more intuitive and clearer we have changed their names to be more descriptive and consistent. The trial licensing model has been changed to accommodate new needs. Therefore it’s not possible anymore to persist changes with a trial license. However, changes can still be reviewed on the Summary Screen.

  • Names of the OSGi bundles have been changed
    • The prefix of the OSGI-bundles and OSGi-features of jSparrow has been changed from: jSparrow → eu.jSparrow 
    • Important: The result is that it is not possible to update from a previous version of jSparrow! It is required to uninstall and reinstall jSparrow to upgrade to 2.2.0. Otherwise there might be side effects because there will be two different named instances of jSparrow within your Eclipse version.
  • Trial Licencing Model Changed
    • The trial licence has changed.
    • The major change is that it’s no longer possible to apply changes to source code.
    • All changes will be displayed by the Preview Wizard and a Summary is shown in the final step at the new Summary Page.
  • Summary Page
    • Introduction of a Summary Page that displays all the changes from all rules that will be made.
  • New Rules have been added
    • Remove Inherited Interfaces from Class Declaration
      • Remove interfaces from class declaration, which are already implemented by a super class. These interfaces are inherited from the super class.
    • Replace Equality Check with isEmpty()
      • Java 6 introduced isEmpty() on collections and Strings. This rule replaces equality checks involving length() or size() with calls to isEmpty().
        For example, ‘s.length() == 0’ becomes ‘s.isEmpty()’.
        Applying this rule improves readability.
    • Replace equals() on Enum constants
      • Replace occurrences of equals() on Enum constants with an identity comparison (==). In the case the equals relation is wrapped with an boolean negation the result will be an not equals (!=).
    • Replace For-Loop with Stream::anyMatch
      • Replaces an occurrences of enhanced for-loops which are only used to initialize or return a boolean variable with Stream::anyMatch. The stream syntax is more concise and improves readability.
    • Replace For-Loop with Stream::collect(Collectors.joining())
      • Transforms loops which are only used for concatenating a string to an invocation of Stream::collect(Collectors.joining()).
        If the Java compliance level is below 1.8 and at least 1.5, then a StringBulder is introduced for concatenating the values on each iteration of the loop.
    • Replace For-Loop with Stream::findFirst
      • Enhanced for-loops which are used to find an element within a collection can be replaced by Stream::findFirst. Using the stream syntax a multi-line control statement can be reduced to a single line.
    • Replace For-Loop with Stream::sum
        • Transforms enhanced for-loops which are only used for summing up the elements of a collection to a Stream::sum invocation
    • Replace indexOf() with contains()
      • This rule replaces calls to indexOf() on instances of String or Collection with calls to the contains() method.
        For example ‘l.indexOf(s) >= 0’ is transformed to ‘l.contains(s)’.
        ‘contains()’ was introduced in Java 1.4 and helps to make the code more readable.
    • Replace Nested Loops with flatMap
      • Nested For-Loops or invocations of forEach commonly used to iterate over all elements of a collection of collections, can be avoided by using flatMap(). Using flatMap() makes code much more readable and can be combined with other stream functions.
    • Replace static final Collections With Collections.unmodifiable…()
      • An unmodifiable Collection can be created with the matching Collections.unmodifiable…() method. Some examples are Collections.unmodifiableList(), Collections.unmodifiableSortedSet(), etc.
        A declaration of a Collection with the static and final modifiers is not sufficient because it might still be modifiable.
        The Collections which are created with Collections.unmodifiable…() throw an UnsupportedOperationException as soon as a modification is attempted.
    • StringBuffer() to StringBuilder()
      • This rule changes the type of local variables from StringBuffer() to StringBuilder().
    • Use equals() on Primitive Objects
      • It is recommended that you use equals() on primitive objects. Applying this rule will replace occurrences of != and == with equals().
        For example, ‘”hello” == “world”‘ will become ‘”hello”.equals(“world”)’
        Using this rule helps to avoid bugs, as == checks for object reference equality instead of value equality.
  • Name Changes of Rules
    • The names of a lot of rules have been adjusted to improve understanding. The following table highlights the changes:
      Previous Name Current Name
      Arithmetic Assignment Replace Assignment with Compound Operator
      Braces to Control-Block Add Parenthesis to Control Statements
      Collection removeAll() to clear() Replace removeAll() with clear()
      Use Diamond Operator Remove Explicit Type Argument
      Enhanced For-Loop to Stream::forEach Replace For-Loop with Stream::forEach
      Field names convention Apply Field Naming Conventions
      For to ForEach Replace For-Loop with Enhanced-For-Loop
      Use FunctionalInterface Use Functional Interfaces
      Replace constructors of primitive types with valueOf() method Replace Inefficient Constructors with valueOf()
      Stream forEach to collect Use Stream::collect
      if-Wrapper in Stream::forEach to Stream::filter Use Stream::filter
      Lambda forEach to map Use Stream::map
      Expression Lambda to Method Reference Replace Expression Lambda with Method Reference
      MultiCatch Use Multi-Catch
      Separate lines for variable declarations Split Multiple Variable Declarations
      OrganiseImportsRule Organize Imports
      @Override annotation rule Use @Override Annotation
      SonarQube: Primitives should not be boxed just for String conversions Remove Boxing for String Conversions
      Rearrange class members Rearrange Class Members
      Remove new String() constructor Remove String Constructor
      Remove toString() from Strings Remove toString() on String
      SerialVersionUid check for static, final Make SerialVersionUID Static Final
      Standard Logger System Out To Logging
      Statement Lambda To Expression Lambda Remove Lambda Expression Parenthesis
      Replace String.concat(param) with Infix-Operation Plus Replace Concatenation with Infix-Operation
      String.format() System line separator Use Portable Newline
      String Literals equality check Reorder String Equality Check
      StringUtils Use StringUtils Methods
      TryWithResource Use Try-With-Resource
      While-loops to for-loop Replace While-Loop With Enhanced For-Loop