movr_acts_as_likeable 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,14 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "shoulda", ">= 0"
10
+ gem "rdoc", "~> 3.12"
11
+ gem "bundler", "~> 1.0.0"
12
+ gem "jeweler", "~> 1.8.3"
13
+ gem "rcov", ">= 0"
14
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,29 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ jeweler (1.8.3)
6
+ bundler (~> 1.0)
7
+ git (>= 1.2.5)
8
+ rake
9
+ rdoc
10
+ json (1.6.5)
11
+ rake (0.9.2.2)
12
+ rcov (1.0.0)
13
+ rdoc (3.12)
14
+ json (~> 1.4)
15
+ shoulda (3.0.1)
16
+ shoulda-context (~> 1.0.0)
17
+ shoulda-matchers (~> 1.0.0)
18
+ shoulda-context (1.0.0)
19
+ shoulda-matchers (1.0.0)
20
+
21
+ PLATFORMS
22
+ ruby
23
+
24
+ DEPENDENCIES
25
+ bundler (~> 1.0.0)
26
+ jeweler (~> 1.8.3)
27
+ rcov
28
+ rdoc (~> 3.12)
29
+ shoulda
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Umer Farooq
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,82 @@
1
+ = movr_acts_as_likeable
2
+ == Resources
3
+
4
+ Install
5
+ * Create a new rails migration and add the following self.up and self.down methods
6
+
7
+ def self.up
8
+ create_table "likings", :force => true do |t|
9
+ t.column "liking", :boolean, :default => false
10
+ t.column "created_at", :datetime, :null => false
11
+ t.column "likeable_type", :string, :limit => 15, :default => "", :null => false
12
+ t.column "likeable_id", :integer, :default => 0, :null => false
13
+ t.column "user_id", :integer, :default => 0, :null => false
14
+ end
15
+
16
+ add_index "likings", ["user_id"], :name => "fk_likings_user"
17
+ end
18
+
19
+ def self.down
20
+ drop_table :likings
21
+ end
22
+
23
+ == Usage
24
+ * Make your ActiveRecord model act as likeable.
25
+
26
+ class Model < ActiveRecord::Base
27
+ acts_as_likeable
28
+ end
29
+
30
+ * Add a liking to a model instance
31
+
32
+ model = Model.new
33
+ liking = Liking.new(:liking => 1) (0=dislike, 1=like)
34
+ model.likings << liking / model.add_liking(liking)
35
+
36
+ * Each liking references the likeable object
37
+
38
+ model = Model.find(1)
39
+ model.likings.get(0).likeable == model
40
+
41
+ * Count total likes of the likeable object
42
+
43
+ model.find(1)
44
+ model.likes_count (Count of Likes)
45
+
46
+ * Count total dislikes of the likeable object
47
+
48
+ model.find(1)
49
+ model.dislikes_count (Count of DisLikes)
50
+
51
+ * Count percentage of likes to dislikes for the likeable object
52
+
53
+ model.find(1)
54
+ model.likes_percentage
55
+
56
+ * Count percentage of dislikes to likes for the likeable object
57
+
58
+ model.find(1)
59
+ model.dislikes_percentage
60
+
61
+ == Inspiration
62
+
63
+ This Plugin is heavily influenced by acts_as_voteable & acts_as_rateable,
64
+ can be used for Thumbs Up/Down or Likes/Dislikes situations, also helps to
65
+ get the Percentage of Likes to Dislikes and vice versa on an Object, to depict
66
+ average popularity.
67
+
68
+ == Contributing to movr_acts_as_likeable
69
+
70
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
71
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
72
+ * Fork the project.
73
+ * Start a feature/bugfix branch.
74
+ * Commit and push until you are happy with your contribution.
75
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
76
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
77
+
78
+ == Copyright
79
+
80
+ Copyright (c) 2012 https://github.com/umerfarooq (umerfarooq) on github for origonal plugin and Daryl Moulder https://github.com/darmou. See LICENSE.txt for
81
+ further details.
82
+
data/Rakefile ADDED
@@ -0,0 +1,53 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "movr_acts_as_likeable"
18
+ gem.homepage = "http://github.com/darmou/movr_acts_as_likeable"
19
+ gem.license = "MIT"
20
+ gem.summary = %Q{Social Media Acts As Likeable}
21
+ gem.description = %Q{This gem is heavily influenced by acts_as_voteable & acts_as_rateable, can be used for Thumbs Up/Down or Likes/Dislikes situations, also helps to get the Percentage of Likes to Dislikes and vice versa on an Object, to depict average popularity.}
22
+ gem.email = "dmoulder@qtome.com"
23
+ gem.authors = ["Daryl Moulder, https://github.com/umerfarooq"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ require 'rcov/rcovtask'
36
+ Rcov::RcovTask.new do |test|
37
+ test.libs << 'test'
38
+ test.pattern = 'test/**/test_*.rb'
39
+ test.verbose = true
40
+ test.rcov_opts << '--exclude "gems/*"'
41
+ end
42
+
43
+ task :default => :test
44
+
45
+ require 'rdoc/task'
46
+ Rake::RDocTask.new do |rdoc|
47
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
48
+
49
+ rdoc.rdoc_dir = 'rdoc'
50
+ rdoc.title = "movr_acts_as_likeable #{version}"
51
+ rdoc.rdoc_files.include('README*')
52
+ rdoc.rdoc_files.include('lib/**/*.rb')
53
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
data/init.rb ADDED
@@ -0,0 +1,3 @@
1
+ # Include hook code here
2
+ require 'acts_as_likeable'
3
+ ActiveRecord::Base.send(:include, ActiveRecord::Acts::Likeable)
data/lib/liking.rb ADDED
@@ -0,0 +1,18 @@
1
+ class Liking < ActiveRecord::Base
2
+ belongs_to :likeable, :polymorphic => true
3
+
4
+ # NOTE: Likings belong to a user
5
+ belongs_to :user
6
+
7
+ named_scope :likes, :conditions => {:liking => 1}
8
+ named_scope :dislikes, :conditions => {:liking => 0}
9
+
10
+ # Helper class method to lookup all likings assigned to all likeable types for a given user.
11
+ def self.find_all_likings_by_user(user)
12
+ find(
13
+ :all,
14
+ :conditions => ["user_id = ?", user.id],
15
+ :order => "created_at DESC"
16
+ )
17
+ end
18
+ end
@@ -0,0 +1,68 @@
1
+ # MovrActsAsLikeable
2
+ module ActiveRecord
3
+ module Acts
4
+ module Likeable
5
+
6
+ def self.included(base)
7
+ base.extend ClassMethods
8
+ end
9
+
10
+ module ClassMethods
11
+ def acts_as_likeable
12
+ has_many :likings, :as => :likeable, :dependent => :destroy
13
+ include ActiveRecord::Acts::Likeable::InstanceMethods
14
+ end
15
+ end
16
+
17
+ # This module contains instance methods
18
+ module InstanceMethods
19
+ # Helper method that associates the Liking with the Object
20
+ def add_liking(liking)
21
+ likings << liking
22
+ end
23
+
24
+ # Helper method to calculate the total likes for this Likeable
25
+ def likes_count
26
+ likes = Liking.find(
27
+ :all,
28
+ :conditions => ["likeable_id = ? AND likeable_type = ? AND liking = TRUE",id, self.type.name])
29
+ likes.size
30
+ end
31
+
32
+ # Helper method to calculate the total dislikes for this Likeable
33
+ def dislikes_count
34
+ likes = Liking.find(
35
+ :all,
36
+ :conditions => ["likeable_id = ? AND likeable_type = ? AND liking = FALSE",id, self.type.name])
37
+ likes.size
38
+ end
39
+
40
+ # Helper method to calculate the total likings for this Likeable
41
+ def likings_count
42
+ self.likings.size
43
+ end
44
+
45
+ # Helper method to calculate the percentage of likes to dislikes for this Likeable
46
+ def likes_percentage
47
+ (likes_count*100)/likings_count
48
+ end
49
+
50
+ # Helper method to calculate the percentage of dislikes to likes for this Likeable
51
+ def dislikes_percentage
52
+ (dislikes_count*100)/likings_count
53
+ end
54
+
55
+ # Helper method to see if a user already liked this likeable
56
+ def liked_by_user?(user)
57
+ rtn = false
58
+ if user
59
+ self.likings.each { |l|
60
+ rtn = true if user.id == l.user_id
61
+ }
62
+ end
63
+ rtn
64
+ end
65
+ end
66
+ end
67
+ end
68
+ end
@@ -0,0 +1,64 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{movr_acts_as_likeable}
8
+ s.version = "0.1.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Daryl Moulder, https://github.com/umerfarooq"]
12
+ s.date = %q{2012-03-15}
13
+ s.description = %q{This gem is heavily influenced by acts_as_voteable & acts_as_rateable, can be used for Thumbs Up/Down or Likes/Dislikes situations, also helps to get the Percentage of Likes to Dislikes and vice versa on an Object, to depict average popularity.}
14
+ s.email = %q{dmoulder@qtome.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ "Gemfile",
22
+ "Gemfile.lock",
23
+ "LICENSE.txt",
24
+ "README.rdoc",
25
+ "Rakefile",
26
+ "VERSION",
27
+ "init.rb",
28
+ "lib/liking.rb",
29
+ "lib/movr_acts_as_likeable.rb",
30
+ "movr_acts_as_likeable.gemspec",
31
+ "test/helper.rb",
32
+ "test/test_movr_acts_as_likeable.rb"
33
+ ]
34
+ s.homepage = %q{http://github.com/darmou/movr_acts_as_likeable}
35
+ s.licenses = ["MIT"]
36
+ s.require_paths = ["lib"]
37
+ s.rubygems_version = %q{1.7.2}
38
+ s.summary = %q{Social Media Acts As Likeable}
39
+
40
+ if s.respond_to? :specification_version then
41
+ s.specification_version = 3
42
+
43
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
44
+ s.add_development_dependency(%q<shoulda>, [">= 0"])
45
+ s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
46
+ s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
47
+ s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
48
+ s.add_development_dependency(%q<rcov>, [">= 0"])
49
+ else
50
+ s.add_dependency(%q<shoulda>, [">= 0"])
51
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
52
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
53
+ s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
54
+ s.add_dependency(%q<rcov>, [">= 0"])
55
+ end
56
+ else
57
+ s.add_dependency(%q<shoulda>, [">= 0"])
58
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
59
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
60
+ s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
61
+ s.add_dependency(%q<rcov>, [">= 0"])
62
+ end
63
+ end
64
+
data/test/helper.rb ADDED
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'movr_acts_as_likeable'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestMovrActsAsLikeable < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,152 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: movr_acts_as_likeable
3
+ version: !ruby/object:Gem::Version
4
+ hash: 27
5
+ prerelease:
6
+ segments:
7
+ - 0
8
+ - 1
9
+ - 0
10
+ version: 0.1.0
11
+ platform: ruby
12
+ authors:
13
+ - Daryl Moulder, https://github.com/umerfarooq
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2012-03-15 00:00:00 Z
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ prerelease: false
22
+ type: :development
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ none: false
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ hash: 3
29
+ segments:
30
+ - 0
31
+ version: "0"
32
+ version_requirements: *id001
33
+ name: shoulda
34
+ - !ruby/object:Gem::Dependency
35
+ prerelease: false
36
+ type: :development
37
+ requirement: &id002 !ruby/object:Gem::Requirement
38
+ none: false
39
+ requirements:
40
+ - - ~>
41
+ - !ruby/object:Gem::Version
42
+ hash: 31
43
+ segments:
44
+ - 3
45
+ - 12
46
+ version: "3.12"
47
+ version_requirements: *id002
48
+ name: rdoc
49
+ - !ruby/object:Gem::Dependency
50
+ prerelease: false
51
+ type: :development
52
+ requirement: &id003 !ruby/object:Gem::Requirement
53
+ none: false
54
+ requirements:
55
+ - - ~>
56
+ - !ruby/object:Gem::Version
57
+ hash: 23
58
+ segments:
59
+ - 1
60
+ - 0
61
+ - 0
62
+ version: 1.0.0
63
+ version_requirements: *id003
64
+ name: bundler
65
+ - !ruby/object:Gem::Dependency
66
+ prerelease: false
67
+ type: :development
68
+ requirement: &id004 !ruby/object:Gem::Requirement
69
+ none: false
70
+ requirements:
71
+ - - ~>
72
+ - !ruby/object:Gem::Version
73
+ hash: 49
74
+ segments:
75
+ - 1
76
+ - 8
77
+ - 3
78
+ version: 1.8.3
79
+ version_requirements: *id004
80
+ name: jeweler
81
+ - !ruby/object:Gem::Dependency
82
+ prerelease: false
83
+ type: :development
84
+ requirement: &id005 !ruby/object:Gem::Requirement
85
+ none: false
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ hash: 3
90
+ segments:
91
+ - 0
92
+ version: "0"
93
+ version_requirements: *id005
94
+ name: rcov
95
+ description: This gem is heavily influenced by acts_as_voteable & acts_as_rateable, can be used for Thumbs Up/Down or Likes/Dislikes situations, also helps to get the Percentage of Likes to Dislikes and vice versa on an Object, to depict average popularity.
96
+ email: dmoulder@qtome.com
97
+ executables: []
98
+
99
+ extensions: []
100
+
101
+ extra_rdoc_files:
102
+ - LICENSE.txt
103
+ - README.rdoc
104
+ files:
105
+ - .document
106
+ - Gemfile
107
+ - Gemfile.lock
108
+ - LICENSE.txt
109
+ - README.rdoc
110
+ - Rakefile
111
+ - VERSION
112
+ - init.rb
113
+ - lib/liking.rb
114
+ - lib/movr_acts_as_likeable.rb
115
+ - movr_acts_as_likeable.gemspec
116
+ - test/helper.rb
117
+ - test/test_movr_acts_as_likeable.rb
118
+ homepage: http://github.com/darmou/movr_acts_as_likeable
119
+ licenses:
120
+ - MIT
121
+ post_install_message:
122
+ rdoc_options: []
123
+
124
+ require_paths:
125
+ - lib
126
+ required_ruby_version: !ruby/object:Gem::Requirement
127
+ none: false
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ hash: 3
132
+ segments:
133
+ - 0
134
+ version: "0"
135
+ required_rubygems_version: !ruby/object:Gem::Requirement
136
+ none: false
137
+ requirements:
138
+ - - ">="
139
+ - !ruby/object:Gem::Version
140
+ hash: 3
141
+ segments:
142
+ - 0
143
+ version: "0"
144
+ requirements: []
145
+
146
+ rubyforge_project:
147
+ rubygems_version: 1.7.2
148
+ signing_key:
149
+ specification_version: 3
150
+ summary: Social Media Acts As Likeable
151
+ test_files: []
152
+