ajaxful_rating.gemspec lib/ajaxful_rating_model.rb @@ -1,4 +1,3 @@ -ajaxful-rating.gemspec CHANGELOG generators/ajaxful_rating/ajaxful_rating_generator.rb generators/ajaxful_rating/templates/images/star.png @@ -8,9 +7,9 @@ generators/ajaxful_rating/templates/model.rb generators/ajaxful_rating/templates/style.css generators/ajaxful_rating/USAGE init.rb -lib/ajaxful-rating.rb lib/ajaxful_rating.rb lib/ajaxful_rating_helper.rb +lib/ajaxful_rating_model.rb Manifest Rakefile README.textile Manifest @@ -23,7 +23,11 @@ To install the plugin: Or the gem - @sudo gem install edgarjs-ajaxful-rating --source=http://gems.github.com@ + @sudo gem install edgarjs-ajaxful_rating --source=http://gems.github.com@ + +You can configure it in your environment.rb file also: + + @config.gem "edgarjs-ajaxful_rating", :lib => "ajaxful_rating", :source => "http://gems.github.com"@ h3. Generate README.textile @@ -2,7 +2,7 @@ require 'rubygems' require 'rake' require 'echoe' -Echoe.new('ajaxful-rating', '2.1.0') do |p| +Echoe.new('ajaxful_rating', '2.1.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" Rakefile @@ -1 +1 @@ -require 'ajaxful-rating' +require 'ajaxful_rating' init.rb @@ -1,223 +1,2 @@ -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 - - def self.included(base) - base.extend ClassMethods - end - - module ClassMethods - attr_reader :options - - # Extends the model to be easy ajaxly rateable. - # - # Options: - # * <tt>:stars</tt> Max number of stars that can be submitted. - # * <tt>:allow_update</tt> Set to true if you want users to be able to update their votes. - # * <tt>:cache_column</tt> Name of the column for storing the cached rating average. - # - # Example: - # class Article < ActiveRecord::Base - # ajaxful_rateable :stars => 10, :cache_column => :custom_column - # end - def ajaxful_rateable(options = {}) - has_many :rates_without_dimension, :as => :rateable, :class_name => 'Rate', - :dependent => :destroy, :conditions => {:dimension => nil} - - - options[:dimensions].each do |dimension| - has_many "#{dimension}_rates", :dependent => :destroy, - :conditions => {:dimension => dimension.to_s}, :class_name => 'Rate', :as => :rateable - end if options[:dimensions].is_a?(Array) - - @options = options.reverse_merge( - :stars => 5, - :allow_update => true, - :cache_column => :rating_average - ) - include AjaxfulRating::InstanceMethods - extend AjaxfulRating::SingletonMethods - end - - # Makes the association between user and Rate model. - 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 - options[:stars] - end - end - - # Instance methods for the rateable object. - module InstanceMethods - - # Submits a new rate. Accepts a hash of tipical Ajax request. - # - # Example: - # # Articles Controller - # def rate - # @article = Article.find(params[:id]) - # @article.rate(params[:stars], current_user, params[:dimension]) - # # 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.options[:allow_update] && rated_by?(user, dimension)) - - rate = (self.class.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 - else - rate.send "#{self.class.user_class_name}_id=", user.id - end if rate.new_record? - rate.save! - self.update_cached_average(dimension) - 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] - ) - 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 - end - - # Return true if the user has rated the object, otherwise false - def rated_by?(user, dimension = nil) - !rate_by(user, dimension).nil? - end - - # Instance's total rates. - def total_rates(dimension = nil) - rates(dimension).size - end - - # Total sum of the rates. - def rates_sum(dimension = nil) - rates(dimension).sum(:stars) - end - - # Rating average for the object. - # - # Pass false as param to force the calculation if you are caching it. - def rate_average(cached = true, dimension = nil) - avg = if cached && self.class.caching_average?(dimension) - send(caching_column_name(dimension)).to_f - else - self.rates_sum(dimension).to_f / self.total_rates(dimension).to_f - end - avg.nan? ? 0.0 : avg - end - - # Overrides the default +rates+ method and returns the propper array - # for the dimension passed. - # - # It may works as an alias for +dimension_rates+ methods. - def rates(dimension = nil) - unless dimension.blank? - send("#{dimension}_rates") - else - rates_without_dimension - end - end - - # Returns the name of the cache column for the passed dimension. - def caching_column_name(dimension = nil) - self.class.caching_column_name(dimension) - end - - # 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) - send("#{caching_column_name(dimension)}=", self.rate_average(false, dimension)) - save! - end - end - end - - module SingletonMethods - - # 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 - end - - # Finds all rateable objects rated by the +user+. - def find_rated_by(user) - find_statement(:user_id, user.id) - end - - # Finds all rateable objects rated with +stars+. - def find_rated_with(stars) - find_statement(:stars, stars) - end - - # Finds the rateable object with the highest rate average. - def find_most_popular(dimension = nil) - all.sort_by { |o| o.rate_average(true, dimension) }.last - end - - # Finds the rateable object with the lowest rate average. - def find_less_popular(dimension = nil) - all.sort_by { |o| o.rate_average(true, dimension) }.first - 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]) - find_by_sql(sql) - end - - # Indicates if the rateable model is able to cache the rate average. - # - # Include a column named +rating_average+ in your rateable model with - # default null, as decimal: - # - # t.decimal :rating_average, :precision => 3, :scale => 1, :default => 0 - # - # To customize the name of the column specify the option <tt>:cache_column</tt> to ajaxful_rateable - # - # ajaxful_rateable :cache_column => :my_custom_column - # - def caching_average?(dimension = nil) - column_names.include?(caching_column_name(dimension)) - end - - # Returns the name of the cache column for the passed dimension. - def caching_column_name(dimension = nil) - name = options[:cache_column].to_s - name += "_#{dimension.to_s.underscore}" unless dimension.blank? - name - end - end -end - -class ActiveRecord::Base - include AjaxfulRating -end +require 'ajaxful_rating_model' +require 'ajaxful_rating_helper' lib/ajaxful_rating.rb ajaxful-rating.gemspec lib/ajaxful-rating.rb ea52518d2760072d8c888ecb869444659e16733e edgarjs edgar.js@gmail.com http://github.com/edgarjs/ajaxful-rating/commit/39ec4a0ba48ab7b4a7d0eb8db0c7d10c6bc8c482 39ec4a0ba48ab7b4a7d0eb8db0c7d10c6bc8c482 2009-07-25T15:04:57-07:00 2009-07-25T15:04:57-07:00 Underscored gem name "ajaxful_rating" 5bc5c98a8a09205f8f046da1e4f7b28f221a9774 edgarjs edgar.js@gmail.com