Resolve conflicts after merge with master

Author: joaojunior

.travis.yml

@@ -7,13 +7,15 @@ python:
   - 3.3
   - 3.4
   - 3.5
+  - 3.6
 
 env:
   - DJANGO="Django>=1.6,<1.7"
   - DJANGO="Django>=1.7,<1.8"
   - DJANGO="Django>=1.8,<1.9"
   - DJANGO="Django>=1.9,<1.10"
   - DJANGO="Django>=1.10,<1.11"
+  - DJANGO="Django>=1.11,<1.12"
 
 install:
   - pip install -U coverage codecov
@@ -30,9 +32,15 @@ matrix:
      env: DJANGO="Django>=1.6,<1.7"
    - python: 3.5
      env: DJANGO="Django>=1.7,<1.8"
+   - python: 3.6
+     env: DJANGO="Django>=1.6,<1.7"
+   - python: 3.6
+     env: DJANGO="Django>=1.7,<1.8"
    - python: 3.3
      env: DJANGO="Django>=1.9,<1.10"
    - python: 3.3
      env: DJANGO="Django>=1.10,<1.11"
+   - python: 3.3
+     env: DJANGO="Django>=1.11,<1.12"
 
 after_success: codecov

AUTHORS.rst

@@ -10,6 +10,7 @@ Authors
 - Daniel Levy
 - Daniel Roschka
 - David Hite
+- Eduardo Cuducos
 - George Vilches
 - Grzegorz Bialy
 - Hamish Downer
@@ -22,6 +23,7 @@ Authors
 - Jonathan Sanchez
 - Josh Fyne
 - Klaas van Schelven
+- Maciej "RooTer" Urbański
 - Martin Bachwerk
 - Marty Alchin
 - Mauricio de Abreu Antunes

CHANGES.rst

@@ -51,6 +51,7 @@ tip (unreleased)
 - Fix a bug when models have a ``ForeignKey`` with ``primary_key=True``
 - Do NOT delete the history elements when a user is deleted.
 - Add support for ``latest``
+- Allow setting a reason for change. [using option changeReason]
 
 1.5.3 (2014-11-18)
 ------------------

MANIFEST.in

@@ -2,4 +2,5 @@ include MANIFEST.in
 include *.rst
 include *.txt
 recursive-include docs *.rst
+recursive-include simple_history/locale *
 recursive-include simple_history/templates *

docs/advanced.rst

@@ -239,3 +239,43 @@ And you don't want to stored the changes for the field ``pub_date``, it is neces
         history = HistoricalRecords(excluded_fields=['pub_date'])
 
 By default, django-simple-history stores the changes for all fields in the model.
+
+Change Reason
+-------------
+
+Change reason is a message to explain why the change was made in the instance. It is stored in the
+field ``history_change_reason`` and its default value is ``None``.
+
+By default, the django-simple-history gets the change reason in the field ``changeReason`` of the instance. Also, is possible to pass
+the ``changeReason`` explicitly. For this, after a save or delete in an instance, is necessary call the
+function ``utils.update_change_reason``. The first argument of this function is the instance and the seccond
+is the message that represents the change reason.
+
+For instance, for the model:
+
+.. code-block:: python
+
+    from django.db import models
+    from simple_history.models import HistoricalRecords
+
+    class Poll(models.Model):
+        question = models.CharField(max_length=200)
+        history = HistoricalRecords()
+
+You can create a instance with a implicity change reason.
+
+.. code-block:: python
+
+    poll = Poll(question='Question 1')
+    poll.changeReason = 'Add a question'
+    poll.save()
+
+Or you can pass the change reason explicitly:
+
+.. code-block:: python
+
+    from simple_history.utils import update_change_reason
+
+    poll = Poll(question='Question 1')
+    poll.save()
+    update_change_reason(poll, 'Add a question')

runtests.py

@@ -27,6 +27,7 @@
 ]
 
 DEFAULT_SETTINGS = dict(
+    ALLOWED_HOSTS=['localhost'],
     AUTH_USER_MODEL='custom_user.CustomUser',
     ROOT_URLCONF='simple_history.tests.urls',
     MEDIA_ROOT=media_root,
@@ -45,6 +46,11 @@
     TEMPLATES=[{
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
         'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.contrib.auth.context_processors.auth',
+            ]
+        },
     }],
 )
 

setup.py

@@ -30,6 +30,8 @@
         'Programming Language :: Python :: 3.2',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
         "License :: OSI Approved :: BSD License",
     ],
     tests_require=tests_require,

simple_history/locale/pt_BR/LC_MESSAGES/django.mo

@@ -0,0 +1,98 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-01 11:02-0300\n"
+"PO-Revision-Date: 2017-06-01 11:06-0300\n"
+"Language: pt_BR\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"X-Generator: Poedit 1.8.11\n"
+
+#: simple_history/admin.py:73
+#, python-format
+msgid "Change history: %s"
+msgstr "Histórico de modificações: %s"
+
+#: simple_history/admin.py:92
+#, python-format
+msgid "The %(name)s \"%(obj)s\" was changed successfully."
+msgstr "%(name)s \"%(obj)s\" modificados com sucesso."
+
+#: simple_history/admin.py:98
+msgid "You may edit it again below"
+msgstr "Você pode fazer novas modificações abaixo:"
+
+#: simple_history/admin.py:156
+#, python-format
+msgid "Revert %s"
+msgstr "Reverter %s"
+
+#: simple_history/templates/simple_history/object_history.html:10
+msgid ""
+"Choose a date from the list below to revert to a previous version of this "
+"object."
+msgstr ""
+"Escolha a data desejada na lista a seguir para reverter as modificações "
+"feitas nesse objeto."
+
+#: simple_history/templates/simple_history/object_history.html:17
+msgid "Object"
+msgstr "Objeto"
+
+#: simple_history/templates/simple_history/object_history.html:18
+msgid "Date/time"
+msgstr "Data/hora"
+
+#: simple_history/templates/simple_history/object_history.html:19
+msgid "Comment"
+msgstr "Comentário"
+
+#: simple_history/templates/simple_history/object_history.html:20
+msgid "Changed by"
+msgstr "Modificado por"
+
+#: simple_history/templates/simple_history/object_history.html:46
+msgid "This object doesn't have a change history."
+msgstr "Esse objeto não tem um histórico de modificações."
+
+#: simple_history/templates/simple_history/object_history_form.html:7
+msgid "Home"
+msgstr "Início"
+
+#: simple_history/templates/simple_history/object_history_form.html:11
+msgid "History"
+msgstr "Histórico"
+
+#: simple_history/templates/simple_history/object_history_form.html:12
+#, python-format
+msgid "Revert %(verbose_name)s"
+msgstr "Reverter %(verbose_name)s"
+
+#: simple_history/templates/simple_history/object_history_form.html:21
+msgid ""
+"Press the 'Revert' button below to revert to this version of the object."
+msgstr ""
+"Clique em 'Reverter' para reverter as modificações feitas nesse objeto."
+
+#: simple_history/templates/simple_history/object_history_form.html:21
+msgid "Or press the 'Change History' button to edit the history."
+msgstr ""
+"Ou clique em 'Histórico de Modificações' para modificar o histórico."
+
+#: simple_history/templates/simple_history/submit_line.html:3
+msgid "Revert"
+msgstr "Reverter"
+
+#: simple_history/templates/simple_history/submit_line.html:4
+msgid "Change History"
+msgstr "Histórico de Modificações"

simple_history/locale/pt_BR/LC_MESSAGES/django.po

@@ -4,15 +4,17 @@
 import importlib
 import threading
 
-from django.db import models, router
-from django.db.models.fields.proxy import OrderWrt
 from django.conf import settings
 from django.contrib import admin
+from django.db import models, router
+from django.db.models.fields.proxy import OrderWrt
 from django.utils import six
-from django.utils.encoding import python_2_unicode_compatible
-from django.utils.encoding import smart_text
+from django.utils.encoding import python_2_unicode_compatible, smart_text
 from django.utils.timezone import now
-from django.utils.translation import string_concat
+from django.utils.translation import string_concat, ugettext as _
+
+from . import exceptions
+from .manager import HistoryDescriptor
 
 try:
     from django.apps import apps
@@ -26,8 +28,6 @@
     add_introspection_rules(
         [], ["^simple_history.models.CustomForeignKeyField"])
 
-from . import exceptions
-from .manager import HistoryDescriptor
 
 registered_models = {}
 
@@ -213,13 +213,15 @@ def get_instance(self):
         return {
             'history_id': models.AutoField(primary_key=True),
             'history_date': models.DateTimeField(),
+            'history_change_reason': models.CharField(max_length=100,
+                                                      null=True),
             'history_user': models.ForeignKey(
                 user_model, null=True, related_name=self.user_related_name,
                 on_delete=models.SET_NULL),
             'history_type': models.CharField(max_length=1, choices=(
-                ('+', 'Created'),
-                ('~', 'Changed'),
-                ('-', 'Deleted'),
+                ('+', _('Created')),
+                ('~', _('Changed')),
+                ('-', _('Deleted')),
             )),
             'history_object': HistoricalObjectDescriptor(model, self.fields_included(model)),
             'instance': property(get_instance),
@@ -258,12 +260,14 @@ def post_delete(self, instance, **kwargs):
     def create_historical_record(self, instance, history_type):
         history_date = getattr(instance, '_history_date', now())
         history_user = self.get_history_user(instance)
+        history_change_reason = getattr(instance, 'changeReason', None)
         manager = getattr(instance, self.manager_name)
         attrs = {}
         for field in self.fields_included(instance):
             attrs[field.attname] = getattr(instance, field.attname)
         manager.create(history_date=history_date, history_type=history_type,
-                       history_user=history_user, **attrs)
+                       history_user=history_user,
+                       history_change_reason=history_change_reason, **attrs)
 
     def get_history_user(self, instance):
         """Get the modifying user from instance or middleware."""