Merge pull request #5 from Wackerbarth/Transition

Transition

Author: lovelydinosaur

.gitignore

@@ -1,7 +1,11 @@
-*.pyc
+# Database content will be handled by fixtures
 *.db
+
+# These are normally defined globally
+*.pyc
 *~
 .*
 
+# Accept these files in the repository
 !.gitignore
 !.travis.yml

snippets/fixtures/initial_data.json

@@ -1,73 +1,73 @@
 [
     {
-        "pk": 2, 
-        "model": "auth.user", 
+        "pk": 2,
+        "model": "auth.user",
         "fields": {
-            "username": "aziz", 
-            "first_name": "", 
-            "last_name": "", 
-            "is_active": true, 
-            "is_superuser": false, 
-            "is_staff": false, 
-            "last_login": "2012-10-28T21:36:57.799Z", 
-            "groups": [], 
-            "user_permissions": [], 
-            "password": "pbkdf2_sha256$10000$2x3LOiFCb9sq$3jiN4zgb3wYHQ9fpn/elUrcn1S1Bq/q0djZFBjb8Y2w=", 
-            "email": "", 
+            "username": "aziz",
+            "first_name": "",
+            "last_name": "",
+            "is_active": true,
+            "is_superuser": false,
+            "is_staff": false,
+            "last_login": "2012-10-28T21:36:57.799Z",
+            "groups": [],
+            "user_permissions": [],
+            "password": "pbkdf2_sha256$10000$2x3LOiFCb9sq$3jiN4zgb3wYHQ9fpn/elUrcn1S1Bq/q0djZFBjb8Y2w=",
+            "email": "",
             "date_joined": "2012-10-28T21:36:57.799Z"
         }
-    }, 
+    },
     {
-        "pk": 3, 
-        "model": "auth.user", 
+        "pk": 3,
+        "model": "auth.user",
         "fields": {
-            "username": "amy", 
-            "first_name": "", 
-            "last_name": "", 
-            "is_active": true, 
-            "is_superuser": false, 
-            "is_staff": false, 
-            "last_login": "2012-10-28T21:42:34.081Z", 
-            "groups": [], 
-            "user_permissions": [], 
-            "password": "pbkdf2_sha256$10000$wjy2WvTgw1Ro$oR8pVFHIBqZUmD9XEHdRl5m4TxWOF+qnvZn/q+npTlc=", 
-            "email": "", 
+            "username": "amy",
+            "first_name": "",
+            "last_name": "",
+            "is_active": true,
+            "is_superuser": false,
+            "is_staff": false,
+            "last_login": "2012-10-28T21:42:34.081Z",
+            "groups": [],
+            "user_permissions": [],
+            "password": "pbkdf2_sha256$10000$wjy2WvTgw1Ro$oR8pVFHIBqZUmD9XEHdRl5m4TxWOF+qnvZn/q+npTlc=",
+            "email": "",
             "date_joined": "2012-10-28T21:42:34.081Z"
         }
-    }, 
+    },
     {
-        "pk": 4, 
-        "model": "auth.user", 
+        "pk": 4,
+        "model": "auth.user",
         "fields": {
-            "username": "max", 
-            "first_name": "", 
-            "last_name": "", 
-            "is_active": true, 
-            "is_superuser": false, 
-            "is_staff": false, 
-            "last_login": "2012-10-28T21:42:45.711Z", 
-            "groups": [], 
-            "user_permissions": [], 
-            "password": "pbkdf2_sha256$10000$NhDNt8GNYfjC$0FlcsJxt8Sac0dvGv+xcaUVSUfh1UYZfWEq3C1WoHjc=", 
-            "email": "", 
+            "username": "max",
+            "first_name": "",
+            "last_name": "",
+            "is_active": true,
+            "is_superuser": false,
+            "is_staff": false,
+            "last_login": "2012-10-28T21:42:45.711Z",
+            "groups": [],
+            "user_permissions": [],
+            "password": "pbkdf2_sha256$10000$NhDNt8GNYfjC$0FlcsJxt8Sac0dvGv+xcaUVSUfh1UYZfWEq3C1WoHjc=",
+            "email": "",
             "date_joined": "2012-10-28T21:42:45.711Z"
         }
-    }, 
+    },
     {
-        "pk": 5, 
-        "model": "auth.user", 
+        "pk": 5,
+        "model": "auth.user",
         "fields": {
-            "username": "jose", 
-            "first_name": "", 
-            "last_name": "", 
-            "is_active": true, 
-            "is_superuser": false, 
-            "is_staff": false, 
-            "last_login": "2012-10-28T21:43:03.591Z", 
-            "groups": [], 
-            "user_permissions": [], 
-            "password": "pbkdf2_sha256$10000$ibnHXtPQKwBN$Kab9tTROT6bpxnAI1imgb0kdlAmBuAQ5Z0fAzHbkL68=", 
-            "email": "", 
+            "username": "jose",
+            "first_name": "",
+            "last_name": "",
+            "is_active": true,
+            "is_superuser": false,
+            "is_staff": false,
+            "last_login": "2012-10-28T21:43:03.591Z",
+            "groups": [],
+            "user_permissions": [],
+            "password": "pbkdf2_sha256$10000$ibnHXtPQKwBN$Kab9tTROT6bpxnAI1imgb0kdlAmBuAQ5Z0fAzHbkL68=",
+            "email": "",
             "date_joined": "2012-10-28T21:43:03.591Z"
         }
     }

snippets/models.py

@@ -1,14 +1,14 @@
 from django.db import models
-from pygments.lexers import get_all_lexers, get_lexer_by_name
+from pygments.lexers import get_all_lexers
 from pygments.styles import get_all_styles
+from pygments.lexers import get_lexer_by_name
 from pygments.formatters import HtmlFormatter
 from pygments import highlight
 
 LEXERS = [item for item in get_all_lexers() if item[1]]
 LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
 STYLE_CHOICES = sorted((item, item) for item in get_all_styles())
 
-
 class Snippet(models.Model):
     created = models.DateTimeField(auto_now_add=True)
     title = models.CharField(max_length=100, default='')
@@ -27,6 +27,10 @@ class Meta:
         ordering = ('created',)
 
     def save(self, *args, **kwargs):
+        """
+        Use the `pygments` library to create a highlighted HTML
+        representation of the code snippet.
+        """
         lexer = get_lexer_by_name(self.language)
         linenos = self.linenos and 'table' or False
         options = self.title and {'title': self.title} or {}
@@ -35,7 +39,7 @@ def save(self, *args, **kwargs):
         self.highlighted = highlight(self.code, lexer, formatter)
         super(Snippet, self).save(*args, **kwargs)
 
-        # maximize the amount of instances to be created
+        # limit the number of instances retained
         snippets = Snippet.objects.all()
         if len(snippets) > 100:
             snippets[0].delete()

snippets/permissions.py

@@ -1,12 +1,18 @@
 from rest_framework import permissions
 
-
 class IsOwnerOrReadOnly(permissions.BasePermission):
+    """
+    Custom permission to only allow owners of an object to edit it.
+    """
+
     def has_permission(self, request, view, obj=None):
+        # Skip the check unless this is an object-level test
         if obj is None:
             return True
 
+        # Read permissions are allowed to any request
         if request.method in permissions.SAFE_METHODS:
             return True
 
+        # Write permissions are only allowed to the owner of the snippet
         return obj.owner == request.user

snippets/serializers.py

@@ -1,7 +1,6 @@
+from rest_framework import serializers
 from snippets.models import Snippet
 from django.contrib.auth.models import User
-from rest_framework import serializers
-
 
 class SnippetSerializer(serializers.HyperlinkedModelSerializer):
     owner = serializers.Field(source='owner.username')

snippets/views.py

@@ -1,13 +1,14 @@
-from rest_framework import generics, permissions, renderers
+from django.contrib.auth.models import User
+from rest_framework import generics
+from rest_framework import permissions
+from rest_framework import renderers
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
 from rest_framework.reverse import reverse
-from django.contrib.auth.models import User
 from snippets.models import Snippet
 from snippets.permissions import IsOwnerOrReadOnly
 from snippets.serializers import SnippetSerializer, UserSerializer
 
-
 @api_view(('GET',))
 def api_root(request, format=None):
     """
@@ -48,7 +49,7 @@ def pre_save(self, obj):
         obj.owner = self.request.user
 
 
-class SnippetInstance(generics.RetrieveUpdateDestroyAPIView):
+class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
     """
     This view presents an instance of a code snippet.
 
@@ -62,7 +63,8 @@ class SnippetInstance(generics.RetrieveUpdateDestroyAPIView):
     """
     model = Snippet
     serializer_class = SnippetSerializer
-    permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly,)
+    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
+                          IsOwnerOrReadOnly,)
 
     def pre_save(self, obj):
         obj.owner = self.request.user

tutorial/settings.py

@@ -11,8 +11,8 @@
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.sqlite3',  # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
-        'NAME': 'tmp.db',                      # Or path to database file if using sqlite3.
+        'ENGINE': 'django.db.backends.sqlite3', # Or use an alternate database backend.
+        'NAME': 'tmp.db',                       # Path to sqlite3 database file.
         'USER': '',                      # Not used with sqlite3.
         'PASSWORD': '',                  # Not used with sqlite3.
         'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
@@ -115,8 +115,12 @@
     'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    'snippets',
+    # Uncomment the next line to enable the admin:
+    # 'django.contrib.admin',
+    # Uncomment the next line to enable admin documentation:
+    # 'django.contrib.admindocs',
     'rest_framework',
+    'snippets',
 )
 
 # A sample logging configuration. The only tangible logging

tutorial/urls.py

@@ -5,7 +5,7 @@
 urlpatterns = format_suffix_patterns(patterns('snippets.views',
     url(r'^$', 'api_root'),
     url(r'^snippets/$', views.SnippetList.as_view(), name='snippet-list'),
-    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetInstance.as_view(), name='snippet-detail'),
+    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view(), name='snippet-detail'),
     url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', views.SnippetHighlight.as_view(), name='snippet-highlight'),
     url(r'^users/$', views.UserList.as_view(), name='user-list'),
     url(r'^users/(?P<pk>[0-9]+)/$', views.UserInstance.as_view(), name='user-detail')