acts_rateable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,140 @@
+# ActsRateable
+
+ActsRateable is a Rails 3 ruby gem designed to enable bi-directional polymorphic rating - users rate companies, companies rate users.  It records individual rates and caches ratings, enable quick ordering of resources by rating.
+
+The cached ratings contain four different points of data:
+
+		:total  => rate count
+		:average => rate average
+		:sum => rate sum
+		:estimate => rate estimate
+
+The estimate is probably the most useful of the data points, as it provides a weighted score based on the number of times the resource has been rated.
+
+To determine this estimate, the gem calculates a bayesian estimate, as inspired by IMDB's top 250 list.
+
+## Inspiration
+
+The formula for calculating the Top Rated 250 Titles gives a true Bayesian estimate:
+
+weighted rating (WR) = (v ÷ (v+m)) × R + (m ÷ (v+m)) × C 
+
+Where:
+
+  R = average for the movie (mean) = (Rating)
+  v = number of votes for the movie = (votes)
+  m = minimum votes required to be listed in the Top 250
+  C = the mean vote across the whole report (currently 7.1)
+
+## Implementation
+
+	* R = average rating for resource
+	* v = number of ratings for resource
+	* m = average number of votes
+	* C = average rating of all resources
+
+## Installation
+
+1) Include the gem in your rails project gem file.
+
+		gem 'acts_rateable'
+
+2) Run 'bundle install'.
+
+3) Add 'acts_rateable' to the models you wish to have the ability to rate or be rated.
+
+## Usage
+
+### author.rate( resource, value )
+
+To rate a resource:
+
+		author.rate( resource, value )
+
+For example,
+
+		current_user.rate( post, 5 )
+
+### resource.rated_by?( author )
+
+To test whether a resource has been rated an author:
+
+		post.rate?( author )
+
+The rate will be returned in the user has rated the resource, otherwise false will be returned.
+
+### author.has_rated?( resource )
+
+To test whether an author has rated a resource:
+
+		current_user.has_rated?( post )
+
+The rate will be returned in the user has rated the resource, otherwise false will be returned.
+
+
+### resource.rating
+
+To get the current rating for a resource:
+
+		post.rating
+
+By default, the bayesian estimate for that rating will be returned.
+
+### resource.rating( column )
+
+Four types of data are cached for every resource rated: 
+
+		:total  => rate count
+		:average => rate average
+		:sum => rate sum
+		:estimate => rate estimate
+
+For example:
+
+		post.rating( :total )
+
+Will return the rate count.
+
+		post.rating( :average )
+
+Will return the rate average.
+
+		post.rating( :sum )
+
+Will return the rate sum.
+
+		post.rating( :estimate )
+
+Will return the rate estimate.
+
+### resource.variation(author)
+
+To find out how close or far off the author was in their rating from the resource estimate:
+
+		post.variation(author)
+
+Will return a percentage of deviation.
+
+### order_by(column, direction)
+
+Any rateable resource may be ordered by any of the four cached data points, in either direction: DESC, ASC.
+
+For example:
+
+	Post.order_by(:estimate, 'DESC')
+
+Will return all posts ordered by estimate in descending order.
+
+## Support
+
+For issues, problems or bugs, please post an issue, here:
+  
+  https://github.com/tyrauber/acts_rateable/issues
+
+## Future Development
+
+For future development:
+
+  1) fork the repository
+  2) extend the functionality
+  3) issue pull request

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsRateable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/acts_rateable.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'acts_rateable/version'
+require 'acts_rateable/acts_rateable'
+require 'acts_rateable/rate.rb'
+require 'acts_rateable/rating.rb'

data/lib/acts_rateable/acts_rateable.rb

@@ -0,0 +1,59 @@
+module ActsRateable
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  module ClassMethods
+    
+    def acts_rateable(options = {})
+      
+      has_many :rates, class_name: ActsRateable::Rate, as: :resource, dependent: :destroy
+      has_many :rated, class_name: ActsRateable::Rate, as: :author, dependent: :destroy
+      has_one :ratings, class_name: ActsRateable::Rating, as: :resource, dependent: :destroy
+      
+      # Resource.order_by(column, direction)
+      # => column: total, average, sum, estimate
+      # => direction: DESC, ASC
+      
+      scope :order_by, lambda { | column='estimate', direction="DESC" | includes(:ratings).order("ar_ratings.#{column.downcase} #{direction.upcase}") }
+      
+      before_save do
+         ActsRateable::Rating.create(self) if !rates.empty?
+      end
+      
+      include LocalInstanceMethods
+      
+    end
+  end
+
+  module LocalInstanceMethods
+    
+    #   Returns the resource rating
+    #   column: total, sum, average and estimate
+    def rating(column='estimate')
+      ActsRateable::Rating.data_for(self)[column]
+    end
+    
+    def variation(author)
+      (rated_by?(author).value/ActsRateable::Rating.data_for(self)['estimate'])
+    end
+    
+    # Checks wheter a resource has been rated by a user. Returns the rating if true, otherwise returns false.
+    def rated_by?( author )
+      ActsRateable::Rate.rated?(self, author)
+    end
+    
+    # Checks wheter a user rated a resource. Returns the rating if true, otherwise returns false.
+    def has_rated?( resource )
+      ActsRateable::Rate.rated?(resource, self)
+    end
+    
+  	# Rates a resource by an author with a given value.
+		def rate( resource, value )
+      ActsRateable::Rate.create(self, resource, value)
+		end
+
+  end
+end
+ActiveRecord::Base.send :include, ActsRateable

data/lib/acts_rateable/rate.rb

@@ -0,0 +1,46 @@
+module ActsRateable
+  class Rate < ActiveRecord::Base
+
+    self.table_name = "ar_rates"
+
+    belongs_to :resource, polymorphic: true
+    belongs_to :author, polymorphic: true
+  
+    validates :author, :resource, :value, presence: true
+  
+    validates_numericality_of :value, :greater_than_or_equal_to => 1, :less_than_or_equal_to => 100
+  	validates_uniqueness_of :author_id, :scope => [:author_type, :resource_id, :resource_type]
+	
+  	attr_accessible :resource_id, :resource_type, :author_type, :author_id, :value
+  
+    after_save :generate_estimate
+  
+    def self.rated?(resource, author)
+      rate = where({
+        author_type: author.class.name, author_id: author.id, 
+        resource_type: resource.class.name, resource_id: resource.id
+      })
+      return rate if rate
+      return false
+    end
+    
+    def self.create(author, resource, value)
+      return unless author && resource && value
+			atts = { 
+			  resource_type: resource.class.name, resource_id: resource.id, 
+			  author_type: author.class.name, author_id: author.id,
+			  value: value
+			}
+			rate = where(atts.except(:value)).first_or_initialize(atts)
+			rate.value = value
+      rate.save
+      return rate
+    end
+
+    private
+  
+    def generate_estimate
+      ActsRateable::Rating.create(resource)
+    end
+  end
+end

data/lib/acts_rateable/rating.rb

@@ -0,0 +1,55 @@
+module ActsRateable
+  class Rating < ActiveRecord::Base
+    
+    self.table_name = "ar_ratings"
+    
+    belongs_to :resource, polymorphic: true
+    has_many :rates, through: :ratings, as: :resource
+    
+  	attr_accessible :resource_id, :resource_type, :total, :sum, :average, :estimate
+  
+    validates :resource, :total, :sum, :average, :estimate, presence: true
+    validates_numericality_of :total, :sum, :average, :estimate
+
+  	@@global_ratings = {} 
+
+    def self.set_totals(resource)
+     sql = "SELECT COUNT(*) total_ratings, SUM(value) rating_sum, AVG(value) rating_avg, "+
+            "(SELECT COUNT(DISTINCT resource_id) FROM ar_rates WHERE resource_type = '#{resource.class.name}') rated_count, "+
+            "((SELECT COUNT(*) from ar_rates WHERE resource_type = '#{resource.class.name}') / (SELECT COUNT(DISTINCT resource_id) FROM ar_rates WHERE resource_type = '#{resource.class.name}')) avg_num_ratings "+
+            "FROM ar_rates WHERE resource_type = '#{resource.class.name}'"
+            @@global_ratings[resource.class.name] = ActsRateable::Rate.connection.execute(sql).first
+    end
+
+  	#  RETURNS = { "total_ratings"=>"", "rating_sum"=>"", "rating_avg"=>"", "rated_count"=>"", "avg_num_ratings"=>"" }
+    def self.get_totals(resource)
+      @@global_ratings[resource.class.name] ||= set_totals(resource)
+    end
+
+    # RETURNS = {"total_ratings"=>"", "rating_sum"=>"", "rating_avg"=>""}
+    def self.values_for(resource)    
+      sql =   "SELECT COUNT(*) total_ratings, COALESCE(SUM(value),0) rating_sum, COALESCE(AVG(value),0) rating_avg "+
+              "FROM ar_rates WHERE resource_type = '#{resource.class.name}' and resource_id = '#{resource.id}'"
+              ActsRateable::Rate.connection.execute(sql).first
+    end
+
+    def self.data_for(resource)
+      local     = values_for(resource)
+      global    = get_totals(resource)
+      estimate  = (local['total_ratings'].to_f / (local['total_ratings'].to_f+global['avg_num_ratings'].to_f)) * local['rating_avg'].to_f + (global['avg_num_ratings'].to_f / (local['total_ratings'].to_f+global['avg_num_ratings'].to_f)) *global['rating_avg'].to_f
+      return    { 'global' => global, 'local' => local.merge!({ 'estimate' => estimate }) }
+    end
+    
+    def self.create(resource)
+      record          = where({ resource_type: resource.class.name, resource_id: resource.id }).first_or_initialize
+      result          = data_for(resource)
+      record.total    = result['local']['total_ratings']
+      record.average  = result['local']['rating_avg']
+      record.sum      = result['local']['rating_sum']
+      record.estimate = result['local']['estimate']
+      if record.save
+        set_totals(resource) # Reset global values
+      end
+    end
+  end
+end

data/lib/acts_rateable/version.rb

@@ -0,0 +1,3 @@
+module ActsRateable
+  VERSION = "0.0.1"
+end

data/lib/generators/acts_rateable/acts_rateable_generator.rb

@@ -0,0 +1,22 @@
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActsRateableGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/acts_rateable_migration.rb'
+  end
+end

data/lib/generators/acts_rateable/templates/migration.rb

@@ -0,0 +1,28 @@
+class ActsRateableMigration < ActiveRecord::Migration
+
+  def self.up
+    create_table :ar_rates do |t|
+      t.references :resource, :polymorphic => true, :null => false
+      t.references :author, :polymorphic => true, :null => false
+      t.integer :value, :default => 0
+      t.timestamps
+    end
+    add_index :ar_rates, [:resource_id, :resource_type]
+    add_index :ar_rates, [:author_id, :author_type]
+    
+    create_table :ar_ratings do |t|
+      t.references :resource, :polymorphic => true, :null => false
+      t.integer :total, :default => 0
+      t.integer :sum, :default => 0
+      t.decimal :average, :default => 0
+      t.decimal :estimate, :default => 0
+      t.timestamps
+    end
+    add_index :ar_ratings, [:resource_id, :resource_type]
+  end
+
+  def self.down
+    drop_table :ar_rates
+    drop_table :ar_ratings
+  end
+end

data/test/acts_rateable_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActsRateableTest < ActiveSupport::TestCase
+
+
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.