chore: Use ast-grep to update code for new version

Author: last-partizan

CHANGELOG.md

@@ -8,6 +8,13 @@ All notable changes to this project will be documented in this file. See [standa
 ### ⚠ BREAKING CHANGES
 
 * Removed `blank` argument support for fields, use mongoengine `required` instead.
+  `ast-grep` can be used to automatically rewrite old code:
+
+  ```
+  ast-grep scan -r sg-rules/0.6.0-rewrite-blank.yml . -i
+  ```
+  It's not 100% safe, as it can introduce `,,` in your code, so be careful to
+  review, clean it up and test.
 
 * Switch to mongoengine style field arguments. Drop old django ([#200](https://github.com/MongoEngine/django-mongoengine/issues/200)) ([9d56f6a](https://github.com/MongoEngine/django-mongoengine/commit/9d56f6a58ccee93e2acae7af0a8d81d9aa43ae5b))
 

django_mongoengine/mongo_auth/models.py

@@ -48,10 +48,13 @@ def get_email_field_name(cls):
 
 
 class ContentType(document.Document):
-    name = fields.StringField(max_length=100)
-    app_label = fields.StringField(max_length=100)
+    name = fields.StringField(max_length=100, required=True)
+    app_label = fields.StringField(max_length=100, required=True)
     model = fields.StringField(
-        max_length=100, verbose_name=_('python model class name'), unique_with='app_label'
+        max_length=100,
+        verbose_name=_('python model class name'),
+        unique_with='app_label',
+        required=True,
     )
     objects = ContentTypeManager()
 
@@ -118,9 +121,9 @@ class Permission(document.Document):
     created for each Django model.
     """
 
-    name = fields.StringField(max_length=50, verbose_name=_('username'))
-    content_type = fields.ReferenceField(ContentType)
-    codename = fields.StringField(max_length=100, verbose_name=_('codename'))
+    name = fields.StringField(max_length=50, verbose_name=_('username'), required=True)
+    content_type = fields.ReferenceField(ContentType, required=True)
+    codename = fields.StringField(max_length=100, verbose_name=_('codename'), required=True)
     # FIXME: don't access field of the other class
     # unique_with=['content_type__app_label', 'content_type__model'])
 
@@ -163,7 +166,9 @@ class Group(document.Document):
     """
 
     name = fields.StringField(max_length=80, unique=True, verbose_name=_('name'))
-    permissions = fields.ListField(fields.ReferenceField(Permission, verbose_name=_('permissions')))
+    permissions = fields.ListField(
+        fields.ReferenceField(Permission, verbose_name=_('permissions'), required=True)
+    )
 
     class Meta:
         verbose_name = _('group')
@@ -223,7 +228,7 @@ class AbstractUser(BaseUser, document.Document):
     date_joined = fields.DateTimeField(default=timezone.now, verbose_name=_('date joined'))
 
     user_permissions = fields.ListField(
-        fields.ReferenceField(Permission),
+        fields.ReferenceField(Permission, required=True),
         verbose_name=_('user permissions'),
         help_text=_('Permissions for the user.'),
     )

django_mongoengine/sessions.py

@@ -26,8 +26,12 @@
 
 class MongoSession(Document):
     session_key = fields.StringField(primary_key=True, max_length=40)
-    session_data = fields.StringField() if MONGOENGINE_SESSION_DATA_ENCODE else fields.DictField()
-    expire_date = fields.DateTimeField()
+    session_data = (
+        fields.StringField(required=True)
+        if MONGOENGINE_SESSION_DATA_ENCODE
+        else fields.DictField(required=True)
+    )
+    expire_date = fields.DateTimeField(required=True)
 
     meta = {
         'collection': MONGOENGINE_SESSION_COLLECTION,

sg-rules/0.6.0-rewrite-blank.yml

@@ -0,0 +1,33 @@
+id: fix-blank
+language: Python
+rule:
+  all:
+    - kind: keyword_argument
+    - regex: blank=True
+    - inside:
+        kind: assignment
+        stopBy: end
+fix: required=False
+
+---
+
+id: add-required-by-default
+language: Python
+rule:
+  all:
+    - pattern: fields.$C($$$A)
+    - regex: '[A-Z]\w+'
+    - not:
+        any:
+          - regex: required=
+          - regex: blank=
+          - regex: primary_key=
+          - regex: default=
+          - regex: null=True
+transform:
+  MAYBE_COMMA:
+    replace:
+      source: $$$A
+      replace: '^.+'
+      by: ', '
+fix: fields.$C($$$A$MAYBE_COMMArequired=True)