self_rateable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20c351175455d48ff66cb1a2f5bf29ac7f782d38
+  data.tar.gz: 2e043b86afb049612bae6e5ec91bfef831436e54
+SHA512:
+  metadata.gz: 0e8e657e454d172c52415b50bd61623c372391948ec60f13264cbbff6e3bd620311ca6775faa74011d05595796b6493d765acf6d2169c011af5b41f5e9312234
+  data.tar.gz: d3f609f983308e46b9852a5550e5109a53ecf1004842290137ec74578d26576caa5c274e38407b7aca59cf8b6f760e7241df249c42eb3d7e3846ddeffc2ddda6

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 oivan
+
+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,81 @@
+# SelfRateable
+
+Clean, powerful, customizable, simple, configurable, gem for displaying and handling ratings, likes, and feedbacks for ActiveRecord model.
+People!!! Please provide your feedbacks what functionality to add on the issues page. I'm open to whatever questions for improving this gem. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'self_rateable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install self_rateable
+
+## Usage
+
+Make you ActiveRecord model self rateable:
+
+The default type is :likes
+
+	class Model < ActiveRecord::Base
+    	self_rateable by: :class_name_of_AR_model_that_can_rate
+ 	end
+
+Rates philosophy as in facebook & vk (like/unlike)
+
+	class Model < ActiveRecord::Base
+    	self_rateable by: :class_name_of_AR_model_that_can_rate, type: :likes
+ 	end
+
+ 	Rate:
+
+ 	object.like object_of_AR_model_that_can_rate
+
+Stars rates diapasone 1..5 (as on movies) 	
+
+ 	class Model < ActiveRecord::Base
+    	self_rateable by: :class_name_of_AR_model_that_can_rate, type: :stars
+ 	end
+
+ 	Rate:
+
+ 	object.rate object_of_AR_model_that_can_rate, count_of_stars
+
+ Rates philosophy as in stackoverflow (+1 vs -1)	
+
+ 	class Model < ActiveRecord::Base
+    	self_rateable by: :class_name_of_AR_model_that_can_rate, type: :points
+ 	end
+
+ 	Rate:
+
+ 	object.vote object_of_AR_model_that_can_rate, bool
+
+This vote method returns false if object_of_AR_model_that_can_rate has already voted once. You can capture that output to show some messages.	
+
+ (If true it adds 1 point if false it decreases 1 point)	
+
+ Run rake task to prepare and update your database:
+
+ 	rake self_rateable	
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request and send it to me.)
+
+## What to do?
+
+1. Create generators for templates to render on UI with images and stylings of different types of ratings.
+2. Create complete test coverage
+3. Add more flexibility by providing more class and instance methods. 

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+spec = Gem::Specification.find_by_name 'test'
+load "#{spec.gem_dir}/tasks/prepare.rake"

data/lib/self_rateable.rb

@@ -0,0 +1,19 @@
+require "self_rateable/version"
+require "rails"
+require "active_record"
+require "active_record/version"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "self_rateable/rateable.rb"
+require "self_rateable/core/instance_methods.rb"
+require "self_rateable/core/class_methods.rb"
+require "self_rateable/rating.rb"
+
+module SelfRateable
+	require "self_rateable/railtie" if defined?(Rails)
+end
+
+$LOAD_PATH.shift
+
+ActiveRecord::Base.extend SelfRateable::Rateable if defined?(ActiveRecord::Base)

data/lib/self_rateable/core/class_methods.rb

@@ -0,0 +1,15 @@
+module SelfRateable::Core
+	module ClassMethods
+	  module Likes	
+		  def self.included(base)
+	      	base.extend SelfRateable::Core::ClassMethods
+	      end
+      end
+
+      module Stars
+      end
+
+      module Points
+      end
+	end
+end

data/lib/self_rateable/core/instance_methods.rb

@@ -0,0 +1,80 @@
+module SelfRateable::Core
+ 	module InstanceMethods
+ 	  module Likes
+	 	  def likes
+	        ratings.sum(:rating).to_f
+	      end
+
+	      def liked_by_rater?(rater)
+	        ratings.where(:rater_id => rater.id).count > 0
+	      end
+
+	      def like(rater)
+	      	rater.present? ? rate = ratings.where(rater_id: rater.id).first : raise('Rater object is incorrect.')
+	      	if rate.present?
+	      	# unlike if already rated 
+	      	 	liked_by_rater?(rater) ? ratings.where(rater_id: rater.id).delete_all : rate.rating += 1
+	      	 	rate.save!
+	      	else
+	      	#create new record if not yet rated	
+	      		ratings << SelfRateable::Rating.new(rating: 1, rater_id: rater.try(:id))
+	      	end
+	      	self.save!
+	      end
+
+	  end
+
+	  module Stars
+	  	  def stars
+	        ratings.average(:rating).to_f
+	      end
+
+	      def rated_by_rater?(rater)
+	        ratings.where(:rater_id => rater.id).count > 0
+	      end
+
+	      def rate(rater, stars)
+	      	rater.present? ? rate = ratings.where(rater_id: rater.id).first : raise('Rater object is incorrect.')
+	      	stars = 5 if stars > 5
+	      	stars = 0 if stars < 1 
+	      	if rated_by_rater?(rater)
+	      	# set new star rating if already rated
+	      	 	rate.rating = stars.to_i
+	      	 	rate.save!
+	      	else
+	      	#create new record if not yet rated	
+	      		ratings << SelfRateable::Rating.new(rating: stars.to_i, rater_id: rater.try(:id))
+	      	end
+	      	self.save!
+	      end
+	  end
+
+	  module Points
+	  	  def votes
+	        ratings.sum(:rating).to_f
+	      end
+
+	      def voted_by_rater?(rater)
+	        ratings.where(:rater_id => rater.id).count > 0
+	      end
+
+	      def vote(rater, val)
+	      	value = parse_val(val)
+	      	if voted_by_rater?(rater)
+	      	# set new star rating if already rated
+	      	 	return false
+	      	else
+	      	#create new record if not yet rated	
+	      		ratings << SelfRateable::Rating.new(rating: value.to_i, rater_id: rater.try(:id))
+	      	end
+	      	self.save!
+	      end
+
+	      private
+
+	      def parse_val(val)
+	      	val ? 1 : -1
+	      end
+	  end
+ 	end
+end

data/lib/self_rateable/railtie.rb

@@ -0,0 +1,12 @@
+require 'self_rateable'
+require 'rails'
+
+module SelfRateable
+  class Railtie < Rails::Railtie
+	railtie_name :self_rateable
+
+    rake_tasks do
+      load 'tasks/prepare.rake'
+    end
+  end
+end

data/lib/self_rateable/rateable.rb

@@ -0,0 +1,25 @@
+module SelfRateable
+  module Rateable
+    def self_rateable(options)
+      ops = validate_opts(options)
+      class_eval do
+        add_associations(ops[:by])
+        include "SelfRateable::Core::InstanceMethods::#{ops[:type].to_s.camelize}".constantize
+        include "SelfRateable::Core::ClassMethods::#{ops[:type].to_s.camelize}".constantize
+      end      
+    end
+
+    private
+
+    def add_associations(rated_by)
+      has_many :ratings, as: :rateable, dependent: :destroy, class_name: 'SelfRateable::Rating'
+      has_one :rater, as: :rater, class_name: rated_by.to_s.camelize
+    end
+
+    def validate_opts(options)
+      raise 'Incorect specification of self_rateable in your model please check documentation' if options[:type].blank? && options[:by].blank?
+      raise 'Incorect specification of self_rateable in your model please check documentation' if options[:by].blank?
+      options[:type].blank? ? {by: options[:by], type: 'likes'} : options 
+    end 
+  end
+end

data/lib/self_rateable/rating.rb

@@ -0,0 +1,6 @@
+module SelfRateable
+  class Rating < ActiveRecord::Base
+    belongs_to :rateable, :polymorphic => true
+    belongs_to :rater
+  end
+end

data/lib/self_rateable/version.rb

@@ -0,0 +1,3 @@
+module SelfRateable
+  VERSION = "1.0.0"
+end

data/lib/tasks/prepare.rake

@@ -0,0 +1,9 @@
+ desc "Creating migration for self_rateable"
+ task :self_rateable do
+ 	system "rails g model ratings rating:integer rateable_type:string rateable_id:integer rater_id:integer:index"
+ 	system "rm -rf app/models/ratings.rb"
+ 	system "rm -rf test/models/ratings_test.rb"
+ 	system "rm -rf test/fixtures/ratings.yml"
+ 	system "rake db:migrate" 
+ 	puts '==  Do not worry I\'ve deleted ratings.rb model and cleaned up test_unit directory =================================================='
+end

data/self_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 'self_rateable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "self_rateable"
+  spec.version       = SelfRateable::VERSION
+  spec.authors       = ["ostaptan"]
+  spec.email         = ["otan256@gmail.com"]
+  spec.description   = %q{Clean, powerful, customizable, simple, configurable, gem for displaying and handling ratings, likes, or stars for ActiveRecord model.}
+  spec.summary       = %q{Gem for displaying and handling ratings, likes, or stars for ActiveRecord model.}
+  spec.homepage      = "https://github.com/ostaptan/self_rateable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: self_rateable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ostaptan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Clean, powerful, customizable, simple, configurable, gem for displaying
+  and handling ratings, likes, or stars for ActiveRecord model.
+email:
+- otan256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/self_rateable.rb
+- lib/self_rateable/core/class_methods.rb
+- lib/self_rateable/core/instance_methods.rb
+- lib/self_rateable/railtie.rb
+- lib/self_rateable/rateable.rb
+- lib/self_rateable/rating.rb
+- lib/self_rateable/version.rb
+- lib/tasks/prepare.rake
+- self_rateable.gemspec
+homepage: https://github.com/ostaptan/self_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.0.7
+signing_key: 
+specification_version: 4
+summary: Gem for displaying and handling ratings, likes, or stars for ActiveRecord
+  model.
+test_files: []