rails_rateable 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c0770a073f90fffb1bfd2cc9b8d786585ed0848
-  data.tar.gz: 17ab4e67a4f49694a7afaec5c6a5595d1afe3d65
+  metadata.gz: 025c051445f757aaa2aa31f8dc8aee7dcfd00122
+  data.tar.gz: c61f328b9fbe752bbdb76c7c02546b3f3d912729
 SHA512:
-  metadata.gz: 613e77a3f6ae71d6a662dfadc6e0f9eb5d6f05c1020efc3725b4ea788ca00e00b84a79f8c755baee211e898ed8e59698af248a3452ce668bcc126933b537d8b8
-  data.tar.gz: 251252e3e85b0574d529540874f1596214eb89d331b2d0d86e33508752f5f665ece10e52a28a0ecb2ec93d64820b11e5f34f422fbce75a2b8ddee2284e0bedf7
+  metadata.gz: edddebccb41fb830a22b89c0b59ae2be4c35bf66c175cbf44393570270a5df6094c0e51fa4bf29560900e19edca868e9d6f87e09b808871973a4d1dd8fb83065
+  data.tar.gz: 02f81100bb78c24e8dae26be9c55a8b2e7a47acfd10943cb3da6c43ee63c71d79ac13288a8e44bd313ffd856a1dd0aa926375ca93037a1ec5dd3c3c295a5459b

data/README.md

@@ -1,6 +1,6 @@
 = Rateble
 
-rateable is a rails gem providing a rating interface for ActiveRecord models.
+rails_rateable is a rails gem providing a rating interface for ActiveRecord models.
 It is compitable only with Rails 3 and above. It is released under the MIT license. 
 
 
@@ -40,7 +40,19 @@ Add 'include RailsRateable' to the modal you want to make rateable, then restart
       include RailsRateable
     end
 
-Now your model is extended by the plugin, you can rate it (1-#) or calculate the average rating.
+Now your model is extended by the Gem, you can rate it (1-#) or calculate the average rating. 
+
+
+By default max_rating is 5 i,e user can give rating from 1 to 5 . You can override it by passing max_rating parameter
+to rails_rateable
+
+In Below example, Comment model is made rateable and max_rating set to 10, so for comment user can provide rating between 1 to 10
+
+    class Comment < ActiveRecord::Base
+	  include RailsRateable
+      rails_rateable :max_rating => 10
+    end
+
 
     @movie.rate_it(4, current_user)
 
@@ -53,11 +65,11 @@ Now your model is extended by the plugin, you can rate it (1-#) or calculate the
 
     Movie.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.
+    By default 20 top rated result will be returned. Youu can override it by passing numer of record you want.
+
+	Movie.find_top_rated(40) # will return 40 records
+
 
-    class Comment < ActiveRecord::Base
-      acts_as_rateable :max_rating => 10
-    end
 
 
 CREDIT:

data/lib/app/models/rails_rateable.rb

@@ -7,18 +7,16 @@ module RailsRateable
 
   module ClassMethods
     #put class method here to be trigger as say User.method_name
-    def acts_as_rateable(options = {})
+    def rails_rateable(options = {})
       unless respond_to?(:max_rating)
         class_attribute :max_rating
         self.max_rating = options[:max_rating] || 5
       end
     end
     
-    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)
+    def find_top_rated(limit = nil)
+      limit = 20 unless limit
+      includes(:rating).order('ratings.average_rating DESC').limit(limit)
     end
     
   end

data/lib/rails_rateable/version.rb

@@ -1,3 +1,3 @@
 module RailsRateable
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_rateable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Arun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler