Release 23.7.1 (#56)

* Add deprecation warnings

* Update version to 23.7.1

Author: Denis-Averin

Makefile

@@ -21,3 +21,7 @@ init:
 update:
 	composer update
 	composer validate
+
+.PHONY: after-gen
+after-gen: format
+	./scripts/add-deprecation-warnings.bash

README.md

@@ -6,7 +6,7 @@
 [![Supported PHP Versions](https://img.shields.io/packagist/dependency-v/aspose/barcode-cloud-php/php)](https://packagist.org/packages/aspose/barcode-cloud-php)
 
 - API version: 3.0
-- Package version: 23.7.0
+- Package version: 23.7.1
 - Supported PHP versions: ">=7.4 || >=8.0"
 
 ## Demo applications

scripts/add-deprecation-warning.py

@@ -0,0 +1,72 @@
+from __future__ import division, print_function
+
+import argparse
+import re
+
+COMMENT_SECTION_START_RE = re.compile(r"^\s+/\*\*$")  # /**
+DEPRECATED_RE = re.compile(  # * @param type $name DEPRECATED: Message
+    r"^\s*\*\s+@param\s+(?P<type>\S+)\s+(?P<property_name>\S+)\s+DEPRECATED:\s+(?P<message>.+)$"
+)
+SETTER_FUNCTION_RE = re.compile(r"^\s*public\s+function\s+set\S+")  # public function setSomething(value)
+FUNCTION_BODY_STARTED_RE = re.compile(r"^(?P<indent>\s*){$")  # {
+
+
+def main(input_file):
+    filename = input_file.name
+    content = [line.rstrip() for line in input_file.readlines()]
+    input_file.close()
+
+    with open(filename, "wt", newline="\n") as result:
+        comment_section_started = False
+        deprecation_message = None
+        setter_function_declaration = False
+
+        for line in content:
+            if COMMENT_SECTION_START_RE.match(line):
+                comment_section_started = True
+
+            deprecated_match = DEPRECATED_RE.match(line)
+            if comment_section_started and deprecated_match:
+                # deprecation message found
+                deprecation_message = deprecated_match.groupdict()["message"].strip()
+                property_name = deprecated_match.groupdict()["property_name"]
+
+            if comment_section_started and deprecation_message and SETTER_FUNCTION_RE.match(line):
+                setter_function_declaration = True
+
+            match_with_indent = FUNCTION_BODY_STARTED_RE.match(line)
+            if match_with_indent:
+                # Function body started
+                if setter_function_declaration and deprecation_message:
+                    result.write(line + "\n")
+
+                    indent = match_with_indent.groupdict()["indent"]
+                    escaped_message = "".join(r"\'" if c == "'" else c for c in deprecation_message)
+                    result.write(
+                        f"{indent}{(' ' * 4)}"
+                        f"trigger_error('Property {property_name} is deprecated. {escaped_message}'"
+                        ", E_USER_DEPRECATED);\n"
+                    )
+
+                    comment_section_started = False
+                    setter_function_declaration = False
+                    deprecation_message = None
+
+                    continue
+
+                comment_section_started = False
+                setter_function_declaration = False
+                deprecation_message = None
+
+            result.write(line + "\n")
+
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("input_file", type=argparse.FileType("rt"))
+    args = parser.parse_args()
+    return vars(args)
+
+
+if __name__ == "__main__":
+    main(**parse_args())

scripts/add-deprecation-warnings.bash

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+SRC_DIR="$( cd "${SCRIPT_DIR}/../src" &> /dev/null && pwd )"
+
+find "${SRC_DIR}" -name "*.php" -exec python "${SCRIPT_DIR}/add-deprecation-warning.py" "{}" \;

src/Aspose/BarCode/Configuration.php

@@ -23,7 +23,7 @@ class Configuration implements JsonSerializable
      *
      * @var string
      */
-    protected $clientVersion = '23.7.0';
+    protected $clientVersion = '23.7.1';
 
     /**
      * ClientId for API

src/Aspose/BarCode/Model/DataMatrixParams.php

@@ -309,6 +309,7 @@ public function getColumns()
      */
     public function setColumns($columns)
     {
+        trigger_error('Property $columns is deprecated. Will be replaced with \'DataMatrix.Version\' in the next release  Columns count.', E_USER_DEPRECATED);
         $this->container['columns'] = $columns;
 
         return $this;
@@ -381,6 +382,7 @@ public function getRows()
      */
     public function setRows($rows)
     {
+        trigger_error('Property $rows is deprecated. Will be replaced with \'DataMatrix.Version\' in the next release  Rows count.', E_USER_DEPRECATED);
         $this->container['rows'] = $rows;
 
         return $this;

src/Aspose/BarCode/Model/GeneratorParams.php

@@ -807,6 +807,7 @@ public function getResolutionX()
      */
     public function setResolutionX($resolution_x)
     {
+        trigger_error('Property $resolution_x is deprecated. Use \'Resolution\' instead.', E_USER_DEPRECATED);
         $this->container['resolution_x'] = $resolution_x;
 
         return $this;
@@ -831,6 +832,7 @@ public function getResolutionY()
      */
     public function setResolutionY($resolution_y)
     {
+        trigger_error('Property $resolution_y is deprecated. Use \'Resolution\' instead.', E_USER_DEPRECATED);
         $this->container['resolution_y'] = $resolution_y;
 
         return $this;