ajaxful_rating 2.2.8.2 → 2.2.9

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('ajaxful_rating', '2.2.8.2') do |p|
+Echoe.new('ajaxful_rating', '2.2.9') 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,24 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ajaxful_rating}
-  s.version = "2.2.8.2"
+  s.version = "2.2.9"
 
   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-08-27}
+  s.authors = [%q{Edgar J. Suarez}]
+  s.date = %q{2011-09-20}
   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/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.extra_rdoc_files = [%q{CHANGELOG}, %q{README.textile}, %q{lib/ajaxful_rating.rb}, %q{lib/axr/css_builder.rb}, %q{lib/axr/errors.rb}, %q{lib/axr/helpers.rb}, %q{lib/axr/locale.rb}, %q{lib/axr/model.rb}, %q{lib/axr/stars_builder.rb}]
+  s.files = [%q{CHANGELOG}, %q{Manifest}, %q{README.textile}, %q{Rakefile}, %q{ajaxful_rating.gemspec}, %q{generators/ajaxful_rating/USAGE}, %q{generators/ajaxful_rating/ajaxful_rating_generator.rb}, %q{generators/ajaxful_rating/templates/images/star.png}, %q{generators/ajaxful_rating/templates/images/star_small.png}, %q{generators/ajaxful_rating/templates/migration.rb}, %q{generators/ajaxful_rating/templates/model.rb}, %q{generators/ajaxful_rating/templates/style.css}, %q{init.rb}, %q{lib/ajaxful_rating.rb}, %q{lib/axr/css_builder.rb}, %q{lib/axr/errors.rb}, %q{lib/axr/helpers.rb}, %q{lib/axr/locale.rb}, %q{lib/axr/model.rb}, %q{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.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Ajaxful_rating}, %q{--main}, %q{README.textile}]
+  s.require_paths = [%q{lib}]
   s.rubyforge_project = %q{ajaxful_rating}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Provides a simple way to add rating functionality to your application.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/generators/ajaxful_rating/templates/migration.rb

@@ -3,7 +3,7 @@ class CreateRates < ActiveRecord::Migration
     create_table :rates do |t|
       t.belongs_to :rater
       t.belongs_to :rateable, :polymorphic => true
-      t.integer :stars, :null => false
+      t.float :stars, :null => false
       t.string :dimension
       t.timestamps
     end

data/lib/axr/helpers.rb

@@ -20,6 +20,7 @@ module AjaxfulRating # :nodoc:
     # * <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.
     # * <tt>:force_static</tt> Force static stars even when you're passing a user instance.
+    # * <tt>:to_nearest</tt> Allow stars to be set and averaged to nearest whatever. eg. 0.5 for the nearest half-star
     # 
     # Example:
     #   <%= ratings_for @article, :wrap => false %> # => Will produce something like:
@@ -69,13 +70,13 @@ module AjaxfulRating # :nodoc:
     # 
     #   ajaxful_rating:
     #     helper:
-    #       global_average: "Global rating average: {{value}} out of {{max}}"
-    #       user_rating: "Your rating: {{value}} out of {{max}}"
-    #       hover: "Rate {{value}} out of {{max}}"    def ratings_for(*args)
+    #       global_average: "Global rating average: %{value} out of %{max}"
+    #       user_rating: "Your rating: %{value} out of %{max}"
+    #       hover: "Rate %{value} out of %{max}"    def ratings_for(*args)
     def ratings_for(*args)
       @axr_css ||= CSSBuilder.new
       options = args.extract_options!.symbolize_keys.slice(:small, :remote_options,
-        :wrap, :show_user_rating, :dimension, :force_static, :current_user)
+        :wrap, :show_user_rating, :dimension, :force_static, :current_user, :disable_remote, :to_nearest)
       remote_options = options.delete(:remote_options) || {}
       rateable = args.shift
       user = args.shift || (respond_to?(:current_user) ? current_user : raise(NoUserSpecified))

data/lib/axr/locale.rb

@@ -4,15 +4,15 @@ module AjaxfulRating # :nodoc:
   #
   #   ajaxful_rating:
   #     helper:
-  #       global_average: "Global rating average: {{value}} out of {{max}}"
-  #       user_rating: "Your rating: {{value}} out of {{max}}"
-  #       hover: "Rate {{value}} out of {{max}}"
+  #       global_average: "Global rating average: %{value} out of %{max}"
+  #       user_rating: "Your rating: %{value} out of %{max}"
+  #       hover: "Rate %{value} out of %{max}"
   module Locale
     
     DEFAULTS = {
-      :user_rating => "Your rating: {{value}} out of {{max}}",
-      :global_average => "Global rating average: {{value}} out of {{max}}",
-      :hover => "Rate {{value}} out of {{max}}",
+      :user_rating => "Your rating: %{value} out of %{max}",
+      :global_average => "Global rating average: %{value} out of %{max}",
+      :hover => "Rate %{value} out of %{max}",
       :no_ratings => "Not yet rated"
     }
     

data/lib/axr/model.rb

@@ -12,6 +12,8 @@ module AjaxfulRating # :nodoc:
     # * <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.
+    # * <tt>:cache_column</tt> Name of the column for storing the cached rating average.
+    # * <tt>:to_nearest</tt> Allow stars to be set and averaged to nearest whatever . eg. 0.5 for the nearest half-star. May be overridden in the ratings_for
     #
     # Example:
     #   class Article < ActiveRecord::Base
@@ -146,11 +148,20 @@ module AjaxfulRating # :nodoc:
     # 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
+    def rate_average(cached = true, dimension = nil, to_nearest = nil)
+      avg = if cached && self.class.caching_average?(dimension, to_nearest)
+        send(caching_column_name(dimension, to_nearest)).to_f
       else
-        self.rates_sum(dimension).to_f / self.total_rates(dimension).to_f
+        avg = self.rates_sum(dimension).to_f / self.total_rates(dimension).to_f
+        avg.nan? ? 0.0 : avg
+        if avg > 0
+          to_nearest ||=  axr_config[:to_nearest]
+          if to_nearest
+            notches = 1/to_nearest.to_f
+            avg = ((avg * notches).round)/notches
+          end
+        end
+        avg
       end
       avg.nan? ? 0.0 : avg
     end
@@ -168,14 +179,14 @@ module AjaxfulRating # :nodoc:
     end
 
     # Returns the name of the cache column for the passed dimension.
-    def caching_column_name(dimension = nil)
-      self.class.caching_column_name(dimension)
+    def caching_column_name(dimension = nil, to_nearest = nil)
+      self.class.caching_column_name(dimension, to_nearest)
     end
 
     # Updates the cached average column in the rateable model.
-    def update_cached_average(dimension = nil)
-      if self.class.caching_average?(dimension)
-        update_attribute caching_column_name(dimension), self.rate_average(false, dimension)
+    def update_cached_average(dimension = nil, to_nearest = nil)
+      if self.class.caching_average?(dimension, to_nearest)
+        update_attribute caching_column_name(dimension, to_nearest), self.rate_average(false, dimension, to_nearest)
       end
     end
   end
@@ -191,6 +202,11 @@ module AjaxfulRating # :nodoc:
       axr_config[:stars]
     end
 
+    # Allow stars to be set and averaged to nearest whatever. eg. 0.5 for the nearest half-star
+    def to_nearest
+      axr_config[:to_nearest] || 1
+    end
+
     # Name of the class for the user model.
     def user_class_name
       Rate.reflect_on_association(:rater).options[:class_name]
@@ -246,14 +262,15 @@ module AjaxfulRating # :nodoc:
     #
     #   ajaxful_rateable :cache_column => :my_custom_column
     #
-    def caching_average?(dimension = nil)
-      column_names.include?(caching_column_name(dimension))
+    def caching_average?(dimension = nil, to_nearest = nil)
+      column_names.include?(caching_column_name(dimension, to_nearest))
     end
 
     # Returns the name of the cache column for the passed dimension.
-    def caching_column_name(dimension = nil)
+    def caching_column_name(dimension = nil, to_nearest = nil)
       name = axr_config[:cache_column].to_s
       name += "_#{dimension.to_s.underscore}" unless dimension.blank?
+      name += "_#{to_nearest.to_s.gsub('.', '_').underscore}" unless to_nearest.blank?
       name
     end
   end

data/lib/axr/stars_builder.rb

@@ -30,6 +30,7 @@ module AjaxfulRating # :nodoc:
         :wrap => true,
         :small => false,
         :show_user_rating => false,
+        :disable_remote => false,
         :force_static => false,
         :current_user => (@template.current_user if @template.respond_to?(:current_user))
       }.merge(options)
@@ -37,7 +38,7 @@ module AjaxfulRating # :nodoc:
       @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
@@ -64,8 +65,8 @@ module AjaxfulRating # :nodoc:
       
       stars << @template.content_tag(:li, i18n(:current), :class => "show-value",
         :style => "width: #{width}%")
-      stars += (1..rateable.class.max_stars).map do |i|
-        star_tag(i)
+      stars += (1..rateable.class.max_stars/rateable.class.to_nearest).map do |i|
+        star_tag(i*rateable.class.to_nearest)
       end
       # When using rails_xss plugin, it needs to render as HTML
       stars = "".respond_to?(:html_safe) ? stars.join.html_safe : stars.join
@@ -74,10 +75,10 @@ module AjaxfulRating # :nodoc:
     
     def star_tag(value)
       already_rated = rateable.rated_by?(user, options[:dimension]) if user
-      css_class = "stars-#{value}"
+      css_class = "stars-%s" % [ value.to_s.gsub('.', '_') ]
       @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
+        :zIndex => "%.f" % ( (rateable.class.max_stars/rateable.class.to_nearest) + 2 - (value/rateable.class.to_nearest))
       })
       @template.content_tag(:li) do
         if !options[:force_static] && (user && options[:current_user] == user &&
@@ -104,11 +105,16 @@ module AjaxfulRating # :nodoc:
         :url => "#{remote_options[:url]}",
         :with => "'#{query}'"
       }
-      @template.link_to_remote(value, remote_options.merge(config))
+      if options[:disable_remote]
+        config[:url] += "?" + query
+        @template.link_to(value, config[:url], config[:html])
+      else
+        @template.link_to_remote(value, remote_options.merge(config))
+      end
     end
     
     def wrapper_tag
-      @template.content_tag(:div, ratings_tag, :class => "ajaxful-rating-wrapper",
+      @template.content_tag(:div, ratings_tag, :class => "ajaxful-rating-wrapper#{' show-user-rating' if @options[:show_user_rating]}",
         :id => rateable.wrapper_dom_id(options))
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ajaxful_rating
 version: !ruby/object:Gem::Version 
-  hash: 91
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 2
   - 2
-  - 8
-  - 2
-  version: 2.2.8.2
+  - 9
+  version: 2.2.9
 platform: ruby
 authors: 
 - Edgar J. Suarez
@@ -16,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-27 00:00:00 -05:00
-default_executable: 
+date: 2011-09-20 00:00:00 Z
 dependencies: []
 
 description: Provides a simple way to add rating functionality to your application.
@@ -57,7 +55,6 @@ files:
 - lib/axr/locale.rb
 - lib/axr/model.rb
 - lib/axr/stars_builder.rb
-has_rdoc: true
 homepage: http://github.com/edgarjs/ajaxful-rating
 licenses: []
 
@@ -93,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ajaxful_rating
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Provides a simple way to add rating functionality to your application.