ajaxful_rating 2.1.3 → 2.1.4

data/CHANGELOG

@@ -1,2 +1,5 @@
 == 2.1.0 July 25, 2009
 * AjaxfulRating is now available as a gem
+
+== 2.1.4 January 25, 2010
+* Added option for showing current_user's rate instead of global average

data/README.textile

@@ -43,10 +43,10 @@ Also this generator copies the necesary images, styles, etc.
 Example:
 _I suppose you have generated already an authenticated model..._
 
-  <pre><code>
-  script/generate authenticated user sessions
-  script/generate ajaxful_rating user
-  </code></pre>
+<pre>
+script/generate authenticated user sessions
+script/generate ajaxful_rating user
+</pre>
 
 So this call will create a Rate model and will link it to your User model.
 
@@ -60,20 +60,20 @@ customise this call:
 * @:dimensions@ Array of dimensions. Allows to rate the model on various specs,
 like for example: a car could be rated for its speed, beauty or price.
 
-  <pre><code>
-  class Car < ActiveRecord::Base
-    ajaxful_rateable :stars => 10, :dimensions => [:speed, :beauty, :price]
-  end
-  </code></pre>
+<pre>
+class Car < ActiveRecord::Base
+  ajaxful_rateable :stars => 10, :dimensions => [:speed, :beauty, :price]
+end
+</pre>
 
 Then you need to add a call @ajaxful_rater@ in the user model. This includes a simple line so
 you can add it _by your own_ as well (@has_many :rates@).
 
-  <pre><code>
-  class User < ActiveRecord::Base
-    ajaxful_rater
-  end
-  </code></pre>
+<pre>
+class User < ActiveRecord::Base
+  ajaxful_rater
+end
+</pre>
 
 Finally, as a mere recomendation to make it even easier, modify your routes to
 map a rate action:
@@ -87,54 +87,66 @@ It tries to call @current_user@ method as the rater instance. You can pass @:sta
 as the second param to display only the static stars (not clickables).
 And also you can pass the dimension you want to show the ratings for.
 
-  <pre><code>
-  #show.html.erb
-  <%= ratings_for @article %>
-  
-  #To display static stars:
-  <%= ratings_for @article, :static %>
+<pre>
+#show.html.erb
+<%= ratings_for @article %>
+
+#To display static stars:
+<%= ratings_for @article, :static %>
 
-  #To display the ratings for a dimension:
-  <%= ratings_for @article, :dimension => :speed %>
-  </code></pre>
+#To display the ratings for a dimension:
+<%= ratings_for @article, :dimension => :speed %>
+</pre>
 
 Or you can specify a custom user instance by passing it as parameter.
 
-  <pre><code>
-  <%= ratings_for @article, @user %>
-  </code></pre>
-		
+<pre>
+<%= ratings_for @article, @user %>
+</pre>
+
+By default ratings_for will display the average user rating. If you would like it to
+display the rating for the current_user, then set the :show_user_rating parameter to true.
+For example:
+
+<pre>
+# To display the rating for the current user (current_user):
+<%= ratings_for @article, :show_user_rating => true %>
+
+# To display the rating for the user specified by @user:
+<%= ratings_for @article, @user, :show_user_rating => true %>
+</pre>
+
 There's a condition here, if you didn't add the route @rate@ to your resource 
 (as shown above) or you named it different, you'll need to pass the url to the
 correct action in your controller:
 
-  <pre><code>
-  <%= ratings_for @article, :remote_options => {:url => your_rate_path(@article)} %>
-  </code></pre>
+<pre>
+<%= ratings_for @article, :remote_options => {:url => your_rate_path(@article)} %>
+</pre>
 
 *To display the stars properly you need to add a call in the head of your layout, which will generate the
 required CSS style for the list. Also don't forget to include the javascripts.*
 
-  <pre><code>
-    #within the head tags of your layout...
-    <%= javascript_include_tag :defaults %>
-    <%= ajaxful_rating_style %>
-  </code></pre>
+<pre>
+  #within the head tags of your layout...
+  <%= javascript_include_tag :defaults %>
+  <%= ajaxful_rating_style %>
+</pre>
 		
 When a user submits a rating it will call the action in your controller, for
 example (if you added the @rate@ route):
 
-  <pre><code>
-  def rate
-    @article = Article.find(params[:id])
-    @article.rate(params[:stars], current_user, params[:dimension])
-    id = "ajaxful-rating-#{!params[:dimension].blank? ? "#{params[:dimension]}-" : ''}article-#{@article.id}"
-    render :update do |page|
-      page.replace_html id, ratings_for(@article, :wrap => false, :dimension => params[:dimension])
-      page.visual_effect :highlight, id
-    end
+<pre>
+def rate
+  @article = Article.find(params[:id])
+  @article.rate(params[:stars], current_user, params[:dimension])
+  id = "ajaxful-rating-#{!params[:dimension].blank? ? "#{params[:dimension]}-" : ''}article-#{@article.id}"
+  render :update do |page|
+    page.replace_html id, ratings_for(@article, :wrap => false, :dimension => params[:dimension])
+    page.visual_effect :highlight, id
   end
-  </code></pre>
+end
+</pre>
 
 There are some more options for this helper, please see the rdoc for details.
 
@@ -145,11 +157,11 @@ corresponding rates for the dimension you want.
 
 For example, you defined these dimensions:
 
-  <pre><code>
-  class Car < ActiveRecord::Base
-    ajaxful_rateable :dimensions => [:speed, :beauty, :price]
-  end
-  </code></pre>
+<pre>
+class Car < ActiveRecord::Base
+  ajaxful_rateable :dimensions => [:speed, :beauty, :price]
+end
+</pre>
 
 And hence you can call @car.rates(:price)@ for the price rates or @car.rates(:speed)@ for the speed ratings and so on.
 
@@ -158,39 +170,39 @@ h3. Namespaces
 If you use the plugin inside a namespace you’ll need to specify the rating url which should points to
 a controller inside a namespace. Your files should be like these:
 
-  <pre><code>
-  routes.rb:
-  map.namespace :admin do |admin|
-    admin.resources :articles, :member => {:rate => :post}
-  end
+<pre>
+routes.rb:
+map.namespace :admin do |admin|
+  admin.resources :articles, :member => {:rate => :post}
+end
 
-  views/admin/articles/show.html.erb
-  <%= ratings_for @article, :remote_options => {:url => rate_admin_article_path(@article)} %>
-  </code></pre>
+views/admin/articles/show.html.erb
+<%= ratings_for @article, :remote_options => {:url => rate_admin_article_path(@article)} %>
+</pre>
 
 h3. Cache
 
 To cache the model's rating average add a column named @rating_average@ to your model table:
 
-  <pre><code>
-  class AddRatingAverageToArticles < ActiveRecord::Migration
-    def self.up
-      add_column :articles, :rating_average, :decimal, :default => 0
-    end
-  
-    def self.down
-      remove_column :articles, :rating_average
-    end
+<pre>
+class AddRatingAverageToArticles < ActiveRecord::Migration
+  def self.up
+    add_column :articles, :rating_average, :decimal, :default => 0, :precision => 6, :scale => 2
   end
-  </code></pre>
+
+  def self.down
+    remove_column :articles, :rating_average
+  end
+end
+</pre>
 
 If you want to customise the name of the cache column just pass it in the options hash:
 
-  <pre><code>
-  class Article < ActiveRecord::Base
-    ajaxful_rateable :cache_column => :my_cached_rating
-  end
-  </code></pre>
+<pre>
+class Article < ActiveRecord::Base
+  ajaxful_rateable :cache_column => :my_cached_rating
+end
+</pre>
 
 To use caching with dimensions, make sure you have a cache column defined for each dimension you want cached.
 So if you want to cache the @spelling@ dimension, you’ll need to have a column called @rating_average_spelling@ on the articles table.

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('ajaxful_rating', '2.1.3') do |p|
+Echoe.new('ajaxful_rating', '2.1.4') do |p|
   p.description    = "Provides a simple way to add rating functionality to your application."
   p.url            = "http://github.com/edgarjs/ajaxful-rating"
   p.author         = "Edgar J. Suarez"
-  p.email          = "e@dgar.org"
+  p.email          = "edgar.js@gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
 end

data/ajaxful_rating.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ajaxful_rating}
-  s.version = "2.1.3"
+  s.version = "2.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Edgar J. Suarez"]
-  s.date = %q{2009-09-09}
+  s.date = %q{2010-01-25}
   s.description = %q{Provides a simple way to add rating functionality to your application.}
-  s.email = %q{e@dgar.org}
+  s.email = %q{edgar.js@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "README.textile", "lib/ajaxful_rating.rb", "lib/ajaxful_rating_helper.rb", "lib/ajaxful_rating_model.rb"]
   s.files = ["CHANGELOG", "Manifest", "README.textile", "Rakefile", "ajaxful_rating.gemspec", "generators/ajaxful_rating/USAGE", "generators/ajaxful_rating/ajaxful_rating_generator.rb", "generators/ajaxful_rating/templates/images/star.png", "generators/ajaxful_rating/templates/images/star_small.png", "generators/ajaxful_rating/templates/migration.rb", "generators/ajaxful_rating/templates/model.rb", "generators/ajaxful_rating/templates/style.css", "init.rb", "lib/ajaxful_rating.rb", "lib/ajaxful_rating_helper.rb", "lib/ajaxful_rating_model.rb"]
   s.homepage = %q{http://github.com/edgarjs/ajaxful-rating}

data/lib/ajaxful_rating_helper.rb

@@ -17,6 +17,7 @@ module AjaxfulRating # :nodoc:
     # * <tt>:remote_options</tt> Hash of options for the link_to_remote function.
     # Default is {:method => :post, :url => rate_rateablemodel_path(rateable)}.
     # * <tt>:wrap</tt> Whether the star list is wrapped within a div tag or not. This is useful when page updating. Default is true.
+    # * <tt>:force_dynamic</tt> Whether the star list is always clickable. This is useful for page caching when set to true. Default is false.
     # 
     # Example:
     #   <%= ratings_for @article %>
@@ -53,6 +54,13 @@ module AjaxfulRating # :nodoc:
     #     # update page, etc.
     #   end
     # 
+    # By default ratings_for will render the average rating for all users. If however you would like to display the rating for a single user, then set the :show_user_rating option to true.
+    # For example:
+    #
+    #   <%= ratings_for @article, :show_user_rating => true %>
+    # Or
+    #   <%= ratings_for @article, @user, :show_user_rating => true %>
+    #
     # I18n:
     # 
     # You can translate the title of the images (the tool tip that shows when the mouse is over) and the 'Currently x/x stars'
@@ -66,20 +74,24 @@ module AjaxfulRating # :nodoc:
     #         other: "{{count}} stars out of {{total}}"
     def ratings_for(rateable, *args)
       user = extract_options(rateable, *args)
+      user_rating = if options[:show_user_rating] == true and rateable.rated_by?(user, options[:dimension])
+        rateable.rates(options[:dimension]).find_by_user_id(user).stars
+      else
+        user_rating = 0
+      end
       ajaxful_styles << %Q(
       .#{options[:class]} { width: #{rateable.class.max_rate_value * 25}px; }
       .#{options[:small_star_class]} { width: #{rateable.class.max_rate_value * 10}px; }
       )
-      width = (rateable.rate_average(true, options[:dimension]) / rateable.class.max_rate_value.to_f) * 100
+      width = ((options[:show_user_rating] == true ? user_rating : rateable.rate_average(true, options[:dimension])) / rateable.class.max_rate_value.to_f) * 100
       ul = content_tag(:ul, options[:html]) do
-        Range.new(1, rateable.class.max_rate_value).collect do |i|
+        (1..rateable.class.max_rate_value).collect do |i|
           build_star rateable, user, i
-        end.insert(0, content_tag(:li, current_average(rateable),
-            :class => 'current-rating', :style => "width:#{width}%"))
+        end.insert(0, content_tag(:li, current_average(rateable), :class => 'current-rating', :style => "width:#{width}%")).join
       end
       if options[:wrap]
         content_tag(:div, ul, :class => 'ajaxful-rating-wrapper', :id => "ajaxful-rating-#{!options[:dimension].blank? ?
-          "#{options[:dimension]}-" : ''}#{rateable.class.name.downcase}-#{rateable.id}")
+          "#{options[:dimension]}-" : ''}#{rateable.class.name.tableize.singularize}-#{rateable.id}")
       else
         ul
       end
@@ -109,7 +121,7 @@ module AjaxfulRating # :nodoc:
         }
       )
       rated = rateable.rated_by?(user, options[:dimension]) if user
-      star = if user && ((rated && rateable.class.options[:allow_update]) || !rated)
+      star = if options[:force_dynamic] || (user && ((rated && rateable.class.options[:allow_update]) || !rated))
         link_to_remote(i, build_remote_options({:class => a_class, :title => pluralize_title(i, rateable.class.max_rate_value)}, i))
       else
         content_tag(:span, i, :class => a_class, :title => current_average(rateable))
@@ -121,6 +133,7 @@ module AjaxfulRating # :nodoc:
     def options
       @ajaxful_options ||= {
         :wrap => true,
+        :force_dynamic => false,
         :class => 'ajaxful-rating',
         :link_class_prefix => :stars,
         :small_stars => false,
@@ -155,6 +168,7 @@ module AjaxfulRating # :nodoc:
   
     # Extracts the hash options and returns the user instance.
     def extract_options(rateable, *args)
+      options[:show_user_rating] = false  # Reset
       user = if args.first.class.name == rateable.class.user_class_name.classify
         args.shift
       elsif args.first != :static
@@ -163,9 +177,9 @@ module AjaxfulRating # :nodoc:
       config = (!args.empty? && args.last.is_a?(Hash)) ? args.last : {}
       if config[:remote_options] && config[:remote_options][:url]
         # we keep the passed url
-      elsif user
+      else#if user
         config[:remote_options] = {
-          :url => respond_to?(url = "rate_#{rateable.class.name.downcase}_path") ?
+          :url => respond_to?(url = "rate_#{rateable.class.name.tableize.singularize}_path") ?
             send(url, rateable) : raise(MissingRateRoute)
         }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ajaxful_rating
 version: !ruby/object:Gem::Version 
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors: 
 - Edgar J. Suarez
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -05:00
+date: 2010-01-25 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
 description: Provides a simple way to add rating functionality to your application.
-email: e@dgar.org
+email: edgar.js@gmail.com
 executables: []
 
 extensions: []