seems_rateable 1.0.13 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5da25869fc6cb9fd1c221b6f6e4a91863e05b199
-  data.tar.gz: e6a95e44392d188f812290df55b638441b4b094e
+  metadata.gz: b5c6c41b54dc14c601e4f35661dcba8c29cc944d
+  data.tar.gz: dba8a7b572f328759c514d5a240230d4d8d0de61
 SHA512:
-  metadata.gz: a77a2cf678894a71dc0c5f0fa985be61d5f4d506d7fec15afec417a1409cf1fc1de4b31dce4e96ab161f84ef1d34a69b12e642af2fbbd907eca542af72ec5930
-  data.tar.gz: bd098828cb0a4900c887f9fbe5c6f79c4939501f87b3ce1ee35e3ec3af12ef57c32c136bb4a760749f7f05cc8678c2082f1bab0cdc2c14ce43304e5d2bf4239a
+  metadata.gz: 324447036712396cd2c77ad6d84f543c647b8ffee420aa68c1eee20fee34ca16f130aa514e6d06d8da6d82cdb7693954306750fc0452f7038efd60a84b8bec59
+  data.tar.gz: ad5e2d9e980a32d119018373ceaef79416186539691251c296e986419246602c6de405b8e655d46831e1b492b78487d2dcc555f8d1ee2415237b1eaa06960a0d

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+tmp
+.project
+.rvmrc
+.rspec
+spec/dummy/log/*
+spec/dummy/db/*.sqlite3
+spec/dummy/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -1,14 +1,20 @@
 # SeemsRateable
 
-Star rating gem for Rails application using jQuery plugin <a href="http://www.myjqueryplugins.com/jquery-plugin/jrating">jRating</a>
+Star rating gem for Rails application using jQuery plugin [jRating](http://www.myjqueryplugins.com/jquery-plugin/jrating)
 
 ## Demo
 
-<a href="http://rateable.herokuapp.com/">Demo</a> application, requires to sign up before rating
+[Demo](http://seemsrateable.herokuapp.com/) application, requires to sign up before rating.
 
-## Instructions
+### Important! If you are upgrading from 1.x.x please do accordingly :
 
-### Installation
+Run :
+
+    $ rails g seems_rateable:uninstall_old
+
+Then follow as instructed.
+
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -24,83 +30,57 @@ Or install it yourself as:
 
 ### Generation
 
+Generate required files :
+
 	$ rails generate seems_rateable:install
 	
-Generator creates migration files, javascript files and initializer
-
-### Prepare
+And run :
 
-Require javascript files by adding this line to application.js
+    $ rake db:migrate
 
-	#application.js
-	//= require_directory ./rateable
+## Prepare
 
-Add <code>seems_rateable</code> to routes.rb file
+To prepare model add `seems_rateable` to your rateable model file. You can also pass a hash of dimensions
+e.g `:quality, :price`
 
-Include stylesheet adding <code><%= seems_rateable_stylesheet %></code> to your layout header
-
-Also make sure you have an existing <code>current_user</code> helper method	
-
-Don't forget to run
+    Post < ActiveRecord::Base
+      seems_rateable # :quality, :speed, :effectiveness
+	end
 
-	$ rake db:migrate
+	
+To track user's given rates add `seems_rateable_rater` to your rater model.
 
-To prepare model add <code> seems_rateable </code> to your rateable model file. You can also pass a hash of options to
-customize the functionality
+    User < ActiveRecord::Base
+      seems_rateable_rater
+    end
 
-<ul>
-<li><code>:dimensions</code>Array of dimensions e.g <code>:dimensions => [:quality, :quantity]</code> </li>
-<li><code>:allow_update</code>Allowing user to re-rate his own ratings, default set to false e.g <code>:allow_update=> true</code></li>
-</ul>
+## Usage
 
-	class Post < ActiveRecord::Base
-		seems_rateable :allow_update => true, :dimensions => [:quality, :length]
-	end
+To display star rating use helper method `rating_for` in your view
 
-To access object's rates use <code>rates</code> method, to get dimension rates pass an argument eg :
+    #show.html.erb
 
-	@object.rates
-	@object.rates(:quality)
-	@object.rates(:quantity)
-	
-This also applies to cached average rating e.g
+    rating_for @post
 
-	@object.average	
-	@object.average(:quality)
-	@object.average(:quantity)
-	
-And to object's raters e.g
-	
-	@object.raters
-	@object.raters(:quality)
-	@object.raters(:quantity)
-	
-To track user's given ratings add <code>seems_rateable_rater</code> to your rater model.
-If your rater class is not "User"(e.g "Client" or "Customer") change configuration in initializer generated by this engine.
-Now you can access user's ratings by <code>@user.ratings_given</code>
+    rating_for @post, dimension: :quality, disabled: true, html_options
 
-### Usage
+You can specify these options :
 
-To display star rating use helper method <code>rating_for</code> in your view
+* `dimension` The dimension of the rating object
+* `disabled` Set to true to display static star rating meaning *no* user would be allowed to rate
+* `html_options` HTML options of the selector
 
-    #index.html.erb
+To edit the javascript options locate rateable.js file in `app/assets/javascripts/rateable/`.
+The javascript options are explained directly in the file.
 
-    rating_for @post
+## Configuration
 
-    rating_for @post, :dimension => :quality, :class => 'post', :id => 'list'
+In *config/initializers/seems_rateable.rb* you can configure these options :
 
-    rating_for @post, :static => true
+* **rate\_owner_class** - Usually `User`, name of the model you put `seems_rateable_rater`
+* **current\_rater_method** - The method representing a rater instance, `current_user` by default
+* **default\_selector_class** - Default HTML class of the rating div
 
-You can specify these options :
-<ul>
-<li><code>:dimension</code>The dimension of the object</li>
-<li><code>:static</code>Set to true to display static star rating, default false</li>
-<li><code>:class</code>Class of the div, default set to 'rateable'</li>
-<li><code>:id</code>ID of the div e.g <code>:id => "info"</code>, default nil</li>
-</ul>
-
-To edit the javascript options locate rateable.js file in /app/assets/javascripts/rateable/.
-The javascript options are explained directly in the file    	
 
 ## Contributing
 

data/Rakefile

@@ -1,11 +1,13 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'SeemsRateable'
@@ -15,3 +17,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/javascripts/seems_rateable/index.js

@@ -0,0 +1 @@
+//= require_tree

data/{lib/generators/seems_rateable/install/templates → app/assets/javascripts/seems_rateable}/jRating.js.erb

@@ -1,225 +1,225 @@
-/************************************************************************
-*************************************************************************
-@Name :       	jRating - jQuery Plugin
-@Revison :    	3.0
-@Date : 		28/01/2013 
-@Author:     	 ALPIXEL - (www.myjqueryplugins.com - www.alpixel.fr) 
-@License :		 Open Source - MIT License : http://www.opensource.org/licenses/mit-license.php
- 
-**************************************************************************
-*************************************************************************/
-(function($) {
-	$.fn.jRating = function(op) {
-		var defaults = {
-			/** String vars **/
-			bigStarsPath : '<%= asset_path "seems_rateable/stars.png" %>', // path of the icon stars.png
-			smallStarsPath : '<%= asset_path "seems_rateable/small.png" %>', // path of the icon small.png
-			path : '<%= SeemsRateable::Engine.routes.url_helpers.ratings_path %>',
-			type : 'big', // can be set to 'small' or 'big'
-
-			/** Boolean vars **/
-			step:false, // if true,  mouseover binded star by star,
-			isDisabled:false,
-			showRateInfo: false,
-			canRateAgain : false,
-
-			/** Integer vars **/
-			length:5, // number of star to display
-			decimalLength : 0, // number of decimals.. Max 3, but you can complete the function 'getNote'
-			rateMax : 20, // maximal rate - integer from 0 to 9999 (or more)
-			rateInfosX : -45, // relative position in X axis of the info box when mouseover
-			rateInfosY : 5, // relative position in Y axis of the info box when mouseover
-			nbRates : 1,
-
-			/** Functions **/
-			onSuccess : null,
-			onError : null
-		}; 
-
-		if(this.length>0)
-		return this.each(function() {
-			/*vars*/
-			var opts = $.extend(defaults, op),    
-			newWidth = 0,
-			starWidth = 0,
-			starHeight = 0,
-			bgPath = '',
-			hasRated = false,
-			globalWidth = 0,
-			nbOfRates = opts.nbRates;
-
-			if($(this).hasClass('jDisabled') || opts.isDisabled)
-				var jDisabled = true;
-			else
-				var jDisabled = false;
-
-			getStarWidth();
-			$(this).height(starHeight);
-			
-			
-			
-			var average = parseFloat($(this).attr('data-average')), // get the average of all rates
-			idBox = parseInt($(this).attr('data-id')), // get the id of the box
-			kls = $(this).attr('data-kls'),
-			dimension = $(this).attr('data-dimension'),
-			widthRatingContainer = starWidth*opts.length, // Width of the Container
-			widthColor = average/opts.rateMax*widthRatingContainer, // Width of the color Container
-			quotient = 
-			$('<div>', 
-			{
-				'class' : 'jRatingColor',
-				css:{
-					width:widthColor
-				}
-			}).appendTo($(this)),
-
-			average = 
-			$('<div>', 
-			{
-				'class' : 'jRatingAverage',
-				css:{
-					width:0,
-					top:- starHeight
-				}
-			}).appendTo($(this)),
-
-			 jstar =
-			$('<div>', 
-			{
-				'class' : 'jStar',
-				css:{
-					width:widthRatingContainer,
-					height:starHeight,
-					top:- (starHeight*2),
-					background: 'url('+bgPath+') repeat-x'
-				}
-			}).appendTo($(this));
-			
-			$(this).css({width: widthRatingContainer,overflow:'hidden',zIndex:1,position:'relative'});
-			
-			if(!jDisabled)
-			$(this).unbind().bind({
-				mouseenter : function(e){
-					var realOffsetLeft = findRealLeft(this);
-					var relativeX = e.pageX - realOffsetLeft;
-					if (opts.showRateInfo)
-					var tooltip = 
-					$('<p>',{
-						'class' : 'jRatingInfos',
-						html : getNote(relativeX)+' <span class="maxRate">/ '+opts.rateMax+'</span>',
-						css : {
-							top: (e.pageY + opts.rateInfosY),
-							left: (e.pageX + opts.rateInfosX)
-						}
-					}).appendTo('body').show();
-				},
-				mouseover : function(e){
-					$(this).css('cursor','pointer');	
-				},
-				mouseout : function(){
-					$(this).css('cursor','default');
-					if(hasRated) average.width(globalWidth);
-					else average.width(0);
-				},
-				mousemove : function(e){
-					var realOffsetLeft = findRealLeft(this);
-					var relativeX = e.pageX - realOffsetLeft;
-					if(opts.step) newWidth = Math.floor(relativeX/starWidth)*starWidth + starWidth;
-					else newWidth = relativeX;
-					average.width(newWidth);					
-					if (opts.showRateInfo)
-					$("p.jRatingInfos")
-					.css({
-						left: (e.pageX + opts.rateInfosX)
-					})
-					.html(getNote(newWidth) +' <span class="maxRate">/ '+opts.rateMax+'</span>');
-				},
-				mouseleave : function(){
-					$("p.jRatingInfos").remove();
-				},
-				click : function(e){
-                    var element = this;
-					
-					/*set vars*/
-					hasRated = true;
-					globalWidth = newWidth;
-					nbOfRates--;
-					
-					if(!opts.canRateAgain || parseInt(nbOfRates) <= 0) $(this).unbind().css('cursor','default').addClass('jDisabled');
-					
-					if (opts.showRateInfo) $("p.jRatingInfos").fadeOut('fast',function(){$(this).remove();});
-					e.preventDefault();
-					var rate = getNote(newWidth);
-					average.width(newWidth);
-					
-
-					$.post(defaults.path,
-						{
-							idBox : idBox,
-							rate : rate,
-							kls : kls,
-							dimension : dimension
-						/**	action : 'rating' **/
-						},
-						function(data) {
-							if(!data.error)
-							{
-								/** Here you can display an alert box, 
-									or use the jNotify Plugin :) http://www.myqjqueryplugins.com/jNotify
-									exemple :	*/
-								if(opts.onSuccess) opts.onSuccess( element, rate );
-							}
-							else
-							{
-
-								/** Here you can display an alert box, 
-									or use the jNotify Plugin :) http://www.myqjqueryplugins.com/jNotify
-									exemple :	*/
-								if(opts.onError) opts.onError( element, rate );
-							}
-						},
-						'json'
-					);
-				}
-			});
-
-			function getNote(relativeX) {
-				var noteBrut = parseFloat((relativeX*100/widthRatingContainer)*opts.rateMax/100);
-				switch(opts.decimalLength) {
-					case 1 :
-						var note = Math.round(noteBrut*10)/10;
-						break;
-					case 2 :
-						var note = Math.round(noteBrut*100)/100;
-						break;
-					case 3 :
-						var note = Math.round(noteBrut*1000)/1000;
-						break;
-					default :
-						var note = Math.round(noteBrut*1)/1;
-				}
-				return note;
-			};
-			
-			function getStarWidth(){
-				switch(opts.type) {
-					case 'small' :
-						starWidth = 12; // width of the picture small.png
-						starHeight = 10; // height of the picture small.png
-						bgPath = opts.smallStarsPath;
-					break;
-					default :
-						starWidth = 23; // width of the picture stars.png
-						starHeight = 20; // height of the picture stars.png
-						bgPath = opts.bigStarsPath;
-				}
-			};
-
-			function findRealLeft(obj) {
-			  if( !obj ) return 0;
-			  return obj.offsetLeft + findRealLeft( obj.offsetParent );
-			};
-		});
-
-	}
-})(jQuery);
+/************************************************************************
+*************************************************************************
+@Name :       	jRating - jQuery Plugin
+@Revison :    	3.1
+@Date : 		13/08/2013
+@Author:     	 ALPIXEL - (www.myjqueryplugins.com - www.alpixel.fr)
+@License :		 Open Source - MIT License : http://www.opensource.org/licenses/mit-license.php
+
+**************************************************************************
+*************************************************************************/
+(function($) {
+	$.fn.jRating = function(op) {
+		var defaults = {
+			/** String vars **/
+			bigStarsPath : '<%= asset_path "seems_rateable/stars.png" %>', // path of the icon stars.png
+			smallStarsPath : '<%= asset_path "seems_rateable/small.png" %>', // path of the icon small.png
+			path : '<%= SeemsRateable::Engine.routes.url_helpers.rates_path %>',
+			type : 'big', // can be set to 'small' or 'big'
+
+			/** Boolean vars **/
+			step: false, // if true,  mouseover binded star by star,
+			isDisabled: false, // if true, user could not rate
+			showRateInfo: false, // show rates informations when cursor moves onto the plugin
+			canRateAgain : false, // if true, the user could rates {nbRates} times with jRating.. Default, 1 time
+			sendRequest: true, // send values to server
+
+			/** Integer vars **/
+			length:5, // number of star to display
+			decimalLength : 0, // number of decimals.
+			rateMax : 5, // maximal rate - integer from 0 to 9999 (or more)
+			rateInfosX : -45, // relative position in X axis of the info box when mouseover
+			rateInfosY : 5, // relative position in Y axis of the info box when mouseover
+			nbRates : 1,
+
+			/** Functions **/
+      onSuccess : function(element, data) {
+        var rateable = $(element).clone();
+        rateable.children().remove();
+        rateable.attr("data-average", data.average);
+        rateable.jRating(this);
+        $(element).replaceWith(rateable);
+      },
+
+      onError : function(element, data) {
+        $('<span>An error occurred</span>').insertAfter(element)
+      },
+
+			onClick: null // Fires when clicking on a star
+		};
+
+		if(this.length>0)
+		return this.each(function() {
+			/*vars*/
+			var opts = $.extend(defaults, op),
+			newWidth = 0,
+			starWidth = 0,
+			starHeight = 0,
+			bgPath = '',
+			hasRated = false,
+			globalWidth = 0,
+			nbOfRates = opts.nbRates;
+
+			if($(this).hasClass('jDisabled') || opts.isDisabled)
+				var jDisabled = true;
+			else
+				var jDisabled = false;
+
+			getStarWidth();
+			$(this).height(starHeight);
+
+			var average = parseFloat($(this).attr('data-average')), // get the average of all rates
+			rateable_id = parseInt($(this).attr('data-rateable-id')),
+			rateable_type = $(this).attr('data-rateable-type'),
+			dimension = $(this).attr('data-dimension'),
+			widthRatingContainer = starWidth*opts.length, // Width of the Container
+			widthColor = average/opts.rateMax*widthRatingContainer, // Width of the color Container
+
+			quotient =
+			$('<div>',
+			{
+				'class' : 'jRatingColor',
+				css:{
+					width:widthColor
+				}
+			}).appendTo($(this)),
+
+			average =
+			$('<div>',
+			{
+				'class' : 'jRatingAverage',
+				css:{
+					width:0,
+					top:- starHeight
+				}
+			}).appendTo($(this)),
+
+			 jstar =
+			$('<div>',
+			{
+				'class' : 'jStar',
+				css:{
+					width:widthRatingContainer,
+					height:starHeight,
+					top:- (starHeight*2),
+					background: 'url('+bgPath+') repeat-x'
+				}
+			}).appendTo($(this));
+
+
+			$(this).css({width: widthRatingContainer,overflow:'hidden',zIndex:1,position:'relative'});
+
+			if(!jDisabled)
+			$(this).unbind().bind({
+				mouseenter : function(e){
+					var realOffsetLeft = findRealLeft(this);
+					var relativeX = e.pageX - realOffsetLeft;
+					if (opts.showRateInfo)
+					var tooltip =
+					$('<p>',{
+						'class' : 'jRatingInfos',
+						html : getNote(relativeX)+' <span class="maxRate">/ '+opts.rateMax+'</span>',
+						css : {
+							top: (e.pageY + opts.rateInfosY),
+							left: (e.pageX + opts.rateInfosX)
+						}
+					}).appendTo('body').show();
+				},
+				mouseover : function(e){
+					$(this).css('cursor','pointer');
+				},
+				mouseout : function(){
+					$(this).css('cursor','default');
+					if(hasRated) average.width(globalWidth);
+					else average.width(0);
+				},
+				mousemove : function(e){
+					var realOffsetLeft = findRealLeft(this);
+					var relativeX = e.pageX - realOffsetLeft;
+					if(opts.step) newWidth = Math.floor(relativeX/starWidth)*starWidth + starWidth;
+					else newWidth = relativeX;
+					average.width(newWidth);
+					if (opts.showRateInfo)
+					$("p.jRatingInfos")
+					.css({
+						left: (e.pageX + opts.rateInfosX)
+					})
+					.html(getNote(newWidth) +' <span class="maxRate">/ '+opts.rateMax+'</span>');
+				},
+				mouseleave : function(){
+					$("p.jRatingInfos").remove();
+				},
+				click : function(e){
+                    var element = this;
+
+					/*set vars*/
+					hasRated = true;
+					globalWidth = newWidth;
+					nbOfRates--;
+
+					if(!opts.canRateAgain || parseInt(nbOfRates) <= 0) $(this).unbind().css('cursor','default').addClass('jDisabled');
+
+					if (opts.showRateInfo) $("p.jRatingInfos").fadeOut('fast',function(){$(this).remove();});
+					e.preventDefault();
+					var stars = getNote(newWidth);
+					average.width(newWidth);
+
+					if(opts.onClick) opts.onClick( element, rate );
+
+					if(opts.sendRequest) {
+            $.post(opts.path,
+              {
+                rate: {
+                  rateable_id : rateable_id,
+                  rateable_type : rateable_type,
+                  stars : stars,
+                  dimension : dimension
+                }
+              },
+
+							function(data) {
+								if(!data.error)
+								{
+									if(opts.onSuccess) opts.onSuccess(element, data);
+								}
+								else
+								{
+									if(opts.onError) opts.onError(element, data);
+								}
+							},
+							'json'
+						);
+					}
+
+				}
+			});
+
+			function getNote(relativeX) {
+				var noteBrut = parseFloat((relativeX*100/widthRatingContainer)*parseInt(opts.rateMax)/100);
+				var dec=Math.pow(10,parseInt(opts.decimalLength));
+				var note = Math.round(noteBrut*dec)/dec;
+				return note;
+			};
+
+			function getStarWidth(){
+				switch(opts.type) {
+					case 'small' :
+						starWidth = 12; // width of the picture small.png
+						starHeight = 10; // height of the picture small.png
+						bgPath = opts.smallStarsPath;
+					break;
+					default :
+						starWidth = 23; // width of the picture stars.png
+						starHeight = 20; // height of the picture stars.png
+						bgPath = opts.bigStarsPath;
+				}
+			};
+
+			function findRealLeft(obj) {
+			  if( !obj ) return 0;
+			  return obj.offsetLeft + findRealLeft( obj.offsetParent );
+			};
+		});
+
+	}
+})(jQuery);