Change DefaultUserCreateMixin -> DefaultCreatedByMixin

Author: ckcollab

README.md

@@ -69,7 +69,7 @@ class LineItemUpdateSerializer(serializers.ModelSerializer):
 
 
 
-#### `DefaultUserCreateMixin` for `ModelSerializers`
+#### `DefaultCreatedByMixin` for `ModelSerializers`
 
 This will automatically set `YourModel.created_by` to `request.user`. To override which
 attribute the user is written to, add a `user_field` to your classes Meta information
@@ -79,7 +79,7 @@ class YourModel(models.Model):
     created_by = models.ForeignKey(User, on_delete=models.CASCADE)
         
 
-class MySerializer(DefaultUserCreateMixin, ModelSerializer):
+class MySerializer(DefaultCreatedByMixin, ModelSerializer):
     class Meta:
         model = YourModel
 ```

ckc/serializers.py

@@ -1,11 +1,11 @@
-class DefaultUserCreateMixin:
+class DefaultCreatedByMixin:
     """This will automatically set `YourModel.created_by` to `request.user`. To override which
     attribute the user is written to, add a `user_field` to your classes Meta information
     Example:
         class YourModel(models.Model):
             owner = models.ForeignKey(User, on_delete=models.CASCADE)
 
-        class MySerializer(DefaultUserCreateMixin, ModelSerializer):
+        class MySerializer(DefaultCreatedByMixin, ModelSerializer):
             class Meta:
                 model = YourModel
                 # YourModel.owner = a foreign key to request.user which differs from the
@@ -17,7 +17,7 @@ def create(self, validated_data):
         user_field = getattr(self.Meta, 'user_field', 'created_by')
 
         assert hasattr(self.Meta.model, user_field), f"{self.Meta.model} needs to have field {user_field} so " \
-                                                     f"DefaultUserCreateMixin can write to it"
+                                                     f"DefaultCreatedByMixin can write to it"
 
         if user_field not in validated_data:
             if 'request' not in self.context:

testproject/testapp/serializers.py

@@ -1,17 +1,17 @@
 from rest_framework.serializers import ModelSerializer
 
 from ckc.fields import PrimaryKeyWriteSerializerReadField
-from ckc.serializers import DefaultUserCreateMixin
+from ckc.serializers import DefaultCreatedByMixin
 from testapp.models import ModelWithACreator, ModelWithADifferentNamedCreator, AModel, BModel
 
 
-class TestModelWithACreatorSerializer(DefaultUserCreateMixin, ModelSerializer):
+class TestModelWithACreatorSerializer(DefaultCreatedByMixin, ModelSerializer):
     class Meta:
         model = ModelWithACreator
         fields = []
 
 
-class TestModelWithADifferentNamedCreatorSerializer(DefaultUserCreateMixin, ModelSerializer):
+class TestModelWithADifferentNamedCreatorSerializer(DefaultCreatedByMixin, ModelSerializer):
     class Meta:
         model = ModelWithADifferentNamedCreator
         fields = []

tests/integration/test_default_user_create_mixin.py

@@ -7,7 +7,7 @@
 User = get_user_model()
 
 
-class TestDefaultUserCreateMixin(APITestCase):
+class TestDefaultCreatedByMixin(APITestCase):
 
     def setUp(self):
         self.user = User.objects.create_user(username="test", password="test")

tests/integration/test_primary_key_write_serializer_read_field.py

@@ -7,7 +7,7 @@
 User = get_user_model()
 
 
-class TestDefaultUserCreateMixin(APITestCase):
+class TestDefaultCreatedByMixin(APITestCase):
     TEST_TITLE_1 = 'test_title_1'
     TEST_TITLE_2 = 'test_title_2'