acts_as_rateable 2.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,11 @@
+== 2.0 released 2009-7-22
+
+* Refactored database structure for better performance: the average rating and ratings count are now pre-computed and updated when new ratings are recorded
+* The API now requires consistently the user object instead of the user_id
+* Added testing framework and unit tests
+* Made available as ruby gem
+
+== 1.0 released 2008
+
+* The original acts_as_rateable plugin, first release by Ferenc Fekete
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,77 @@
+= Acts As Rateble
+
+Acts_as_rateable is a rails plugin providing a rating interface for ActiveRecord models. 
+It is released under the MIT license. 
+The original plugin is used on cotcot.hu for article rating, sponsored quizzes, etc.
+
+= Features
+
+* Rating scores are recorded by user
+* Users can update previous ratings
+* Uses a polymorphic association to your model, so no changes to your existing models in the database are required
+* Stores computed score and number of ratings for efficient data access
+* Possibility to change range of the ratings (1..5 is default)
+
+= Installation
+
+== Install as gem (recommended)
+
+Install as a gem:
+
+    $ sudo gem install mreinsch-acts_as_rateable
+
+Then add the gem dependency in your config:
+
+    # config/environment.rb
+    config.gem "mreinsch-acts_as_rateable", :source => "http://gems.github.com", :lib => "acts_as_rateable"
+
+== Install as plugin
+
+To install as a plugin, use:
+
+    $ ./script/plugin install git://github.com/mreinsch/acts_as_rateable.git
+
+= Example Usage
+
+Install the plugin into your vendor/plugins directory, insert 'acts_as_rateable' into your model, then restart your application.
+
+    class Post < ActiveRecord::Base
+      acts_as_rateable
+    end
+
+Now your model is extended by the plugin, you can rate it (1-#) or calculate the average rating.
+
+    @post.rate_it(4, current_user)
+
+    @post.average_rating          #=> 4.0
+    @post.average_rating_round    #=> 4
+    @post.average_rating_percent  #=> 80
+    @post.rated_by?(current_user) #=> true
+    @post.rating_by(current_user) #=> 4
+    @post.ratings_couunt          #=> 1
+
+    Post.find_top_rated           #=> top rated records
+
+Optional you can specify the highest score using the :max_rating paramter as follows. The default for :max_rating is 5.
+
+    class Comment < ActiveRecord::Base
+      acts_as_rateable :max_rating => 10
+    end
+
+See acts_as_rateable.rb for further details!
+
+= Updating
+
+== Updating from Ferenc Fekete's acts_as_rateable v1.0
+
+1. Remove the old plugin, and install this version.
+1. Check your code and make sure you pass the user object instead of the user ID for the rate_it, rated_by? and rating_by methods.
+1. Generate an update migration using: ./script/generate acts_as_rateable_update1
+1. Run your test cases
+
+
+= Copyright
+
+Copyright (c) 2007 Ferenc Fekete, http://xpnindustries.com , released under the MIT license
+
+Copyright (c) 2009 mobalean LLC, http://www.mobalean.com

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_ratable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_ratable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsRatable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/acts_as_rateable_migration/acts_as_rateable_migration_generator.rb

@@ -0,0 +1,7 @@
+class ActsAsRateableMigrationGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "acts_as_rateable_migration"
+    end
+  end
+end

data/generators/acts_as_rateable_migration/templates/migration.rb

@@ -0,0 +1,24 @@
+class ActsAsRateableMigration < ActiveRecord::Migration
+  def self.up
+    create_table "ratings" do |t|
+      t.references "rateable",       :polymorphic => true, :nil => false
+      t.float      "average_rating"
+      t.integer    "ratings_count"
+      t.timestamps
+    end
+    add_index "ratings", ["rateable_id", "rateable_type"]
+
+    create_table "user_ratings" do |t|
+      t.references "rating", :nil => false
+      t.references "user",   :nil => false
+      t.integer    "score",  :nil => false
+      t.timestamps
+    end
+    add_index "user_ratings", ["user_id", "rating_id"]
+  end
+
+  def self.down
+    drop_table "user_ratings"
+    drop_table "ratings"
+  end
+end

data/generators/acts_as_rateable_update1/acts_as_rateable_update1_generator.rb

@@ -0,0 +1,7 @@
+class ActsAsRateableUpdate1Generator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "acts_as_rateable_update1"
+    end 
+  end
+end

data/generators/acts_as_rateable_update1/templates/migration.rb

@@ -0,0 +1,48 @@
+class ActsAsRateableUpdate1 < ActiveRecord::Migration
+  def self.up
+    rename_table "rates", "old_rates"
+    rename_table "ratings", "old_ratings"
+
+    create_table "ratings" do |t|
+      t.references "rateable",       :polymorphic => true, :nil => false
+      t.float      "average_rating"
+      t.integer    "ratings_count"
+      t.timestamps
+    end
+    add_index "ratings", ["rateable_id", "rateable_type"]
+
+    create_table "user_ratings" do |t|
+      t.references "rating", :nil => false
+      t.references "user",   :nil => false
+      t.integer    "score",  :nil => false
+      t.timestamps
+    end
+    add_index "user_ratings", ["user_id", "rating_id"]
+
+    say_with_time "migrating exsting ratings" do
+      connection.transaction do
+        sql = "SELECT rateable_id, rateable_type, user_id, score, old_ratings.created_at, old_ratings.updated_at " +
+          "FROM old_ratings INNER JOIN old_rates ON old_ratings.rate_id = old_rates.id"
+        connection.select_all(sql).each do |row|
+          rating = Rating.find_or_create_by_rateable_id_and_rateable_type(
+            :rateable_id => row['rateable_id'],
+            :rateable_type => row['rateable_type'],
+            :created_at => row['created_at'])
+          rating.user_ratings.find_or_create_by_user_id(
+            :user_id => row['user_id'],
+            :score => row['score'],
+            :created_at => row['created_at'],
+            :updated_at => row['updated_at'])
+        end
+        Rating.find(:all).each {|rating| rating.update_rating }
+      end
+    end
+
+    drop_table "old_rates"
+    drop_table "old_ratings"
+  end
+
+  def self.down
+    raise ActiveRecord::IrreversibleMigration, "Can't recover old ratings tables"
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/acts_as_rateable.rb

@@ -0,0 +1,80 @@
+module ActiveRecord
+  module Acts
+    module Rateable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_rateable(options = {})
+          has_one :rating, :as => :rateable, :dependent => :destroy
+
+          unless respond_to?(:max_rating)
+            class_inheritable_accessor :max_rating
+            attr_protected :max_rating
+            self.max_rating = options[:max_rating] || 5
+          end
+
+          include ActiveRecord::Acts::Rateable::ClassMethods
+          include ActiveRecord::Acts::Rateable::InstanceMethods
+        end
+      end
+
+      module ClassMethods
+        # Returns the top rated records, ordered by their average rating.
+        # You can use the usual finder parameters to narrow down the records
+        # to return.
+        # The finder limits the number of returned records to 20 by default.
+        # Specify :limit to change it.
+        def find_top_rated(params = {})
+          find_params = params.merge(:include => :rating)
+          find_params[:order] = ['ratings.average_rating DESC', find_params.delete(:order)].compact.join(", ")
+          find_params[:limit] = 20 unless find_params.key?(:limit)
+          find(:all, find_params)
+        end
+      end
+
+      module InstanceMethods
+        # Rates the object by a given score. A user object should be passed to the method.
+        def rate_it(score, user)
+          create_rating unless rating
+          rating.rate(score, user)
+        end
+
+        # Returns the average rating. Calculation based on the already given scores.
+        def average_rating
+          rating && rating.average_rating || 0.0
+        end
+
+        # Rounds the average rating value.
+        def average_rating_round
+          average_rating.round
+        end
+
+        # Returns the average rating in percent.
+        def average_rating_percent
+          f = 100 / max_rating.to_f
+          average_rating * f
+        end
+
+        # Returns the number of ratings.
+        def ratings_count
+          rating && rating.ratings_count || 0
+        end
+
+        # Checks whether a user rated the object or not.
+        def rated_by?(user)
+          rating && rating.user_ratings.exists?(:user_id => user)
+        end
+
+        # Returns the rating a specific user has given the object.
+        def rating_by(user)
+          user_rating = rating && rating.user_ratings.find_by_user_id(user.id)
+          user_rating ? user_rating.score : nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rating.rb

@@ -0,0 +1,21 @@
+class Rating < ActiveRecord::Base
+  belongs_to :rateable, :polymorphic => true
+  has_many :user_ratings
+
+  delegate :max_rating, :to => :rateable
+
+  def rate(score, user)
+    user_ratings.find_or_initialize_by_user_id(user.id).update_attributes!(:score => score)
+    reload
+  end
+
+  # Call this method the update the avarage rating; you don't normally need to
+  # do this manually, saving or updating a user rating already takes care of
+  # updating the avarage rating.
+  def update_rating
+    self.average_rating = user_ratings.average(:score)
+    self.ratings_count = user_ratings.count
+    save!
+  end
+
+end

data/lib/user_rating.rb

@@ -0,0 +1,24 @@
+class UserRating < ActiveRecord::Base
+  belongs_to :rating
+
+  delegate :max_rating, :to => :rating
+
+  validates_presence_of :score
+  validates_uniqueness_of :user_id, :scope => :rating_id
+  validate :max_rating_allowed_by_parent
+
+  after_save do |user_rating|
+    user_rating.rating.update_rating
+  end
+
+  private
+
+  def max_rating_allowed_by_parent
+    if score < 1
+      errors.add(:score, "must be greater than or equal to 1")
+    elsif score > max_rating
+      errors.add(:score, "must be less than or equal to #{max_rating}")
+    end
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'acts_as_rateable'
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Rateable)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_rateable
+version: !ruby/object:Gem::Version 
+  version: 2.0.1
+platform: ruby
+authors: 
+- Ferenc Fekete
+- Gabriel Gironda
+- Michael Reinsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Acts_as_rateable is a rails plugin providing a rating interface for ActiveRecord models.
+email: michael@mobalean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- MIT-LICENSE
+files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- init.rb
+- rails/init.rb
+- lib/rating.rb
+- lib/user_rating.rb
+- lib/acts_as_rateable.rb
+- generators/acts_as_rateable_update1/templates/migration.rb
+- generators/acts_as_rateable_update1/acts_as_rateable_update1_generator.rb
+- generators/acts_as_rateable_migration/templates/migration.rb
+- generators/acts_as_rateable_migration/acts_as_rateable_migration_generator.rb
+has_rdoc: true
+homepage: http://github.com/mreinsch/acts_as_rateable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails plugin providing a rating interface for ActiveRecord models
+test_files: []
+