Commits

Anonymous committed 1a07638

Initial version

Comments (0)

Files changed (28)

+glob:*.pyc
+recursive-include favman/templates *.html
+recursive-include favman/fixtures *.txt
+recursive-include favman/static *.js *.css *.png *.jpg *.gif
+recursive-include favman/locale *.mo *.po
+include README.rst
+django-favman
+===============================================
+
+* `Overview`_
+* `Quick start`_
+
+.. _Overview: #overview
+.. _Quick start: #quick-start
+
+.. _overview:
+
+Overview?
+------------------------------------
+django-favman is a simple application that let users bookmark their favorites.
+
+
+
+.. _quick-start:
+
+Quick start
+------------------------------------
+In settings.py, add 'favman' to the INSTALLED_APPS 
+In urls.py add ``(r'^favorites/', include('favman.urls'))`` to your urlpatterns
+
+In your templates ::
+
+    {% load favman_tags %}
+    
+    {% favman_media %}
+    
+    {{object_to_manage}}{% favman_item object=object_to_manage %}
+
+
+It will create a two-state icon that indicates if the object is in the user favorites.
+Clicking on this icon will toggle the state.
+
+The user can also see the list of /favorites/list/
+
+License
+=======
+
+django-favman is licensed under the GNU-LGPL
+
+      GNU LESSER GENERAL PUBLIC LICENSE
+           Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+          Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+      GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+  
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+          NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+         END OF TERMS AND CONDITIONS
+
+

favman/__init__.py

+# -*- coding: utf-8 -*-
+
+VERSION = (0, 1, 0)
+
+def get_version():
+    version = '%s.%s.%s' % (VERSION[0], VERSION[1], VERSION[2])
+    return version
+
+__version__ = get_version()
+# -*- coding: utf-8 -*-
+from django.contrib import admin
+import models
+from django.utils.translation import ugettext_lazy as _
+
+class FavoriteAdmin(admin.ModelAdmin):
+    list_display = ["__unicode__", "user", "content_type", "object_id"]
+    list_filter  = ["user", "content_type"]
+admin.site.register(models.Favorite, FavoriteAdmin)
+# -*- coding: utf-8 -*-
+
+from django import forms
+from django.contrib.contenttypes.models import ContentType
+from django.utils.translation import ugettext as _
+from django.core.exceptions import ValidationError
+
+class ContentTypeField(forms.CharField): 
+    def clean(self, value):
+        super(ContentTypeField, self).clean(value)
+        if value:
+            try:
+                return ContentType.objects.get(id=value)
+            except ContentType.DoesNotExist:
+                raise ValidationError(_(u"The content type {0} doesn't exist").format(value))
+        return value
+
+class UpdateFavoriteForm(forms.Form):
+    object_id = forms.IntegerField(required=True)
+    content_type = ContentTypeField(required=True)
+    
+    def __init__(self, *args, **kwargs):
+        instance = kwargs.pop('instance', None)
+        if instance:
+            kwargs['initial'] = {
+                'object_id': instance.id,
+                'content_type': ContentType.objects.get_for_model(instance.__class__).id,
+            }
+        super(UpdateFavoriteForm, self).__init__(*args, **kwargs)
+
+    

favman/locale/fr/LC_MESSAGES/django.mo

Binary file added.

favman/locale/fr/LC_MESSAGES/django.po

+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2013-04-03 15:55+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=n>1;\n"
+
+#: .\forms.py:15
+msgid "The content type {0} doesn't exist"
+msgstr "Le type de contenu {0} n'existe pas"
+
+#: .\models.py:12
+msgid "user"
+msgstr "utilisateur"
+
+#: .\models.py:13
+msgid "content_type"
+msgstr "type de contenu"
+
+#: .\models.py:14
+msgid "object id"
+msgstr "identifiant de l'objet"
+
+#: .\models.py:18
+msgid "Favorite"
+msgstr "Favori"
+
+#: .\models.py:19
+msgid "Favorites"
+msgstr "Favoris"
+
+#: .\views.py:33
+msgid "Invalid object"
+msgstr "Objet invalide"
+
+#: .\views.py:40
+msgid "'{0}' has been added to the favorites"
+msgstr "'{0}' a été ajouté à vos favoris"
+
+#: .\views.py:47
+msgid "'{0}' has been removed from the favorites"
+msgstr "'{0}' a été retiré de vos favoris"
+
+#: .\views.py:54
+msgid "An error occured"
+msgstr "Une erreur est survenue"

favman/migrations/0001_initial.py

+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Adding model 'Favorite'
+        db.create_table('favman_favorite', (
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['auth.User'])),
+            ('content_type', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['contenttypes.ContentType'])),
+            ('object_id', self.gf('django.db.models.fields.PositiveIntegerField')()),
+        ))
+        db.send_create_signal('favman', ['Favorite'])
+
+        # Adding unique constraint on 'Favorite', fields ['user', 'content_type', 'object_id']
+        db.create_unique('favman_favorite', ['user_id', 'content_type_id', 'object_id'])
+
+
+    def backwards(self, orm):
+        # Removing unique constraint on 'Favorite', fields ['user', 'content_type', 'object_id']
+        db.delete_unique('favman_favorite', ['user_id', 'content_type_id', 'object_id'])
+
+        # Deleting model 'Favorite'
+        db.delete_table('favman_favorite')
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'favman.favorite': {
+            'Meta': {'unique_together': "(('user', 'content_type', 'object_id'),)", 'object_name': 'Favorite'},
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'object_id': ('django.db.models.fields.PositiveIntegerField', [], {}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"})
+        }
+    }
+
+    complete_apps = ['favman']

favman/migrations/__init__.py

Empty file added.
+# -*- coding: utf-8 -*-
+
+from django.db import models
+from django.utils.translation import ugettext_lazy as _
+from django.contrib.contenttypes import generic
+from django.contrib.contenttypes.models import ContentType
+from datetime import date
+from django.core.urlresolvers import reverse
+from django.contrib.auth.models import User
+
+class Favorite(models.Model):
+    user = models.ForeignKey(User, verbose_name=_("user"))
+    content_type = models.ForeignKey(ContentType, verbose_name=_("content_type"))
+    object_id = models.PositiveIntegerField(verbose_name=_("object id"))
+    content_object = generic.GenericForeignKey('content_type', 'object_id')
+    
+    class Meta:
+        verbose_name = _(u'Favorite')
+        verbose_name_plural = _(u'Favorites')
+        unique_together = (('user', 'content_type', 'object_id'),)
+        
+    def __unicode__(self):
+        return u"{0} - {1}".format(self.user, self.content_object)

favman/static/css/favorites.css

+.fav-icon {
+    width: 20px;
+    height: 20px;
+    display: inline-block;
+    background-image: url(../img/fav-out.png);
+    background-size: cover;
+}
+
+.fav-icon:hover {
+    background-image: url(../img/fav-hover.png);
+}
+
+.fav-icon.in-fav {
+    background-image: url(../img/fav-in.png);
+}

favman/static/img/fav-hover.png

Added
New image

favman/static/img/fav-in.png

Added
New image

favman/static/img/fav-out.png

Added
New image

favman/static/js/favorites.js

+$(function() {
+    $(".fav-icon").live('click', function() {
+        var form = $(this).find('form');
+        var elt = $(this);
+        $.ajax({
+            type: "POST",
+            url: form.attr('action'),
+            dataType: 'json',
+            data: form.serialize(),
+            success: function(data) {
+                if (data.success) {
+                    elt.removeClass('in-fav').removeClass('out-fav').addClass(data.status);
+                } else {
+                    alert(data.message);
+                }
+                /*
+                var css_class = data.success?"fav-success":"fav-error";
+                var html_msg = '<div class="fav-message '+css_class+'">'+data.message+'</div>';
+                $(body).append(html_msg);
+                */
+            }
+        });
+        return false;
+    })
+})

favman/templates/favman/_item.html

+{% load i18n %}{% load url from future %}
+
+<div class="fav-icon {{ status }}">
+    <form style="display:none" action="{{post_url}}">{% csrf_token %}{{ form }}</form>
+</div>

favman/templates/favman/_media.html

+{% load staticfiles %}
+<script type="text/javascript" src="{% static 'js/favorites.js' %}?v1.0"></script>
+<link rel="stylesheet" href="{% static 'css/favorites.css' %}?v=1.0" type="text/css" media="screen" />

favman/templates/favman/base.html

+{% extends "base.html" %}
+
+{% block favs_header %}
+{% endblock %}
+
+{% block favs_content%}
+{% endblock %}

favman/templates/favman/favorites_list.html

+{% extends "favorites/base.html" %}
+{% load i18n favman_tags %}
+
+{% block favs_header %}
+    {% fav_media %}
+{% endblock %}
+
+{% block favs_content%}
+    <ul class="favs">
+    {% for type, favs in favs_by_type %}
+        {% for fav in favs %}
+            <li>{{ fav.content_object }}{% fav_item object=fav.content_object %}</li>
+        {% endfor %}
+    {% endfor %}
+    </ul>
+{% endblock %}

favman/templatetags/__init__.py

+# -*- coding: utf-8 -*-

favman/templatetags/favman_tags.py

+# -*- coding: utf-8 -*-
+from django import template
+from django.template.base import Variable, VariableDoesNotExist
+from favman.forms import UpdateFavoriteForm
+from favman.models import Favorite
+from django.core.urlresolvers import reverse
+from django.contrib.contenttypes.models import ContentType
+
+register = template.Library()
+#
+#class IfIsFavNode(template.Node):
+#    def __init__(self, object, nodelist_true, nodelist_false):
+#        self.object = object
+#        self.nodelist_true = nodelist_true
+#        self.nodelist_false = nodelist_false
+#
+#    def __iter__(self):
+#        for node in self.nodelist_true:
+#            yield node
+#        for node in self.nodelist_false:
+#            yield node
+#
+#    def render(self, context):
+#        try:
+#            value = Variable(self.object).resolve(context)
+#        except VariableDoesNotExist:
+#            value = None
+#        if value:
+#            return self.nodelist_true.render(context)
+#        else:
+#            return self.nodelist_false.render(context)
+#        
+#
+#@register.tag
+#def if_is_fav(parser, token):
+#    object = token.contents.split()[1]
+#    nodelist_true = parser.parse(('else', 'endif'))
+#    token = parser.next_token()
+#    if token.contents == 'else':
+#        nodelist_false = parser.parse(('endif',))
+#        parser.delete_first_token()
+#    else:
+#        nodelist_false = template.NodeList()
+#    return IfIsFavNode(object, nodelist_true, nodelist_false)
+
+
+#-------------------------------------------------------------------------------
+
+@register.inclusion_tag('favman/_media.html', takes_context=True)
+def fav_media(context):
+    return {
+    }
+    
+@register.inclusion_tag('favman/_item.html', takes_context=True)
+def fav_item(context, object):
+    ct = ContentType.objects.get_for_model(object.__class__)
+    is_in_favorite = Favorite.objects.filter(
+        user = context['request'].user,
+        content_type = ct,
+        object_id = object.id
+    ).count()
+
+    return {
+        'status': 'in-fav' if is_in_favorite else 'out-fav',
+        'post_url': reverse('favman_toggle'),
+        'form': UpdateFavoriteForm(instance=object),
+    }
+# -*- coding: utf-8 -*-
+
+from django.test import TestCase
+from django.contrib.auth.models import User, Group, Permission
+from django.contrib.contenttypes.models import ContentType
+from django.core.urlresolvers import reverse
+from django.template import Template, Context
+import json
+from model_mommy import mommy
+from models import Favorite
+
+class BaseTestCase(TestCase):
+    
+    def _log_in(self):
+        user = User.objects.create_user('toto', 'toto@toto.fr', 'toto')
+        user.save()
+        if self.client.login(username='toto', password='toto'):
+            return user
+        return None
+    
+class UpdateFavoriteTestCase(BaseTestCase):
+    
+    def test_render_template(self):
+        user = self._log_in()
+        for i in xrange(5):
+            mommy.make_one(User)
+        
+        template_content = """
+        {% load favs %}
+        {% fav_media %}
+        <ul class="users">
+        {% for u in users %}
+            <li>{{ u.username }}{% fav_item u %}</li>
+        {% endfor %}
+        </ul>
+        """
+        template = Template(template_content)
+        
+        class DummyRequest(object): pass
+        dummy_request = DummyRequest()
+        setattr(dummy_request, 'user', user)
+        context = {
+            'users': User.objects.all(),
+            'request': dummy_request,
+        }
+        
+        html = template.render(Context(context))
+        
+    def test_post_not_logged(self):
+        user = mommy.make_one(User)
+        data = {
+            'content_type': ContentType.objects.get_for_model(User).id,
+            'object_id': user.id, 
+        }
+        response = self.client.post(reverse('favorites_toggle_favorite'), data)
+        self.assertEqual(302, response.status_code)
+        self.assertTrue(response['Location'].find('login')>0)
+        self.assertEqual(0, Favorite.objects.count())
+        
+        
+    def test_post_add(self):
+        logged_user = self._log_in()
+        faved_user = mommy.make_one(User)
+        
+        data = {
+            'content_type': ContentType.objects.get_for_model(User).id,
+            'object_id': faved_user.id, 
+        }
+        
+        response = self.client.post(reverse('favorites_toggle_favorite'), data)
+        self.assertEqual(200, response.status_code)
+        resp_data = json.loads(response.content)
+        self.assertEqual(True, resp_data['success'])
+        self.assertEqual('in-fav', resp_data['status'])
+        self.assertEqual(1, Favorite.objects.count())
+        
+        fav = Favorite.objects.all()[0]
+        self.assertEqual(fav.content_object, faved_user)
+        self.assertEqual(fav.user, logged_user)
+        
+    def test_post_remove(self):
+        logged_user = self._log_in()
+        faved_user = mommy.make_one(User)
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        Favorite.objects.create(user=logged_user, object_id=faved_user.id,
+            content_type=user_ct)
+        self.assertEqual(1, Favorite.objects.count())
+        
+        data = {
+            'content_type': user_ct.id,
+            'object_id': faved_user.id, 
+        }
+        response = self.client.post(reverse('favorites_toggle_favorite'), data)
+        self.assertEqual(200, response.status_code)
+        resp_data = json.loads(response.content)
+        self.assertEqual(True, resp_data['success'])
+        self.assertEqual('out-fav', resp_data['status'])
+        self.assertEqual(0, Favorite.objects.count())
+        
+        
+    def test_post_wrong_id(self):
+        logged_user = self._log_in()
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        
+        data = {
+            'content_type': user_ct.id,
+            'object_id': 1111, 
+        }
+        response = self.client.post(reverse('favorites_toggle_favorite'), data)
+        self.assertEqual(200, response.status_code)
+        resp_data = json.loads(response.content)
+        self.assertEqual(False, resp_data['success'])
+        
+    def test_post_wrong_ct(self):
+        logged_user = self._log_in()
+        faved_user = mommy.make_one(User)
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        
+        data = {
+            'content_type': 55555,
+            'object_id': faved_user.id, 
+        }
+        response = self.client.post(reverse('favorites_toggle_favorite'), data)
+        self.assertEqual(200, response.status_code)
+        resp_data = json.loads(response.content)
+        self.assertEqual(False, resp_data['success'])
+        
+        
+class ListFavoritesTestCase(BaseTestCase):
+    
+    def test_not_logged(self):
+        response = self.client.get(reverse('favorites_list'))
+        self.assertEqual(302, response.status_code)
+        self.assertTrue(response['Location'].find('login')>0)
+        
+    def test_empty_list(self):
+        self._log_in()
+        response = self.client.get(reverse('favorites_list'))
+        self.assertEqual(200, response.status_code)
+        
+    def test_list(self):
+        logged_user = self._log_in()
+        faved_users = [mommy.make_one(User, username='user-{0}'.format(i)) for i in xrange(5)]
+        not_faved_users = [mommy.make_one(User, username='NOT-{0}'.format(i)) for i in xrange(5)]
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        for u in faved_users:
+            Favorite.objects.create(user=logged_user, content_type=user_ct, object_id=u.id)
+        
+        response = self.client.get(reverse('favorites_list'))
+        self.assertEqual(200, response.status_code)
+        for u in faved_users:
+            self.assertContains(response, u)
+        for u in not_faved_users:
+            self.assertNotContains(response, u)
+            
+    def test_someone_else_list(self):
+        logged_user = self._log_in()
+        other_user = mommy.make_one(User)
+        faved_users = [mommy.make_one(User, username='user-{0}'.format(i)) for i in xrange(5)]
+        not_my_faved_users = [mommy.make_one(User, username='OTHER-{0}'.format(i)) for i in xrange(5)]
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        
+        for u in faved_users:
+            Favorite.objects.create(user=logged_user, content_type=user_ct, object_id=u.id)
+        
+        for u in not_my_faved_users:
+            Favorite.objects.create(user=other_user, content_type=user_ct, object_id=u.id)
+        
+        response = self.client.get(reverse('favorites_list'))
+        self.assertEqual(200, response.status_code)
+        
+        for u in faved_users:
+            self.assertContains(response, u)
+        for u in not_my_faved_users:
+            self.assertNotContains(response, u)
+            
+    def test_list_different_cts(self):
+        logged_user = self._log_in()
+        faved_users = [mommy.make_one(User, username='user-{0}'.format(i)) for i in xrange(5)]
+        faved_groups = [mommy.make_one(Group, name='group-{0}'.format(i)) for i in xrange(5)]
+        
+        user_ct = ContentType.objects.get_for_model(User)
+        group_ct = ContentType.objects.get_for_model(Group)
+        
+        for u in faved_users:
+            Favorite.objects.create(user=logged_user, content_type=user_ct, object_id=u.id)
+        
+        for g in faved_groups:
+            Favorite.objects.create(user=logged_user, content_type=group_ct, object_id=g.id)
+        
+        response = self.client.get(reverse('favorites_list'))
+        self.assertEqual(200, response.status_code)
+        for u in faved_users:
+            self.assertContains(response, u)
+        for u in faved_groups:
+            self.assertContains(response, u)
+    
+# -*- coding: utf-8 -*-
+
+from django.conf.urls.defaults import patterns, url
+
+urlpatterns = patterns('favman.views',
+    url(r'^toggle/$', 'toggle_favorite', name='favman_toggle'),
+    url(r'^list/$', 'list_favorites', name='favman_list'),
+)
+
+# -*- coding: utf-8 -*-
+
+from django.http import HttpResponse
+from django.shortcuts import render_to_response
+from django.template import RequestContext
+from django.core.urlresolvers import reverse
+import json
+from django.utils.translation import ugettext as _
+from django.contrib.contenttypes.models import ContentType
+from django.contrib.auth.decorators import login_required
+import models, forms
+import logging
+logger = logging.getLogger("favman")
+
+@login_required
+def toggle_favorite(request):
+    try:
+        if request.method == "POST":
+            form = forms.UpdateFavoriteForm(request.POST)
+            
+            if form.is_valid():
+                object_id = form.cleaned_data["object_id"]
+                content_type = form.cleaned_data["content_type"]
+                
+                favorite, is_new = models.Favorite.objects.get_or_create(
+                    user = request.user,
+                    content_type = content_type,
+                    object_id = object_id
+                )
+                
+                if not favorite.content_object:
+                    favorite.delete()
+                    raise Exception(_(u'Invalid object'))
+            
+                label = getattr(favorite.content_object, 'name', unicode(favorite.content_object))
+                if is_new:
+                    data = {
+                        'success': True,
+                        'status': 'in-fav',
+                        'message': _(u"'{0}' has been added to the favorites".format(label))
+                    }
+                else:
+                    favorite.delete()
+                    data = {
+                        'success': True,
+                        'status': 'out-fav',
+                        'message': _(u"'{0}' has been removed from the favorites".format(label))
+                    }
+            else:
+                raise Exception(u"{0}".format(form.errors))
+        else:
+            raise Exception(u"POST expected")
+    except Exception:
+        data = {'success': False, 'message': _('An error occured')}
+        logger.exception("update_favorite")
+    return HttpResponse(json.dumps(data), content_type="application/json")
+
+
+@login_required
+def list_favorites(request):
+    
+    content_types = ContentType.objects.filter(favorite__user=request.user).distinct()
+    
+    favs_by_type = []
+    for ct in content_types:
+        favs_by_type.append((ct, models.Favorite.objects.filter(user=request.user, content_type=ct)))
+        
+    context = {
+        'favs_by_type': favs_by_type,
+    }
+    
+    return render_to_response(
+        'favman/favorites_list.html',
+        context,
+        context_instance=RequestContext(request)
+    )
+ django-favman: let users bookmark their favorites
+  ~~~~~
+  License for use and distribution
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  django-favman
+  (C)2013 - Luc Jean - luc.jean@gmail.com
+  (C)2013 - Apidev - http://www.apidev.fr
+ 
+  This is distributed under GNU LGPL license (see copying.txt for details)
+
+  GNU LGPL information
+  --------------------
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+  Apidev www.apidev.fr., hereby disclaims all copyright interest in the
+  library 'django-favman' written by Luc JEAN.
+  
+  Apidev
+  Luc JEAN
+  296 rue Saint Pierre
+  42810 Rozier en Donzy
+  France
+
+# -*- coding: utf-8 -*-
+
+try:
+    from setuptools import setup, find_packages
+except ImportError:
+    import ez_setup
+    ez_setup.use_setuptools()
+    from setuptools import setup, find_packages
+
+VERSION = __import__('favman').__version__
+
+import os
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+setup(
+    name='django-favman',
+    version = VERSION,
+    description="Let users bookmark their favorite objects",
+    packages = find_packages(),
+    include_package_data=True,
+    author='Luc Jean',
+    author_email='ljean@apidev.fr',
+    license='GNU LGPL',
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Framework :: Django',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)',
+        'Programming Language :: Python',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development :: Libraries',
+    ],
+)
+