kitsudaiki / libkitsunemimipersistence Goto Github PK

Cleanup-request

Description

Originally the file_methods-file was introduces as wrapper for the boost-filesystem-library. This should made the switch to C++17 in the future easier. But now becomes harder to handle in libKitsunemimiSakuraParser and can not be restricted to the file anymore. So the file should only contains some complexer stuff, but something like the check if a file exist should be removed and used directly from the boost-filesystem-library.

Feature-request

Description

Add a wrapper-class for etcd, similar to the already existing class for sqlite.

Feature-request

Description

Add log-rotation to logger.

Like in libKitsuneCommon, a build-script is totally necessary to make things easier.

Cleanup-request

Description

While using the function for reading and writing binary files again, I found some problems in the handling and bugs in the code. For example, writing the complete buffer to the file multiple times always resize the file by 100% of the buffer size each time. So the file becomes much larger then necessary.

For a lightweight sql-support sqlite should be added. Results of database request should be converted into data-items of libKitsuneCommon to be able to print the results via the table-items.

At the moment the data-buffer is binded to a binary file. This is totally unnecessary and should be removed. Instead of the, the data-buffer-pointer should be added as parameter to the read- and write-function.

Make the O_DIRECT-flag for binary-files optional, for the case you want to read a file, which is not created by this class and has not a size of a multiple of 512 bytes.

Tag-request

Checklist

• Changelog
• Version-tag in pro-file
• Version-tag of requirements in Readme
• Version-tag of requirements in build-script
• Add tag

The boost-library already provides a good logger. But I would like it to have all persist-functions collected into this lib. So a wrapper have to be implemented, which use internally the logger of the boost-lib.

Tag-request

Checklist

• Changelog
• Version-tag in pro-file
• Version-tag of requirements in Readme
• Version-tag of requirements in build-script
• Add tag

BUG-issue

Description

When initializing a file-logger, there is no validation, if the file is really open. So if the file can't be created, for example because missing permissions for the file-location, it fails silently and doesn't create a file.

there are missing unit-tests for the updateFileSize-method of the BinaryFile-class

move the logger-methods out of the Kitsune::Persistence namespace, to be easier handable in other projects.

BUG-issue

What you wanted to do

• write a text-file with Kitsunemimi::Persistence::writeFile

Description of the bug you run into

No file was written and the result of the command was not negative, because the target-directory hadn't exist.

Possible Solution

• additional check for the target-directory

Steps to Reproduce

1. call Kitsunemimi::Persistence::writeFile to write a file into a non existing directory

Environment

The logger is a bit stupid to handle at the moment, because it have to be handled via pointer. To make it easier, the static variables and standalone-methods should be used, to call the logger from every position of the code.

Cleanup-request

Description

• add missing tests for readCompleteFile and writeCompleteFile

in the text-file-class, at least one error-message is broken

Tag-request

Checklist

• Changelog
• Version-tag in pro-file
• Version-tag of requirements in Readme
• Version-tag of requirements in build-script
• Add tag

some points related to the logger-class have to be changed:

• add flag to enable/disable debug log

• add optional command-line-output

• replace spin-lock with mutex

• add some checks

Feature-request

Description

The connection for sqlite-databases requires the sqlite3-library. Because of this, each repo, which use libKitsunemimiPersistence, requires this library even if it doesn't use sqlite itself.

Thats why there should be a flag to optionally disable sqlite while building.