Add next and previous record diffs #798

brylie · 2021-02-19T11:15:51Z

Closes #797

Added next and previous record diffs for consistency

Description

These helper properties would make it easier to get revision diffs in Django templlates.

Related Issue

#797

Motivation and Context

Making it easier to show revision diffs directly in templates.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have run the make format command to format my code
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have added my name and/or github handle to AUTHORS.rst
I have added my change to CHANGES.rst
All new and existing tests passed.

Closes #797 Added next and previous record diffs for consistency

codecov · 2021-02-19T11:18:22Z

Codecov Report

Merging #798 (df66df4) into master (e8b9ce0) will increase coverage by 0.39%.
The diff coverage is n/a.

❗ Current head df66df4 differs from pull request most recent head 4db4a2a. Consider uploading reports for the commit 4db4a2a to get more accurate results

@@            Coverage Diff             @@
##           master     #798      +/-   ##
==========================================
+ Coverage   97.47%   97.87%   +0.39%     
==========================================
  Files          18       18              
  Lines         992      988       -4     
  Branches      151      150       -1     
==========================================
  Hits          967      967              
+ Misses         12        9       -3     
+ Partials       13       12       -1

Impacted Files	Coverage Δ
simple_history/__init__.py	`100.00% <ø> (ø)`
simple_history/utils.py	`100.00% <ø> (+6.06%)`	⬆️

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 e8b9ce0...4db4a2a. Read the comment docs.

….7 (#800)

Bumps [tox](https://github.com/tox-dev/tox) from 3.21.4 to 3.22.0. - [Release notes](https://github.com/tox-dev/tox/releases) - [Changelog](https://github.com/tox-dev/tox/blob/master/docs/changelog.rst) - [Commits](tox-dev/tox@3.21.4...3.22.0) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.4.3 to 3.5.1. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES) - [Commits](sphinx-doc/sphinx@v3.4.3...v3.5.1) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [coverage](https://github.com/nedbat/coveragepy) from 5.4 to 5.5. - [Release notes](https://github.com/nedbat/coveragepy/releases) - [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) - [Commits](nedbat/coveragepy@coverage-5.4...coverage-5.5) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [tox](https://github.com/tox-dev/tox) from 3.22.0 to 3.23.0. - [Release notes](https://github.com/tox-dev/tox/releases) - [Changelog](https://github.com/tox-dev/tox/blob/3.23.0/docs/changelog.rst) - [Commits](tox-dev/tox@3.22.0...3.23.0) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.1 to 3.5.2. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES) - [Commits](sphinx-doc/sphinx@v3.5.1...v3.5.2) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Rename Django's dev branch to main. More information: https://groups.google.com/g/django-developers/c/tctDuKUGosc/ Refs: django/django#14048 * Downgrade to 18.04 to work-around the issue with mysql/mariadb.

Bumps [flake8](https://gitlab.com/pycqa/flake8) from 3.8.4 to 3.9.0. - [Release notes](https://gitlab.com/pycqa/flake8/tags) - [Commits](https://gitlab.com/pycqa/flake8/compare/3.8.4...3.9.0) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [tox-gh-actions](https://github.com/ymyzk/tox-gh-actions) from 2.4.0 to 2.5.0. - [Release notes](https://github.com/ymyzk/tox-gh-actions/releases) - [Commits](ymyzk/tox-gh-actions@v2.4.0...v2.5.0) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.2 to 3.5.3. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES) - [Commits](https://github.com/sphinx-doc/sphinx/commits) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [isort](https://github.com/pycqa/isort) from 5.7.0 to 5.8.0. - [Release notes](https://github.com/pycqa/isort/releases) - [Changelog](https://github.com/PyCQA/isort/blob/develop/CHANGELOG.md) - [Commits](PyCQA/isort@5.7.0...5.8.0) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* update fr messagefile * improve french translation

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.3 to 3.5.4. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/4.x/CHANGES) - [Commits](https://github.com/sphinx-doc/sphinx/commits/v3.5.4) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [flake8](https://gitlab.com/pycqa/flake8) from 3.9.0 to 3.9.1. - [Release notes](https://gitlab.com/pycqa/flake8/tags) - [Commits](https://gitlab.com/pycqa/flake8/compare/3.9.0...3.9.1) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Remove changeReason and update CHANGES * call out breaking changes

Bumps [tox](https://github.com/tox-dev/tox) from 3.23.0 to 3.23.1. - [Release notes](https://github.com/tox-dev/tox/releases) - [Changelog](https://github.com/tox-dev/tox/blob/master/docs/changelog.rst) - [Commits](tox-dev/tox@3.23.0...3.23.1) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.4 to 4.0.2. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/4.x/CHANGES) - [Commits](sphinx-doc/sphinx@v3.5.4...v4.0.2) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [black](https://github.com/psf/black) from 20.8.b1 to 21.5b1. - [Release notes](https://github.com/psf/black/releases) - [Changelog](https://github.com/psf/black/blob/main/CHANGES.md) - [Commits](https://github.com/psf/black/commits) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [flake8](https://gitlab.com/pycqa/flake8) from 3.9.1 to 3.9.2. - [Release notes](https://gitlab.com/pycqa/flake8/tags) - [Commits](https://gitlab.com/pycqa/flake8/compare/3.9.1...3.9.2) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

The plural seems to confuse the double backticks.

* Return self if called on the class instead of instance to not error out in metaprogramming in internals of djangorestframework. * Add entry on changelog.

This not only means comparison is done on primitive values, but as a side effect removes the extra query for base models

Bumps [tox-gh-actions](https://github.com/ymyzk/tox-gh-actions) from 2.7.0 to 2.8.0. - [Release notes](https://github.com/ymyzk/tox-gh-actions/releases) - [Commits](ymyzk/tox-gh-actions@v2.7.0...v2.8.0) --- updated-dependencies: - dependency-name: tox-gh-actions dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [tox-gh-actions](https://github.com/ymyzk/tox-gh-actions) from 2.8.0 to 2.8.1. - [Release notes](https://github.com/ymyzk/tox-gh-actions/releases) - [Commits](ymyzk/tox-gh-actions@v2.8.0...v2.8.1) --- updated-dependencies: - dependency-name: tox-gh-actions dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

Opt-out of the index with `SETTINGS_HISTORY_DATE_INDEX=False`. Allow history_date indexing to be disabled or composite with model pk Co-authored-by: jeking3 <[email protected]>

* Add SIMPLE_HISTORY_ENABLED flag * Update AUTHORS * Consider SIMPLE_HISTORY_ENABLED in bulk queries Co-authored-by: Danial Erfanian <[email protected]>

Bumps [coverage](https://github.com/nedbat/coveragepy) from 5.5 to 6.0. - [Release notes](https://github.com/nedbat/coveragepy/releases) - [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) - [Commits](nedbat/coveragepy@coverage-5.5...6.0) --- updated-dependencies: - dependency-name: coverage dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Coercing OneToOneFields to be ForeignKeys on historical models causes issues when the OneToOneField is a custom subclass that includes additional arguments that do not exist on the ForeignKey.__init__ method. These additional arguments can be specified via excluded_field_kwargs to allow these custom OneToOneFields be coerced into ForeignKeys on the historical model. Fixes #870 Co-authored-by: Jim King <[email protected]>

…DUCT.md'

Fix broken CI: add pre-commit checks for better CI

Bumps [flake8](https://github.com/pycqa/flake8) from 3.9.2 to 4.0.1. - [Release notes](https://github.com/pycqa/flake8/releases) - [Commits](PyCQA/flake8@3.9.2...4.0.1) --- updated-dependencies: - dependency-name: flake8 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [coverage](https://github.com/nedbat/coveragepy) from 6.0 to 6.0.2. - [Release notes](https://github.com/nedbat/coveragepy/releases) - [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) - [Commits](nedbat/coveragepy@6.0...6.0.2) --- updated-dependencies: - dependency-name: coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

jeking3 · 2021-10-25T20:10:09Z

@brylie My last comment should help with the current issues.

Closes #797 Added next and previous record diffs for consistency

…django-simple-history into next-and-previous-diff

for more information, see https://pre-commit.ci

…django-simple-history into next-and-previous-diff

for more information, see https://pre-commit.ci

brylie · 2021-10-26T08:16:38Z

@jeking3, I have rebased master into this branch and fixed some lint issues in code related to this pull request.

…django-simple-history into next-and-previous-diff

brylie · 2021-10-26T08:21:20Z

simple_history/models.py:379:5: C901 'HistoricalRecords.get_extra_fields' is too complex (13)

I will leave HistoricalRecords.get_extra_fields unmodified.

Add next and previous record diffs

9c2952d

Closes #797 Added next and previous record diffs for consistency

brylie mentioned this pull request Feb 19, 2021

Get previous revision delta in template? #797

Open

Fix typo

c3c48ed

smithdc1 and others added 26 commits February 20, 2021 11:59

Updated test matrix -- Django Dev dropped support for Python3.6 and 3…

4d71615

….7 (#800)

Rename Django's dev branch to main. (#807)

9852eea

* Rename Django's dev branch to main. More information: https://groups.google.com/g/django-developers/c/tctDuKUGosc/ Refs: django/django#14048 * Downgrade to 18.04 to work-around the issue with mysql/mariadb.

Remove Python 3.5 from doc.

b07bd50

Increase black and isort python version to 3.6.

b23bad4

Remove Django 3.0 support.

d46fe6f

Add Django 3.2 support.

d288869

Improve French translations (#811)

723462c

* update fr messagefile * improve french translation

Remove changeReason and update CHANGES to prepare for 3.0.0 (#819)

67c7c43

* Remove changeReason and update CHANGES * call out breaking changes

fix title underline (#820)

df66df4

Fix documentation display issue (#835)

b1a031c

The plural seems to confuse the double backticks.

Fix bug where descriptor class missed instance=None case (#822)

666b6a6

* Return self if called on the class instead of instance to not error out in metaprogramming in internals of djangorestframework. * Add entry on changelog.

RealOrangeOne and others added 16 commits September 22, 2021 08:11

Reuse model_to_dict

bc210ac

This not only means comparison is done on primitive values, but as a side effect removes the extra query for base models

Fail hard if an unknown field is provided

65c66b6

Add index to history_date field to improve performance.

f38a77b

Opt-out of the index with `SETTINGS_HISTORY_DATE_INDEX=False`. Allow history_date indexing to be disabled or composite with model pk Co-authored-by: jeking3 <[email protected]>

add missing changelog for gh-885

2a22590

On off flag (#832)

f5340e5

* Add SIMPLE_HISTORY_ENABLED flag * Update AUTHORS * Consider SIMPLE_HISTORY_ENABLED in bulk queries Co-authored-by: Danial Erfanian <[email protected]>

Fix that #871 was not rebased on latest

83ee3db

Jazzband: Created local 'CODE_OF_CONDUCT.md' from remote 'CODE_OF_CON…

6dc604d

…DUCT.md'

add pre-commit checks for better CI and fix CI error

0c2457f

Merge pull request #896 from cloudtruth/jking/fix-pre-commit

25bb5b2

Fix broken CI: add pre-commit checks for better CI

allow for running tests with break on error

8215eb9

brylie and others added 9 commits October 26, 2021 11:11

Add next and previous record diffs

1b9c3a5

Closes #797 Added next and previous record diffs for consistency

Fix typo

744fb6a

Initial diff tests

cad8348

Fix diff perspective for clearer semantics

89c63fb

Merge branch 'next-and-previous-diff' of https://github.com/jazzband/…

9f6a878

…django-simple-history into next-and-previous-diff

[pre-commit.ci] auto fixes from pre-commit.com hooks

7ed2f86

for more information, see https://pre-commit.ci

Lint/fix typo

4ca849c

Merge branch 'next-and-previous-diff' of https://github.com/jazzband/…

780581f

…django-simple-history into next-and-previous-diff

[pre-commit.ci] auto fixes from pre-commit.com hooks

7598ff5

for more information, see https://pre-commit.ci

Brylie Christopher Oxley added 2 commits October 26, 2021 11:18

Remove duplicate test case

127f4e0

Merge branch 'next-and-previous-diff' of https://github.com/jazzband/…

4db4a2a

…django-simple-history into next-and-previous-diff

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add next and previous record diffs #798

Add next and previous record diffs #798

brylie commented Feb 19, 2021 •

edited

codecov bot commented Feb 19, 2021 •

edited

jeking3 commented Oct 25, 2021

brylie commented Oct 26, 2021

brylie commented Oct 26, 2021

Add next and previous record diffs #798

Are you sure you want to change the base?

Add next and previous record diffs #798

Conversation

brylie commented Feb 19, 2021 • edited

Description

Related Issue

Motivation and Context

Types of changes

Checklist:

codecov bot commented Feb 19, 2021 • edited

Codecov Report

jeking3 commented Oct 25, 2021

brylie commented Oct 26, 2021

brylie commented Oct 26, 2021

brylie commented Feb 19, 2021 •

edited

codecov bot commented Feb 19, 2021 •

edited