qleany 0.3.0

Python tool for Qleany

Qleany - Clean Architecture Framework for C++/Qt6 Projects

Qleany is a streamlined framework designed to integrate Clean Architecture principles within C++ Qt6 applications. It is built on three core components:

1. Qleany C++/Qt Library: Provides a range of common and generic tools and classes essential for implementing Clean Architecture in C++/Qt projects.
2. Python/Jinja2 Project Structure Generator: Features a dedicated user interface developed using PySide. This generator facilitates the creation of a structured project environment based on the principles of Clean Architecture.
3. Examples and Documentation: A collection of examples to guide users in implementing the framework effectively.

Important Notices

Please avoid using Qt Design Studio version 4.3 (which utilizes Qt 6.6) due to a known issue that impacts Qt versions 6.5.3 and 6.6. This bug can cause crashes in previews (qml2puppet) when working with QML mocks generated by Qleany. We recommend using Qt Design Studio LTS version 4.1 instead, as it is based on Qt 6.5.1 and does not exhibit this problem. Qt Design Studio 4.4 preview seems to run well with Qleany.

Framework's Objective

Qleany's primary goal is to automate the generation of a structured project environment for C++/Qt6 applications. This is achieved by interpreting a simple manifest file, named qleany.yaml, located at the root of the project. The framework generates a comprehensive structure including folders, CMakeLists.txt, and essential C++ files. The generated projects support both QWidget and QML GUIs or a combination of both. Upon initial generation, the projects are immediately compilable, requiring developers only to design GUIs and implement custom use cases.

The framework acknowledges the repetitive nature of file creation in Clean Architecture and addresses this by automating the generation of similar files. Additional features include:

• An asynchronous undo-redo system based on the command pattern.
• A SQLite-based database layer for data persistence.
• Support for custom use cases with user-defined DTOs (Data Transfer Objects) for inputs and outputs.
• The ability to define both soft and hard relationships between entities, including one-to-one and one-to-many (unordered or ordered) associations.
• Entities within the framework handle cascade deletion. Additionally, the implementation of soft-deletion (recoverable trash binning) is currently in progress.

Framework Structure

Many developers are likely familiar with the following depiction of Clean Architecture:

It's important to note that this conceptual representation needs to be tailored to fit the specific requirements of the language and project at hand. Qleany presents a distinct interpretation of Clean Architecture, uniquely adapted and structured to suit its specific use cases and environment.

• Entities: Contains entities and is encapsulated in a library named entities.
• Application: Groups use cases by functionalities, organized within a library called application.
• Persistence: Manages internal data persistence. It includes a 'repository' wrapper for SQLite database interactions, with each entity having its repository in the RepositoryProvider class.
• Contracts: A common library for most other components, housing all interfaces from persistence, gateway, and infrastructure. This design minimizes tight coupling and circular dependencies.
• DTO Libraries: Each functionality has its DTO library, facilitating communication with the application layer. DTOs are used for both input and output in interactions with the outer layers, such as interactors.
• Gateway: Optional library for handling remote connections and services. It can be manually added by the developer and is used similarly to repositories in use cases.
• Infrastructure: Optional. Handles actions like file management, local settings, and system queries. It's injected into use cases similar to repositories and gateways.
• Interactor: Acts as an internal API to invoke use cases, streamlining the interaction between the user interface and application logic.
• Presenter: Maintains Qt models and representations of unique entities (referred to as Singles), enhancing their integration and usage within the GUI.
• Registration: Each component (persistence, gateway, infrastructure, interactor) initializes its classes in a corresponding name_registration.cpp file, typically called together in the main.cpp.

Project dependencies:

Example of project structure:

Installing the Qleany library

Manually

Prerequisites:

• Qt 6.5 (dev packages)
• QCoro (dev packages)
• Cmake and extra-cmake-modules

The use of sccache is optional. Also, adapt the -j6 to your number of CPU minus one.

CMake options are:

• QLEANY_BUILD_EXAMPLES
• QLEANY_BUILD_TESTS
• BUILD_SHARED_LIBS
• QLEANY_BUILD_WITH_QT_GUI

git clone https://github.com/jacquetc/qleany.git
cd qleany
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DQLEANY_BUILD_WITH_QT_GUI=on -DQLEANY_BUILD_EXAMPLES=off -DQLEANY_BUILD_TESTS -DCMAKE_CXX_COMPILER_LAUNCHER=sccache ..
cmake --build . -- -j6
sudo cmake --install .

Installing the Qleany GUI Interface

Qleany tooling can be installed using pip install qleany. Alternatively, you can install it using pipx run qleany if you have pipx installed.

Utilizing the Qleany GUI Interface

To access Qleany's user-friendly graphical interface, run qleany in a terminal. This interface allows developers to efficiently manage file generation. This is the recommended way to generate files.

1. Run the Qleany GUI:

   • Launch Qleany's graphical user interface by executing the script generator/qleany_generator_ui.py.

2. Select the qleany.yaml File:

   • Begin by choosing your project's qleany.yaml file. This configuration file is essential for the GUI to operate correctly.

3. List Available Files:

   • In the GUI, use the "list" button for each component. This will generate a list of files that can be created for that component.

4. Select Files to Generate:

   • Choose the files you want to generate from the provided list, depending on your project requirements.

5. Preview Files:

   • Opt for the "preview" feature to generate and inspect the selected files in a "preview" folder. The location of this folder is defined in your qleany.yaml file.

6. Generate Files:

   • After previewing, proceed to generate the files by clicking the "generate" button. This will create the files in their designated locations within your project.

7. Overwrite Confirmation:

   • Should the file generation process require overwriting existing files, a warning message will appear. This alert ensures you are informed about and agree to the upcoming changes to your current files.

Alternatively, you can list and generate all the files of the project.

Qleany YAML Configuration Rules

The qleany.yaml file is the core configuration file for the Qleany framework. A working example can be foound in example/simple/qleany.yaml. Below are the rules and structure for defining the configuration:

Global Settings

global:
  application_name: SimpleExample
  application_cpp_domain_name: Simple
  organisation:
    name: simpleexample
    domain: qleany.eu

Entities Definition

Defines entities and their properties. Setting parent to EntityBase (provided by Qleany) offers the "id" field of type "int". It's mandatory to use EntityBase as heritage.

entities:
  list:
    - name: EntityName
      parent: ParentEntity
      only_for_heritage: true/false
      fields:
        # basic:
        - type: DataType
          name: fieldName
          hidden: true/false (default: false)
        # one-to-one relationship:
        - type: OtherEntityName
          name: fieldName
          strong: true/false
          hidden: true/false (default: false)
        # one-to-many relationship:
        - type: QList<OtherEntityName>
          name: fieldName
          strong: true/false
          ordered: true/false
          hidden: true/false (default: false)
        # other fields ...
    # other entities ...
  folder_path: path/to/entity/folder

Repositories Configuration

Specifies settings for entity repositories.

repositories:
  list:
    - entity_name: EntityName
      lazy_loaders: true/false
    # other repositories, typically one for each entity
  repository_folder_path: path/to/repository/folder
  base_folder_path: path/to/base/folder

Interactor Settings

Configures interactor-specific settings.

interactor: 
  folder_path: path/to/interactor/folder
  create_undo_redo_interactor: true/false

Application Layer Configuration

Defines application-specific settings and CRUD operations.

application:
  common_cmake_folder_path: path/to/application/folder
  features:
    - name: FeatureName
      DTO:
        dto_identical_to_entity:
          enabled: true/false
          entity_mappable_with: EntityName
      CRUD:
        enabled: true/false (default: false)
        entity_mappable_with: EntityName
        get:
          enabled: true/false
        get_all:
          enabled: true/false
        get_with_details:
          enabled: true/false
        create: 
          enabled: true/false
        remove: 
          enabled: true/false
        update: 
          enabled: true/false       
        insert_relation: 
          enabled: true/false        
        remove_relation: 
          enabled: true/false 
      commands:
        - name: CommandName
          entities:
            - EntityName
          validator: 
            enabled: true/false 
          undo: true/false 
          dto:
            in:
              enabled: true/false (default: true)
              type_prefix: CommandName
              fields:
                - type: DataType
                  name: fieldName
            out:
              enabled: true/false (default: true)
              type_prefix: CommandNameReply
              fields:
                - type: DataType
                  name: fieldName
      queries:
        - name: QueryName
          entities:
            - EntityName
          validator: 
            enabled: true/false 
          undo: false (useless for queries)
          dto:
            in:
              enabled: true/false (default: true)
              type_prefix: QueryName
              fields:
                - type: DataType
                  name: fieldName
            out:
              type_prefix: QueryNameReply
              fields:
                - type: DataType
                  name: fieldName
              

DTOs (Data Transfer Objects) Configuration

DTOs:
  common_cmake_folder_path: path/to/dtos/folder

Contracts Configuration

Defines settings for contracts in the application.

contracts:
  inverted_app_domain: domain.identifier
  folder_path: path/to/contracts/folder

Presenter Settings

Configures presenter-specific settings. Note: the name can be set to auto

presenter:
  folder_path: path/to/presenter/folder
  create_undo_and_redo_singles: true/false (default false)
  singles:
    - name: SingleName (or "auto")
      entity: EntityName
      read_only: true/false (default: false)
    # Additional singles...
  list_models:
    - name: ListModelName (or auto)
      entity: EntityName
      displayed_field: fieldName
      in_relation_of: RelationEntity
      relation_field_name: relationFieldName
      read_only: true/false (default: false)
    # Additional list models...

QML Configuration

Specifies paths for QML folder. The folders mock_imports and real_imports will be created in it.

qml:
  folder_path: path/to/qml/folder

Mozilla Public License Version 2.0

1. Definitions

---

1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.

1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution.

1.3. "Contribution" means Covered Software of a particular Contributor.

1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.

1.5. "Incompatible With Secondary Licenses" means

(a) that the initial Contributor has attached the notice described
    in Exhibit B to the Covered Software; or

(b) that the Covered Software was made available under the terms of
    version 1.1 or earlier of the License, but not also under the
    terms of a Secondary License.

1.6. "Executable Form" means any form of the work other than Source Code Form.

1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.

1.8. "License" means this document.

1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.

1.10. "Modifications" means any of the following:

(a) any file in Source Code Form that results from an addition to,
    deletion from, or modification of the contents of Covered
    Software; or

(b) any new file in Source Code Form that contains any Covered
    Software.

1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.

1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.

1.13. "Source Code Form" means the form of the work preferred for making modifications.

1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.

2. License Grants and Conditions

---

2.1. Grants

Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:

(a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and

(b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.

2.2. Effective Date

The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.

2.3. Limitations on Grant Scope

The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:

(a) for any code that a Contributor has removed from Covered Software; or

(b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or

(c) under Patent Claims infringed by Covered Software in the absence of its Contributions.

This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).

2.4. Subsequent Licenses

No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).

2.5. Representation

Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.

2.6. Fair Use

This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.

2.7. Conditions

Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.

3. Responsibilities

---

3.1. Distribution of Source Form

All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form.

3.2. Distribution of Executable Form

If You distribute Covered Software in Executable Form then:

(a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and

(b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License.

3.3. Distribution of a Larger Work

You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).

3.4. Notices

You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.

3.5. Application of Additional Terms

You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.

4. Inability to Comply Due to Statute or Regulation

---

If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.

5. Termination

---

5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.

5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.

5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.

---

•                                                                  *
  

• 6. Disclaimer of Warranty *
• ------------------------- *

•                                                                  *
  

• Covered Software is provided under this License on an "as is" *
• basis, without warranty of any kind, either expressed, implied, or *
• statutory, including, without limitation, warranties that the *
• Covered Software is free of defects, merchantable, fit for a *
• particular purpose or non-infringing. The entire risk as to the *
• quality and performance of the Covered Software is with You. *
• Should any Covered Software prove defective in any respect, You *
• (not any Contributor) assume the cost of any necessary servicing, *
• repair, or correction. This disclaimer of warranty constitutes an *
• essential part of this License. No use of any Covered Software is *
• authorized under this License except under this disclaimer. *

•                                                                  *
  

---

---

•                                                                  *
  

• 7. Limitation of Liability *
• -------------------------- *

•                                                                  *
  

• Under no circumstances and under no legal theory, whether tort *
• (including negligence), contract, or otherwise, shall any *
• Contributor, or anyone who distributes Covered Software as *
• permitted above, be liable to You for any direct, indirect, *
• special, incidental, or consequential damages of any character *
• including, without limitation, damages for lost profits, loss of *
• goodwill, work stoppage, computer failure or malfunction, or any *
• and all other commercial damages or losses, even if such party *
• shall have been informed of the possibility of such damages. This *
• limitation of liability shall not apply to liability for death or *
• personal injury resulting from such party's negligence to the *
• extent applicable law prohibits such limitation. Some *
• jurisdictions do not allow the exclusion or limitation of *
• incidental or consequential damages, so this exclusion and *
• limitation may not apply to You. *

•                                                                  *
  

---

8. Litigation

---

Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims.

9. Miscellaneous

---

This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.

10. Versions of the License

---

10.1. New Versions

Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.

10.2. Effect of New Versions

You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.

10.3. Modified Versions

If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).

10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses

If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.

Exhibit A - Source Code Form License Notice

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

Exhibit B - "Incompatible With Secondary Licenses" Notice

This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.