Merge pull request #3 from MarcinOrlowski/dev

Accessors' name conflict resolution improvements

Author: MarcinOrlowski

.codecov.yml

@@ -0,0 +1,13 @@
+#
+# trans-tool
+# The translation files checker and syncing tool.
+#
+# Copyright ©2021-2022 Marcin Orlowski <mail [@] MarcinOrlowski.com>
+# https://github.com/MarcinOrlowski/trans-tool/
+#
+comment: false
+coverage:
+  status:
+    patch:
+      default:
+        enabled: no

.github/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+Contributing rules
+
+* Open issue/FR ticket first and discuss your intent
+* For the repository and make your work in **dev** branch
+* Ensure all changes are covered by unit tests and are documented
+* Create pull request against **dev** branch and ensure you follow PR checklist
+

.github/workflows/codecov.yml

@@ -7,6 +7,8 @@
 # @license   https://opensource.org/licenses/LGPL-3.0 LGPL-3.0
 # @link      https://github.com/MarcinOrlowski/lombok-php
 #
+# Config file: .codeconv.yml
+#
 ##################################################################################
 
 name: "Coverage"

.github/workflows/dependabot.yml

@@ -0,0 +1,60 @@
+##################################################################################
+#
+# Lombok PHP - Write less code!
+#
+# @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
+# @copyright 2022 Marcin Orlowski
+# @license   https://opensource.org/licenses/LGPL-3.0 LGPL-3.0
+# @link      https://github.com/MarcinOrlowski/lombok-php
+#
+# Github Action that looks for "DEPENDS_ON <ID>" and "BLOCKED_BY <ID>"
+# in PR description and checks state of referenced PRs ensure these
+# are merged first.
+#
+##################################################################################
+
+name: Dependabot
+
+on:
+  issues:
+    types:
+      - opened
+      - edited
+      - reopened
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - reopened
+      # Makes sure we always add status check for PRs. Useful only if
+      # this action is required to pass before merging. Can be removed
+      # otherwise.
+      - synchronize
+
+  # Schedule a daily check. Useful if you reference cross-repository
+  # issues or pull requests. Can be removed otherwise.
+  schedule:
+    #        m h dom mon dow
+    - cron: '0 0 * * *'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      # https://github.com/marketplace/actions/dependent-issues
+      - uses: z0al/dependent-issues@v1
+        env:
+          # (Required) The token to use to make API calls to GitHub.
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # (Optional) The token to use to make API calls to GitHub for remote repos.
+          # GITHUB_READ_TOKEN: ${{ secrets.GITHUB_READ_TOKEN }}
+        with:
+          # (Optional) The label to use to mark dependent issues
+          label: dependent
+
+          # (Optional) Enable checking for dependencies in issues.
+          # Enable by setting the value to "on". Default "off"
+          check_issues: off
+
+          # (Optional) A comma-separated list of keywords.
+          keywords: DEPENDS_ON, BLOCKED_BY

.github/workflows/markdown.yml

@@ -24,11 +24,23 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+    # https://github.com/marketplace/actions/checkout
     - uses: actions/checkout@v2
 
+    # https://github.com/marketplace/actions/paths-changes-filter
+    - name: "Look for changed doc related files..."
+      uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: |
+          docs:
+            - 'docs/**'
+            - '**/*.md'
+
     # https://github.com/marketplace/actions/my-markdown-linter
     - name: "Running markdown linter..."
       uses: ruzickap/action-my-markdown-linter@v1
       with:
-        exclude: vendor
+        # LICENSE is externally sourced and we're not going to fix it.
+        exclude: "LICENSE.md"
         config_file: .markdownlint.yaml.dist

.markdownlint.yaml.dist

@@ -11,7 +11,7 @@
 #
 # Manual run:
 #
-#  markdownlint --config .markdownlint.yaml --ignore vendor **.md
+#  markdownlint --config .markdownlint.yaml --ignore vendor **.md --ignore LICENSE.md
 #
 
 # Default state for all rules

LICENSE.md

@@ -0,0 +1,67 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+
+As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+
+    a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+    b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+
+    a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+    b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+
+    a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+    b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+    c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+    d) Do one of the following:
+        0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+        1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+    e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+
+    a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+    b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

README.md

@@ -13,16 +13,17 @@
 * [Introduction](#introduction)
 * [Why should I use it?](#benefits)
 * [Usage examples](#examples)
-* [Features](#features)
-* [Extensive documentation](docs/README.md)
+* [Documentation](docs/README.md)
 * [License](#license)
 * [Changelog](CHANGES.md)
 
 ---
 
 ## Introduction ##
 
-`Lombok PHP` is a handy package providing set of PHP8+ attributes aimed to help you reduce
+`Lombok PHP` is a package providing growing set
+of [PHP attributes](https://www.php.net/manual/en/language.attributes.php) (feature
+[introduced by PHP 8.0](https://www.php.net/releases/8.0/)) and is intended to help you reduce
 boilerplate code in your project, by providing commonly used functionality you can easily apply.
 
 And yes, the project name is shamelessly borrowed from the beloved Java's

docs/attributes/getter.md

@@ -26,6 +26,11 @@ Can be applied to each of property individually or to whole class.
   whole class however, all the `public` and `static` properties will be silently ignored.
 
 
+* When applied to each property individually, will throw an exception when accessor method name
+  collides with existing class method. When applied to the whole class however, conflicts are
+  silently ignored and original method remains, with no accessor provided.
+
+
 * While mixing accessor attributes in class scope and property scope, class scope will **only** be
   applied if no property attribute were used. This lets you set wider scope for the whole class
   and still narrow it for specific properties. For example, if you put `#[Setter, Getter]` to
@@ -97,3 +102,38 @@ class Entity extends \Lombok\Helper
 
 In the above case, `Lombok PHP` will provide both accessors for `$name` property (`getName()` and
 `setName()`) but only getter for `$id`.
+
+---
+
+Method name conflict resolution:
+
+```php
+use Lombok\Getter;
+
+class Entity extends \Lombok\Helper
+{
+    #[Getter]
+    protected int $id = 0;
+    
+    public function getId() {}
+}
+```
+
+This will throw `MethodAlreadyExistsException` as `getId()` method already exists.
+
+Behavior is different for class level attributes:
+
+```php
+use Lombok\Getter;
+
+#[Getter]
+class Entity extends \Lombok\Helper
+{
+    
+    protected int $id = 0;
+    
+    public function getId() {}
+}
+```
+
+Original `getId()` method remain and no `Lombok PHP` accessor will be provided.

docs/attributes/setter.md

@@ -30,6 +30,11 @@ to each of property individually or to whole class.
   your `class`, but `#[Getter]` to specific property, that property will NOT have setter added.
 
 
+* When applied to each property individually, will throw an exception when accessor method name
+  collides with existing class method. When applied to the whole class however, conflicts are
+  silently ignored and original method remains, with no accessor provided.
+
+
 * When applied to each property individually, will throw an exception when applied to
   either `public`   or `static` property as neither is supported by design. When applied to the
   whole class however, all the `public` and `static` properties will be silently ignored.
@@ -97,3 +102,38 @@ class Entity extends \Lombok\Helper
 
 In the above case, `Lombok PHP` will provide both accessors for `$name` property (`getName()` and
 `setName()`) but only getter for `$id`.
+
+---
+
+Method name conflict resolution:
+
+```php
+use Lombok\Setter;
+
+class Entity extends \Lombok\Helper
+{
+    #[Setter]
+    protected int $id = 0;
+    
+    public function setId(int $id) {}
+}
+```
+
+This will throw `MethodAlreadyExistsException` as `setId()` method already exists.
+
+Behavior is different for class level attributes:
+
+```php
+use Lombok\Setter;
+
+#[Setter]
+class Entity extends \Lombok\Helper
+{
+    
+    protected int $id = 0;
+    
+    public function setId(int $id) {}
+}
+```
+
+In this case original `setId()` method remain and no `Lombok PHP` accessor will be provided.