feat: added modal to save most used snippets and pre-fill the code editor

.gitignore

@@ -21,3 +21,4 @@ eggs/
 .cache
 .env
 pip-log.txt
+demo/db.sqlite3

django_admin_shell/admin.py

@@ -0,0 +1,14 @@
+"""Admin for django_admin_shell."""
+
+from django.contrib import admin
+
+from .models import SavedSnippets
+
+
+class SavedSnippetsAdmin(admin.ModelAdmin):
+    """Admin for SavedSnippets."""
+
+    list_display = ('name', 'code')
+    search_fields = ('name', 'code')
+
+admin.site.register(SavedSnippets, SavedSnippetsAdmin)

django_admin_shell/migrations/0001_initial.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.2.25 on 2024-04-26 12:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SavedSnippets',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=32)),
+                ('code', models.TextField()),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+            ],
+            options={
+                'verbose_name': 'Saved Snippet',
+                'verbose_name_plural': 'Saved Snippets',
+            },
+        ),
+    ]

django_admin_shell/models.py

@@ -0,0 +1,23 @@
+"""Models for django_admin_shell."""
+
+from django.db import models
+
+
+class SavedSnippets(models.Model):
+    """Models to contain saved snipets."""
+
+    name = models.CharField(max_length=32)
+    code = models.TextField()
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    objects = models.Manager()
+
+    class Meta:
+        """Meta class for SavedSnippets."""
+
+        verbose_name = "Saved Snippet"
+        verbose_name_plural = "Saved Snippets"
+
+    def __str__(self):
+        """Return name of saved snippet."""
+        return self.name

django_admin_shell/static/django_admin_shell/css/shell.css

@@ -21,6 +21,11 @@ a.btn {
     color: #fff;
 }
 
+#code_container:hover {
+    cursor: pointer;
+    filter: brightness(95%);
+}
+
 #output_container {
     width : 100%;
     height: 200px;

django_admin_shell/static/django_admin_shell/js/shell.js

@@ -59,6 +59,10 @@ $(document).ready(function(){
 
     set_height();
 
+    $('#saved_snippet').on('change', function(e){
+        $shell.val(e.target.value);
+    });
+
     // ----------
     // Keys:
     // Ctrl + Enter = execute code

django_admin_shell/templates/django_admin_shell/shell.html

@@ -24,6 +24,14 @@ <h5> Django version : {{django_version}} </h5>
         </div>
     </div>
 
+    <script>
+        function save_snippet(code) {
+            var encoded = encodeURIComponent(code);
+            var url = document.location.origin + "/admin/admin_shell/savedsnippets/add/?code=" + encoded;
+            window.open(url, '_blank');
+        }
+    </script>
+
     <div id="output_container">
 
         {% if auto_import %}
@@ -34,7 +42,11 @@ <h5> Django version : {{django_version}} </h5>
 
         {% for result in output reversed %}
             <div class="output">
-                <div class="code"><pre>{{ result.code }}</pre></div>
+                <div
+                    class="code"
+                    id="code_container"
+                    ondblclick="save_snippet('{{ result.code|escapejs }}')"
+                ><pre>{{ result.code }}</pre></div>
                 <div class="out"><pre class="{{ result.status }}">{{ result.out }}</pre></div>
             </div>
         {% endfor %}
@@ -45,6 +57,20 @@ <h5> Django version : {{django_version}} </h5>
 
             <form id="shell_form" class="form form-horizontal" method="post" action=".">
                 {% csrf_token %}
+
+                {% if saved_snippets %}
+                    <div class="form-group" style="margin-top: 10px;margin-bottom: 0px;">
+                        <div class="col-xs-12">
+                            <select class="form-control" name="snippet" id="saved_snippet">
+                                <option value="">Select saved snippet...</option>
+                                {% for snippet in saved_snippets %}
+                                    <option value="{{ snippet.code }}">{{ snippet.name }}</option>
+                                {% endfor %}
+                            </select>
+                        </div>
+                    </div>
+                {% endif %}
+
                 {% if form.non_field_errors %}
                     <div class="alert alert-danger">
                         {{ form.non_field_errors }}
@@ -57,7 +83,7 @@ <h5> Django version : {{django_version}} </h5>
                         {{ form.code.errors }}
                     {% endif %}
                 </div>
-
+                
                 <button id="run_code" type="submit" class="btn btn-success btn-block">
                     <span class="glyphicon glyphicon-play-circle"></span>
                     Run code (ctrl + enter)
@@ -76,7 +102,8 @@ <h5> Django version : {{django_version}} </h5>
         <div class="col-xs-6 text-info">
             <span class="glyphicon glyphicon-info-sign"></span> Ctrl + Enter : Run code<br/>
             <span class="glyphicon glyphicon-info-sign"></span> Ctrl + Up/Down : Load code from history<br/>
-            <span class="glyphicon glyphicon-info-sign"></span> Tab : Indent = 4 spaces
+            <span class="glyphicon glyphicon-info-sign"></span> Tab : Indent = 4 spaces<br/>
+            <span class="glyphicon glyphicon-info-sign"></span> Double click : Save code snippet
         </div>
     </div>
 

django_admin_shell/views.py

@@ -8,6 +8,8 @@
 )
 from django.conf import settings
 
+from django_admin_shell.models import SavedSnippets
+
 try:
     # Only for python 2
     from StringIO import StringIO
@@ -250,4 +252,5 @@ def get_context_data(self, **kwargs):
         ctx['python_version'] = get_py_version()
         ctx['django_version'] = get_dj_version()
         ctx['auto_import'] = str(self.runner.importer)
+        ctx['saved_snippets'] = SavedSnippets.objects.all()
         return ctx