Standardization CWF. Code by Sylll

Author: HerikLyma

CPPWebFramework/cwf/model.cpp

@@ -2,16 +2,6 @@
 
 CWF_BEGIN_NAMESPACE
 
-Model::Model(const QString &name) : QObject(nullptr)
-{
-    m_name = name;
-}
-
-Model::~Model()
-{
-
-}
-
 void Model::updateDB()
 {
     // ****************************************************************
@@ -45,7 +35,7 @@ void Model::build(const QMap<QString, QVariant> &selectCondition)
 
     QStringList properties = listAllProperties();
 
-    QMap<QString, QVariant> propValueMap = m_basicOperation.build(m_name, selectCondition, properties);
+    QMap<QString, QVariant> propValueMap = basicOperation.build(name, selectCondition, properties);
 
     // Loop on all the prop value to update the current object
     for(const auto& it : propValueMap.toStdMap() )
@@ -56,9 +46,9 @@ void Model::build(const QMap<QString, QVariant> &selectCondition)
     // Depending on the content of propValueMap, we set the built flag to true or false.
     // If the db query failed then the list is empty here.
     if(propValueMap.empty() )
-        m_built = false;
+        built = false;
     else
-        m_built = true;
+        built = true;
 }
 
 void Model::buildFromJson(const QJsonObject &json, bool withTableNamePrefix)
@@ -79,7 +69,7 @@ void Model::buildFromJson(const QJsonObject &json, bool withTableNamePrefix)
 
         if(jsonValue.isUndefined() )
         {
-            m_built = false;
+            built = false;
             break;
         }
 
@@ -89,7 +79,7 @@ void Model::buildFromJson(const QJsonObject &json, bool withTableNamePrefix)
 
         if(!success)
         {
-            m_built = false;
+            built = false;
             break;
         }
     }
@@ -113,14 +103,14 @@ bool Model::save()
     QDateTime currentDt = QDateTime::currentDateTime();
 
     // Creation of a new object
-    if(m_id == -1)
+    if(id == -1)
     {
-        this->setProperty("createdDateTime", currentDt.toString(m_dtFormat) );
+        this->setProperty("createdDateTime", currentDt.toString(dtFormat) );
         setCreatedDt(currentDt);
     }
 
     // Modification
-    this->setProperty("lastModifiedDateTime", currentDt.toString(m_dtFormat) );
+    this->setProperty("lastModifiedDateTime", currentDt.toString(dtFormat) );
     setLastModifiedDt(currentDt);
 
     // --------------------------------------------------
@@ -133,7 +123,7 @@ bool Model::save()
 
     QMap<QString, QVariant> propsMap = computePropsMap(*this);
 
-    qint64 id = m_basicOperation.save(m_name, propsMap);
+    qint64 id = basicOperation.save(name, propsMap);
 
     setProperty("id", id);
 
@@ -147,27 +137,27 @@ bool Model::remove()
 {
     const qint64& id = getId();
 
-    return m_basicOperation.remove(getTableName(), id);
+    return basicOperation.remove(getTableName(), id);
 }
 
 QString Model::getCreatedDtStr() const
 {
-    return m_createdDateTime;
+    return createdDateTime;
 }
 
 QDateTime Model::getCreatedDt() const
 {
-    return QDateTime::fromString(m_createdDateTime, m_dtFormat);
+    return QDateTime::fromString(createdDateTime, dtFormat);
 }
 
 QDateTime Model::getLastModifiedDt() const
 {
-    return QDateTime::fromString(m_lastModifiedDateTime, m_dtFormat);
+    return QDateTime::fromString(lastModifiedDateTime, dtFormat);
 }
 
 QString Model::getLastModifiedDtStr() const
 {
-    return m_lastModifiedDateTime;
+    return lastModifiedDateTime;
 }
 
 QStringList Model::listAllProperties() const
@@ -207,15 +197,15 @@ bool Model::preSaveCheck() const
 
 void Model::verifyDbTableExist()
 {
-    bool tableExistInDb = m_basicOperation.isTableInDb(m_name);
+    bool tableExistInDb = basicOperation.isTableInDb(name);
 
     if(!tableExistInDb)
     {
-       bool success = m_basicOperation.createTable(m_name);
+       bool success = basicOperation.createTable(name);
 
        if(success)
        {
-           qInfo() << "Model::verifyDbTableExist:" << "Table " << m_name << " was successfuly created";
+           qInfo() << "Model::verifyDbTableExist:" << "Table " << name << " was successfuly created";
        }
     }
 }
@@ -229,7 +219,7 @@ void Model::verifyDbFields()
     QStringList fieldsFromObject = listAllProperties();
 
     // Then get all the fields of the object that are stored in the db
-    QStringList fieldsFromDb = m_basicOperation.fields(m_name);
+    QStringList fieldsFromDb = basicOperation.fields(name);
 
     // Loop on all the fields of the object and check if they are in the database
     for(const QString& fieldName : fieldsFromObject)
@@ -240,7 +230,7 @@ void Model::verifyDbFields()
         {
             // The field is not present in the db and we need to add it
 
-            qInfo() << "Model::verifyDbFields:"<< "In" << m_name
+            qInfo() << "Model::verifyDbFields:"<< "In" << name
                      << "the field" << fieldName << "is present in the object but was not found in database."
                      << "We update the database."
                         ;
@@ -250,9 +240,9 @@ void Model::verifyDbFields()
 
             QVariant::Type propertyType = this->propertyType(fieldName);
 
-            m_basicOperation.addFieldToTable(fieldName, propertyType, m_name);
+            basicOperation.addFieldToTable(fieldName, propertyType, name);
 
-            customizeField(fieldName, propertyType, m_name);
+            customizeField(fieldName, propertyType, name);
         }
     }
 
@@ -272,13 +262,13 @@ void Model::verifyDbFields()
     // If we performed a change in the db
     if(dbChangedPerformed)
     {
-        qInfo() << "The database was modified to update the table" << m_name << "."
+        qInfo() << "The database was modified to update the table" << name << "."
                 << "We will update the version for this table."
                 ;
 
-        qint32 tableVersion = m_basicOperation.tableVersion(m_name);
+        qint32 tableVersion = basicOperation.tableVersion(name);
         tableVersion += 1;
-        m_basicOperation.changeTableVersion(m_name, tableVersion);
+        basicOperation.changeTableVersion(name, tableVersion);
     }
 }
 
@@ -310,7 +300,7 @@ QMetaProperty Model::findProperty(const QString &propertyName) const
 
     if(!found)
     {
-        QString msg = QString("") + "Model::findProperty:" + " The property " + propertyName + " was not found in " + m_name;
+        QString msg = QString("") + "Model::findProperty:" + " The property " + propertyName + " was not found in " + name;
         qDebug() << msg;
         qFatal("Property should always be found here");
     }
@@ -362,7 +352,7 @@ void Model::setCreatedDt(const QDateTime &dt)
 {
     if(dt != getCreatedDt() )
     {
-        m_createdDateTime = dt.toString(m_dtFormat);
+        createdDateTime = dt.toString(dtFormat);
 
         createdDateTimeChanged();
     }
@@ -372,7 +362,7 @@ void Model::setLastModifiedDt(const QDateTime &dt)
 {
     if(dt != getLastModifiedDt() )
     {
-        m_lastModifiedDateTime = dt.toString(m_dtFormat);
+        lastModifiedDateTime = dt.toString(dtFormat);
 
         lastModifiedDateTimeChanged();
     }

CPPWebFramework/cwf/model.h

@@ -32,7 +32,7 @@ CWF_BEGIN_NAMESPACE
  * {
  *    Q_OBJECT
  *
- *    Q_PROPERTY(QString email MEMBER m_email NOTIFY emailChanged)
+ *    Q_PROPERTY(QString email MEMBER email NOTIFY emailChanged)
  *
  *    public:
  *      UserModel() : Model("user") // Name of the model and database table
@@ -45,7 +45,7 @@ CWF_BEGIN_NAMESPACE
  *      void emailChanged();
  *
  *    private:
- *      QString m_email;
+ *      QString email;
  * }
  * ```
  *
@@ -83,86 +83,82 @@ class CPPWEBFRAMEWORKSHARED_EXPORT Model : public QObject
 {
     Q_OBJECT
 
-    Q_PROPERTY(qint64 id MEMBER m_id NOTIFY idChanged)
-    Q_PROPERTY(QString createdDateTime MEMBER m_createdDateTime NOTIFY createdDateTimeChanged)
-    Q_PROPERTY(QString lastModifiedDateTime MEMBER m_lastModifiedDateTime NOTIFY lastModifiedDateTimeChanged)
+    Q_PROPERTY(qint64 id MEMBER id NOTIFY idChanged)
+    Q_PROPERTY(QString createdDateTime MEMBER createdDateTime NOTIFY createdDateTimeChanged)
+    Q_PROPERTY(QString lastModifiedDateTime MEMBER lastModifiedDateTime NOTIFY lastModifiedDateTimeChanged)
 
 public:
-    Model(const QString& name); ///< @brief Constructor
-    virtual ~Model(); ///< @brief Destructor
-
     /**
-     * @brief updateDB Will create or update the database schema to match the model class.
-     *
+      * @brief Constructor
+     */
+    Model(const QString &name) : name(name) {}
+    /**
+      * @brief Destructor
+      */
+    virtual ~Model() = default;
+    /**
+     * @brief updateDB Will create or update the database schema to match the model class.     
      * This allows to create a working table from scratch or to update one. Note that a table update can add new
      * fields (Qt properties in the model code) but cannot remove any. Therefore, a developer should only add new
      * properties to a model and never remove one.
      */
     void updateDB();
-
     /**
      * @brief build Populate the model with data from the database.
      * @param id The id of the data to be used to populate the model.
      */
     void build(const qint64& id);
-
     /**
      * @brief build Populate the model with data from the database.
      * @param selectCondition A map ([propertyName] = propertyValue) of property values
      * used to choose which data to insert in the model.
      *
      * The first entry of database table that matchs all the property values will be used to populate the model.
      */
-    void build(const QMap<QString, QVariant>& selectCondition);
-
+    void build(const QMap<QString, QVariant> &selectCondition);
     /**
      * @brief buildFromJson Populate a model from json data
      * @param json The data used to populate the model instance
      * @param withTableNamePrefix Are the date properties prefixed with the name of this model db table ? This is false by default.
      */
-    void buildFromJson(const QJsonObject& json, bool withTableNamePrefix=false);
-
+    void buildFromJson(const QJsonObject &json, bool withTableNamePrefix = false);
     /**
      * @brief save Persist the model in the database
      * @return Bool: Was the model correctly persisted ?
      */
     bool save();
-
     /**
      * @brief remove Delete the model from the database
      * @return Bool: Was the data removed without error ?
      */
     bool remove();
-
     /**
      * @brief setCreatedDt Manually set the creation date
      * @param dt Date of the model first save into the database.
      */
     void setCreatedDt(const QDateTime& dt);
-
     /**
      * @brief setLastModifiedDt Set the last date at which the model was persisted in the database.
      * @param dt The date to be used.
      */
     void setLastModifiedDt(const QDateTime& dt);
-
     /**
      * @brief setWasBuild Set the "was build" flag that indicate if a model instance was correctly populated (build) by data.
      * @param b The flag.
      */
-    void setWasBuild(bool b) {m_built = b;}
+    void setWasBuild(bool b) { built = b;}
 
     /**
      * @brief getWasBuild Get the value of the "was build" flag.
      * @return Bool: Was the model instance populated by data from the database ?
      */
-    bool getWasBuild() const {return m_built;}
+    bool getWasBuild() const { return built; }
 
     /**
      * @brief getId Get the id of the model
      * @return qint64: The id of the model
      */
-    const qint64& getId() const {return m_id;}
+    const qint64& getId() const { return id; }
 
     /**
      * @brief getCreatedDt Get the creation date of the model
@@ -192,7 +188,7 @@ class CPPWEBFRAMEWORKSHARED_EXPORT Model : public QObject
      * @brief getTableName The name of database table corresponding to the model
      * @return QString: Name of database table and of the model
      */
-    const QString& getTableName() const {return m_name;}
+    const QString& getTableName() const { return name; }
 
     /**
      * @brief findProperty Find a property with its name
@@ -233,40 +229,37 @@ class CPPWEBFRAMEWORKSHARED_EXPORT Model : public QObject
     void lastModifiedDateTimeChanged();
 
 protected:
-    ModelBasicOperation m_basicOperation;
+    ModelBasicOperation basicOperation;
 
     /**
      * @brief preSaveCheck Perform some checks before persisting (saving) the model instance.
      * The persisting is done only if the checks where successful.
      * @return Bool: Was the check successful ?
      */
     virtual bool preSaveCheck() const;
-
     /**
      * @brief customizeField Allow to give special instructions when a field is created in the database.
      */
-    virtual void customizeField(const QString &/*fieldName*/,
-                                const QVariant::Type /*type*/,
-                                const QString &/*tableName*/
-                                ) const {;}
+    virtual void customizeField(const QString &fieldName,
+                                const QVariant::Type &type,
+                                const QString &tableName
+                                ) const = 0;
 
 private:
-    QString m_name; ///< @brief m_name The name of the model
-
+    QString name; ///< @brief name The name of the model
     /**
-     * @brief m_id The database id of the model
-     *
+     * @brief id The database id of the model
      * The id is set to -1 by default. It may change if the model was populated with data from the database (the id will become the one
      * of the entity stored in the database) or if a user manually set the variable before.
      */
-    qint64 m_id = -1;
+    qint64 id = -1;
 
-    qint64 m_version; ///< @brief The version of the table (database side)
-    bool m_built = false; ///< @brief Was the model instance populated with data ?
+    qint64 version; ///< @brief The version of the table (database side)
+    bool built = false; ///< @brief Was the model instance populated with data ?
 
-    QString m_dtFormat = "dd/MM/yyyy hh:mm:ss.zzz"; ///< @brief Format of the date used in this class
-    QString m_createdDateTime; ///< @brief First save in the database date
-    QString m_lastModifiedDateTime; ///< @brief Last modified and persisted date
+    QString dtFormat = "dd/MM/yyyy hh:mm:ss.zzz"; ///< @brief Format of the date used in this class
+    QString createdDateTime; ///< @brief First save in the database date
+    QString lastModifiedDateTime; ///< @brief Last modified and persisted date
 
     void verifyDbTableExist(); ///< @brief Check the database contains table corresponding to this model. Also create or update the table if needed.
     void verifyDbFields(); ///< @brief Check the database table contains all required fields (columns). If not, create them.