ratyrate 1.2.0.alpha

data/lib/ratyrate/helpers.rb

@@ -0,0 +1,144 @@
+module Helpers
+  def rating_for(rateable_obj, dimension=nil, options={})
+
+    cached_average = rateable_obj.average dimension
+    avg = cached_average ? cached_average.avg : 0
+
+    star         = options[:star]         || 5
+    enable_half  = options[:enable_half]  || true 
+    half_show    = options[:half_show]    || true 
+    star_path    = options[:star_path]    || "/assets"
+    star_on      = options[:star_on]      || "star-on.png"
+    star_off     = options[:star_off]     || "star-off.png"
+    star_half    = options[:star_half]    || "star-half.png"
+    cancel       = options[:cancel]       || false
+    cancel_place = options[:cancel_place] || "left"
+    cancel_hint  = options[:cancel_hint]  || "Cancel current rating!"
+    cancel_on    = options[:cancel_on]    || "cancel-on.png"
+    cancel_off   = options[:cancel_off]   || "cancel-off.png"
+    noRatedMsg   = options[:noRatedMsg]   || "I'am readOnly and I haven't rated yet!"
+    # round        = options[:round]        || { down: .26, full: .6, up: .76 }
+    space        = options[:space]        || false 
+    single       = options[:single]       || false
+    target       = options[:target]       || ''
+    targetText   = options[:targetText]   || ''
+    targetType   = options[:targetType]   || 'hint'
+    targetFormat = options[:targetFormat] || '{score}'
+    targetScore  = options[:targetScore]  || ''
+
+    disable_after_rate = options[:disable_after_rate] && true
+    disable_after_rate = true if disable_after_rate == nil
+
+    if disable_after_rate
+      readonly = !(current_user && rateable_obj.can_rate?(current_user, dimension))
+    else
+      readonly = false
+    end
+
+    if options[:imdb_avg] && readonly
+      content_tag :div, '', :style => "background-image:url(/assets/mid-star.png);width:61px;height:57px;margin-top:10px;" do
+          content_tag :p, avg, :style => "position:relative;font-size:.8rem;text-align:center;line-height:60px;"
+      end
+    else
+      content_tag :div, '', "data-dimension" => dimension, :class => "star", "data-rating" => avg,
+                  "data-id" => rateable_obj.id, "data-classname" => rateable_obj.class.name,
+                  "data-disable-after-rate" => disable_after_rate,
+                  "data-readonly" => readonly,
+                  "data-enable-half" => enable_half,
+                  "data-half-show" => half_show,
+                  "data-star-count" => star, 
+                  "data-star-path" => star_path,
+                  "data-star-on" => star_on,
+                  "data-star-off" => star_off,
+                  "data-star-half" => star_half,
+                  "data-cancel" => cancel,
+                  "data-cancel-place" => cancel_place,
+                  "data-cancel-hint"  => cancel_hint,
+                  "data-cancel-on" => cancel_on,
+                  "data-cancel-off" => cancel_off,
+                  "data-no-rated-message" => noRatedMsg,
+                  # "data-round" => round,
+                  "data-space" => space,
+                  "data-single" => single,
+                  "data-target" => target,
+                  "data-target-text" => targetText,
+                  "data-target-type" => targetType,
+                  "data-target-format" => targetFormat,
+                  "data-target-score" => targetScore
+    end
+  end
+
+  def imdb_style_rating_for(rateable_obj, user, options = {})
+    overall_avg = rateable_obj.overall_avg(user)
+
+    content_tag :div, '', :style => "background-image:url(/assets/big-star.png);width:81px;height:81px;margin-top:10px;" do
+        content_tag :p, overall_avg, :style => "position:relative;line-height:85px;text-align:center;"
+    end
+  end
+
+  def rating_for_user(rateable_obj, rating_user, dimension = nil, options = {})
+    @object = rateable_obj
+    @user = rating_user
+	  @rating = Rate.find_by_rater_id_and_rateable_id_and_dimension(@user.id, @object.id, dimension)
+	  stars = @rating ? @rating.stars : 0
+
+    star         = options[:star]         || 5
+    enable_half  = options[:enable_half]  || true 
+    half_show    = options[:half_show]    || true 
+    star_path    = options[:star_path]    || "/assets"
+    star_on      = options[:star_on]      || "star-on.png"
+    star_off     = options[:star_off]     || "star-off.png"
+    star_half    = options[:star_half]    || "star-half.png"
+    cancel       = options[:cancel]       || false
+    cancel_place = options[:cancel_place] || "left"
+    cancel_hint  = options[:cancel_hint]  || "Cancel current rating!"
+    cancel_on    = options[:cancel_on]    || "cancel-on.png"
+    cancel_off   = options[:cancel_off]   || "cancel-off.png"
+    noRatedMsg   = options[:noRatedMsg]   || "I'am readOnly and I haven't rated yet!"
+    # round        = options[:round]        || { down: .26, full: .6, up: .76 }
+    space        = options[:space]        || false 
+    single       = options[:single]       || false
+    target       = options[:target]       || ''
+    targetText   = options[:targetText]   || ''
+    targetType   = options[:targetType]   || 'hint'
+    targetFormat = options[:targetFormat] || '{score}'
+    targetScore  = options[:targetScore]  || ''
+
+    disable_after_rate = options[:disable_after_rate] || false
+
+    readonly=false
+    if disable_after_rate
+      readonly = current_user.present? ? !rateable_obj.can_rate?(current_user.id, dimension) : true
+    end
+
+    content_tag :div, '', "data-dimension" => dimension, :class => "star", "data-rating" => stars,
+                "data-id" => rateable_obj.id, "data-classname" => rateable_obj.class.name,
+                "data-disable-after-rate" => disable_after_rate,
+                "data-readonly" => readonly,
+                "data-enable-half" => enable_half,
+                "data-half-show" => half_show,
+                "data-star-count" => stars, 
+                "data-star-path" => star_path,
+                "data-star-on" => star_on,
+                "data-star-off" => star_off,
+                "data-star-half" => star_half,
+                "data-cancel" => cancel,
+                "data-cancel-place" => cancel_place,
+                "data-cancel-hint"  => cancel_hint,
+                "data-cancel-on" => cancel_on,
+                "data-cancel-off" => cancel_off,
+                "data-no-rated-message" => noRatedMsg,
+                # "data-round" => round,
+                "data-space" => space,
+                "data-single" => single,
+                "data-target" => target,
+                "data-target-text" => targetText,
+                "data-target-format" => targetFormat,
+                "data-target-score" => targetScore
+  end
+
+end
+
+class ActionView::Base
+  include Helpers
+end

data/lib/ratyrate/model.rb

@@ -0,0 +1,153 @@
+require 'active_support/concern'
+module Ratyrate
+  extend ActiveSupport::Concern
+
+  def rate(stars, user, dimension=nil, dirichlet_method=false)
+    dimension = nil if dimension.blank?
+
+    if can_rate? user, dimension
+      rates(dimension).create! do |r|
+        r.stars = stars
+        r.rater = user
+      end
+      if dirichlet_method
+        update_rate_average_dirichlet(stars, dimension)
+      else
+        update_rate_average(stars, dimension)
+      end
+    else
+      update_current_rate(stars, user, dimension)
+    end
+  end
+
+  def update_rate_average_dirichlet(stars, dimension=nil)
+    ## assumes 5 possible vote categories
+    dp = {1 => 1, 2 => 1, 3 => 1, 4 => 1, 5 => 1}
+    stars_group = Hash[rates(dimension).group(:stars).count.map{|k,v| [k.to_i,v] }]
+    posterior = dp.merge(stars_group){|key, a, b| a + b}
+    sum = posterior.map{ |i, v| v }.inject { |a, b| a + b }
+    davg = posterior.map{ |i, v| i * v }.inject { |a, b| a + b }.to_f / sum
+
+    if average(dimension).nil?
+      RatingCache.create! do |avg|
+        avg.cacheable_id = self.id
+        avg.cacheable_type = self.class.name
+        avg.qty = 1
+        avg.avg = davg
+        avg.dimension = dimension
+      end
+    else
+      a = average(dimension)
+      a.qty = rates(dimension).count
+      a.avg = davg
+      a.save!(validate: false)
+    end
+  end
+  
+  def update_rate_average(stars, dimension=nil)
+    if average(dimension).nil?
+      RatingCache.create! do |avg|
+        avg.cacheable_id = self.id
+        avg.cacheable_type = self.class.name
+        avg.avg = stars
+        avg.qty = 1
+        avg.dimension = dimension
+      end
+    else
+      a = average(dimension)
+      a.qty = rates(dimension).count
+      a.avg = rates(dimension).average(:stars)
+      a.save!(validate: false)
+    end
+  end
+
+  def update_current_rate(stars, user, dimension)
+    current_rate = user.ratings_given.where(rater_id: user.id, rateable_id: self.id, dimension: dimension).take
+    current_rate.stars = stars
+    current_rate.save!(validate: false)
+
+    if rates(dimension).count > 1
+      update_rate_average(stars, dimension)
+    else # Set the avarage to the exact number of stars
+      a = average(dimension)
+      a.avg = stars
+      a.save!(validate: false)
+    end
+  end
+
+  def overall_avg(user)
+    # avg = OverallAverage.where(rateable_id: self.id)
+    # #FIXME: Fix the bug when the movie has no ratings
+    # unless avg.empty? 
+    #   return avg.take.avg unless avg.take.avg == 0
+    # else # calculate average, and save it
+    #   dimensions_count = overall_score = 0
+    #   user.ratings_given.select('DISTINCT dimension').each do |d|
+    #     dimensions_count = dimensions_count + 1
+    #     unless average(d.dimension).nil?
+    #       overall_score = overall_score + average(d.dimension).avg 
+    #     end
+    #   end
+    #   overall_avg = (overall_score / dimensions_count).to_f.round(1)
+    #   AverageCache.create! do |a|
+    #     a.rater_id = user.id
+    #     a.rateable_id = self.id
+    #     a.avg = overall_avg
+    #   end
+    #   overall_avg
+    # end
+  end
+  
+  # calculate the movie overall average rating for all users
+  def calculate_overall_average
+  end
+
+  def average(dimension=nil)
+    dimension ? self.send("#{dimension}_average") : rate_average_without_dimension
+  end
+
+  def can_rate?(user, dimension=nil)
+    user.ratings_given.where(dimension: dimension, rateable_id: id, rateable_type: self.class.name).size.zero?
+  end
+
+  def rates(dimension=nil)
+    dimension ? self.send("#{dimension}_rates") : rates_without_dimension
+  end
+
+  def raters(dimension=nil)
+    dimension ? self.send("#{dimension}_raters") : raters_without_dimension
+  end
+
+  module ClassMethods
+
+    def ratyrate_rater
+      has_many :ratings_given, :class_name => "Rate", :foreign_key => :rater_id
+    end
+
+    def ratyrate_rateable(*dimensions)
+      has_many :rates_without_dimension, -> { where dimension: nil}, :as => :rateable, :class_name => "Rate", :dependent => :destroy
+      has_many :raters_without_dimension, :through => :rates_without_dimension, :source => :rater
+
+      has_one :rate_average_without_dimension, -> { where dimension: nil}, :as => :cacheable,
+              :class_name => "RatingCache", :dependent => :destroy
+
+      dimensions.each do |dimension|
+        has_many "#{dimension}_rates".to_sym, -> {where dimension: dimension.to_s},
+                                              :dependent => :destroy,
+                                              :class_name => "Rate",
+                                              :as => :rateable
+
+        has_many "#{dimension}_raters".to_sym, :through => "#{dimension}_rates", :source => :rater
+
+        has_one "#{dimension}_average".to_sym, -> { where dimension: dimension.to_s },
+                                              :as => :cacheable, :class_name => "RatingCache",
+                                              :dependent => :destroy
+      end
+    end
+  end
+
+end
+
+class ActiveRecord::Base
+  include Ratyrate
+end

data/lib/ratyrate/version.rb

@@ -0,0 +1,3 @@
+module Ratyrate
+  VERSION = "1.2.0.alpha"
+end

data/lib/ratyrate.rb

@@ -0,0 +1,7 @@
+require "ratyrate/version" 
+require "ratyrate/model" 
+require "ratyrate/helpers" 
+
+module Ratyrate
+    
+end

data/ratyrate.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ratyrate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ratyrate"
+  s.version     = Ratyrate::VERSION
+  s.authors     = ["Islam Wazery"]
+  s.email       = ["wazery@ubuntu.com"]
+  s.homepage    = "http://github.com/wazery/ratyrate"
+  s.summary     = %q{A Ruby Gem that provides the same functionality of jQuery Raty library, and adds IMDB style rating.}
+  s.description = %q{A Ruby Gem that provides the same functionality of jQuery Raty library, and adds IMDB style rating.}
+
+  s.rubyforge_project = "ratyrate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: ratyrate
+version: !ruby/object:Gem::Version
+  version: 1.2.0.alpha
+platform: ruby
+authors:
+- Islam Wazery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby Gem that provides the same functionality of jQuery Raty library,
+  and adds IMDB style rating.
+email:
+- wazery@ubuntu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/generators/ratyrate/USAGE
+- lib/generators/ratyrate/ratyrate_generator.rb
+- lib/generators/ratyrate/templates/average_cache_migration.rb
+- lib/generators/ratyrate/templates/average_cache_model.rb
+- lib/generators/ratyrate/templates/big-star.png
+- lib/generators/ratyrate/templates/cache_migration.rb
+- lib/generators/ratyrate/templates/cache_model.rb
+- lib/generators/ratyrate/templates/cancel-off.png
+- lib/generators/ratyrate/templates/cancel-on.png
+- lib/generators/ratyrate/templates/jquery.raty.js
+- lib/generators/ratyrate/templates/mid-star.png
+- lib/generators/ratyrate/templates/migration.rb
+- lib/generators/ratyrate/templates/model.rb
+- lib/generators/ratyrate/templates/overall_average_migration.rb
+- lib/generators/ratyrate/templates/overall_average_model.rb
+- lib/generators/ratyrate/templates/rater_controller.rb
+- lib/generators/ratyrate/templates/ratyrate.js.erb
+- lib/generators/ratyrate/templates/star-half.png
+- lib/generators/ratyrate/templates/star-off.png
+- lib/generators/ratyrate/templates/star-on.png
+- lib/ratyrate.rb
+- lib/ratyrate/helpers.rb
+- lib/ratyrate/model.rb
+- lib/ratyrate/version.rb
+- ratyrate.gemspec
+homepage: http://github.com/wazery/ratyrate
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: ratyrate
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem that provides the same functionality of jQuery Raty library, and
+  adds IMDB style rating.
+test_files: []