seems_rateable 1.0.6 → 1.0.7

data/lib/generators/seems_rateable/{templates/rate_migration.rb → install/templates/rates_migration.rb}

@@ -1,6 +1,6 @@
-class CreateRates < ActiveRecord::Migration
+class CreateSeemsRateableRates < ActiveRecord::Migration
   def self.up
-    create_table :rates do |t|
+    create_table :seems_rateable_rates do |t|
       t.belongs_to :rater
       t.belongs_to :rateable, :polymorphic => true
       t.float :stars, :null => false
@@ -10,9 +10,6 @@ class CreateRates < ActiveRecord::Migration
       t.string :dimension
       t.timestamps
     end
-    
-    #add_index :rates, :rater_id
-    #add_index :rates, [:rateable_id, :rateable_type]
   end
 
   def self.down

data/lib/seems_rateable/engine.rb

@@ -0,0 +1,17 @@
+module SeemsRateable
+  class Engine < ::Rails::Engine
+    isolate_namespace SeemsRateable
+   
+    config.generators do |g|
+		g.test_framework :rspec, :fixture => false
+		g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+    
+    initializer :seems_rateable do
+		ActiveRecord::Base.send :include, SeemsRateable::Model
+		ActionView::Base.send :include, SeemsRateable::Helpers
+		ActionDispatch::Routing::Mapper.send :include, SeemsRateable::Routes
+    end
+        
+  end
+end

data/lib/seems_rateable/errors.rb

@@ -0,0 +1,21 @@
+module SeemsRateable
+	module Errors
+		class InvalidRateableObjectError < StandardError
+			def to_s
+				"Stated object is not rateable. Add 'seems_rateable' to your object's class model."
+			end
+		end
+		
+		class NoCurrentUserInstanceError < StandardError
+			def to_s
+				"User instance current_user is not available."
+			end
+		end
+		
+		class AlreadyRatedError < StandardError
+			def to_s
+				"User has already rated an object."
+			end
+		end	
+	end
+end

data/lib/seems_rateable/helpers.rb

@@ -1,23 +1,27 @@
-module Helpers
-  	def seems_rateable_style
-  		stylesheet_link_tag "rateable/jRating.jquery"
-  	end
-  		
-  	def rating_for(obj, opts={:dimension => nil, :static => false, :id => nil}) 	  
-  	   begin
-  			kls = opts[:dimension].nil? ? obj.average : obj.average(opts[:dimension])
-  			avg = kls ? kls.avg : 0
-  			content_tag :div, "", "data-average" => avg,
-  			:id => opts[:id],
-        :class => "rateable#{opts[:static] ? " jDisabled" : nil}#{current_user ? nil : " jDisabled"}",
-        "data-id" => obj.id, "data-kls" => obj.class.name,
-        "data-dimension" => opts[:dimension]      
-  		rescue StandardError => error
-  			eval "raise 'Rateable object #{obj.inspect} does not exist'"
-  		end
-  	end
-  end
-
-class ActionView::Base
-	include Helpers
-end	
+module SeemsRateable
+	module Helpers  		
+		def rating_for(obj, opts={})
+			raise Errors::InvalidRateableObjectError unless obj.class.respond_to?(:rateable?) 
+			
+			options = {
+				:dimension => nil,
+				:static => false,
+				:class => 'rateable',
+				:id => nil
+			}.update(opts)
+				  	
+			content_tag :div, "", "data-average" => obj.average(options[:dimension]) ? obj.average(options[:dimension]).avg : 0, :id => options[:id],
+							:class => "#{options[:class]}#{jdisabled?(options[:static])}",
+							"data-id" => obj.id, "data-kls" => obj.class.name, "data-dimension" => options[:dimension]    
+		end
+		
+		def seems_rateable_stylesheet
+			stylesheet_link_tag "seems_rateable/jRating.jquery" 
+		end
+		
+		private
+		def jdisabled?(option)
+			" jDisabled" if option || !current_user
+		end
+	end
+end

data/lib/seems_rateable/model.rb

@@ -0,0 +1,111 @@
+require 'active_support/concern'
+module SeemsRateable
+	module Model
+		extend ActiveSupport::Concern
+			
+		def rate(stars, user_id, dimension=nil)
+			if !has_rated?(user_id, dimension)   
+			  self.rates.create do |r| 
+				 r.stars = stars
+				 r.rater_id = user_id 
+			  end
+			  update_overall_average_rating(stars, dimension) 
+			elsif has_rated?(user_id, dimension) && can_update?
+			  update_users_rating(stars, user_id, dimension)    
+			else
+			  raise Errors::AlreadyRatedError  
+			end		
+		end
+			
+		def update_overall_average_rating(stars, dimension=nil)
+			 if average(dimension).nil?
+			  CachedRating.create do |r|
+				 r.avg = stars
+				 r.dimension = dimension
+				 r.cacheable_id = self.id
+				 r.cacheable_type = self.class.name
+				 r.cnt = 1
+			  end						                   
+			 else
+				r = average(dimension)
+				r.avg = (r.avg * r.cnt + stars) / (r.cnt+1)
+				r.cnt += 1
+				r.save!
+			 end   
+		end  
+			
+		def update_users_rating(stars, user_id, dimension=nil)
+			obj = rates(dimension).where(:rater_id => user_id).first
+			current_record = average(dimension)
+			current_record.avg = (current_record.avg*current_record.cnt - obj.stars + stars) / (current_record.cnt)
+			current_record.save!
+			obj.stars = stars
+			obj.save!
+		end
+			
+			
+		def average(dimension=nil)
+		 if dimension.nil?
+			self.send "rate_average_without_dimension"
+		 else
+			self.send "#{dimension}_average"
+		 end      
+		end
+			
+		def rates(dimension=nil)
+			if dimension.nil?
+			 self.send "rates_without_dimension"
+			else
+			 self.send "#{dimension}_rates"
+			end
+		 end
+		
+		def raters(dimension=nil)
+			if dimension.nil?
+				self.send "raters_without_dimension"
+			else
+				self.send "#{dimension}_raters"
+			end
+		end
+			
+		def has_rated?(user_id, dimension=nil)
+			record = self.rates(dimension).where(:rater_id => user_id)  
+			record.empty? ? false : true				       
+		end 	  
+			
+		def can_update?
+			self.class.can_update?
+		end
+
+		module ClassMethods
+		  def seems_rateable(opts={})               
+			#has_many :rates_without_dimension, -> { where(dimension: nil) }, :as => :rateable, :class_name => SeemsRateable::Rate, :dependent => :destroy			  
+			has_many :rates_without_dimension, :conditions => { dimension: nil }, :as => :rateable, :class_name => SeemsRateable::Rate, :dependent => :destroy			  
+			has_many :raters_without_dimension, :through => :rates_without_dimension, :source => :rater 
+			has_one :rate_average_without_dimension, :conditions => { dimension: nil }, :as => :cacheable, :class_name => SeemsRateable::CachedRating, :dependent => :destroy
+			  
+			@permission = opts[:allow_update] ? true : false		 
+			 
+			def self.can_update?	 		 
+			 @permission
+			end
+			  
+			def self.rateable?
+			 true
+			end
+			  
+				if opts[:dimensions].is_a?(Array)
+					opts[:dimensions].each do |dimension|        
+						has_many :"#{dimension}_rates", :conditions => { dimension: dimension.to_s }, :dependent => :destroy, :class_name => SeemsRateable::Rate, :as => :rateable
+						has_many :"#{dimension}_raters", :through => :"#{dimension}_rates", :source => :rater         
+						has_one :"#{dimension}_average", :conditions => { dimension: dimension.to_s }, :as => :cacheable, :class_name => SeemsRateable::CachedRating, :dependent => :destroy
+					end
+				end	 	 					
+			end
+		  
+			def seems_rateable_rater
+			 has_many :ratings_given, :class_name => SeemsRateable::Rate, :foreign_key => :rater_id
+			end	
+		end
+	end
+end

data/lib/seems_rateable/routes.rb

@@ -0,0 +1,7 @@
+module SeemsRateable
+  module Routes
+    def seems_rateable
+      mount SeemsRateable::Engine => '/rateable', :as => :rateable
+    end
+  end
+end

data/lib/seems_rateable/version.rb

@@ -1,3 +1,3 @@
 module SeemsRateable
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/lib/seems_rateable.rb

@@ -1,6 +1,14 @@
-require "seems_rateable/version"
+begin
+ require 'rails' 
+rescue LoadError
+end
+
+require "seems_rateable/engine"
+require "seems_rateable/errors"
 require "seems_rateable/helpers"
-require "seems_rateable/record"
+require "seems_rateable/model"
+require "seems_rateable/routes"
+require "seems_rateable/version"
 
 module SeemsRateable
-end
+end

data/lib/tasks/seems_rateable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :seems_rateable do
+#   # Task goes here
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seems_rateable
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Peter Toth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -39,51 +53,87 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
-description: Star rating gem for Rails application using jQuery plugin jRating
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Star rating engine using jQuery plugin jRating for Rails applications
 email:
 - proximin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- lib/generators/seems_rateable/USAGE
-- lib/generators/seems_rateable/seems_rateable_generator.rb
-- lib/generators/seems_rateable/templates/cached_model.rb
-- lib/generators/seems_rateable/templates/cached_rating_migration.rb
-- lib/generators/seems_rateable/templates/controller.rb
-- lib/generators/seems_rateable/templates/images/bg_jRatingInfos.png
-- lib/generators/seems_rateable/templates/images/small.png
-- lib/generators/seems_rateable/templates/images/stars.png
-- lib/generators/seems_rateable/templates/javascripts/jRating.jquery.js.erb
-- lib/generators/seems_rateable/templates/javascripts/rateable.jquery.js.erb
-- lib/generators/seems_rateable/templates/model.rb
-- lib/generators/seems_rateable/templates/rate_migration.rb
-- lib/generators/seems_rateable/templates/stylesheets/jRating.jquery.css
-- lib/generators/seems_rateable_destroy_generator.rb
+- app/views/layouts/seems_rateable/application.html.erb
+- app/assets/stylesheets/seems_rateable/jRating.jquery.css
+- app/assets/stylesheets/seems_rateable/application.css
+- app/assets/javascripts/seems_rateable/application.js
+- app/assets/javascripts/seems_rateable/jRating.jquery.js.erb
+- app/assets/images/seems_rateable/stars.png
+- app/assets/images/seems_rateable/small.png
+- app/assets/images/seems_rateable/bg_jRatingInfos.png
+- app/controllers/seems_rateable/ratings_controller.rb
+- app/controllers/seems_rateable/application_controller.rb
+- app/helpers/seems_rateable/ratings_helper.rb
+- app/helpers/seems_rateable/application_helper.rb
+- app/models/seems_rateable/rate.rb
+- app/models/seems_rateable/cached_rating.rb
+- config/routes.rb
 - lib/seems_rateable.rb
-- lib/seems_rateable/helpers.rb
-- lib/seems_rateable/record.rb
+- lib/generators/seems_rateable/install/install_generator.rb
+- lib/generators/seems_rateable/install/templates/initializer.rb
+- lib/generators/seems_rateable/install/templates/rateable.js.erb
+- lib/generators/seems_rateable/install/templates/rates_migration.rb
+- lib/generators/seems_rateable/install/templates/cached_ratings_migration.rb
+- lib/generators/seems_rateable/install/templates/jRating.js.erb
 - lib/seems_rateable/version.rb
-- seems_rateable.gemspec
-homepage: ''
+- lib/seems_rateable/helpers.rb
+- lib/seems_rateable/routes.rb
+- lib/seems_rateable/errors.rb
+- lib/seems_rateable/engine.rb
+- lib/seems_rateable/model.rb
+- lib/tasks/seems_rateable_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://rateable.herokuapp.com
 licenses: []
 metadata: {}
 post_install_message: 
@@ -105,5 +155,5 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Star rating gem for Rails application using jQuery plugin jRating
+summary: Star Rating Engine
 test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.project
-.rvmrc

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-# Specify your gem's dependencies in seems_rateable.gemspec
-gemspec
-group :test, :development do
-  gem 'factory_girl_rails', '~> 4.0'
-  gem 'rspec'
-  gem 'debugger'
-  gem 'shoulda-matchers'
-end

data/lib/generators/seems_rateable/seems_rateable_generator.rb

@@ -1,65 +0,0 @@
-require 'rails/generators/migration'
-require 'fileutils'
-
-class SeemsRateableGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::Migration
-  source_root File.expand_path('../templates', __FILE__)      
-                                                       
-  desc "Copying asset files ..."
-  def assets
-	 FileUtils.mkdir_p 'vendor/assets/images/rateable'
-	 Dir::mkdir 'vendor/assets/stylesheets/rateable'
-	 Dir::mkdir 'vendor/assets/javascripts/rateable'
-	
-	 copy_file 'images/bg_jRatingInfos.png', 'vendor/assets/images/rateable/bg_jRatingInfos.png'
-	 copy_file 'images/small.png', 'vendor/assets/images/rateable/small.png'
-	 copy_file 'images/stars.png', 'vendor/assets/images/rateable/stars.png'
-			
-	 copy_file 'stylesheets/jRating.jquery.css', 'vendor/assets/stylesheets/rateable/jRating.jquery.css'
-	 copy_file 'javascripts/jRating.jquery.js.erb',  'vendor/assets/javascripts/rateable/jRating.jquery.js.erb'
-	 copy_file 'javascripts/rateable.jquery.js.erb',  'vendor/assets/javascripts/rateable/rateable.jquery.js.erb'
-	end         
-  
-  desc "Generating controller file ..."
-  def controller
-  	class_collisions 'RatingsController'
-  	template "controller.rb", File.join('app/controllers', 'ratings_controller.rb')
-  end
-  
-  desc "Generating model files ..."
-  def models
-		model_file = File.join('app/models', "#{file_path}.rb")
-		raise "User model (#{model_file}) must exits." unless File.exists?(model_file)
-		class_collisions 'Rate'
-		class_collisions 'CachedRating'
-		template 'model.rb', File.join('app/models', 'rate.rb')
-		template 'cached_model.rb', File.join('app/models', 'cached_rating.rb')	
-  end 
-                                                                            
-  desc "Creating route ..."
-  def routegen
-    route "resources :ratings, :only => :create"
-  end
-
-  desc "Generating migrations ..."
-  def migrations
-    migration_template "cached_rating_migration.rb", "db/migrate/create_cached_ratings.rb"
-    migration_template "rate_migration.rb", "db/migrate/create_rates.rb"
-  end
-  
-  desc "Creating needed database tables"
-  def migrating
-   rake("db:migrate")
-  end
-  
-  private 
-  def self.next_migration_number(dirname)
-    #if ActiveRecord::Base.timestamped_migrations
-    #  Time.now.utc.strftime("%Y%m%d%H%M%S%L")
-    #else
-      "%.3d" % (current_migration_number(dirname) + 1)
-    #end    
-  end
-  
-end  
-         

data/lib/generators/seems_rateable/templates/cached_model.rb

@@ -1,4 +0,0 @@
-class CachedRating < ActiveRecord::Base
-  attr_accessible :avg, :dimension	
-  belongs_to :cacheable, :polymorphic => true 
-end

data/lib/generators/seems_rateable/templates/controller.rb

@@ -1,15 +0,0 @@
-class RatingsController < ApplicationController
-
-def create   
-    obj = eval "#{params[:kls]}.find(#{params[:idBox]})" rescue nil
-    if obj.nil?
-      raise "Object does not exist."
-    end
-    
-    if obj && obj.rate(params[:rate].to_f, current_user.id, params[:dimension])
-       render :json => true
-    else  
-       render :json => {:error => true}
-    end
-  end
-end

data/lib/generators/seems_rateable/templates/javascripts/rateable.jquery.js.erb

@@ -1,25 +0,0 @@
-$(document).ready(function(){
-      $(".rateable").jRating({		
-		//default options displayed below ->
-			
-		 rateMax: 5, //			//Maximal rate
-         length : 5, // 		//Number of stars
-         //decimalLength : 0    //Number of decimals in the rate
-         //type : big,  		//Big or small
-         //step : true, 		//If set to true, filling of the stars is done star by star (step by step).
-         //isDisabled: false,   //Set true to display static rating
-         //showRateInfo:false   //Rate info panel, set true to display
-         //rateInfosX : 45		//In pixel - Absolute left position of the information box during mousemove.
-         //rateInfosY : 5		//In pixel - Absolute top position of the information box during mousemove.
-         path : '<%= Rails.application.class.routes.url_helpers.ratings_path %>',
-           onSuccess : function(element, rate){
-				//something like ->
-				//alert('success');
-				$('<span class="text-success"><small>Thanks for rating!</small></span>').insertAfter(element)
-         },
-         onError : function(element, rate) {
-				$('<span class="text-error"><small>You have already rated!</small></span>').insertAfter(element)
-			}
-       });
- 
-});

data/lib/generators/seems_rateable/templates/model.rb

@@ -1,7 +0,0 @@
-class Rate < ActiveRecord::Base
-  belongs_to :rater, :class_name => "<%= file_name.classify %>"
-  belongs_to :rateable, :polymorphic => true
-  
-  attr_accessible :stars, :dimension
-  
-end

data/lib/generators/seems_rateable_destroy_generator.rb

@@ -1,19 +0,0 @@
-require 'fileutils'
-class SeemsRateableDestroyGenerator < Rails::Generators::Base
-
-  def remove_asset_files    
-    FileUtils.remove_dir('vendor/assets/stylesheets/rateable')
-    FileUtils.remove_dir('vendor/assets/javascripts/rateable')
-    FileUtils.remove_dir('vendor/assets/images/rateable')
-  end
-  
-  def remove_model_files
-    FileUtils.rm('app/models/rate.rb')
-    FileUtils.rm('app/models/cached_rating.rb')
-  end
-  
-   def remove_controller_file
-    FileUtils.rm('app/controllers/ratings_controller.rb')
-  end
-  
-end