rails_rateable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 158d90fcd250b62fd8772598b33323925067f4ae
+  data.tar.gz: b3d26ae78979182f5c86c427f2e716bad6edb7be
+SHA512:
+  metadata.gz: 9584af79998c5c5feb884fb522c42995180e47eb7d5c4279d92425c78dfc2ce7be1c785356a5f47c10a5701a4693f9e8785be10330a553df29ad287540fda006
+  data.tar.gz: cb336887f9c14e52f8ec71bfa69572b1ec6426f3c52d83e5818516e05249aad906449bc16575f483cee8ff8d596c5d68d0c02c72381f2752ef2b1e0f6a2a3b41

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_rateable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Arun
+
+MIT License
+
+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.md

@@ -0,0 +1,64 @@
+= Rateble
+
+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. 
+
+
+= Features
+
+* Make any of yor model rateable without any change to the existing model
+* Users can update previous ratings
+* Stores computed score and number of ratings for efficient data access
+* Possibility to change range of the ratings (1..5 is default)
+
+= Installation
+
+== Install as gem
+
+Install as a gem:
+
+    $ sudo gem instal rails_rateable
+
+or
+	Add below to Gemfile and run bundle install
+
+	gem 'rails_rateable'
+
+After you install rateable, you need to run the generator:
+
+rails generate rails_rateable
+
+The generator will add new migration, so run migration:
+
+rake db:migrate
+
+= Example Usage
+
+Add 'include RailsRateable' to the modal you want to make rateable, then restart your application.
+
+    class Movie < ActiveRecord::Base
+      include RailsRateable
+    end
+
+Now your model is extended by the plugin, you can rate it (1-#) or calculate the average rating.
+
+    @movie.rate_it(4, current_user)
+
+    @movie.average_rating          #=> 4.0
+    @movie.average_rating_round    #=> 4
+    @movie.average_rating_percent  #=> 80
+    @movie.rated_by?(current_user) #=> true
+    @movie.rating_by(current_user) #=> 4
+    @movie.ratings_count          #=> 1
+
+    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.
+
+    class Comment < ActiveRecord::Base
+      acts_as_rateable :max_rating => 10
+    end
+
+
+CREDIT:
+The gem is based on https://github.com/mreinsch/acts_as_rateable. This gem simply enhance it to be compitable with Rails 3 and up

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/rails_rateable/rails_rateable_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/migration'
+
+class RailsRateableMigrationGenerator < Rails::Generator::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @_rails_rateable_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migration_file
+    migration_template 'migration.rb', 'db/migrate/rails_rateable_migration.rb'
+  end
+end

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

@@ -0,0 +1,24 @@
+class RateableMigration < ActiveRecord::Migration
+  def self.up
+    create_table "ratings" do |t|
+      t.references "rateable",       :polymorphic => true, :nil => false
+      t.float      "average_rating"
+      t.integer    "ratings_count"
+      t.timestamps
+    end
+    add_index "ratings", ["rateable_id", "rateable_type"]
+
+    create_table "user_ratings" do |t|
+      t.references "rating", :nil => false
+      t.references "user",   :nil => false
+      t.integer    "score",  :nil => false
+      t.timestamps
+    end
+    add_index "user_ratings", ["user_id", "rating_id"]
+  end
+
+  def self.down
+    drop_table "user_ratings"
+    drop_table "ratings"
+  end
+end

data/lib/rails_rateable/version.rb

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

data/lib/rails_rateable.rb

@@ -0,0 +1,64 @@
+module RailsRateable
+  extend ActiveSupport::Concern
+
+  included do
+    has_one :rating, :as => :rateable, :dependent => :destroy
+  end
+
+  module ClassMethods
+    #put class method here to be trigger as say User.method_name
+    def acts_as_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)
+    end
+    
+  end
+
+  # Rates the object by a given score. A user object should be passed to the method.
+  def rate_it(score, user)
+    create_rating unless rating
+    rating.rate(score, user)
+  end
+
+  # Returns the average rating. Calculation based on the already given scores.
+  def average_rating
+    rating && rating.average_rating || 0.0
+  end
+
+  # Rounds the average rating value.
+  def average_rating_round
+    average_rating.round
+  end
+
+  # Returns the average rating in percent.
+  def average_rating_percent
+    f = 100 / max_rating.to_f
+    average_rating * f
+  end
+
+  # Returns the number of ratings.
+  def ratings_count
+    rating && rating.ratings_count || 0
+  end
+
+  # Checks whether a user rated the object or not.
+  def rated_by?(user)
+    rating && rating.user_ratings.exists?(:user_id => user)
+  end
+
+  # Returns the rating a specific user has given the object.
+  def rating_by(user)
+    user_rating = rating && rating.user_ratings.find_by_user_id(user.id)
+    user_rating ? user_rating.score : nil
+  end
+  
+end

data/lib/rating.rb

@@ -0,0 +1,21 @@
+class Rating < ActiveRecord::Base
+  belongs_to :rateable, :polymorphic => true
+  has_many :user_ratings
+
+  delegate :max_rating, :to => :rateable
+
+  def rate(score, user)
+    user_ratings.find_or_initialize_by(user_id: user.id).update_attributes!(:score => score)
+    reload
+  end
+
+  # Call this method the update the avarage rating; you don't normally need to
+  # do this manually, saving or updating a user rating already takes care of
+  # updating the avarage rating.
+  def update_rating
+    self.average_rating = user_ratings.average(:score)
+    self.ratings_count = user_ratings.count
+    save!
+  end
+
+end

data/lib/user_rating.rb

@@ -0,0 +1,24 @@
+class UserRating < ActiveRecord::Base
+  belongs_to :rating
+
+  delegate :max_rating, :to => :rating
+
+  validates_presence_of :score
+  validates_uniqueness_of :user_id, :scope => :rating_id
+  validate :max_rating_allowed_by_parent
+
+  after_save do |user_rating|
+    user_rating.rating.update_rating
+  end
+
+  private
+
+  def max_rating_allowed_by_parent
+    if score < 1
+      errors.add(:score, "must be greater than or equal to 1")
+    elsif score > max_rating
+      errors.add(:score, "must be less than or equal to #{max_rating}")
+    end
+  end
+
+end

data/rails_rateable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_rateable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_rateable"
+  spec.version       = RailsRateable::VERSION
+  spec.authors       = ["Arun"]
+  spec.email         = ["trustarun@yahoo.co.in"]
+  spec.summary       = %q{rateable module to be used with rails 4}
+  spec.description   = %q{rateable module to be used with rails 4. Made your module rateable by simply calling rateable in your Model}
+  spec.homepage      = "https://github.com/trustarun/rails_rateable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rails_rateable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: rateable module to be used with rails 4. Made your module rateable by
+  simply calling rateable in your Model
+email:
+- trustarun@yahoo.co.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_rateable/rails_rateable_generator.rb
+- lib/generators/rails_rateable/templates/migration.rb
+- lib/rails_rateable.rb
+- lib/rails_rateable/version.rb
+- lib/rating.rb
+- lib/user_rating.rb
+- rails_rateable.gemspec
+homepage: https://github.com/trustarun/rails_rateable
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: rateable module to be used with rails 4
+test_files: []