ajaxful_rating 2.1.5 → 2.2.0

data/CHANGELOG

@@ -1,3 +1,14 @@
+== 2.2.0 March 7, 2010
+* Improved model methods and options.
+* Works now with inherited models.
+* Removed HTML and CSS options for helper for sake of simpleness.
+* Renamed helper option :small_stars to :small.
+* Changed whole helper approach. It should work the same as before.
+  (Except for the renamed and removed options)
+* Removed :force_dynamic, you should exclude the helper from cache since it uses
+  authorization.
+* Fixed opened bugs so far.
+
 == 2.1.5 January 28, 2010
 * Renamed options method name to avoid collapse.
 * Removed CSS duplication.

data/Manifest

@@ -12,5 +12,9 @@ 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
+lib/axr/css_builder.rb
+lib/axr/errors.rb
+lib/axr/helpers.rb
+lib/axr/locale.rb
+lib/axr/model.rb
+lib/axr/stars_builder.rb

data/README.textile

@@ -34,7 +34,7 @@ You can configure it in your environment.rb file also:
 h3. Generate
 
   @script/generate ajaxful_rating UserModelName@
-	
+  
 The generator takes one argument: UserModelName, which is the name of your *current*
 user model. This is necessary to link both the rate and user models.
 
@@ -132,20 +132,19 @@ required CSS style for the list. Also don't forget to include the javascripts.*
   <%= 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>
-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
+  def rate
+    @car = Car.find(params[:id])
+    @car.rate(params[:stars], current_user, params[:dimension])
+    render :update do |page|
+      page.replace_html @car.wrapper_dom_id(params[:dimension]), ratings_for(@car, params.merge(:wrap => false))
+      page.visual_effect :highlight, @car.wrapper_dom_id(params[:dimension])
+    end
   end
-end
 </pre>
 
 There are some more options for this helper, please see the rdoc for details.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('ajaxful_rating', '2.1.5') do |p|
+Echoe.new('ajaxful_rating', '2.2.0') 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"

data/ajaxful_rating.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ajaxful_rating}
-  s.version = "2.1.5"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Edgar J. Suarez"]
-  s.date = %q{2010-01-28}
+  s.date = %q{2010-03-07}
   s.description = %q{Provides a simple way to add rating functionality to your application.}
   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.extra_rdoc_files = ["CHANGELOG", "README.textile", "lib/ajaxful_rating.rb", "lib/axr/css_builder.rb", "lib/axr/errors.rb", "lib/axr/helpers.rb", "lib/axr/locale.rb", "lib/axr/model.rb", "lib/axr/stars_builder.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/axr/css_builder.rb", "lib/axr/errors.rb", "lib/axr/helpers.rb", "lib/axr/locale.rb", "lib/axr/model.rb", "lib/axr/stars_builder.rb"]
   s.homepage = %q{http://github.com/edgarjs/ajaxful-rating}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ajaxful_rating", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ajaxful_rating}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Provides a simple way to add rating functionality to your application.}
 
   if s.respond_to? :specification_version then

data/generators/ajaxful_rating/templates/migration.rb

@@ -1,16 +1,15 @@
 class CreateRates < ActiveRecord::Migration
   def self.up
     create_table :rates do |t|
-      t.references :<%= file_name %>
-      t.references :rateable, :polymorphic => true
-      t.integer :stars
+      t.belongs_to :rater
+      t.belongs_to :rateable, :polymorphic => true
+      t.integer :stars, :null => false
       t.string :dimension
-
       t.timestamps
     end
     
-    add_index :rates, :<%= file_name %>_id
-    add_index :rates, :rateable_id
+    add_index :rates, :rater_id
+    add_index :rates, [:rateable_id, :rateable_type]
   end
 
   def self.down

data/generators/ajaxful_rating/templates/model.rb

@@ -1,5 +1,5 @@
 class Rate < ActiveRecord::Base
-  belongs_to :<%= file_name %>
+  belongs_to :rater, :class_name => <%= file_name.classify %>
   belongs_to :rateable, :polymorphic => true
   
   attr_accessible :rate, :dimension

data/generators/ajaxful_rating/templates/style.css

@@ -6,7 +6,7 @@
 .ajaxful-rating a:hover,
 .ajaxful-rating a:active,
 .ajaxful-rating a:focus,
-.ajaxful-rating .current-rating{
+.ajaxful-rating .show-value{
     background: url(/images/ajaxful_rating/star.png) left -1000px repeat-x;
 }
 .ajaxful-rating{
@@ -22,7 +22,7 @@
 .ajaxful-rating li{ display: inline; }
 .ajaxful-rating a,
 .ajaxful-rating span,
-.ajaxful-rating .current-rating{
+.ajaxful-rating .show-value{
     position: absolute;
     top: 0;
     left: 0;
@@ -63,21 +63,21 @@ width: 100%;
 z-index: 2;
 }
 */
-.ajaxful-rating .current-rating{
+.ajaxful-rating .show-value{
     z-index: 1;
     background-position: left center;
 }
 
 /* smaller star */
-.small-star{
+.ajaxful-rating.small{
     /*width: 50px; this is setted dynamically */
     height: 10px;
 }
-.small-star,
-.small-star a:hover,
-.small-star a:active,
-.small-star a:focus,
-.small-star .current-rating{
+.ajaxful-rating.small,
+.ajaxful-rating.small a:hover,
+.ajaxful-rating.small a:active,
+.ajaxful-rating.small a:focus,
+.ajaxful-rating.small .show-value{
     background-image: url(/images/ajaxful_rating/star_small.png);
     line-height: 10px;
     height: 10px;

data/init.rb

@@ -1 +1,6 @@
+puts "------------------------------------------"
+puts "IMPORTANT: AjaxfulRating has been updated to v2.2.x and some options changed."\
+  "Please read the changelog at http://github.com/edgarjs/ajaxful-rating/blob/master/CHANGELOG"
+puts "------------------------------------------"
+
 require 'ajaxful_rating'

data/lib/ajaxful_rating.rb

@@ -1,2 +1,11 @@
-require 'ajaxful_rating_model'
-require 'ajaxful_rating_helper'
+puts "------------------------------------------"
+puts "IMPORTANT: AjaxfulRating has been updated to v2.2.x and some options changed."\
+  "Please read the changelog at http://github.com/edgarjs/ajaxful-rating/blob/master/CHANGELOG"
+puts "------------------------------------------"
+
+require 'axr/locale'
+require 'axr/errors'
+require 'axr/model'
+require 'axr/css_builder'
+require 'axr/stars_builder'
+require 'axr/helpers'

data/lib/axr/css_builder.rb

@@ -0,0 +1,30 @@
+module AjaxfulRating # :nodoc:
+  class CSSBuilder
+    attr_reader :rules
+    
+    def initialize
+      @rules = {}
+    end
+    
+    def rule(selector, attrs)        
+      @rules[selector] = self.class.stringify_properties(attrs) unless @rules.has_key?(selector)
+    end
+    
+    def to_css
+      css = ''
+      @rules.each do |key, value|
+        css << "#{key} {#{value}}\n"
+      end
+      css
+    end
+    
+    def self.stringify_properties(properties)
+      css = ''
+      properties.each do |key, value|
+        value = value.is_a?(Fixnum) || value.is_a?(Float) ? "#{value}px" : value
+        css << "#{key.to_s.underscore.dasherize}: #{value}; "
+      end
+      css
+    end
+  end
+end

data/lib/axr/errors.rb

@@ -0,0 +1,27 @@
+module AjaxfulRating # :nodoc:
+  module Errors
+    class AlreadyRatedError < StandardError
+      def to_s
+        "Model has already been rated by this user. To allow update of ratings pass :allow_update => true to the ajaxful_rateable call."
+      end
+    end
+    
+    class MissingRateRoute < StandardError
+      def to_s
+        "Add a member route to your routes file for rate with :post method. Or specify a custom url in the options."
+      end
+    end
+    
+    class NoUserSpecified < StandardError
+      def to_s
+        "You need to specify a user instance or create a helper with the name current_user."
+      end
+    end
+    
+    class MissingStarsCSSBuilder < StandardError
+      def to_s
+        "Add a call to ajaxful_rating_style within the head of your layout."
+      end
+    end
+  end
+end

data/lib/axr/helpers.rb

@@ -0,0 +1,89 @@
+module AjaxfulRating # :nodoc:
+  module Helpers
+    include AjaxfulRating::Errors
+    
+    # Outputs the required css file, and the dynamic CSS generated for the
+    # current page.
+    def ajaxful_rating_style
+      @axr_css ||= CSSBuilder.new
+      stylesheet_link_tag('ajaxful_rating') +
+        content_tag(:style, @axr_css.to_css, :type => "text/css")
+    end
+    
+    # Generates the stars list to submit a rate.
+    # 
+    # It accepts the next options:
+    # * <tt>:small</tt> Set this param to true to display smaller images. Default is false.
+    # * <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>:show_user_rating</tt> Set to true if you want to display only the current user's rating, instead of the global average.
+    # * <tt>:dimension</tt> The dimension to show the ratings for.
+    # 
+    # Example:
+    #   <%= ratings_for @article, :wrap => false %> # => Will produce something like:
+    #   <ul class="ajaxful-rating">
+    #     <li class="current-rating" style="width: 60%;">3</li>
+    #     <li><%= link_to_remote 1, :url => rate_article_path(@article, :stars => 1), :method => :post, :html => {:class => 'stars-1', :title => '1 star out of 5'} %></li>
+    #     <li><%= link_to_remote 2, :url => rate_article_path(@article, :stars => 2), :method => :post, :html => {:class => 'stars-2', :title => '2 stars out of 5'} %></li>
+    #     <li><%= link_to_remote 3, :url => rate_article_path(@article, :stars => 3), :method => :post, :html => {:class => 'stars-3', :title => '3 stars out of 5'} %></li>
+    #     <li><%= link_to_remote 4, :url => rate_article_path(@article, :stars => 4), :method => :post, :html => {:class => 'stars-4', :title => '4 stars out of 5'} %></li>
+    #     <li><%= link_to_remote 5, :url => rate_article_path(@article, :stars => 5), :method => :post, :html => {:class => 'stars-5', :title => '5 stars out of 5'} %></li>
+    #   </ul>
+    #   
+    # It will try to use the method <tt>current_user</tt> as the user instance. You can specify a custom instance in the second parameter
+    # or pass <tt>:static</tt> to leave the list of stars static.
+    # 
+    # Example:
+    #   <%= ratings_for @article, @user, :small => true %>
+    #   # => Will use @user instead <tt>current_user</tt>
+    #   
+    #   <%= ratings_for @article, :static, :small => true %>
+    #   # => Will produce a static list of stars showing the current rating average for @article.
+    #   
+    # The user passed here will *not* be the one who submits the rate. It will be used only for the display behavior of the stars.
+    # Like for example, if there is a user logged in or if the current logged in user is able to submit a rate depending on the
+    # configuration (accepts update of rates, etc).
+    # 
+    # So to actually set the user who will rate the model you need to do it in your controller:
+    # 
+    #   # controller
+    #   def rate
+    #     @article = Article.find(params[:id])
+    #     @article.rate(params[:stars], current_user) # or any user instance
+    #     # 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'
+    # string by setting these keys on your translation hash:
+    # 
+    #   ajaxful_rating:
+    #     stars:
+    #       current_average: "Current rating: {{average}}/{{max}}"
+    #       title:
+    #         one: 1 star out of {{total}}
+    #         other: "{{count}} stars out of {{total}}"
+    def ratings_for(*args)
+      @axr_css ||= CSSBuilder.new
+      options = args.extract_options!.symbolize_keys.slice(:small, :remote_options,
+        :wrap, :show_user_rating, :dimension)
+      remote_options = options.delete(:remote_options) || {}
+      rateable = args.shift
+      user = args.shift || (respond_to?(:current_user) ? current_user : raise(NoUserSpecified))
+      StarsBuilder.new(rateable, user, self, @axr_css, options, remote_options).render
+    end
+  end
+end
+
+class ActionView::Base # :nodoc:
+  include AjaxfulRating::Helpers
+end

data/lib/axr/locale.rb

@@ -0,0 +1,21 @@
+module AjaxfulRating # :nodoc:
+  
+  # Customize messages by adding I18n keys:
+  #
+  #   ajaxful_rating:
+  #     helper:
+  #       global_average: "Current rating average: {{value}} out of {{max}}"
+  #       user_rating: "Your rating: {{value}} out of {{max}}"
+  module Locale
+    def i18n(global = true)
+      key = "ajaxful_rating.helper.#{global ? 'global_average' : 'user_rating'}"
+      default =
+        if global
+          "Current rating average: {{value}} out of {{max}}"
+        else
+          "Your rating: {{value}} out of {{max}}"
+        end
+      I18n.t(key, :value => show_value, :max => rateable.class.max_stars, :default => default)
+    end
+  end
+end

data/lib/{ajaxful_rating_model.rb → axr/model.rb}

@@ -1,17 +1,11 @@
 module AjaxfulRating # :nodoc:
-  class AlreadyRatedError < StandardError
-    def to_s
-      "Model has already been rated by this user. To allow update of ratings pass :allow_update => true to the ajaxful_rateable call."
-    end
-  end
+  include AjaxfulRating::Errors
 
   def self.included(base)
     base.extend ClassMethods
   end
 
   module ClassMethods
-    attr_reader :ajaxful_rating_options
-
     # Extends the model to be easy ajaxly rateable.
     #
     # Options:
@@ -26,18 +20,28 @@ module AjaxfulRating # :nodoc:
     def ajaxful_rateable(options = {})
       has_many :rates_without_dimension, :as => :rateable, :class_name => 'Rate',
         :dependent => :destroy, :conditions => {:dimension => nil}
-
+      has_many :raters_without_dimension, :through => :rates_without_dimension, :source => :rater
       
       options[:dimensions].each do |dimension|
         has_many "#{dimension}_rates", :dependent => :destroy,
           :conditions => {:dimension => dimension.to_s}, :class_name => 'Rate', :as => :rateable
+        has_many "#{dimension}_raters", :through => "#{dimension}_rates", :source => :rater
       end if options[:dimensions].is_a?(Array)
 
-      @ajaxful_rating_options = options.reverse_merge(
-        :stars => 5,
-        :allow_update => true,
-        :cache_column => :rating_average
-      )
+      class << self
+        def axr_config
+          @axr_config ||= {
+            :stars => 5,
+            :allow_update => true,
+            :cache_column => :rating_average
+          }
+        end
+        
+        alias_method :ajaxful_rating_options, :axr_config
+      end
+      
+      axr_config.update(options)
+      
       include AjaxfulRating::InstanceMethods
       extend AjaxfulRating::SingletonMethods
     end
@@ -46,19 +50,15 @@ module AjaxfulRating # :nodoc:
     def ajaxful_rater(options = {})
       has_many :rates, options
     end
-
-    # Maximum value accepted when rating the model. Default is 5.
-    #
-    # Change it by passing the :stars option to +ajaxful_rateable+
-    #
-    #   ajaxful_rateable :stars => 10
-    def max_rate_value
-      ajaxful_rating_options[:stars]
-    end
   end
 
   # Instance methods for the rateable object.
   module InstanceMethods
+    
+    # Proxy for axr_config singleton method.
+    def axr_config
+      self.class.axr_config
+    end
 
     # Submits a new rate. Accepts a hash of tipical Ajax request.
     #
@@ -70,40 +70,61 @@ module AjaxfulRating # :nodoc:
     #     # some page update here ...
     #   end
     def rate(stars, user, dimension = nil)
-      return false if (stars.to_i > self.class.max_rate_value)
-      raise AlreadyRatedError if (!self.class.ajaxful_rating_options[:allow_update] && rated_by?(user, dimension))
+      return false if (stars.to_i > self.class.max_stars)
+      raise AlreadyRatedError if (!self.class.axr_config[:allow_update] && rated_by?(user, dimension))
 
-      rate = (self.class.ajaxful_rating_options[:allow_update] && rated_by?(user, dimension)) ?
-        rate_by(user, dimension) : rates(dimension).build
-      rate.stars = stars
-      if user.respond_to?(:rates)
-        user.rates << rate
+      rate = if self.class.axr_config[:allow_update] && rated_by?(user, dimension)
+        rate_by(user, dimension)
       else
-        rate.send "#{self.class.user_class_name}_id=", user.id
-      end if rate.new_record?
+        returning rates(dimension).build do |r|
+          r.rater = user
+        end
+      end
+      rate.stars = stars
       rate.save!
       self.update_cached_average(dimension)
     end
+    
+    # Builds the DOM id attribute for the wrapper in view.
+    def wrapper_dom_id(dimension = nil)
+      prefix = "ajaxful_rating"
+      prefix << "_#{dimension}" unless dimension.blank?
+      ApplicationController.helpers.dom_id(self, prefix)
+    end
 
-    # Returns an array with all users that have rated this object.
-    def raters
-      eval(self.class.user_class_name.classify).find_by_sql(
-        ["SELECT DISTINCT u.* FROM #{self.class.user_class_name.pluralize} u INNER JOIN rates r ON " +
-            "u.[id] = r.[#{self.class.user_class_name}_id] WHERE r.[rateable_id] = ? AND r.[rateable_type] = ?",
-          id, self.class.name]
-      )
+    # Returns an array with the users that have rated this object for the
+    # passed dimension.
+    #
+    # It may works as an alias for +dimension_raters+ methods.
+    def raters(dimension = nil)
+      sql = "SELECT DISTINCT u.* FROM #{self.class.user_class.table_name} u "\
+        "INNER JOIN rates r ON u.id = r.rater_id WHERE "
+      
+      sql << self.class.send(:sanitize_sql_for_conditions, {
+        :rateable_id => id,
+        :rateable_type => self.class.base_class.name,
+        :dimension => (dimension.to_s if dimension)
+      }, 'r')
+      
+      self.class.user_class.find_by_sql(sql)
     end
 
     # Finds the rate made by the user if he/she has already voted.
     def rate_by(user, dimension = nil)
-      filter = "find_by_#{self.class.user_class_name}_id"
-      rates(dimension).send filter, user
+      rates(dimension).find_by_rater_id(user.id)
     end
 
     # Return true if the user has rated the object, otherwise false
     def rated_by?(user, dimension = nil)
       !rate_by(user, dimension).nil?
     end
+    
+    # Returns whether or not the user can rate this object.
+    # Based on if the user has already rated the object or the
+    # :allow_update option is enabled.
+    def can_rate_by?(user, dimension = nil)
+      !rated_by?(user, dimension) || self.class.axr_config[:allow_update]
+    end
 
     # Instance's total rates.
     def total_rates(dimension = nil)
@@ -147,30 +168,40 @@ module AjaxfulRating # :nodoc:
     # Updates the cached average column in the rateable model.
     def update_cached_average(dimension = nil)
       if self.class.caching_average?(dimension)
-        rates(:refresh).size if self.respond_to?(:rates_count)
         update_attribute caching_column_name(dimension), self.rate_average(false, dimension)
       end
     end
   end
 
   module SingletonMethods
+    
+    # Maximum value accepted when rating the model. Default is 5.
+    #
+    # Change it by passing the :stars option to +ajaxful_rateable+
+    #
+    #   ajaxful_rateable :stars => 10
+    def max_stars
+      axr_config[:stars]
+    end
 
     # Name of the class for the user model.
     def user_class_name
-      @@user_class_name ||= Rate.column_names.find do |c|
-        u = c.scan(/(\w+)_id$/).flatten.first
-        break u if u && u != 'rateable'
-      end
+      Rate.reflect_on_association(:rater).options[:class_name]
+    end
+    
+    # Gets the user's class
+    def user_class
+      user_class_name.constantize
     end
 
     # Finds all rateable objects rated by the +user+.
-    def find_rated_by(user)
-      find_statement(:user_id, user.id)
+    def find_rated_by(user, dimension = nil)
+      find_statement(:rater_id, user.id, dimension)
     end
 
     # Finds all rateable objects rated with +stars+.
-    def find_rated_with(stars)
-      find_statement(:stars, stars)
+    def find_rated_with(stars, dimension = nil)
+      find_statement(:stars, stars, dimension)
     end
 
     # Finds the rateable object with the highest rate average.
@@ -184,12 +215,16 @@ module AjaxfulRating # :nodoc:
     end
 
     # Finds rateable objects by Rate's attribute.
-    def find_statement(attr_name, attr_value)
-      rateable = self.base_class.name
-      sql = sanitize_sql(["SELECT DISTINCT r2.* FROM rates r1 INNER JOIN " +
-            "#{rateable.constantize.table_name} r2 ON r1.rateable_id = r2.id " +
-            "WHERE (r1.[rateable_type] = ? AND r1.[#{attr_name}] = ?)",
-          rateable, attr_value])
+    def find_statement(attr_name, attr_value, dimension = nil)
+      sql = "SELECT DISTINCT r2.* FROM rates r1 INNER JOIN "\
+        "#{self.base_class.table_name} r2 ON r1.rateable_id = r2.id WHERE "
+      
+      sql << sanitize_sql_for_conditions({
+        :rateable_type => self.base_class.name,
+        attr_name => attr_value,
+        :dimension => (dimension.to_s if dimension)
+      }, 'r1')
+      
       find_by_sql(sql)
     end
 
@@ -210,7 +245,7 @@ module AjaxfulRating # :nodoc:
 
     # Returns the name of the cache column for the passed dimension.
     def caching_column_name(dimension = nil)
-      name = ajaxful_rating_options[:cache_column].to_s
+      name = axr_config[:cache_column].to_s
       name += "_#{dimension.to_s.underscore}" unless dimension.blank?
       name
     end

data/lib/axr/stars_builder.rb

@@ -0,0 +1,111 @@
+module AjaxfulRating # :nodoc:
+  class StarsBuilder # :nodoc:
+    include AjaxfulRating::Locale
+    
+    attr_reader :rateable, :user, :options, :remote_options
+    
+    def initialize(rateable, user_or_static, template, css_builder, options = {}, remote_options = {})
+      @user = user_or_static unless user_or_static == :static
+      @rateable, @template, @css_builder = rateable, template, css_builder
+      apply_stars_builder_options!(options, remote_options)
+    end
+    
+    def show_value
+      if options[:show_user_rating]
+        rate = rateable.rate_by(user, options[:dimension])
+        rate ? rate.stars : 0
+      else
+        rateable.rate_average(true, options[:dimension])
+      end
+    end
+    
+    def render
+      options[:wrap] ? wrapper_tag : ratings_tag
+    end
+    
+    private
+    
+    def apply_stars_builder_options!(options, remote_options)
+      @options = {
+        :wrap => true,
+        :small => false,
+        :show_user_rating => false
+      }.merge(options)
+      
+      @options[:small] = @options[:small].to_s == 'true'
+      @options[:show_user_rating] = @options[:show_user_rating].to_s == 'true'
+      @options[:wrap] = @options[:wrap].to_s == 'true'
+      
+      @remote_options = {
+        :url => nil,
+        :method => :post
+      }.merge(remote_options)
+      
+      if @remote_options[:url].nil?
+        rateable_name = ActionController::RecordIdentifier.singular_class_name(rateable)
+        url = "rate_#{rateable_name}_path"
+        if @template.respond_to?(url)
+          @remote_options[:url] = @template.send(url, rateable)
+        else
+          raise(MissingRateRoute)
+        end
+      end
+    end
+    
+    def ratings_tag
+      stars = []
+      width = (show_value / rateable.class.max_stars.to_f) * 100
+      li_class = "axr-#{show_value}-#{rateable.class.max_stars}".gsub('.', '_')
+      @css_builder.rule('.ajaxful-rating', :width => (rateable.class.max_stars * 25))
+      @css_builder.rule('.ajaxful-rating.small',
+        :width => (rateable.class.max_stars * 10)) if options[:small]
+      
+      stars << @template.content_tag(:li, i18n, :class => "show-value",
+        :style => "width: #{width}%")
+      stars += (1..rateable.class.max_stars).map do |i|
+        star_tag(i)
+      end
+      @template.content_tag(:ul, stars.join, :class => "ajaxful-rating#{' small' if options[:small]}")
+    end
+    
+    def star_tag(value)
+      already_rated = rateable.rated_by?(user, options[:dimension]) if user
+      css_class = "stars-#{value}"
+      @css_builder.rule(".ajaxful-rating .#{css_class}", {
+        :width => "#{(value / rateable.class.max_stars.to_f) * 100}%",
+        :zIndex => (rateable.class.max_stars + 2 - value).to_s
+      })
+      
+      @template.content_tag(:li) do
+        if user && (!already_rated || rateable.axr_config[:allow_update])
+          link_star_tag(value, css_class)
+        else
+          @template.content_tag(:span, show_value, :class => css_class, :title => i18n)
+        end
+      end
+    end
+    
+    def link_star_tag(value, css_class)
+      query = {
+        :stars => value,
+        :dimension => options[:dimension],
+        :small => options[:small],
+        :show_user_rating => options[:show_user_rating]
+      }.to_query
+      config = {
+        :html => {
+          :class => css_class,
+          :title => i18n(false)
+        },
+        :url => "#{remote_options[:url]}",
+        :with => "'#{query}'"
+      }
+      @template.link_to_remote(value, remote_options.merge(config))
+    end
+    
+    def wrapper_tag
+      @template.content_tag(:div, ratings_tag, :class => "ajaxful-rating-wrapper",
+        :id => rateable.wrapper_dom_id(options[:dimension]))
+    end
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ajaxful_rating
 version: !ruby/object:Gem::Version 
-  version: 2.1.5
+  prerelease: false
+  segments: 
+  - 2
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Edgar J. Suarez
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -06:00
+date: 2010-03-07 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -23,8 +28,12 @@ extra_rdoc_files:
 - CHANGELOG
 - README.textile
 - lib/ajaxful_rating.rb
-- lib/ajaxful_rating_helper.rb
-- lib/ajaxful_rating_model.rb
+- lib/axr/css_builder.rb
+- lib/axr/errors.rb
+- lib/axr/helpers.rb
+- lib/axr/locale.rb
+- lib/axr/model.rb
+- lib/axr/stars_builder.rb
 files: 
 - CHANGELOG
 - Manifest
@@ -40,8 +49,12 @@ files:
 - generators/ajaxful_rating/templates/style.css
 - init.rb
 - lib/ajaxful_rating.rb
-- lib/ajaxful_rating_helper.rb
-- lib/ajaxful_rating_model.rb
+- lib/axr/css_builder.rb
+- lib/axr/errors.rb
+- lib/axr/helpers.rb
+- lib/axr/locale.rb
+- lib/axr/model.rb
+- lib/axr/stars_builder.rb
 has_rdoc: true
 homepage: http://github.com/edgarjs/ajaxful-rating
 licenses: []
@@ -60,18 +73,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: ajaxful_rating
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Provides a simple way to add rating functionality to your application.

data/lib/ajaxful_rating_helper.rb

@@ -1,195 +0,0 @@
-module AjaxfulRating # :nodoc:
-  module Helper
-    class MissingRateRoute < StandardError
-      def to_s
-        "Add :member => {:rate => :post} to your routes, or specify a custom url in the options."
-      end
-    end
-  
-    # Generates the stars list to submit a rate.
-    # 
-    # It accepts the next options:
-    # * <tt>:class</tt> CSS class for the ul. Default is 'ajaxful-rating'.
-    # * <tt>:link_class_prefix</tt> Prefix for the li a CSS class. Default is 'stars'.
-    # * <tt>:small_stars</tt> Set this param to true to display smaller images. Default is false.
-    # * <tt>:small_star_class</tt> CSS class for the list when using small images. Default is 'small-stars'.
-    # * <tt>:html</tt> Hash of options to customise the ul tag.
-    # * <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 %>
-    #   # => Will produce something like:
-    #   <ul class="ajaxful-rating">
-    #     <li class="current-rating" style="width: 60%;">Currently 3/5 stars</li>
-    #     <li><%= link_to_remote 1, :url => rate_article_path(@article, :stars => 1), :method => :post, :html => {:class => 'stars-1', :title => '1 star out of 5'} %></li>
-    #     <li><%= link_to_remote 2, :url => rate_article_path(@article, :stars => 2), :method => :post, :html => {:class => 'stars-2', :title => '2 stars out of 5'} %></li>
-    #     <li><%= link_to_remote 3, :url => rate_article_path(@article, :stars => 3), :method => :post, :html => {:class => 'stars-3', :title => '3 stars out of 5'} %></li>
-    #     <li><%= link_to_remote 4, :url => rate_article_path(@article, :stars => 4), :method => :post, :html => {:class => 'stars-4', :title => '4 stars out of 5'} %></li>
-    #     <li><%= link_to_remote 5, :url => rate_article_path(@article, :stars => 5), :method => :post, :html => {:class => 'stars-5', :title => '5 stars out of 5'} %></li>
-    #   </ul>
-    #   
-    # It will try to use the method <tt>current_user</tt> as the user instance. You can specify a custom instance in the second parameter
-    # or pass <tt>:static</tt> to leave the list of stars static.
-    # 
-    # Example:
-    #   <%= ratings_for @article, @user, :small_stars => true %>
-    #   # => Will use @user instead <tt>current_user</tt>
-    #   
-    #   <%= ratings_for @article, :static, :small_stars => true %>
-    #   # => Will produce a static list of stars showing the current rating average for @article.
-    #   
-    # The user passed here will *not* be the one who submits the rate. It will be used only for the display behavior of the stars.
-    # Like for example, if there is a user logged in or if the current logged in user is able to submit a rate depending on the
-    # configuration (accepts update of rates, etc).
-    # 
-    # So to actually set the user who will rate the model you need to do it in your controller:
-    # 
-    #   # controller
-    #   def rate
-    #     @article = Article.find(params[:id])
-    #     @article.rate(params[:stars], current_user) # or any user instance
-    #     # 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'
-    # string by setting these keys on your translation hash:
-    # 
-    #   ajaxful_rating:
-    #     stars:
-    #       current_average: "Current rating: {{average}}/{{max}}"
-    #       title:
-    #         one: 1 star out of {{total}}
-    #         other: "{{count}} stars out of {{total}}"
-    def ratings_for(rateable, *args)
-      user = extract_options(rateable, *args)
-      user_rating = if ajaxful_rating_options[:show_user_rating] == true and rateable.rated_by?(user, ajaxful_rating_options[:dimension])
-        rateable.rates(ajaxful_rating_options[:dimension]).find_by_user_id(user).stars
-      else
-        user_rating = 0
-      end
-      ajaxful_styles[ajaxful_rating_options[:class]] ||= ".#{ajaxful_rating_options[:class]} { width: #{rateable.class.max_rate_value * 25}px; }"
-      ajaxful_styles[ajaxful_rating_options[:small_star_class]] ||= ".#{ajaxful_rating_options[:class]}.#{ajaxful_rating_options[:small_star_class]} { width: #{rateable.class.max_rate_value * 10}px; }"
-      width = ((ajaxful_rating_options[:show_user_rating] == true ? user_rating : rateable.rate_average(true, ajaxful_rating_options[:dimension])) / rateable.class.max_rate_value.to_f) * 100
-      ul = content_tag(:ul, ajaxful_rating_options[:html]) do
-        (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}%")).join
-      end
-      if ajaxful_rating_options[:wrap]
-        content_tag(:div, ul, :class => 'ajaxful-rating-wrapper', :id => "ajaxful-rating-#{!ajaxful_rating_options[:dimension].blank? ?
-          "#{ajaxful_rating_options[:dimension]}-" : ''}#{rateable.class.name.tableize.singularize}-#{rateable.id}")
-      else
-        ul
-      end
-    end
-  
-    # Call this method <strong>within head tags</strong> of the main layout to yield the dynamic styles.
-    # It will include the necessary stlyesheet and output the dynamic CSS.
-    #
-    # Example:
-    #   <head>
-    #     <%= ajaxful_rating_style %>
-    #   </head>
-    def ajaxful_rating_style
-      stylesheet_link_tag('ajaxful_rating') + content_tag(:style, ajaxful_styles.values.join("\n"),
-        :type => 'text/css') unless ajaxful_styles.blank?
-    end
-  
-    private
-  
-    # Builds a star
-    def build_star(rateable, user, i)
-      a_class = "#{ajaxful_rating_options[:link_class_prefix]}-#{i}"
-      selector = ".#{ajaxful_rating_options[:class]} .#{a_class}"
-      ajaxful_styles[selector] ||= <<-EOS
-        #{selector} {
-            width: #{(i / rateable.class.max_rate_value.to_f) * 100}%;
-            z-index: #{rateable.class.max_rate_value + 2 - i};
-        }
-      EOS
-      rated = rateable.rated_by?(user, ajaxful_rating_options[:dimension]) if user
-      star = if ajaxful_rating_options[:force_dynamic] || (user && ((rated && rateable.class.ajaxful_rating_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))
-      end
-      content_tag(:li, star)
-    end
-  
-    # Default options for the helper.
-    def ajaxful_rating_options
-      @ajaxful_rating_options ||= {
-        :wrap => true,
-        :force_dynamic => false,
-        :class => 'ajaxful-rating',
-        :link_class_prefix => :stars,
-        :small_stars => false,
-        :small_star_class => 'small-star',
-        :html => {},
-        :remote_options => {:method => :post}
-      }
-    end
-  
-    # Builds the proper title for the star.
-    def pluralize_title(current, max)
-      (current == 1) ? I18n.t('ajaxful_rating.stars.title.one', :max => max, :default => "1 star out of {{max}}") :
-        I18n.t('ajaxful_rating.stars.title.other', :count => current, :max => max, :default => "{{count}} stars out of {{max}}")
-    end
-    
-    # Returns the current average string.
-    def current_average(rateable)
-      I18n.t('ajaxful_rating.stars.current_average', :average => rateable.rate_average(true, ajaxful_rating_options[:dimension]),
-        :max => rateable.class.max_rate_value, :default => "Current rating: {{average}}/{{max}}")
-    end
-  
-    # Temporary instance to hold dynamic styles.
-    def ajaxful_styles
-      @ajaxful_styles ||= {}
-    end
-  
-    # Builds the default options for the link_to_remote function.
-    def build_remote_options(html, i)
-      ajaxful_rating_options[:remote_options].reverse_merge(:html => html).merge(
-        :url => "#{ajaxful_rating_options[:remote_options][:url]}?#{{:stars => i, :dimension => ajaxful_rating_options[:dimension], :small_stars => ajaxful_rating_options[:small_stars]}.to_query}")
-    end
-  
-    # Extracts the hash options and returns the user instance.
-    def extract_options(rateable, *args)
-      ajaxful_rating_options[:show_user_rating] = false  # Reset
-      user = if args.first.class.name == rateable.class.user_class_name.classify
-        args.shift
-      elsif args.first != :static
-        current_user if respond_to?(:current_user)
-      end
-      config = (!args.empty? && args.last.is_a?(Hash)) ? args.last : {}
-      if config[:remote_options] && config[:remote_options][:url]
-        # we keep the passed url
-      else#if user
-        config[:remote_options] = {
-          :url => respond_to?(url = "rate_#{rateable.class.name.tableize.singularize}_path") ?
-            send(url, rateable) : raise(MissingRateRoute)
-        }
-      end
-      config[:small_stars] = (config[:small_stars].downcase == "true") if config[:small_stars].is_a?(String)
-      ajaxful_rating_options.merge!(config)
-      ajaxful_rating_options[:html].reverse_merge!(:class => "#{ajaxful_rating_options[:class]} #{ajaxful_rating_options[:small_star_class] if ajaxful_rating_options[:small_stars]}")
-      user
-    end
-  end
-end
-
-class ActionView::Base
-  include AjaxfulRating::Helper
-end