Refactor how the phileo widget works

pinax · Aug 20, 2012 · 065ccae · 065ccae
1 parent 68d607f
commit 065ccae
Show file tree

Hide file tree

Showing 20 changed files with 128 additions and 720 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,2 @@
 include README.rst
-recursive-include phileo/static *
 recursive-include phileo/templates *
diff --git a/README.rst b/README.rst
@@ -5,8 +5,9 @@ Phileo
 a liking app
 
 
-Attribution
------------
+Commercial Support
+------------------
 
-The default liking AJAX liking widget that ships with this package uses the Iconic icons packaged
-into a typeface from http://somerandomdude.com/work/iconic/.
+This app, and many others like it, have been built in support of many of Eldarion's
+own sites, and sites of our clients. We would love to help you on your next project
+so get in touch by dropping us a note at info@eldarion.com.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -7,14 +7,18 @@ ChangeLog
 ---
 
 - Added permission checking
-
+- Added rendering of HTML in the ajax response to liking
+- Got rid of all the js/css cruft; up to site owner now but ships with bootstrap/bootstrap-ajax enabled templates
 
 Backward Incompatibilities
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - Added an auth_backend to check permissions, you can just add the `phileo.auth_backends.PermCheckBackend`
   and do nothing else, or you can implement you own backend checking the `phileo.can_like`
   permission against the object and user according to your own business logic.
+- No more ``phileo_css``, ``phileo_js``, or ``phileo_widget_js`` tags.
+- ``PHILEO_LIKABLE_MODELS`` has changed from a ``list`` to a ``dict``
+- ``phileo_widget`` optional parameters have been removed and instead put into per model settings
 
 
 0.3

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -14,6 +14,12 @@ Installation
         "phileo",
     )
 
+* Add the models that you want to be likeable to ``PHILEO_LIKABLE_MODELS``:
+
+    PHILEO_LIKABLE_MODELS = {
+        "app.Model": {}  # can override default config settings for each model here
+    }
+
 * Add ``'phileo.auth_backends.CanLikeBackend'`` to your ``AUTHENTICATION_BACKENDS``
   (or use your own custom version checking against the ``phileo.can_like`` permission):
 

diff --git a/docs/templatetags.rst b/docs/templatetags.rst
@@ -14,16 +14,6 @@ This simple returns the count of likes for a given object::
 Template Tags
 =============
 
-likes_css
----------
-
-This renders some css style sheets that will style the widget.::
-
-    {% phileo_css %}
-
-It renders "phileo/_css.html" and can be overridden as desired.
-
-
 render_like
 -----------
 
@@ -47,38 +37,19 @@ basis:
 * phileo/_like.html
 
 
-phileo_js
----------
-
-This renders some script tags that are needed to make the widget work.::
-
-    {% phileo_js %}
-
-It renders "phileo/_js.html" and can be overridden as desired.
-
-
 phileo_widget
-------------
+-------------
 
 This renders a fragement of html that will be what the user will click
 on to unlike or like objects. It only has two required parameters, which
 are the user and the object.::
 
-    {% likes_widget user object like_text="Like|Unlike" counts_text="like|likes" [widget_id="unique_id" like_type="likes" toggle_class="phileo-liked"] %}
+    {% likes_widget user object %}
 
 
 It renders "phileo/_widget.html" and can be overridden as desired.
 
 
-phileo_widget_js
-----------------
-
-This renders a script tag that will use the jquery plugin that `phileo_js`
-includes into the page.
-
-It renders "phileo/_widget_js.html" and can be overriden as desired.
-
-
 liked
 -----
 

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -25,16 +25,6 @@ to load the tags::
     {% load phileo_tags %}
 
 
-Then in the <head> section of your template load the css::
-
-    {% phileo_css %}
-
-
-Load the required JavaScript file, wherever you load your JavaScript libraries::
-
-    {% phileo_js %}
-
-
 In the body where you want the liking widget to go, add::
 
     {% phileo_widget request.user post %}

diff --git a/phileo/settings.py b/phileo/settings.py
@@ -0,0 +1,21 @@
+from collections import defaultdict
+
+from django.conf import settings
+
+
+DEFAULT_LIKE_CONFIG = getattr(settings, "PHILEO_DEFAULT_LIKE_CONFIG", {
+    "css_class_on": "icon-heart",
+    "css_class_off": "icon-heart-empty",
+    "like_text_on": "Unlike",
+    "like_text_off": "Like",
+    "count_text_singular": "like",
+    "count_text_plural": "likes"
+})
+
+LIKABLE_MODELS = getattr(settings, "PHILEO_LIKABLE_MODELS", defaultdict(dict))
+
+for model in LIKABLE_MODELS:
+    custom_data = LIKABLE_MODELS[model].copy()
+    default_data = DEFAULT_LIKE_CONFIG.copy()
+    LIKABLE_MODELS[model] = default_data
+    LIKABLE_MODELS[model].update(custom_data)
diff --git a/phileo/static/phileo/css/iconic.css b/phileo/static/phileo/css/iconic.css
diff --git a/phileo/static/phileo/css/iconic_stroke.eot b/phileo/static/phileo/css/iconic_stroke.eot
diff --git a/phileo/static/phileo/css/iconic_stroke.otf b/phileo/static/phileo/css/iconic_stroke.otf