Merge pull request #30 from texastribune/uuid-pks-n-stuffing

Uuid pks n stuffing

Author: crccheck

MANIFEST.in

@@ -1,4 +1,3 @@
 include setup.py README.* MANIFEST.in LICENSE
-recursive-include django_object_actions *
-recursive-include example_project *
+recursive-include django_object_actions/templates *
 global-exclude *.pyc

Makefile

@@ -1,15 +1,21 @@
+VERSION=0.5.0
 PROJECT=./example_project
 MANAGE=$(PROJECT)/manage.py
 
 help:
 	@echo "make commands:"
-	@echo "  make help     - this help"
-	@echo "  make clean    - remove files generated by distutils"
-	@echo "  make test     - run test suite"
-	@echo "  make coverage - run coverage"
-	@echo "  make resetdb  - delete and recreate the sqlite database"
+	@echo "  make help       - this help"
 	@echo "  make quickstart - setup a dev environment the first time"
+	@echo "  make clean      - remove generated files"
+	@echo "  make test       - run test suite"
+	@echo "  make coverage   - get coverage report"
+	@echo "  make resetdb    - delete and recreate the sqlite database"
+	@echo "  make release    - publish a release to PyPI"
 
+# just a demo of how to get up and running quickly
+quickstart: resetdb
+	python $(MANAGE) createsuperuser
+	python $(MANAGE) runserver
 
 clean:
 	rm -rf .coverage
@@ -19,7 +25,6 @@ clean:
 	rm -rf dist
 	rm -rf *.egg-info
 
-
 test:
 	python -W ignore::RuntimeWarning $(MANAGE) test django_object_actions
 
@@ -35,7 +40,17 @@ resetdb:
 	python $(MANAGE) migrate --noinput
 	python $(MANAGE) loaddata sample_data
 
-# just a demo of how to get up and running quickly
-quickstart: resetdb
-	python $(MANAGE) createsuperuser
-	python $(MANAGE) runserver
+# Release Instructions:
+#
+# 1. bump version number above
+# 2. `make release`
+# 3. git push origin master --tags
+#
+# If this doesn't work, make sure you have wheels installed:
+#     pip install wheel
+release:
+	@sed -i -r /version/s/[0-9.]+/$(VERSION)/ setup.py
+	@sed -i -r /version/s/[0-9.]+/$(VERSION)/ django_object_actions/__init__.py
+	@git commit -am "bump version to v$(VERSION)"
+	@git tag v$(VERSION)
+	python setup.py sdist bdist_wheel upload

django_object_actions/__init__.py

@@ -1,4 +1,4 @@
-""" A Django app for adding object tools to models """
+"""A Django app for adding object tools for models in the admin."""
 __version__ = '0.5.0'
 
 

django_object_actions/tests/test_admin.py

@@ -0,0 +1,17 @@
+"""
+Integration tests that actually try and use the tools setup in admin.py
+"""
+from __future__ import unicode_literals
+
+from .tests import LoggedInTestCase
+from example_project.polls.factories import CommentFactory
+
+
+class CommentTest(LoggedInTestCase):
+    def test_action_on_a_model_with_uuid_pk_works(self):
+        comment = CommentFactory()
+        url = '/admin/polls/comment/{0}/tools/hodor/'.format(comment.pk)
+        # sanity check that url has a uuid
+        self.assertIn('-', url)
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 302)

django_object_actions/tests/tests.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 
+from example_project.polls.factories import UserFactory
 from example_project.polls.models import Choice
-from ..factories import UserFactory
 
 
 class LoggedInTestCase(TestCase):
@@ -12,6 +12,8 @@ def setUp(self):
         self.assertTrue(self.client.login(username='admin', password='admin'))
 
 
+# TODO move most of these to test_admin.py after I sit down and re-read these
+# and don't need the fixtures
 class AppTests(LoggedInTestCase):
     fixtures = ['sample_data']
 

django_object_actions/utils.py

@@ -1,6 +1,8 @@
+from __future__ import unicode_literals
+
 from functools import wraps
 
-from django.conf.urls import patterns
+from django.conf.urls import patterns, url
 from django.contrib import messages
 from django.db.models.query import QuerySet
 from django.http import Http404, HttpResponse, HttpResponseRedirect
@@ -19,8 +21,10 @@ def get_tool_urls(self):
         for tool in self.objectactions:
             tools[tool] = getattr(self, tool)
         my_urls = patterns('',
-            (r'^(?P<pk>\d+)/tools/(?P<tool>\w+)/$', self.admin_site.admin_view(
-                ModelToolsView.as_view(model=self.model, tools=tools)))
+            # supports pks that are numbers or uuids
+            url(r'^(?P<pk>[0-9a-f\-]+)/tools/(?P<tool>\w+)/$',
+                self.admin_site.admin_view(
+                    ModelToolsView.as_view(model=self.model, tools=tools)))
         )
         return my_urls
 

example_project/polls/admin.py

@@ -1,3 +1,5 @@
+from __future__ import unicode_literals
+
 from django.contrib import admin
 from django.core.urlresolvers import reverse
 from django.db.models import F
@@ -6,7 +8,7 @@
 from django_object_actions import (DjangoObjectActions,
         takes_instance_or_queryset)
 
-from .models import Choice, Poll
+from .models import Choice, Poll, Comment
 
 
 class ChoiceAdmin(DjangoObjectActions, admin.ModelAdmin):
@@ -51,7 +53,7 @@ class ChoiceInline(admin.StackedInline):
 
 class PollAdmin(DjangoObjectActions, admin.ModelAdmin):
     fieldsets = [
-        (None,               {'fields': ['question']}),
+        (None, {'fields': ['question']}),
         ('Date information', {'fields': ['pub_date'], 'classes': ['collapse']}),
     ]
     inlines = [ChoiceInline]
@@ -74,6 +76,15 @@ def delete_all_choices(self, request, obj):
     delete_all_choices.label = "Delete All Choices"
 
     objectactions = ('delete_all_choices', )
+admin.site.register(Poll, PollAdmin)
 
 
-admin.site.register(Poll, PollAdmin)
+class CommentAdmin(DjangoObjectActions, admin.ModelAdmin):
+    def hodor(self, request, obj):
+        if not obj.comment:
+            # bail because we need a comment
+            return
+        obj.comment = ' '.join(['hodor' for x in obj.comment.split()])
+        obj.save()
+    objectactions = ('hodor', )
+admin.site.register(Comment, CommentAdmin)

django_object_actions/factories.py renamed to example_project/polls/factories.py

@@ -7,6 +7,8 @@
 
 import factory
 
+from . import models
+
 
 class UserFactory(factory.DjangoModelFactory):
     FACTORY_FOR = get_user_model()
@@ -17,3 +19,7 @@ class UserFactory(factory.DjangoModelFactory):
     email = factory.LazyAttribute(lambda x: '{0}@{1}.com'.format(
         x.first_name.lower(), x.last_name.lower()))
     password = factory.PostGenerationMethodCall('set_password', 'password')
+
+
+class CommentFactory(factory.DjangoModelFactory):
+    FACTORY_FOR = models.Comment

example_project/polls/models.py

@@ -2,6 +2,7 @@
 
 from django.db import models
 from django.utils import timezone
+from django_extensions.db.fields import UUIDField
 
 
 class Poll(models.Model):
@@ -25,3 +26,11 @@ class Choice(models.Model):
 
     def __unicode__(self):
         return self.choice_text
+
+
+class Comment(models.Model):
+    uuid = UUIDField(primary_key=True)
+    comment = models.TextField(null=True, blank=True)
+
+    def __unicode__(self):
+        return self.comment or ''

requirements.txt

@@ -1,10 +1,9 @@
-Django==1.7
-
+Django==1.7.1
 dj-database-url==0.3.0
-# for heroku support
-psycopg2==2.5.4
-
-django-extensions==1.3.11
-tox==1.7.2
+django-extensions==1.4.6
+tox==1.8.1
 factory-boy==2.4.1
 coverage==3.7.1
+
+# for heroku support
+psycopg2==2.5.4