A ground-up rebuild of the plugin

Author: BlazOrazem

.github/workflows/main.yml

@@ -0,0 +1,94 @@
+---
+name: Tests
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+jobs:
+    phpUnitTests:
+        runs-on: ubuntu-latest
+        name: Unit Tests / PHP ${{ matrix.phpVersion }} / Winter ${{ matrix.winterRelease }}
+        strategy:
+            max-parallel: 6
+            matrix:
+                phpVersion: ['8.0', '8.1', '8.2']
+                winterRelease: ['develop']
+                winterReleaseDir: ['develop']
+            fail-fast: false
+        env:
+            phpExtensions: mbstring, intl, gd, xml, sqlite
+            cacheKey: ext-cache-v1
+            winterCmsRelease: develop
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        steps:
+            - name: Checkout changes
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Run Super-Linter
+              uses: github/super-linter@v4
+              env:
+                  DEFAULT_BRANCH: main
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  VALIDATE_YAML: true
+                  VALIDATE_JSON: true
+                  VALIDATE_MARKDOWN: true
+                  VALIDATE_PHP_BUILTIN: true
+
+            - name: Move files to a widgets-plugin directory
+              run: mkdir widgets-plugin && find . -mindepth 1 -maxdepth 1 ! -name 'widgets-plugin' -exec mv -t widgets-plugin -- {} +
+
+            - name: Setup cache environment
+              id: extcache
+              uses: shivammathur/cache-extensions@v1
+              with:
+                  php-version: ${{ matrix.phpVersion }}
+                  extensions: ${{ env.phpExtensions }}
+                  key: ${{ env.cacheKey }}
+
+            - name: Cache extensions
+              uses: actions/cache@v4
+              with:
+                  path: ${{ steps.extcache.outputs.dir }}
+                  key: ${{ steps.extcache.outputs.key }}
+                  restore-keys: ${{ steps.extcache.outputs.key }}
+
+            - name: Install PHP and extensions
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.phpVersion }}
+                  extensions: ${{ env.phpExtensions }}
+
+            - name: Install Winter CMS
+              run: |
+                  wget https://github.com/wintercms/winter/archive/${{ matrix.winterRelease }}.zip
+                  unzip ${{ matrix.winterRelease }}.zip
+                  rm ${{ matrix.winterRelease }}.zip
+                  shopt -s dotglob
+                  mv winter-${{ matrix.winterReleaseDir }}/* ./
+                  rmdir winter-${{ matrix.winterReleaseDir }}
+                  shopt -u dotglob
+                  cp config/cms.php config/testing/cms.php
+                  mkdir -p plugins/numencode
+                  mv widgets-plugin plugins/numencode/widgets
+
+            - name: Get Composer cache directory
+              id: composercache
+              run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_ENV
+
+            - name: Cache dependencies
+              uses: actions/cache@v4
+              with:
+                  path: ${{ env.dir }}
+                  key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+                  restore-keys: ${{ runner.os }}-composer-
+
+            - name: Install Composer dependencies
+              run: composer install --no-interaction --no-progress --no-suggest
+
+            - name: Run unit tests
+              run: php artisan winter:test -p NumenCode.Widgets

.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.cache

CHANGELOG.md

@@ -1,19 +1,18 @@
 # Changelog
 
-All notable changes to `numencode/wn-widgets-plugin` will be documented in this file
+All notable changes to this project will be documented in this file.
 
-## 2.0.1 - 2021-11-20
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-- content update
+## [1.0.0] - 2025-01-16
+### Added
+- Initial release of the **Widgets Plugin**.
+- Features:
+    - Support for Winter CMS.
+    - Fully compatible with Winter CMS version `1.2.7`.
 
-## 2.0.0 - 2021-05-06
+---
 
-- migration to Winter CMS
-
-## 1.0.1 - 2021-01-31
-
-- major refactoring
-
-## 1.0.0 - 2021-01-07
-
-- initial release
+### Links
+- GitHub repository: [wn-widgets-plugin](https://github.com/numencode/wn-widgets-plugin)

CONTRIBUTING.md

@@ -2,53 +2,84 @@
 
 Contributions are **welcome** and will be fully **credited**.
 
-Please read and understand the contribution guide before creating an issue or pull request.
+Before creating an issue or pull request, please take a moment to read and understand this contribution guide.
+
+---
 
 ## Etiquette
 
-This project is open source, and as such, the maintainers give their free time to build and maintain the
-source code held within. They make the code freely available in the hope that it will be of use to other
-developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.
+This project is open source, and the maintainers volunteer their time to build and maintain it. They provide the source code freely with the hope that it will be useful to others. Please be respectful and considerate when raising issues or submitting pull requests.
+
+- **Be respectful**: Avoid abusive, angry, or impatient behavior toward maintainers or contributors.
+- **Stay constructive**: Provide detailed, actionable feedback and clearly describe issues or suggestions.
+- **Understand maintainers' decisions**: Contributions are accepted at the discretion of the maintainers. Respect their decision, even if your submission is not used.
 
-Please be considerate towards maintainers when raising issues or presenting pull requests.
-Let's show the world that developers are civilized and selfless people.
+Let’s show the world that developers are civilized, collaborative, and selfless!
 
-It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
-quality to benefit the project. Many developers have different skill sets, strengths, and weaknesses.
-Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+---
 
 ## Viability
 
-When requesting or submitting new features, first consider whether it might be useful to others.
-Open source projects are used by many developers, who may have entirely different needs to your own.
-Think about whether your feature is likely to be used by other users of the project.
+Before suggesting new features or changes, consider their viability:
+- Will the feature benefit other users of the project?
+- Is the feature aligned with the project's scope and goals?
+- Could the feature introduce unnecessary complexity or maintenance challenges?
+
+Open source projects serve a diverse group of developers with varied needs, so your contributions should aim to add value to the broader community.
+
+---
 
-## Procedure
+## Reporting Issues
 
 Before filing an issue:
+1. **Attempt to replicate the problem** to rule out one-off incidents.
+2. **Search existing issues** to ensure your problem or suggestion hasn’t already been raised.
+3. **Check pull requests** for ongoing work that may address the issue.
 
-- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
-- Check to make sure your feature suggestion isn't already present within the project.
-- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
-- Check the pull requests tab to ensure that the feature isn't already in progress.
+---
 
-Before submitting a pull request:
+## Submitting Pull Requests
 
-- Check the codebase to ensure that your feature doesn't already exist.
-- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+When submitting a pull request:
+1. **Ensure the feature doesn’t already exist** in the codebase.
+2. **Review existing pull requests** to ensure no one else is working on the same feature or fix.
+3. Follow these best practices:
+    - **One pull request per feature**: If you want to contribute multiple changes, submit separate pull requests for each.
+    - **Provide a coherent commit history**: Squash intermediate commits into meaningful ones.
+    - **Document your changes**: Update the `README.md` or other relevant documentation to reflect your changes.
+    - **Adhere to coding standards**: Use the PSR-12 coding standard.
+
+---
 
 ## Requirements
 
-If the project maintainer has any additional requirements, you will find them listed here.
+This project follows specific standards and guidelines to ensure consistency and maintainability:
+
+1. **Coding Standard**
+    - Follow **[PSR-12](https://www.php-fig.org/psr/psr-12/)**.
+    - Use tools like [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer) to check your code.
+
+2. **Semantic Versioning**
+    - This project adheres to **[SemVer v2.0.0](http://semver.org/)**.
+    - Avoid making random or unnecessary breaking changes to public APIs.
+
+3. **Documentation**
+    - Document any changes in functionality.
+    - Update all relevant files, including `README.md` and other documentation, as needed.
 
-- **[PSR-12 Coding Standard](https://www.php-fig.org/psr/psr-12/)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
+---
 
-- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+## Contribution Workflow
 
-- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+To contribute effectively:
+1. Fork the repository and create a new branch for your work.
+2. Ensure your branch is up-to-date with the `main` branch.
+3. Implement your feature or fix, ensuring compliance with the guidelines.
+4. Run tests and ensure no existing functionality is broken.
+5. Create a pull request with a clear description of the changes and why they are necessary.
 
-- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+---
 
-- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+**Thank you for contributing!** Your effort and time are greatly appreciated. Let’s build something amazing together.
 
 **Happy coding**!

LICENSE.md

@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) 2021 NumenCode
+Copyright (c) 2025 NumenCode
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Plugin.php

@@ -24,7 +24,7 @@ public function pluginDetails(): array
             'description' => 'numencode.widgets::lang.plugin.description',
             'author'      => 'Blaz Orazem',
             'icon'        => 'oc-icon-briefcase',
-            'homepage'    => 'https://github.com/numencode/widgets-plugin',
+            'homepage'    => 'https://github.com/numencode/wn-widgets-plugin',
         ];
     }
 

README.md

@@ -1,66 +1,103 @@
 # Widgets Plugin
 
-NumenCode Widgets plugin for Winter CMS.
+The **NumenCode Widgets** plugin for Winter CMS provides a flexible and easy-to-use solution for managing reusable
+widgets in Winter CMS. This plugin simplifies adding dynamic, visually engaging components to your themes and
+templates, enhancing the overall user experience.
 
-## Installation and usage
+[![Version](https://img.shields.io/github/v/release/numencode/wn-widgets-plugin?sort=semver&style=flat-square&color=0099FF)](https://github.com/numencode/wn-widgets-plugin/releases)
+[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/numencode/wn-widgets-plugin?style=flat-square&color=0099FF)](https://packagist.org/packages/numencode/wn-widgets-plugin)
+[![Checks](https://img.shields.io/github/check-runs/numencode/wn-widgets-plugin/main?style=flat-square)](https://github.com/numencode/wn-widgets-plugin/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/numencode/wn-widgets-plugin/main.yml?branch=main&label=tests&style=flat-square)](https://github.com/numencode/wn-widgets-plugin/actions)
+[![License](https://img.shields.io/github/license/numencode/wn-widgets-plugin?label=open%20source&style=flat-square&color=0099FF)](https://packagist.org/packages/numencode/wn-widgets-plugin/blob/main/LICENSE.md)
 
-This package requires [Winter CMS](https://wintercms.com/) application.
+---
 
-Install the package with Composer:
+## Target Audience
+
+The target audience for this plugin includes developers and designers who want to enhance their Winter CMS projects
+by incorporating reusable, visually appealing widgets. The provided widgets, such as counters, promotions, features,
+and highlights, are commonly used in modern web design and are often found in templates and themes available on
+various marketplaces. This plugin bridges the gap between static designs and dynamic functionality.
+
+## Installation
+
+This plugin is available for installation via [Composer](http://getcomposer.org/).
 
 ```bash
 composer require numencode/wn-widgets-plugin
 ```
 
-## Details
+After installing the plugin you will need to run the migrations.
+
+```bash
+php artisan migrate
+```
+
+## Requirements
 
-This plugin allows end users to create and edit various website widgets with a simple user interface.
-The plugin has full multilingual support and implements Winter.Translate plugin.
+* Winter CMS 1.2.7 or higher.
+* PHP version 8.0 or higher.
+
+---
+
+## Features Overview
+
+This plugin provides an intuitive interface to create and manage a variety of widgets, enabling end users
+to customize their websites with ease. With multilingual support via the `Winter.Translate` plugin,
+it ensures global usability.
 
 ### Counters
 
-Display statistics or numeric information on your website with an animated attention-grabbing dynamic element
-that draws visitors in. Simply enter the number to display, fill in the text that explains what the number is
-about, and set an optional CSS class for the icon. Counters are managed via the component properties.
+Showcase statistics or numeric information on your website using dynamic and engaging animated counters.
+Enter the desired number, provide explanatory text, and optionally include an icon class for added flair.
+Counters can be easily configured through component properties.
 
 ### Promotions
 
-Promotions, such as content sliders and carousels, are simple to set up, totally customisable to the look and
-feel of your website, and allow you to showcase creative content in a relatively small footprint. Promotions
-are managed on the Promotions tab of the Widgets plugin.
+Create attention-grabbing promotional content such as sliders and carousels that seamlessly integrate
+into your website's aesthetic. Perfect for highlighting creative content within a compact space.
+Promotions are managed via the `Promotions` tab in the Widgets plugin.
 
 ### Features
 
-Features can be used to display multiple items, either as a list of items or as a slider/carousel.
-Features are managed on the Features tab of the Widgets plugin.
+Display multiple items in an organized list or an eye-catching slider/carousel format. This is ideal
+for showcasing services, products, or other grouped content. Manage features directly from the `Features` tab.
 
 ### Highlights
 
-Highlights are visuals with descriptions and can be displayed as content cards which should be
-exposed on the website. Highlights are managed on the Highlights tab of the Widgets plugin.
+Create visually striking content cards with accompanying descriptions to emphasize key aspects of your website.
+Highlights are perfect for promoting unique selling points or key features and are managed through the `Highlights` tab.
+
+---
+
+## Changelog
+
+All notable changes are documented in the [CHANGELOG](CHANGELOG.md).
+
+---
 
-# Changelog
+## Contributing
 
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+Please refer to the [CONTRIBUTING](CONTRIBUTING.md) guide for details on contributing to this project.
 
-# Contributing
+---
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+## Security
 
-# Security
+If you identify any security issues, email [email protected] rather than using the issue tracker.
 
-If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
+---
 
-# Author
+## Author
 
-**NumenCode.Widgets** plugin was created by and is maintained by [Blaz Orazem](https://orazem.si/).
+The **NumenCode.Fundamentals** plugin is created and maintained by [Blaz Orazem](https://orazem.si/).
 
-Please write an email to [email protected] about all the things concerning this project.
+For inquiries, contact: [email protected]
 
-Follow [@blazorazem](https://twitter.com/blazorazem) on Twitter.
+---
 
-# License
+## License
 
 This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
 
-[![MIT License](https://img.shields.io/github/license/numencode/widgets-plugin?label=License&color=blue&style=flat-square&cacheSeconds=600)](https://github.com/numencode/widgets-plugin/blob/main/LICENSE.md)
+[![License](https://img.shields.io/github/license/numencode/wn-widgets-plugin?style=flat-square&color=0099FF)](https://packagist.org/packages/numencode/wn-widgets-plugin/blob/main/LICENSE.md)