Merge pull request #196 from Inikup/table-name

Support for custom tables names

Author: macro1

AUTHORS.rst

@@ -16,6 +16,7 @@ Authors
 - Joao Pedro Francese
 - jofusa
 - John Whitlock
+- Jonathan Leroy
 - Jonathan Sanchez
 - Josh Fyne
 - Klaas van Schelven

CHANGES.rst

@@ -6,6 +6,7 @@ tip (unreleased)
 - Add ability to list history in admin when the object instance is deleted. (gh-72)
 - Add ability to change history through the admin. (Enabled with the `SIMPLE_HISTORY_EDIT` setting.)
 - Add Django 1.9 support.
+- Support for custom tables names. (gh-196)
 
 1.6.3 (2015-07-30)
 ------------------

docs/advanced.rst

@@ -158,3 +158,29 @@ To change the auto-generated HistoricalRecord models base class from
         pub_date = models.DateTimeField('date published')
         changed_by = models.ForeignKey('auth.User')
         history = HistoricalRecords(bases=[RoutableModel])
+
+Custom history table name
+-------------------------
+
+By default, the table name for historical models follow the Django convention
+and just add ``historical`` before model name. For instance, if your application
+name is ``polls`` and your model name ``Question``, then the table name will be
+``polls_historicalquestion``.
+
+You can use the ``table_name`` parameter with both ``HistoricalRecords()`` or
+``register()`` to change this behavior.
+
+.. code-block:: python
+
+    class Question(models.Model):
+        question_text = models.CharField(max_length=200)
+        pub_date = models.DateTimeField('date published')
+        history = HistoricalRecords(table_name='polls_question_history')
+
+.. code-block:: python
+
+    class Question(models.Model):
+        question_text = models.CharField(max_length=200)
+        pub_date = models.DateTimeField('date published')
+
+    register(Question, table_name='polls_question_history')

simple_history/__init__.py

@@ -5,7 +5,7 @@
 
 def register(
         model, app=None, manager_name='history', records_class=None,
-        **records_config):
+        table_name=None, **records_config):
     """
     Create historical model for `model` and attach history manager to `model`.
 
@@ -14,6 +14,8 @@ def register(
     manager_name -- class attribute name to use for historical manager
     records_class -- class to use for history relation (defaults to
         HistoricalRecords)
+    table_name -- Custom name for history table (defaults to
+        'APPNAME_historicalMODELNAME')
 
     This method should be used as an alternative to attaching an
     `HistoricalManager` instance directly to `model`.
@@ -24,6 +26,7 @@ def register(
             records_class = models.HistoricalRecords
         records = records_class(**records_config)
         records.manager_name = manager_name
+        records.table_name = table_name
         records.module = app and ("%s.models" % app) or model.__module__
         records.add_extra_methods(model)
         records.finalize(model)

simple_history/models.py

@@ -41,9 +41,10 @@ class HistoricalRecords(object):
     thread = threading.local()
 
     def __init__(self, verbose_name=None, bases=(models.Model,),
-                 user_related_name='+'):
+                 user_related_name='+', table_name=None):
         self.user_set_verbose_name = verbose_name
         self.user_related_name = user_related_name
+        self.table_name = table_name
         try:
             if isinstance(bases, six.string_types):
                 raise TypeError
@@ -114,6 +115,8 @@ def create_history_model(self, model):
         attrs.update(self.get_extra_fields(model, fields))
         # type in python2 wants str as a first argument
         attrs.update(Meta=type(str('Meta'), (), self.get_meta_options(model)))
+        if self.table_name is not None:
+            attrs['Meta'].db_table = self.table_name
         name = 'Historical%s' % model._meta.object_name
         registered_models[model._meta.db_table] = model
         return python_2_unicode_compatible(

simple_history/tests/models.py

@@ -264,3 +264,16 @@ class Province(models.Model):
 class City(models.Model):
     country = models.ForeignKey(Country, db_column='countryCode')
     history = HistoricalRecords()
+
+
+class Contact(models.Model):
+    name = models.CharField(max_length=30)
+    email = models.EmailField(max_length=255, unique=True)
+    history = HistoricalRecords(table_name='contacts_history')
+
+
+class ContactRegister(models.Model):
+    name = models.CharField(max_length=30)
+    email = models.EmailField(max_length=255, unique=True)
+
+register(ContactRegister, table_name='contacts_register_history')

simple_history/tests/tests/test_models.py

@@ -19,7 +19,7 @@
     ExternalModel1, ExternalModel3, UnicodeVerboseName, HistoricalChoice,
     HistoricalState, HistoricalCustomFKError, Series, SeriesWork, PollInfo,
     UserAccessorDefault, UserAccessorOverride, Employee, Country, Province,
-    City
+    City, Contact, ContactRegister
 )
 from ..external.models import ExternalModel2, ExternalModel4
 
@@ -764,3 +764,22 @@ def test_restore_employee(self):
         self.assertEqual(original.manager_id, 1)
         with self.assertRaises(Employee.DoesNotExist):
             original.manager
+
+
+class CustomTableNameTest1(TestCase):
+
+    @staticmethod
+    def get_table_name(manager):
+        return manager.model._meta.db_table
+
+    def test_custom_table_name(self):
+        self.assertEqual(
+            self.get_table_name(Contact.history),
+            'contacts_history',
+        )
+
+    def test_custom_table_name_from_register(self):
+        self.assertEqual(
+            self.get_table_name(ContactRegister.history),
+            'contacts_register_history',
+        )