Follow.__str__() - Code Metrics - Inspection of "[WIP] swappable Abstract base models" - justquick/django-activity-stream - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#387)

unknown

created 2018-04-16 05:25 UTC

Follow.str() A

↳ Parent: AbstractFollow

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	2
rs	10
cc	1

from __future__ import unicode_literals

from django.apps import apps
from django.conf import settings
from django.contrib.contenttypes.fields import ContentType, GenericForeignKey
from django.db import models
from django.utils.encoding import python_2_unicode_compatible
from django.utils.functional import SimpleLazyObject
from django.utils.timesince import timesince as djtimesince
from django.utils.translation import ugettext as _


try:
    from django.urls import reverse
except ImportError:
    from django.core.urlresolvers import reverse

try:
    from django.utils import timezone
    now = timezone.now
except ImportError:
    from datetime import datetime
    now = datetime.now


from actstream import settings as actstream_settings
from actstream.managers import FollowManager

now = timezone.now


@python_2_unicode_compatible
class AbstractFollow(models.Model):
    """
    Lets a user follow the activities of any specific actor
    """
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL, on_delete=models.CASCADE, db_index=True
    )

    content_type = models.ForeignKey(
        ContentType, on_delete=models.CASCADE, db_index=True
    )
    object_id = models.CharField(max_length=255, db_index=True)
    follow_object = GenericForeignKey()
    actor_only = models.BooleanField(
        "Only follow actions where "
        "the object is the target.",
        default=True
    )
    flag = models.CharField(max_length=255, blank=True, db_index=True, default='')
    started = models.DateTimeField(default=now, db_index=True)
    objects = FollowManager()

    class Meta:
        abstract = True
        unique_together = ('user', 'content_type', 'object_id', 'flag')

    def __str__(self):
        return '%s -> %s : %s' % (self.user, self.follow_object, self.flag)


@python_2_unicode_compatible
class AbstractAction(models.Model):
    """
    Action model describing the actor acting out a verb (on an optional
    target).
    Nomenclature based on http://activitystrea.ms/specs/atom/1.0/

    Generalized Format::

        <actor> <verb> <time>
        <actor> <verb> <target> <time>
        <actor> <verb> <action_object> <target> <time>

    Examples::

        <justquick> <reached level 60> <1 minute ago>
        <brosner> <commented on> <pinax/pinax> <2 hours ago>
        <washingtontimes> <started follow> <justquick> <8 minutes ago>
        <mitsuhiko> <closed> <issue 70> on <mitsuhiko/flask> <about 2 hours ago>

    Unicode Representation::

        justquick reached level 60 1 minute ago
        mitsuhiko closed issue 70 on mitsuhiko/flask 3 hours ago

    HTML Representation::

        <a href="http://oebfare.com/">brosner</a> commented on <a href="http://github.com/pinax/pinax">pinax/pinax</a> 2 hours ago

    """
    actor_content_type = models.ForeignKey(
        ContentType, related_name='actor',
        on_delete=models.CASCADE, db_index=True
    )
    actor_object_id = models.CharField(max_length=255, db_index=True)
    actor = GenericForeignKey('actor_content_type', 'actor_object_id')

    verb = models.CharField(max_length=255, db_index=True)
    description = models.TextField(blank=True, null=True)

    target_content_type = models.ForeignKey(
        ContentType, blank=True, null=True,
        related_name='target',
        on_delete=models.CASCADE, db_index=True
    )
    target_object_id = models.CharField(
        max_length=255, blank=True, null=True, db_index=True
    )
    target = GenericForeignKey(
        'target_content_type',
        'target_object_id'
    )

    action_object_content_type = models.ForeignKey(
        ContentType, blank=True, null=True,
        related_name='action_object',
        on_delete=models.CASCADE, db_index=True
    )
    action_object_object_id = models.CharField(
        max_length=255, blank=True, null=True, db_index=True
    )
    action_object = GenericForeignKey(
        'action_object_content_type',
        'action_object_object_id'
    )

    timestamp = models.DateTimeField(default=now, db_index=True)

    public = models.BooleanField(default=True, db_index=True)

    objects = actstream_settings.get_action_manager()

    class Meta:
        abstract = True
        ordering = ('-timestamp',)

    def __str__(self):
        ctx = {
            'actor': self.actor,
            'verb': self.verb,
            'action_object': self.action_object,
            'target': self.target,
            'timesince': self.timesince()
        }
        if self.target:
            if self.action_object:
                return _('%(actor)s %(verb)s %(action_object)s on %(target)s %(timesince)s ago') % ctx
            return _('%(actor)s %(verb)s %(target)s %(timesince)s ago') % ctx
        if self.action_object:
            return _('%(actor)s %(verb)s %(action_object)s %(timesince)s ago') % ctx
        return _('%(actor)s %(verb)s %(timesince)s ago') % ctx

    def actor_url(self):
        """
        Returns the URL to the ``actstream_actor`` view for the current actor.
        """
        return reverse('actstream_actor', None,
                       (self.actor_content_type.pk, self.actor_object_id))

    def target_url(self):
        """
        Returns the URL to the ``actstream_actor`` view for the current target.
        """
        return reverse('actstream_actor', None,
                       (self.target_content_type.pk, self.target_object_id))

    def action_object_url(self):
        """
        Returns the URL to the ``actstream_action_object`` view for the current action object
        """
        return reverse('actstream_actor', None, (
            self.action_object_content_type.pk, self.action_object_object_id))

    def timesince(self, now=None):
        """
        Shortcut for the ``django.utils.timesince.timesince`` function of the
        current timestamp.
        """
        return djtimesince(self.timestamp, now).encode('utf8').replace(b'\xc2\xa0', b' ').decode('utf8')

    def get_absolute_url(self):
        return reverse(
            'actstream.views.detail', [self.pk])


class Action(AbstractAction):
    class Meta(AbstractAction.Meta):
        swappable = 'ACTSTREAM_ACTION_MODEL'


class Follow(AbstractFollow):
    class Meta(AbstractFollow.Meta):
        swappable = 'ACTSTREAM_FOLLOW_MODEL'


# convenient accessors
actor_stream = Action.objects.actor
action_object_stream = Action.objects.action_object
target_stream = Action.objects.target
user_stream = Action.objects.user
model_stream = Action.objects.model_actions
any_stream = Action.objects.any
followers = Follow.objects.followers
following = Follow.objects.following


1			from __future__ import unicode_literals
2
3			from django.apps import apps
4			from django.conf import settings
5			from django.contrib.contenttypes.fields import ContentType, GenericForeignKey
6			from django.db import models
7			from django.utils.encoding import python_2_unicode_compatible
8			from django.utils.functional import SimpleLazyObject
9			from django.utils.timesince import timesince as djtimesince
10			from django.utils.translation import ugettext as _
11
12
13			try:
14			from django.urls import reverse
15			except ImportError:
16			from django.core.urlresolvers import reverse
17
18			try:
19			from django.utils import timezone
20			now = timezone.now
21			except ImportError:
22			from datetime import datetime
23			now = datetime.now
24
25
26			from actstream import settings as actstream_settings
27			from actstream.managers import FollowManager
28
29			now = timezone.now
30
31
32			@python_2_unicode_compatible
33			class AbstractFollow(models.Model):
34			"""
35			Lets a user follow the activities of any specific actor
36			"""
37			user = models.ForeignKey(
38			settings.AUTH_USER_MODEL, on_delete=models.CASCADE, db_index=True
39			)
40
41			content_type = models.ForeignKey(
42			ContentType, on_delete=models.CASCADE, db_index=True
43			)
44			object_id = models.CharField(max_length=255, db_index=True)
45			follow_object = GenericForeignKey()
46			actor_only = models.BooleanField(
47			"Only follow actions where "
48			"the object is the target.",
49			default=True
50			)
51			flag = models.CharField(max_length=255, blank=True, db_index=True, default='')
52			started = models.DateTimeField(default=now, db_index=True)
53			objects = FollowManager()
54
55			class Meta:
56			abstract = True
57			unique_together = ('user', 'content_type', 'object_id', 'flag')
58
59			def __str__(self):
60			return '%s -> %s : %s' % (self.user, self.follow_object, self.flag)
61
62
63			@python_2_unicode_compatible
64			class AbstractAction(models.Model):
65			"""
66			Action model describing the actor acting out a verb (on an optional
67			target).
68			Nomenclature based on http://activitystrea.ms/specs/atom/1.0/
69
70			Generalized Format::
71
72			<actor> <verb> <time>
73			<actor> <verb> <target> <time>
74			<actor> <verb> <action_object> <target> <time>
75
76			Examples::
77
78			<justquick> <reached level 60> <1 minute ago>
79			<brosner> <commented on> <pinax/pinax> <2 hours ago>
80			<washingtontimes> <started follow> <justquick> <8 minutes ago>
81			<mitsuhiko> <closed> <issue 70> on <mitsuhiko/flask> <about 2 hours ago>
82
83			Unicode Representation::
84
85			justquick reached level 60 1 minute ago
86			mitsuhiko closed issue 70 on mitsuhiko/flask 3 hours ago
87
88			HTML Representation::
89
90			<a href="http://oebfare.com/">brosner</a> commented on <a href="http://github.com/pinax/pinax">pinax/pinax</a> 2 hours ago
91
92			"""
93			actor_content_type = models.ForeignKey(
94			ContentType, related_name='actor',
95			on_delete=models.CASCADE, db_index=True
96			)
97			actor_object_id = models.CharField(max_length=255, db_index=True)
98			actor = GenericForeignKey('actor_content_type', 'actor_object_id')
99
100			verb = models.CharField(max_length=255, db_index=True)
101			description = models.TextField(blank=True, null=True)
102
103			target_content_type = models.ForeignKey(
104			ContentType, blank=True, null=True,
105			related_name='target',
106			on_delete=models.CASCADE, db_index=True
107			)
108			target_object_id = models.CharField(
109			max_length=255, blank=True, null=True, db_index=True
110			)
111			target = GenericForeignKey(
112			'target_content_type',
113			'target_object_id'
114			)
115
116			action_object_content_type = models.ForeignKey(
117			ContentType, blank=True, null=True,
118			related_name='action_object',
119			on_delete=models.CASCADE, db_index=True
120			)
121			action_object_object_id = models.CharField(
122			max_length=255, blank=True, null=True, db_index=True
123			)
124			action_object = GenericForeignKey(
125			'action_object_content_type',
126			'action_object_object_id'
127			)
128
129			timestamp = models.DateTimeField(default=now, db_index=True)
130
131			public = models.BooleanField(default=True, db_index=True)
132
133			objects = actstream_settings.get_action_manager()
134
135			class Meta:
136			abstract = True
137			ordering = ('-timestamp',)
138
139			def __str__(self):
140			ctx = {
141			'actor': self.actor,
142			'verb': self.verb,
143			'action_object': self.action_object,
144			'target': self.target,
145			'timesince': self.timesince()
146			}
147			if self.target:
148			if self.action_object:
149			return _('%(actor)s %(verb)s %(action_object)s on %(target)s %(timesince)s ago') % ctx
150			return _('%(actor)s %(verb)s %(target)s %(timesince)s ago') % ctx
151			if self.action_object:
152			return _('%(actor)s %(verb)s %(action_object)s %(timesince)s ago') % ctx
153			return _('%(actor)s %(verb)s %(timesince)s ago') % ctx
154
155			def actor_url(self):
156			"""
157			Returns the URL to the ``actstream_actor`` view for the current actor.
158			"""
159			return reverse('actstream_actor', None,
160			(self.actor_content_type.pk, self.actor_object_id))
161
162			def target_url(self):
163			"""
164			Returns the URL to the ``actstream_actor`` view for the current target.
165			"""
166			return reverse('actstream_actor', None,
167			(self.target_content_type.pk, self.target_object_id))
168
169			def action_object_url(self):
170			"""
171			Returns the URL to the ``actstream_action_object`` view for the current action object
172			"""
173			return reverse('actstream_actor', None, (
174			self.action_object_content_type.pk, self.action_object_object_id))
175
176			def timesince(self, now=None):
177			"""
178			Shortcut for the ``django.utils.timesince.timesince`` function of the
179			current timestamp.
180			"""
181			return djtimesince(self.timestamp, now).encode('utf8').replace(b'\xc2\xa0', b' ').decode('utf8')
182
183			def get_absolute_url(self):
184			return reverse(
185			'actstream.views.detail', [self.pk])
186
187
188			class Action(AbstractAction):
189			class Meta(AbstractAction.Meta):
190			swappable = 'ACTSTREAM_ACTION_MODEL'
191
192
193			class Follow(AbstractFollow):
194			class Meta(AbstractFollow.Meta):
195			swappable = 'ACTSTREAM_FOLLOW_MODEL'
196
197
198			# convenient accessors
199			actor_stream = Action.objects.actor
200			action_object_stream = Action.objects.action_object
201			target_stream = Action.objects.target
202			user_stream = Action.objects.user
203			model_stream = Action.objects.model_actions
204			any_stream = Action.objects.any
205			followers = Follow.objects.followers
206			following = Follow.objects.following
207

justquick / django-activity-stream

Pull Request — master (#387)

Follow.__str__() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Follow.str() A