party_boy 0.1.2 → 0.1.3

data/README.rdoc

@@ -54,7 +54,7 @@ To retrieve a set of models based on the relationships, use:
 
 ==== STI
 
-STI is also handled by party_boy. The relationship is always stored using the super-most class. However, relationships to inheriting classes can also be retrieved. Do so by passing in the type(s):
+STI is also handled by party_boy. The relationship is always stored using the super-most class. However, relationships to inheriting classes can also be retrieved. Do so by passing in the type:
 
  class Quarterback < User; end
  class Cheerleader < User; end
@@ -62,11 +62,14 @@ STI is also handled by party_boy. The relationship is always stored using the su
 
 In string form
  a.followers('users')
- a.following(%w(users quarterbacks))
-
+  => [#<User id: 1, created_at: "2010-01-27 01:09:42", updated_at: "2010-01-27 01:09:42">]
+ a.following(quarterbacks)
+  => [#<Quarterback id: 3, created_at: "2010-01-27 01:09:42", updated_at: "2010-01-27 01:09:42">]
 Or in class form
  a.followers(User)
- b.following([User, Quarterback, Cheerleader])
+  => [#<User id: 1, created_at: "2010-01-27 01:09:42", updated_at: "2010-01-27 01:09:42">]
+ b.following(Quarterback)
+  => [#<Quarterback id: 3, created_at: "2010-01-27 01:09:42", updated_at: "2010-01-27 01:09:42">]
 
 ==== STI - part deux
 
@@ -81,8 +84,31 @@ On top of accessing relationships through followers / following methods, party_b
 
 === acts_as_friend
 
-Docs coming soon. I don't need it, do you?
+To allow two models to become friends (requiring acceptance), add acts_as_friend to both. Now you can create a relationship between the two models by:
+
+ class Bob < ActiveRecord::Base
+  acts_as_friend
+ end
+
+ class Joe < ActiveRecord::Base
+  acts_as_friend
+ end
+
+ b = Bob.create
+ j = Joe.create
+
+ b.request_friendship(j)
+
+ b.pending?(j)
+  => true
+
+ b.outgoing_friend_requests   # or j.incoming_friend_requests
+  => [#<Relationship id: 1, :requestor_id: 1, :requestor_type: 'Bob', requestee_id: 1, requestee_type: 'Joe', restricted: true>]
+
+ j.accept_friendship(b)
 
+ b.friends
+  => [#<Joe id: 1>]
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/party_boy.rb

@@ -40,26 +40,18 @@ module Party
 		module RelateableInstanceMethods
 		
 		private
-			
+		
 			# should be able to pass a class, string, or object and get back the super-most class (before activerecord)
 			def super_class_name(obj = self)
-				obj = (obj.class == Class && obj || obj.class == String && obj.constantize || obj.class)
-				if obj.superclass != ActiveRecord::Base
-					super_class_name(obj.superclass)
-				else
-					obj.name
-				end
-			end
-			
-			def super_class_names(obj = self)
 				if obj.nil?
 					return nil
 				end
-				obj = (obj.class == Class && obj || obj.class == String && obj.constantize || obj.class)
+				
+				obj = (obj.class == Class && obj || obj.class == String && obj.classify.constantize || obj.class)
 				if obj.superclass != ActiveRecord::Base
-					[obj.name, super_class_names(obj.superclass)].flatten
+					super_class_name(obj.superclass)
 				else
-					[obj.name]
+					obj.name
 				end
 			end
 			
@@ -112,11 +104,10 @@ module Party
 			end
 			
 			def followers(type = nil)
-				type = [type].flatten.compact.uniq
-				super_class = type.last
-				exact_class = type.first
+				super_class = super_class_name(type)
+				exact_class = type && type.to_s.classify
 				results = relationships_from(super_class)
-				if super_class != exact_class
+				if super_class && exact_class && super_class != exact_class
 					results.collect{|r| r.requestor.class.name == exact_class && r.requestor || nil}.compact
 				else
 					results.collect{|r| r.requestor}
@@ -125,11 +116,10 @@ module Party
 			end
 			
 			def following(type = nil)
-				type = [type].flatten.compact.uniq
-				super_class = type.last
-				exact_class = type.first
+				super_class = super_class_name(type)
+				exact_class = type && type.to_s.classify
 				results = relationships_to(super_class)
-				if super_class != exact_class
+				if super_class && exact_class && super_class != exact_class
 					results.collect{|r| r.requestee.class.name == exact_class && r.requestee || nil}.compact
 				else
 					results.collect{|r| r.requestee}
@@ -143,12 +133,11 @@ module Party
 			def method_missing(method, *args)
 				case method.id2name
 				when /^(.+)ss_followers$/
-					# this is for the rare case of a class name ending in ss, like 'business'; 'business'.classify => 'Busines'
-					followers(super_class_names("#{$1.classify}ss"))
+					followers("#{$1}ss".classify)
 				when /^(.+)s_followers$/, /^(.+)_followers$/
-					followers(super_class_names($1.classify))
+					followers($1.classify)
 				when /^following_(.+)$/
-					following(super_class_names($1.classify))
+					following($1.classify)
 				else
 					super
 				end
@@ -184,7 +173,7 @@ module Party
 				self.incoming_friendships.unaccepted.all
 			end
 			
-			def is_friends_with?(something)
+			def friends_with?(something)
 				arr = something && [self.id, super_class_name, super_class_name(something), something.id]
 				arr && Relationship.accepted.count(:conditions => [(['(requestor_id = ? AND requestor_type = ? AND requestee_type = ? AND requestee_id = ?)']*2).join(' OR '), arr, arr.reverse].flatten) > 0
 			end
@@ -201,14 +190,14 @@ module Party
 			
 			def request_friendship(friendship_or_something)
 				rel = relationship_from(friendship_or_something)
-				rel.nil? && Relationship.create(:requestor => self, :requestee => friendship_or_something, :restricted => true) || rel.update_attributes(:restricted => false)
+				rel.nil? && Relationship.create(:requestor => self, :requestee => friendship_or_something, :restricted => true) || (rel.requestee == self && rel.update_attributes(:restricted => false))
 			end
 			
 			def deny_friendship(friendship_or_something)
 				(rel = relationship_from(friendship_or_something)) && rel.destroy
 			end
 			
-			alias_method :reject_friendship, :deny_friendship
+			[:reject_friendship, :destroy_friendship, :leave_friendship].each{|key| alias_method key, :deny_friendship}
 			alias_method :accept_friendship, :request_friendship
 			
 		private
@@ -224,4 +213,16 @@ module Party
 			end	
 		end
 	end
-end
+end
+
+class String
+	def classify
+		if self[(self.length - 2)...self.length] == 'ss'
+			"#{self[0...(self.length-2)].classify}ss"
+		else
+			super
+		end
+	end
+end
+
+::ActiveRecord::Base.send :include, Party::Boy

data/party_boy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{party_boy}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mike Nelson"]
-  s.date = %q{2010-01-28}
+  s.date = %q{2010-01-29}
   s.description = %q{Models relationships between AR models. Allows you to follow, friend, and block other AR's. Consists of two mixins: acts_as_followable and acts_as_friend. These options allow an AR to inherit either a twitter-like follower system or a facebook-like friend system.}
   s.email = %q{mdnelson30@gmail.com}
   s.extra_rdoc_files = [

data/spec/party_boy_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 
-describe "PartyBoy" do
+describe "party_boy" do
 	
 	it "should integrate follower methods properly" do
 		%w(followers following following? followed_by?).each do |method|
@@ -39,7 +39,7 @@ describe "PartyBoy" do
 	
 end
 
-describe "PartyBoy -- Follower" do
+describe "party_boy -- follower" do
 	it "should generate relationships and return proper counts" do
 		a = FollowerClass.create
 		b = FollowerClass.create
@@ -126,7 +126,7 @@ describe "PartyBoy -- Follower" do
 	
 	class User < FollowerClass; end
 	class Business < FollowerClass; end
-	
+	class Program < FollowerClass; end
 	
 	it "should handle STI properly" do 
 		u = User.create
@@ -138,6 +138,26 @@ describe "PartyBoy -- Follower" do
 		u.following.first.class.name.should eql('Business')
 	end
 	
+	it "should handle passed data types properly" do 
+		u = User.create
+		b = Business.create
+		p = Program.create
+		
+		u.follow(b)
+		u.follow(p)
+		
+		u.following(Business).should eql([b])
+		u.following(Program).should eql([p])
+		u.following.size.should eql(2)
+		
+		u.following('Business').should eql([b])
+		u.following('businesses').should eql([b])
+		u.following('Program').should eql([p])
+		u.following('programs').should eql([p])
+		
+		u.following.size.should eql(2)
+	end
+	
 	it "should handle method_missing properly" do
 		u = User.create
 		b = Business.create
@@ -165,3 +185,62 @@ describe "PartyBoy -- Follower" do
 	
 end
 
+
+describe "party_boy - friend" do 
+	
+	it "should make and break friendships properly" do
+		a = FriendClass.create
+		b = FriendClass.create
+		
+		r = a.request_friendship(b)
+		r.accepted?.should be_false
+		
+		b.incoming_friend_requests.size.should eql(1)
+		a.outgoing_friend_requests.size.should eql(1)
+		
+		b.accept_friendship(a)
+		
+		a.friends.should eql([b])
+		b.friends.should eql([a])
+		
+		a.leave_friendship(b)
+		
+		a.friends.empty?.should be_true
+		b.friends.empty?.should be_true
+		
+		a.request_friendship(b)
+		b.request_friendship(a)
+		
+		a.friends.should eql([b])
+		b.friends.should eql([a])
+	end
+	
+	it "should return proper counts and states" do
+		a = FriendClass.new
+		b = FriendClass.new
+		c = FriendClass.new
+		d = FriendClass.new
+		
+		a.request_friendship(b)
+		a.request_friendship(c)
+		b.request_friendship(c)
+		
+		a.pending?(b).should be_true
+		a.pending?(c).should be_true
+		a.pending?(d).should be_false
+		
+		b.accept_friendship(a)
+		c.accept_friendship(a)
+		c.reject_friendship(b)
+		
+		a.friend_count.should eql(2)
+		b.friend_count.should eql(1)
+		c.friend_count.should eql(1)
+		
+		a.friends_with?(b).should be_true
+		c.friends_with?(a).should be_true
+		b.friends_with?(c).should be_false
+	end
+	
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: party_boy
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Mike Nelson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -05:00
+date: 2010-01-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency