has_friends-rails3 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nando Vieira
+
+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.markdown

@@ -0,0 +1,123 @@
+has_friends
+===========
+
+**ATTENTION:** This is a Rails 3 implementation.
+
+NOTE: You should have a User model. When you execute the plugin generator, I'll add a column
+friends_count on users' table.
+
+
+Instalation
+-----------
+
+1) Add a gem line to your Gemfile. `gem 'has_friends-rails3, :require => 'has_friends'`
+
+2) Execute the plugin generator `rails g has_friends:migration`
+
+3) Run the migrations with `rake db:migrate`
+
+Usage
+-----
+
+1) Add the method call `has_friends` to your model.
+
+	class User < ActiveRecord::Base
+	  has_friends
+	end
+
+	john = User.find_by_login 'john'
+	mary = User.find_by_login 'mary'
+	paul = User.find_by_login 'paul'
+
+	# John wants to be friend with Mary
+	# always return a friendship object
+	john.be_friends_with(mary, "Hi Mary! I have worked with you on Meroy Merlin!")
+	
+	# Creating a new Relation kind
+	RelationType.create(:name => "coworker")
+	
+	# You can pass kind of relationship, when...
+	john.be_friends_with(mary, "Hi Mary! I have worked with you on Meroy Merlin!", [:coworker])
+
+	# if you specify a non existent Relation, 
+	# it will create a new Relation
+	# and associate then to friendship 
+	john.be_friends_with(mary, "Hi Mary! I have worked with you on Meroy Merlin!", [:coworker, :friend])
+	# In this case, friend is a new relation
+
+	# are they friends?
+	john.friends?(mary) ==> false
+
+	# get the friendship object
+	john.friendship_for(mary)
+	
+	# Mary accepts John's request if it exists...
+	mary.accept_friendship_with(john)
+	mary.friends?(john) ==> true
+	
+	# either if Mary request John's friendship, then they will be friends automatically.
+	mary.be_friends_with(john)
+	mary.friends?(john) ==> true
+	
+	# Mary can reject John's friendship.
+	mary.remove_friendship_with(john)
+	
+	# check if an user is the current user, so it can
+	# be differently presented
+	mary.friends.each {|friend| friend.is?(current_user) }
+
+	# if you're dealing with a friendship object,
+	# the following methods are available
+	friendship.accept!
+	
+	# You can specify relations when accept a friendship, so...
+	friendship.accept!([:friend])
+	
+	# If you want to accept friendship and clear current relations...
+	friendship.accept!([])
+	
+	# the be_friends_with method returns 2 params: friendship object and status.
+	# the friendship object will be present only when the friendship is created
+	# (that is, when is requested for the first time)
+	# STATUS_ALREADY_FRIENDS       # => users are already friends
+	# STATUS_ALREADY_REQUESTED     # => user has already requested friendship
+	# STATUS_IS_YOU                # => user is trying add himself as friend
+	# STATUS_FRIEND_IS_REQUIRED    # => friend argument is missing
+	# STATUS_FRIENDSHIP_ACCEPTED   # => friendship has been accepted
+	# STATUS_REQUESTED             # => friendship has been requested
+	
+	friendship, status = mary.be_friends_with(john)
+	
+	if status == Friendship::STATUS_REQUESTED
+	  # the friendship has been requested
+	  Mailer.deliver_friendship_request(friendship)
+	elsif status == Friendship::STATUS_ALREADY_FRIENDS
+	  # they're already friends
+	else
+	  # ...
+	end
+
+
+LICENSE:
+--------
+
+(The 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/RakeFile

@@ -0,0 +1,25 @@
+if defined?(Rspec)
+  require 'spec/rake/spectask'
+
+  namespace :has_friends do
+    desc "Run all specs in spec directory (excluding plugin specs)"
+    Spec::Rake::SpecTask.new(:spec) do |t|
+      t.spec_files = FileList["spec/**/*_spec.rb"]
+    end
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "has_friends-rails3"
+    gemspec.summary = "Rails 3 version of has_friends gem"
+    gemspec.description = "Rails 3 version of has_friends gem"
+    gemspec.email = "rrouse@rachotech.com"
+    gemspec.homepage = "http://github.com/rrouse/has_friends"
+    gemspec.authors = ["Robert Rouse"]
+    gemspec.files.include %w(lib/**/*.rb)
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/app/models/friendship.rb

@@ -0,0 +1,72 @@
+class Friendship < ActiveRecord::Base
+  # constants
+  STATUS_ALREADY_FRIENDS     = 1
+  STATUS_ALREADY_REQUESTED   = 2
+  STATUS_IS_YOU              = 3
+  STATUS_FRIEND_IS_REQUIRED  = 4
+  STATUS_FRIENDSHIP_ACCEPTED = 5
+  STATUS_REQUESTED           = 6
+  
+  FRIENDSHIP_ACCEPTED = "accepted"
+  FRIENDSHIP_PENDING = "pending"
+  FRIENDSHIP_REQUESTED = "requested"
+  
+  # scopes
+  scope :pending, :conditions => {:status => FRIENDSHIP_PENDING}
+  scope :accepted, :conditions => {:status => FRIENDSHIP_ACCEPTED}
+  scope :requested, :conditions => {:status => FRIENDSHIP_REQUESTED}
+  
+  # associations
+  belongs_to :user
+  belongs_to :friend, :class_name => 'User', :foreign_key => 'friend_id'
+  belongs_to :message, :class_name => "FriendshipMessage", :foreign_key => "friendship_message_id", :dependent => :destroy
+  
+  has_many :friendship_relations, :class_name => "FriendshipRelationType", :readonly => true, :dependent => :destroy
+  has_many :relations, :through => :friendship_relations, :class_name => "RelationType", :source => :relation
+  
+  # callback
+  after_destroy do |f|
+    User.decrement_counter(:friends_count, f.user_id) if f.status == FRIENDSHIP_ACCEPTED
+  end
+  
+  def pending?
+    status == FRIENDSHIP_PENDING
+  end
+  
+  def accepted?
+    status == FRIENDSHIP_ACCEPTED
+  end
+  
+  def requested?
+    status == FRIENDSHIP_REQUESTED
+  end
+
+  def accept!(new_relation_names = nil)
+    unless accepted?
+      self.transaction do
+        User.increment_counter(:friends_count, user_id)
+        update_attribute(:status, FRIENDSHIP_ACCEPTED)
+        update_attribute(:accepted_at, Time.now)
+        add_relations(new_relation_names) unless new_relation_names.nil?
+      end
+    end
+  end
+  
+  def add_relations(new_relation_names = [])
+    self.transaction do
+      actual_relation_names = self.relation_names
+      self.friendship_relations.each do |fr|
+        fr.destroy unless actual_relation_names.include?(fr.relation.name.to_sym)
+      end
+
+      new_relation_names.each do |nr|
+        relation = RelationType.find_or_create_by_name(nr.to_s)
+        self.relations << relation unless relations.include?(relation)
+      end
+    end
+  end
+  
+  def relation_names
+    relations.all(:select => :name, :order => :name).collect{|r| r.name}
+  end
+end

data/app/models/friendship_message.rb

@@ -0,0 +1,3 @@
+class FriendshipMessage < ActiveRecord::Base
+  validates :body, :presence => true
+end

data/app/models/friendship_relation_type.rb

@@ -0,0 +1,4 @@
+class FriendshipRelationType < ActiveRecord::Base
+  belongs_to :friendship
+  belongs_to :relation, :class_name => "RelationType"
+end

data/app/models/relation_type.rb

@@ -0,0 +1,10 @@
+class RelationType < ActiveRecord::Base
+  validates :name, :presence => true
+  
+  after_destroy :destroy_all_friendsip_relations
+  
+  private
+    def destroy_all_friendsip_relations
+      FriendshipRelationType.delete_all :relation_id => self.id
+    end
+end

data/has_friends-rails3.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in RakeFile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_friends-rails3}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robert Rouse"]
+  s.date = %q{2010-07-25}
+  s.description = %q{Rails 3 version of has_friends gem}
+  s.email = %q{rrouse@rachotech.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.markdown",
+     "RakeFile",
+     "VERSION",
+     "app/models/friendship.rb",
+     "app/models/friendship_message.rb",
+     "app/models/friendship_relation_type.rb",
+     "app/models/relation_type.rb",
+     "has_friends-rails3.gemspec",
+     "lib/generators/has_friends.rb",
+     "lib/generators/has_friends/migration/migration_generator.rb",
+     "lib/generators/has_friends/migration/templates/create_has_friends_tables.rb",
+     "lib/has_friends.rb",
+     "lib/has_friends/engine.rb",
+     "lib/has_friends/exceptions.rb",
+     "lib/has_friends/has_friends.rb",
+     "spec/fixtures/relation_types.yml",
+     "spec/fixtures/users.yml",
+     "spec/friendship_message_spec.rb",
+     "spec/friendship_relation_type_spec.rb",
+     "spec/friendship_spec.rb",
+     "spec/has_friends_spec.rb",
+     "spec/relation_type_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rrouse/has_friends}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails 3 version of has_friends gem}
+  s.test_files = [
+    "spec/friendship_message_spec.rb",
+     "spec/friendship_relation_type_spec.rb",
+     "spec/friendship_spec.rb",
+     "spec/has_friends_spec.rb",
+     "spec/relation_type_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/generators/has_friends/migration/migration_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/has_friends'
+
+module HasFriends
+  module Generators
+    class MigrationGenerator < Base
+      desc "Generate has_friends migration"
+      
+      def create_migration_file
+        migration_template "create_has_friends_tables.rb", File.join('db', 'migrate', "create_has_friends_tables.rb")
+      end
+      
+    end
+  end
+end

data/lib/generators/has_friends/migration/templates/create_has_friends_tables.rb

@@ -0,0 +1,42 @@
+class CreateHasFriendsTables < ActiveRecord::Migration
+  def self.up
+    create_table :friendships, :force => true do |t|
+      t.references :user, :friend, :friendship_message
+      t.datetime :requested_at, :accepted_at
+      t.string :status
+      t.timestamps
+    end
+    
+    add_index :friendships, :user_id
+    add_index :friendships, :friend_id
+    add_index :friendships, :status
+    
+    create_table :relation_types, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+    
+    add_index :relation_types, :name
+    
+    create_table :friendship_messages, :force => true do |t|
+      t.string :body
+      t.timestamps
+    end
+    
+    create_table :friendship_relation_types, :force => true do |t|
+      t.references :relation, :friendship
+      t.timestamps
+    end
+    
+    add_column :users, :friends_count, :integer, :default => 0, :null => false
+  end
+
+  def self.down
+    remove_column :users, :friends_count
+    
+    drop_table :friendship_relation_types
+    drop_table :friendship_messages
+    drop_table :relation_types
+    drop_table :friendships
+  end
+end

data/lib/generators/has_friends.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/migration'
+
+module HasFriends
+  module Generators
+    class Base < Rails::Generators::Base
+      
+      include Rails::Generators::Migration
+      
+      def self.source_root
+        @_has_friends_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'has_friends', generator_name, 'templates'))
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+    end
+  end
+end

data/lib/has_friends/engine.rb

@@ -0,0 +1,10 @@
+require 'has_friends'
+require 'rails'
+
+module Has
+  module Friends
+    class Engine < Rails::Engine
+    
+    end
+  end
+end

data/lib/has_friends/exceptions.rb

@@ -0,0 +1 @@
+class YouCanNotJudgeARequestFriendshipError < StandardError; end

data/lib/has_friends/has_friends.rb

@@ -0,0 +1,118 @@
+module Has
+  module Friends
+    def self.included(base)
+      base.extend Has::Friends::ClassMethods
+    end
+    
+    module ClassMethods
+      def has_friends
+        include Has::Friends::InstanceMethods
+        
+        has_many :friendships
+        has_many :friends, :through => :friendships, :source => :friend, :conditions => "friendships.status = 'accepted'"
+        
+        after_destroy :destroy_all_friendships
+      end
+    end
+    
+    module InstanceMethods
+      def be_friends_with(friend, message = nil, relations = [])
+        # no user object
+        return nil, Friendship::STATUS_FRIEND_IS_REQUIRED unless friend
+        
+        # should not create friendship if user is trying to add himself
+        return nil, Friendship::STATUS_IS_YOU if is?(friend)
+        
+        # should not create friendship if users are already friends
+        return nil, Friendship::STATUS_ALREADY_FRIENDS if friends?(friend)
+        
+        # retrieve the friendship request
+        friendship = self.friendship_for(friend)
+        
+        # let's check if user has already a friendship request or have removed
+        request = friend.friendship_for(self)
+        
+        # friendship has already been requested
+        return nil, Friendship::STATUS_ALREADY_REQUESTED if friendship && friendship.requested?
+        
+        # friendship is pending so accept it
+        if friendship && friendship.pending?
+          ActiveRecord::Base.transaction do
+            friendship.accept!
+            request.accept!
+          end
+          
+          return friendship, Friendship::STATUS_FRIENDSHIP_ACCEPTED
+        end
+        
+        ActiveRecord::Base.transaction do
+          message = FriendshipMessage.create(:body => message) if message
+
+          # we didn't find a friendship, so let's create one!
+          friendship = self.friendships.create(:friend_id => friend.id, :status => 'requested', :message => message, :requested_at => Time.now)
+          friendship.add_relations(relations)
+
+          # we didn't find a friendship request, so let's create it!
+          request = friend.friendships.create(:friend_id => id, :status => 'pending', :message => message, :requested_at => Time.now)
+          request.add_relations(relations)
+        end
+        
+        return friendship, Friendship::STATUS_REQUESTED
+      end
+      
+      def friends?(friend)
+        friendship = friendship_for(friend)
+        !!(friendship && friendship.accepted?)
+      end
+      
+      def friendship_for(friend)
+        friendships.first :conditions => {:friend_id => friend.id}
+      end
+      
+      def is?(friend)
+        self.id == friend.id
+      end
+      
+      def remove_friendship_with(friend)
+        ActiveRecord::Base.transaction do
+          [friendship_for(friend), friend.friendship_for(self)].compact.each do |friendship|
+            friendship.destroy if friendship
+          end
+        end
+      end
+      
+      def deny_friendship_with(friend)
+        if (pendent = self.friendship_for(friend)).pending?
+          ActiveRecord::Base.transaction do
+            [friendship_for(friend), friend.friendship_for(self)].compact.each do |friendship|
+              friendship.destroy if friendship
+            end
+          end
+        else
+          raise YouCanNotJudgeARequestFriendshipError
+        end
+      end
+      
+      def accept_friendship_with(friend, relations = nil)
+        if (pendent = self.friendship_for(friend)).pending?
+          requested = friend.friendship_for(self)
+          
+          ActiveRecord::Base.transaction do
+            pendent.accept!(relations) 
+            requested.accept! unless requested.accepted?
+          end
+        else
+          raise YouCanNotJudgeARequestFriendshipError
+        end
+      end      
+      
+      private
+        def destroy_all_friendships
+          ActiveRecord::Base.transaction do
+            Friendship.delete_all({:user_id => id})
+            Friendship.delete_all({:friend_id => id})
+          end
+        end
+    end
+  end
+end

data/lib/has_friends.rb

@@ -0,0 +1,5 @@
+require 'has_friends/engine'
+require 'has_friends/has_friends'
+require 'has_friends/exceptions'
+
+ActiveRecord::Base.send(:include, Has::Friends)

data/spec/fixtures/relation_types.yml

@@ -0,0 +1,8 @@
+friend:
+  name: friend
+
+met:
+  name: met
+
+coworker:
+  name: coworker

data/spec/fixtures/users.yml

@@ -0,0 +1,14 @@
+vader:
+  login: darth_vader
+
+luke:
+  login: luke_skywalker
+
+leia:
+  login: princess_leia
+
+han_solo:
+  login: han_solo
+  
+yoda:
+  login: yoda

data/spec/friendship_message_spec.rb

@@ -0,0 +1,10 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe FriendshipMessage do
+  it "should require a body" do
+    @message = FriendshipMessage.new
+
+    @message.should_not be_valid
+    @message.errors[:body].should == "can't be blank"
+  end
+end

data/spec/friendship_relation_type_spec.rb

@@ -0,0 +1,17 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe FriendshipRelationType do
+  describe "structure" do
+    it "should belong_to :friendship" do
+      @friendship = Friendship.new
+      @friendship_relation = FriendshipRelationType.new :friendship => @friendship
+      @friendship_relation.friendship.should == @friendship
+    end
+
+    it "should belong_to :relation" do
+      @relation = RelationType.new
+      @friendship_relation = FriendshipRelationType.new :relation => @relation
+      @friendship_relation.relation.should == @relation
+    end
+  end
+end

data/spec/friendship_spec.rb

@@ -0,0 +1,113 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe Friendship do
+  fixtures :all
+  
+  describe "structure" do
+    before(:each) do
+      @friendship = Friendship.new
+    end
+
+    it "should belong to user" do
+      @friendship.user = @vader
+      @friendship.user.should == @vader
+    end
+
+    it "should_belong to friend" do
+      @friendship.friend = @luke
+      @friendship.friend.should == @luke
+    end
+
+    it "should belong to message" do
+      @message = FriendshipMessage.new :body => "Luke, I'm your father!"
+      @friendship.message = @vader_message_for_luke
+      @friendship.message.should == @vader_message_for_luke
+    end
+
+    it "should has many relations" do
+      @friendship.relations << @friend
+      @friendship.relations << @coworker
+
+      @friendship.relations.should == [@friend, @coworker]
+    end
+    
+    it "should list relations names" do
+      @friendship.relations << @friend
+      @friendship.relations << @coworker
+      @friendship.save
+      @friendship.reload
+
+      @friendship.relation_names.should == ["coworker", "friend"]
+    end
+  end
+
+  it "should be pending status" do
+    @friendship = Friendship.new(:status => 'pending')
+    @friendship.should be_pending
+  end
+
+  it "should be accepted status" do
+    @friendship = Friendship.new(:status => 'accepted')
+    @friendship.should be_accepted
+  end
+
+  it "should be requested status" do
+    @friendship = Friendship.new(:status => 'requested')
+    @friendship.should be_requested
+  end
+
+  describe "on accept pending friendship" do
+    before(:each) do
+      @friendship = Friendship.create(:user => @vader, :friend => @luke, :status => Friendship::FRIENDSHIP_PENDING)
+    end
+
+    it "should be ok" do
+      @friendship.accept!
+      @friendship.status.should == Friendship::FRIENDSHIP_ACCEPTED
+    end
+
+    it "should be ok and add new relations" do
+      @friendship.accept!([:met, :coworker])
+      @friendship.status.should == Friendship::FRIENDSHIP_ACCEPTED
+      @friendship.relations.size == 2
+      @friendship.relations.should == [@met, @coworker]
+    end
+
+    describe "with relations" do
+      before(:each) do
+        [@friend, @met].each do |r|
+          @friendship.relations << r
+        end
+        @friendship.save
+      end
+
+      it "should be ok and no change current relations" do
+        @friendship.accept!
+        @friendship.reload
+
+        @friendship.status.should == Friendship::FRIENDSHIP_ACCEPTED
+        @friendship.relations.size.should == 2
+        @friendship.relations.should == [@friend, @met]
+      end
+
+      it "should be ok and change relations" do
+        @friendship.accept!([:met, :coworker])
+        @friendship.reload
+
+        @friendship.status.should == Friendship::FRIENDSHIP_ACCEPTED
+        @friendship.relations.size.should == 2
+        @friendship.relations.should == [@met, @coworker]
+      end
+
+      it "should be ok and clear current relations" do
+        @friendship.accept!([])
+        @friendship.reload
+
+        @friendship.status.should == Friendship::FRIENDSHIP_ACCEPTED
+        @friendship.relations.size.should == 0
+        @friendship.relations.should == []
+      end
+    end
+
+  end
+end

data/spec/has_friends_spec.rb

@@ -0,0 +1,252 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe "has_friends" do
+  fixtures :all
+  
+  describe "methods" do
+    it "should respond to has_friends method" do
+      User.should respond_to(:has_friends)
+    end
+    
+    it "should respond to be_friends_with method" do
+      @vader.should respond_to(:be_friends_with)
+    end
+    
+    it "should respond to friends? method" do
+      @vader.should respond_to(:friends?)
+    end
+    
+    it "should respond to accept_friendship_with" do
+      @vader.should respond_to(:accept_friendship_with)
+    end
+    
+    it "should respond to remove_friendship_with" do
+      @vader.should respond_to(:remove_friendship_with)
+    end
+  end
+  
+  describe "user" do
+    before(:each) do
+      #requesting friendship between @vader and @luke
+      @vader.be_friends_with(@luke)
+      @leia.be_friends_with(@luke)
+      @luke.accept_friendship_with(@leia)
+    end
+    
+    it "should accept a friendship" do
+      @luke.accept_friendship_with(@vader)
+
+      @luke.reload
+      @vader.reload
+
+      @vader.friends.should == [@luke]
+      @luke.friends.should == [@vader, @leia]
+      @vader.friends_count.should == 1
+      @luke.friends_count.should  == 2
+    end
+
+    it "should accept a friendship with relation types" do
+      doing {
+        @luke.accept_friendship_with(@vader, [:parent, :met])
+      }.should change(FriendshipRelationType, :count).by(2)
+    end
+
+    it "should reject when user try accept his friendship request" do
+      lambda { @vader.accept_friendship_with(@luke) }.should raise_error(YouCanNotJudgeARequestFriendshipError)
+
+      @luke.reload
+      @vader.reload
+
+      @vader.friends.should == []
+      @luke.friends.should == [@leia]
+      @vader.friends_count.should == 0
+      @luke.friends_count.should  == 1
+    end
+    
+    it "should accept a friendship with relation types" do
+      @luke.deny_friendship_with(@vader)
+      
+      @luke.reload
+      @vader.reload
+      
+      @vader.friends.should == []
+      @luke.friends.should == [@leia]
+      @vader.friends_count.should == 0
+      @luke.friends_count.should  == 1
+    end
+    
+    it "should reject when user try deny his friendship request" do
+      lambda { @vader.deny_friendship_with(@luke) }.should raise_error(YouCanNotJudgeARequestFriendshipError)
+      
+      @luke.reload
+      @vader.reload
+      
+      @vader.friends.should == []
+      @luke.friends.should == [@leia]
+      @vader.friends_count.should == 0
+      @luke.friends_count.should  == 1
+    end
+    
+    it "should remove a friendship" do
+      #make @vader and @luke friends
+      @luke.be_friends_with(@vader)
+      
+      @vader.remove_friendship_with(@luke)
+      
+      @luke.reload
+      @vader.reload
+
+      @vader.friends.should == []
+      @luke.friends.should == [@leia]
+      @vader.friends_count.should == 0
+      @luke.friends_count.should == 1
+    end
+  end
+  
+  describe "friends" do
+    before(:each) do
+      create_friendship @vader, @luke
+      create_friendship @vader, @leia
+      create_friendship @luke, @leia
+      create_friendship @luke, @yoda
+      create_friendship @leia, @han_solo
+    end
+    
+    it "should order vader's friends" do
+      # => princess_leia, luke_skywalker
+      @vader.friends.all(:order => 'login desc').should == [@leia, @luke]
+    end
+    
+    it "should return luke's friends" do
+      @luke.friends.should == [@vader, @leia, @yoda]
+    end
+    
+    it "should return leia's frieds" do
+      @leia.friends.should == [@vader, @luke, @han_solo]
+    end
+    
+    it "should return yoda's friends" do
+      @yoda.friends.should == [@luke]
+    end
+    
+    it "should return solo's friends" do
+      @han_solo.friends.should == [@leia]
+    end
+    
+    it "should increment counter" do
+      @vader.reload
+      @vader.friends_count.should == 2
+    end
+    
+    it "should decrement counter" do
+      friendship = @vader.friendship_for(@luke)
+      friendship.destroy
+      
+      @vader.reload
+      @vader.friends_count.should == 1
+    end
+    
+    it "should be @vader" do
+      @vader.is?(@vader).should be_true
+    end
+    
+    it "should not be @vader" do
+      @vader.is?(@leia).should_not be_true
+    end
+  end
+  
+  describe "friendship request" do
+    it "should return nil and 'friend is required' status" do
+      friendship, status = @vader.be_friends_with(nil)
+      
+      friendship.should be_nil
+      status.should == Friendship::STATUS_FRIEND_IS_REQUIRED
+    end
+    
+    it "should return nil and 'is you' status" do
+      friendship, status = @vader.be_friends_with(@vader)
+      
+      friendship.should be_nil
+      status.should == Friendship::STATUS_IS_YOU
+    end
+    
+    it "should return nil and 'already friends status" do
+      @vader.be_friends_with(@luke)
+      @luke.be_friends_with(@vader)
+      friendship, status = @vader.be_friends_with(@luke)
+      
+      friendship.should be_nil
+      status.should == Friendship::STATUS_ALREADY_FRIENDS
+    end
+    
+    it "should return nil and 'already requested' status" do
+      @vader.be_friends_with(@luke)
+      friendship, status = @vader.be_friends_with(@luke)
+      
+      friendship.should be_nil
+      status.should == Friendship::STATUS_ALREADY_REQUESTED
+    end
+    
+    it "should return friendship and 'accepted friendship' status" do
+      @vader.be_friends_with(@luke)
+      friendship, status = @luke.be_friends_with(@vader)
+      
+      friendship.should be_kind_of(Friendship)
+      status.should == Friendship::STATUS_FRIENDSHIP_ACCEPTED
+      @vader.should be_friends(@luke)
+      @luke.should be_friends(@vader)
+    end
+    
+    it "should create friendships" do
+      doing {
+        friendship, status = @vader.be_friends_with(@luke)
+      
+        @vader.friendships.count.should == 1
+        @luke.friendships.count.should == 1
+        status.should == Friendship::STATUS_REQUESTED
+      }.should change(Friendship, :count).by(2)
+    end
+    
+    it "should create friendship with message" do
+      doing {
+        friendship, status = @vader.be_friends_with(@luke, "Luke, I'm your father!")
+        friendship.message.body.should == "Luke, I'm your father!"
+      }.should change(FriendshipMessage, :count).by(1)
+    end
+    
+    it "should create friendship with exist relations" do
+      doing {
+        doing {
+          friendship, status = @vader.be_friends_with(@luke, nil, [:met, :friend])
+        }.should change(FriendshipRelationType, :count).by(4)
+      }.should_not change(RelationType, :count)
+    end
+    
+    it "should create friendship with new relations" do
+      doing {
+        friendship, status = @vader.be_friends_with(@luke, nil, [:parent, :met])
+      }.should change(RelationType, :count).by(1)
+    end
+  end
+  
+  describe "pagination" do
+    before(:each) do
+      pending unless Object.const_defined?('Paginate')
+      
+      create_friendship @vader, @luke
+      create_friendship @vader, @leia
+      create_friendship @vader, @han_solo
+    end
+    
+    it "should paginate friends" do
+      @vader.friends.paginate(:limit => 1).to_a.should == [@luke, @leia]
+    end
+  end
+  
+  private
+    def create_friendship(user1, user2)
+      user1.be_friends_with(user2)
+      user2.be_friends_with(user1)
+    end
+  
+end

data/spec/relation_type_spec.rb

@@ -0,0 +1,9 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe RelationType do
+  it "should require a name" do
+    @relation_type = RelationType.new
+    @relation_type.should_not be_valid
+    @relation_type.errors[:name].should == "can't be blank"
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,37 @@
+ActiveRecord::Schema.define(:version => 0) do
+  begin
+    drop_table :users
+    drop_table :friendships
+    drop_table :friendship_messages
+    drop_table :relations_types
+    drop_table :friendship_relations
+  rescue
+  end
+  
+  create_table :users do |t|
+    t.string :login
+    t.integer :friends_count, :default => 0, :null => false
+  end
+  
+  create_table :friendships do |t|
+    t.references :user, :friend, :friendship_message
+    t.string :status
+    t.timestamps
+  end  
+  
+  create_table :friendship_messages do |t|
+    t.string :body
+    t.timestamps
+  end
+  
+  create_table :relation_types do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :friendship_relation_types do |t|
+    t.references :relation, :friendship
+    t.timestamps
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../../../../config/environment"))
+require "spec"
+require "spec/rails"
+require "ruby-debug"
+
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ":memory:"}}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations["test"])
+
+load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+Spec::Runner.configure do |config|
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = true
+  config.fixture_path = File.dirname(__FILE__) + '/fixtures/'
+end
+
+class Object
+  def self.unset_class(*args)
+    class_eval do 
+      args.each do |klass|
+        eval(klass) rescue nil
+        remove_const(klass) if const_defined?(klass)
+      end
+    end
+  end
+end
+
+alias :doing :lambda
+
+# unset models used for testing purposes
+Object.unset_class('User')
+
+class User < ActiveRecord::Base
+  has_friends
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: has_friends-rails3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Robert Rouse
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-25 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Rails 3 version of has_friends gem
+email: rrouse@rachotech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- RakeFile
+- VERSION
+- app/models/friendship.rb
+- app/models/friendship_message.rb
+- app/models/friendship_relation_type.rb
+- app/models/relation_type.rb
+- has_friends-rails3.gemspec
+- lib/generators/has_friends.rb
+- lib/generators/has_friends/migration/migration_generator.rb
+- lib/generators/has_friends/migration/templates/create_has_friends_tables.rb
+- lib/has_friends.rb
+- lib/has_friends/engine.rb
+- lib/has_friends/exceptions.rb
+- lib/has_friends/has_friends.rb
+- spec/fixtures/relation_types.yml
+- spec/fixtures/users.yml
+- spec/friendship_message_spec.rb
+- spec/friendship_relation_type_spec.rb
+- spec/friendship_spec.rb
+- spec/has_friends_spec.rb
+- spec/relation_type_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rrouse/has_friends
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 version of has_friends gem
+test_files: 
+- spec/friendship_message_spec.rb
+- spec/friendship_relation_type_spec.rb
+- spec/friendship_spec.rb
+- spec/has_friends_spec.rb
+- spec/relation_type_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb