Revert Icon Legend module

[RobAndrewHurst]

Revert & Refactor legendIcon Function to Improve Code Readability and Maintainability

This pull request contains changes to refactor the legendIcon function in the /ui/elements/legendIcon module. The main goal of the PR was to revert the module to a previous working version and to refactor the module to improve code readability, maintainability, and reduce cognitive complexity.

Changes ✍️

1. Refactored the legendIcon function to reduce cognitive complexity:

   • Extracted the icon array handling logic into a separate function called createIconFromArray.
   • Moved the icon creation logic for non-array icons to a separate function called createIconFromInlineStyle.
   • Extracted the line symbol creation logic into a separate function called createLineSymbol.
   • Extracted the polygon symbol creation logic into a separate function called createPolygonSymbol.
   • Simplified the conditional statements in the main legendIcon function by using early returns.

2. Added JSDoc comments for better documentation 📝 :

   • Provided a description of the legendIcon function and its parameters.
   • Added comments to explain the purpose and functionality of each separate function.

3. Improved code readability and maintainability 👀 :

   • Separated the complex logic into smaller, more focused functions.
   • Used meaningful function names to describe the purpose of each function.
   • Added comments to clarify the different branches and conditions in the code.

Benefits 👍

• Reduced cognitive complexity 🧠 :

  • The refactoring has brought down the cognitive complexity of the legendIcon function from 18 to within the allowed limit of 15.
  • The extraction of separate functions for icon array handling, icon creation, line symbol creation, and polygon symbol creation has made the code easier to understand and maintain.

• Improved code readability and maintainability 🔧 :

  • The separation of concerns into smaller functions has made the code more modular and easier to read.
  • The added comments provide clear explanations of the purpose and functionality of each function.
  • The meaningful function names make it easier to understand the intent of each function at a glance.

• Enhanced documentation:

  • The JSDoc comments provide a clear description of the legendIcon function and its parameters.
  • The comments added to each separate function explain their purpose and functionality.

Testing 🧪

• The refactored code has been roughly tested to ensure that it produces the same results as the original code.
• Test cases have been run to verify that icons, line symbols, and polygon symbols are generated correctly based on the provided style parameters.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[AlexanderGeere]

Using icon.anchor on the legend icons, moves them out of view.

[AlexanderGeere]

Checked out a few instances, all looks well to me.

[simon-leech]

Tested a few myself too and happy its working as expected!
Tested in reports too and using anchors and legendScale