Add tools for baking Opencart tables in Model files

Author: Webmaster

tools/bake.sh

@@ -0,0 +1,121 @@
+#!/bin/bash
+
+VER=$1
+if [ -z $VER ]; then
+    echo "Provide version"
+    exit 255
+fi
+
+if [ ! -d "vendor/cakephp/bake" ]; then
+    echo "First, \`cd\` to a CakePHP project folder. Currently in: $(pwd)"
+    exit 255
+fi
+
+INFLECTOR="$(dirname ${0})/inflector.php"
+if [ ! -f "${INFLECTOR}" ]; then
+    echo "The $(basename ${INFLECTOR}) script needs to be available in the same folder with this script. Checked for: ${INFLECTOR}"
+    exit 255
+fi
+
+read -p "Name of the plugin to hold Opencart connector code: " PLUGIN
+
+# Shorthand
+E="plugins/${PLUGIN}/src/Model/Entity"
+T="plugins/${PLUGIN}/src/Model/Table"
+
+# Clean up
+rm -rf ${E}/Opencart${VER}
+mkdir -p ${E}/Opencart${VER}
+#rm -rf ${E}/OpencartCommon # DON'T. oc2 has some classes removed in oc4
+mkdir -p ${E}/OpencartCommon
+rm -rf ${T}/Opencart${VER}
+mkdir -p ${T}/Opencart${VER}
+
+# Get the list of all bake-able models. Results will be in CamelCase
+LIST=$(bin/cake bake model --connection opencart${VER}-clean | tail -n +2 -)
+# Loop through each table
+for NAME in ${LIST}; do
+    if [ "${NAME}" = "-" ]; then
+        continue;
+    fi
+    # Shorthand
+    ALIAS=$(php "${INFLECTOR}" pluralize ${NAME})
+    ENTITY=${NAME}
+    # Only one exception for OC4, all other tables are singular
+    if [ "${ENTITY}" = "Statistics" ]; then
+        ENTITY="Statistic"
+    fi
+    TABLE=$(php "${INFLECTOR}" underscore ${NAME})
+    printf "\n"
+    echo "NAME:${NAME} ALIAS:${ALIAS} TABLE:${TABLE} ENTITY:${ENTITY}"
+    # Do the actual baking
+    bin/cake bake model ${ALIAS} --table ${TABLE} --force --no-fixture --no-test --plugin ${PLUGIN} --connection opencart${VER}-clean
+
+    # Handle the Table class
+    mv "${T}/${ALIAS}Table.php" "${T}/Opencart${VER}/${ALIAS}Table.php"
+    F="${T}/Opencart${VER}/${ALIAS}Table.php"
+    sed -i "s/${PLUGIN}\\\Model\\\Table/${PLUGIN}\\\Model\\\Table\\\Opencart${VER}/g" "${F}"
+    # Remove hardcoded connection name, look up the method and lines around it
+    awk '/defaultConnectionName/ {print NR-5 "," NR+3 "d"}' "${F}" \
+        | sed -i -f - "${F}"
+
+    # Descriptions will not be picked up automatically, handle them here
+    if [ "${NAME:(-11)}" = "Description" ]; then
+        # Convert NAME to plural (table alias) and underscore (table name)
+        TRANSLATABLE="${NAME%"Description"}"
+        TRANSLATABLE_ALIAS=$(php "${INFLECTOR}" pluralize ${TRANSLATABLE})
+        TRANSLATABLE_TABLE=$(php "${INFLECTOR}" underscore ${TRANSLATABLE})
+        # Create the snippet we will read from
+        cat > "/tmp/descriptions_snippet" << EOF
+        \$this->hasMany('${ALIAS}', [
+            'foreignKey' => '${TRANSLATABLE_TABLE}_id',
+            'className' => '${PLUGIN}.${ALIAS}',
+        ]);
+        \$this->hasOne('${NAME}', [
+            'foreignKey' => '${TRANSLATABLE_TABLE}_id',
+            'className' => '${PLUGIN}.${NAME}',
+            'conditions' => [
+                // to be populated by ${PLUGIN}\Connector
+            ],
+        ]);
+EOF
+
+awk '
+    /}/ && !done {          # Search for the first "}" and check if insertion is not done
+        while ((getline line < "/tmp/descriptions_snippet") > 0) {
+            print line      # Print each line from the snippet file
+        }
+        print "    }"           # Print the original "}" after the snippet
+        done=1              # Set done to 1 to avoid further insertions
+        next                # Skip the original line containing "}"
+    }
+    { print }               # Print all other lines as is
+' "${T}/Opencart${VER}/${TRANSLATABLE_ALIAS}Table.php" > /tmp/descriptions_tmp && mv /tmp/descriptions_tmp "${T}/Opencart${VER}/${TRANSLATABLE_ALIAS}Table.php"
+    fi
+
+    # Handle the Entity class
+    mv "${E}/${ENTITY}.php" "${E}/Opencart${VER}/${ENTITY}.php"
+    F="${E}/Opencart${VER}/${ENTITY}.php"
+    sed -i "s/${PLUGIN}\\\Model\\\Entity/${PLUGIN}\\\Model\\\Entity\\\Opencart${VER}/g" "${F}"
+    # Entity: common
+    mkdir -p "${E}/OpencartCommon"
+    if [ ! -f "${E}/OpencartCommon/${ENTITY}.php" ]; then
+        cat > "${E}/OpencartCommon/${ENTITY}.php" << EOF
+<?php
+
+namespace ${PLUGIN}\Model\Entity\OpencartCommon;
+
+use Cake\ORM\Entity;
+
+class ${ENTITY} extends Entity
+{
+
+
+
+}
+EOF
+    fi
+    sed -i "s/class ${ENTITY} extends Entity/class ${ENTITY} extends \\\\${PLUGIN}\\\Model\\\Entity\\\OpencartCommon\\\\${ENTITY}/g" "${F}"
+    # Delete `use Cake\ORM\Entity;` and the empty line after it
+    sed -i '/^use Cake\\\ORM\\\Entity;/{N;d;}' "${F}"
+done

tools/inflector.php

@@ -0,0 +1,7 @@
+<?php
+
+require('vendor/cakephp/cakephp/src/Utility/Inflector.php');
+
+$inflector = new \Cake\Utility\Inflector();
+
+echo $inflector::{$argv[1]}($argv[2]).PHP_EOL;