Add register model using Django settings

[2ykwang]

This PR makes it easy to register model in the django-auditlog.

Setting variable

AUDITLOG_INCLUDE_ALL_MODELS
-> registers all models loaded from the django instance.

from django.apps import apps

apps.get_models()

e.g)

# The code below means to register all models.
AUDITLOG_INCLUDE_ALL_MODELS=True

AUDITLOG_INCLUDE_TRACKING_MODELS
-> assign models to register. this has the same behavior as audit log.register()

e.g)

AUDITLOG_INCLUDE_TRACKING_MODELS = (
    "<appname>.<model1>",
    {
        "model": "<appname>.<model1>",
        "include_fields": ["field1", "field2"],
        "exclude_fields": ["field3", "field4"],
        "mapping_fields": {
            "field1": "FIELD",
        },
        "mask_fields": ["field5", "field6"],
    },
    "<appname>.<model3>",
)

AUDITLOG_EXCLUDE_TRACKING_MODELS
-> assign models to exclude. this option is executed when AUDITLOG_INCLUDE_ALL_MODELS value is True.

e.g)

AUDITLOG_EXCLUDE_TRACKING_MODELS = (
    "<app_name>",
    "<app_name>.<model>"
)

[codecov]

Codecov Report

Merging #368 (3b1cec1) into master (a93f539) will increase coverage by 2.26%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
+ Coverage   83.39%   85.66%   +2.26%     
==========================================
  Files          20       21       +1     
  Lines         506      565      +59     
==========================================
+ Hits          422      484      +62     
+ Misses         84       81       -3     

Impacted Files	Coverage Δ
auditlog/apps.py	100.00% <100.00%> (ø)
auditlog/conf.py	100.00% <100.00%> (ø)
auditlog/registry.py	98.18% <100.00%> (+6.80%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a93f539...3b1cec1. Read the comment docs.

[hramezani]

Thanks @2ykwang for this patch. Please:

• Add tests for lines that don't have test coverage. for example :https://github.com/jazzband/django-auditlog/pull/368/files#diff-15d9f21d10a43b67bf64254c6cfa8802be37b5e9be2a07a44482f33a920882c5R162
• Add documentation for these features in https://github.com/jazzband/django-auditlog/blob/master/docs/source/usage.rst

[Linkid]

Could you add some tests with excluding fields, errors in new config vars and with a batch registration, please? Thanks

[hramezani]

@2ykwang Please add a changelog entry.

[2ykwang]

@hramezani Done!

[hramezani]

I think you forgot to add documentation

[hramezani]

Let's use assertRaisesMessage to check the error message as well

[hramezani]

@hramezani Can you help me with the documentation? If you don't mind. my English is not so fluent.

Please provide the initial version of the documentation and then we can improve it with the help of @Linkid

[hramezani]

Why do we have these two args here? Do they need just to make the function easier to test?

[hramezani]

@2ykwang Could you please open my access to your fork, I am going to push some changes to your PR

[2ykwang]

@hramezani I just invited you. thank you!

[hramezani]

@2ykwang I will work on this patch and will update it later when I have time.
Then we can merge this patch.
Thanks for your effort!

[hramezani]

@2ykwang I've refactored some parts of your patch. Please take look.

[hramezani]

@Linkid It would be great if you have time for a review!

[2ykwang]

@hramezani
Thanks to you, the code looks much better. Thanks for the work 😄

dismiss