amistad 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+A history of changes to the gem...

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Rawane ZOSSOU
+
+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,107 @@
+# amistad #
+
+Amistad adds friendships management into a rails 3.0 application.
+
+## Installation ##
+
+Just run the following command :
+
+    gem install amistad
+  
+Then in your gem file add the following line :
+
+    gem 'amistad'
+  
+## Usage ##
+
+First generate a friendship model :
+
+    rails generate friendship  
+    
+This commands create a new model called __friendship__ in *'app/models'* :
+
+    class Friendship < ActiveRecord::Base
+      acts_as_friendship
+    end
+
+It also creates a new migration for the friendship model so don't forget to migrate your database :
+
+    db:migrate
+
+Then activate __amistad__ in your user model :
+
+    class User < ActiveRecord::Base  
+      acts_as_friend  
+    end
+    
+## Friendships management ##
+
+### Creating friendships ###
+To create a new friendship with another user use the method called __invite()__ :
+
+    @john.invite @jane
+    @peter.invite @john
+    @peter.invite @jane
+    @victoria.invite @john
+    
+The __invite()__ method return *true* if the friendship successfully created, otherwise it returns *false*. The friendships remain in pending state until they are approved by the user requested. To approve the friendship created above use the method called __approve()__ :
+
+    @jane.approve @john
+    @john.approve @peter
+    @jane.approve @peter
+    
+As __invite()__, __approve()__ return *true* if the friendship was successfuly approved or *false* if not.
+
+### Listing friends ###
+
+There are two types of friends in __amistad__ :
+
+- the friends who were invited by the user
+- the friends who invited the user
+
+To get the friend who where invited by __@john__, use the __invited()__ method :
+
+    @john.invited #=> [@jane]
+    
+To get the friends who invited __@john__, use the __invited_by()__ method :
+
+    @john.invited_by #=> [@peter]
+    
+To get all the friends of __@john__ (those he invited and those who invited him) :
+
+    @john.friends #=> [@jane, @peter]
+    
+To get the pending friendships use :
+
+    @victoria.pending_invited #=> [@john]
+    @john.pending_invited_by #=> [@victoria]
+    
+It is also possible to check if two users are friends :
+
+    @john.is_friend_with? @jane #=> true
+    @victoria.is_friend_with? @john #=> false
+    
+You can also find the friends that two users have in common :
+
+    @john.common_friend_with(@peter) #=> [@jane]
+    
+### Removing friendships ###
+
+The __remove()__ method allow a user to remove its friendships :
+
+    @john.remove @jane
+    @john.remove @peter
+    @john.remove @victoria
+
+## Note on Patches/Pull Requests ##
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* 
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright © 2010 Rawane ZOSSOU. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "amistad"
+    gemspec.summary = "Adds friendships management into a rails 3.0 application"
+    gemspec.description = "Extends your user model with friendships management methods"
+    gemspec.email = "dev@raw1z.fr"
+    gemspec.homepage = "http://github.com/raw1z/amistad"
+    gemspec.authors = ["Rawane ZOSSOU"]
+    gemspec.files =  FileList["[A-Z]*", "{lib}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run the tests"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts = ["--format", "specdoc", "--color"]
+    t.spec_files = Dir.glob('spec/**/*_spec.rb')
+  end
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/amistad.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'amistad/friend_model')
+require File.join(File.dirname(__FILE__), 'amistad/friendship_model')

data/lib/amistad/friend_model.rb

@@ -0,0 +1,92 @@
+module Amistad
+  module FriendModel
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_friend
+        has_many  :friendships
+        
+        has_many  :pending_invited,
+                  :through => :friendships,
+                  :source => :friend,
+                  :conditions => { :'friendships.pending' => true }
+                  
+        has_many  :invited,
+                  :through => :friendships,
+                  :source => :friend,
+                  :conditions => { :'friendships.pending' => false }
+
+        has_many  :inverse_friendships, :class_name => "Friendship", :foreign_key => "friend_id"
+        
+        has_many  :pending_invited_by,
+                  :through => :inverse_friendships,
+                  :source => :user,
+                  :conditions => {:'friendships.pending' => true}
+                  
+        has_many  :invited_by,
+                  :through => :inverse_friendships,
+                  :source => :user,
+                  :conditions => {:'friendships.pending' => false}
+        
+        class_eval <<-EOV
+          include Amistad::FriendModel::InstanceMethods
+        EOV
+      end
+    end
+
+    module InstanceMethods
+      def invite(user)
+        return false if user == self
+        
+        friendship = find_any_friendship_with(user)
+        return false if not friendship.nil?
+        
+        friendship = Friendship.new(:user_id => self.id, :friend_id => user.id)
+        friendship.save
+      end
+      
+      def approve(user)
+        friendship = find_any_friendship_with(user)
+        return false if friendship.nil?
+        friendship.pending = false
+        friendship.save
+      end
+      
+      def friends
+        self.invited(true) + self.invited_by(true)
+      end
+      
+      def remove(user)
+        friendship = find_any_friendship_with(user)
+        return false if friendship.nil?
+        friendship.destroy
+        friendship.destroyed?
+      end
+      
+      def is_friend_with?(user)
+        friends.include?(user)
+      end
+      
+      def common_friends_with(user)
+        self.friends & user.friends
+      end
+      
+      private
+      
+      def find_any_friendship_with(user)
+        friendship = Friendship.where(:user_id => self.id, :friend_id => user.id).first
+        if friendship.nil?
+          friendship = Friendship.where(:user_id => user.id, :friend_id => self.id).first
+        end
+        friendship
+      end
+      
+    end    
+  end
+end
+
+class ActiveRecord::Base
+  include Amistad::FriendModel
+end

data/lib/amistad/friendship_model.rb

@@ -0,0 +1,32 @@
+module Amistad
+  module FriendshipModel
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_friendship
+        belongs_to :user
+        belongs_to :friend, :class_name => "User", :foreign_key => "friend_id"
+        
+        validates_presence_of :user_id, :friend_id
+        
+        class_eval <<-EOV
+          include Amistad::FriendshipModel::InstanceMethods
+        EOV
+      end
+    end
+    
+    module InstanceMethods
+      def pending?
+        self.pending
+      end
+    end
+    
+  end
+end
+
+class ActiveRecord::Base
+  include Amistad::FriendshipModel
+end

data/lib/generators/friendship/friendship_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class FriendshipGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.next_migration_number
+    now = DateTime.now
+    "#{now.year}#{'%02d' % now.month}#{'%02d' % now.day}#{'%02d' % now.hour}#{'%02d' % now.minute}#{'%02d' % now.second}"
+  end
+  
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+  
+  desc "This generator creates a friendship model and its migration file"
+  def create_friendship_model_files
+    template 'friendship.rb', 'app/models/friendship.rb'
+    template 'create_friendships.rb', "db/migrate/#{self.class.next_migration_number}_create_friendships.rb"
+  end
+end

data/lib/generators/friendship/templates/create_friendships.rb

@@ -0,0 +1,13 @@
+class CreateFriendships < ActiveRecord::Migration
+  def self.up
+    create_table :friendships do |t|
+      t.integer :user_id
+      t.integer :friend_id
+      t.boolean :pending, :default => true
+    end
+  end
+
+  def self.down
+    drop_table :friendships
+  end
+end

data/lib/generators/friendship/templates/friendship.rb

@@ -0,0 +1,3 @@
+class Friendship < ActiveRecord::Base
+  acts_as_friendship
+end

data/spec/friend_model_spec.rb

@@ -0,0 +1,149 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amistad::FriendModel do
+  
+  before(:all) do
+    %w(John Jane david James Peter Mary Victoria Elisabeth).each do |name|
+      eval "@#{name.downcase} = User.create(:name => '#{name}')"
+    end
+  end
+  
+  context "when creating friendships" do
+    before(:each) do
+      Friendship.delete_all
+    end
+    
+    it "requests frienships with other users" do
+      @john.invite(@jane).should == true
+      @victoria.invite(@john).should == true
+    end
+
+    it "approves frienships requested by other users" do
+      @john.invite(@jane).should == true
+      @victoria.invite(@john).should == true
+
+      @jane.approve(@john).should == true
+      @john.approve(@victoria).should == true
+    end
+    
+    it "could not create a new friendship with a user which is already a friend" do
+      @john.invite(@jane).should == true
+      @john.invite(@jane).should == false
+      @jane.invite(@john).should == false
+    end
+    
+    it "could not create a friendship with himself" do
+      @john.invite(@john).should == false
+    end
+    
+    it "could not approuve a non-existent friendship" do
+      @peter.approve(@john).should == false
+    end
+  end
+  
+  context "when listing friendships" do
+    before(:each) do
+      Friendship.delete_all
+      @john.invite(@jane).should == true
+      @john.invite(@james).should == true
+      
+      @peter.invite(@john).should == true
+      @mary.invite(@john).should == true
+      
+      @james.approve(@john).should == true
+      @john.approve(@mary).should == true
+    end
+    
+    it "lists all the friends" do
+      @john.friends.count.should == 2
+      @john.friends.should include(@james)
+      @john.friends.should include(@mary)
+    end
+    
+    it "lists the friends who invited him" do
+      @john.invited_by.should include(@mary)
+      @john.invited_by.should_not include(@peter)
+    end
+    
+    it "lists the friends who was invited by him" do
+      @john.invited.should include(@james)
+      @john.invited.should_not include(@jane)
+    end
+    
+    it "lists the pending friends who invited him" do
+      @john.pending_invited_by.should_not include(@mary)
+      @john.pending_invited_by.should include(@peter)
+    end
+
+    it "lists the pending friends who was invited by him" do
+      @john.pending_invited.should_not include(@james)
+      @john.pending_invited.should include(@jane)
+    end
+
+    it "checks if a user is a friend" do
+      @john.is_friend_with?(@james).should == true
+      @john.is_friend_with?(@mary).should == true
+      
+      @john.is_friend_with?(@jane).should == false
+      @john.is_friend_with?(@peter).should == false
+    end
+    
+    it "lists the friends he has in common with another user" do
+      @james.common_friends_with(@mary).count.should == 1
+      @james.common_friends_with(@mary).should include(@john)
+    end
+  end
+  
+  context "when removing friendships" do
+    before(:each) do
+      Friendship.delete_all
+      @victoria.invite(@mary).should == true
+      @victoria.invite(@john).should == true
+      @victoria.invite(@elisabeth).should == true
+      
+      @james.invite(@victoria).should == true
+      @peter.invite(@victoria).should == true
+      @jane.invite(@victoria).should == true
+      
+      @mary.approve(@victoria).should == true
+      @john.approve(@victoria).should == true
+      @victoria.approve(@james).should == true
+      @victoria.approve(@jane).should == true
+    end
+    
+    it "removes the friends invited by him" do
+      @victoria.remove(@mary).should == true
+      
+      @victoria.invited.count.should == 1
+      @victoria.invited.should include(@john)
+      @victoria.friends.should_not include(@mary)
+      
+      @mary.invited_by.should_not include(@victoria)
+      @mary.friends.should_not include(@victoria)
+    end
+    
+    it "removes the friends who invited him" do
+      @victoria.remove(@james).should == true
+      
+      @victoria.invited_by.count.should == 1
+      @victoria.invited_by.should include(@jane)
+      @victoria.friends.should_not include(@james)
+      
+      @james.invited.should_not include(@victoria)
+      @james.friends.should_not include(@victoria)
+    end
+    
+    it "removes the pending friends invited by him" do
+      @victoria.remove(@elisabeth).should == true
+      @victoria.pending_invited.count.should == 0
+      @elisabeth.pending_invited_by.should_not include(@victoria)
+    end
+    
+    it "removes the pending friends who invited him" do
+      @victoria.remove(@peter).should == true
+      @victoria.pending_invited_by.count.should == 0
+      @peter.pending_invited.should_not include(@victoria)
+    end
+  end
+
+end

data/spec/friendship_model_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amistad::FriendshipModel do
+  
+  before(:each) do
+    Friendship.delete_all
+  end
+  
+  it "validates presence of the user's id and the friend's id" do
+    friendship = Friendship.new
+    friendship.save.should == false
+    
+    friendship = Friendship.new(:user_id => 1, :friend_id => 2)
+    friendship.save.should == true
+  end
+  
+  it "is in pending state when created" do
+    friendship = Friendship.create(:user_id => 1, :friend_id => 2)
+    friendship.pending?.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'active_record'
+require 'logger'
+
+require File.join(File.dirname(__FILE__), '../lib/amistad')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "tmp/amistad.sqlite3.db"
+)
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string :name, :null => false
+  end
+
+  create_table :friendships, :force => true do |t|
+    t.integer :user_id
+    t.integer :friend_id
+    t.boolean :pending, :default => true
+  end
+end
+
+ActiveRecord::Base.logger = Logger.new(File.open('tmp/database.log', 'a'))
+
+class User < ActiveRecord::Base
+  acts_as_friend
+end
+
+class Friendship < ActiveRecord::Base
+  acts_as_friendship
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: amistad
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rawane ZOSSOU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Extends your user model with friendships management methods
+email: dev@raw1z.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- CHANGELOG
+- LICENCE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/amistad.rb
+- lib/amistad/friend_model.rb
+- lib/amistad/friendship_model.rb
+- lib/generators/friendship/friendship_generator.rb
+- lib/generators/friendship/templates/create_friendships.rb
+- lib/generators/friendship/templates/friendship.rb
+has_rdoc: true
+homepage: http://github.com/raw1z/amistad
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds friendships management into a rails 3.0 application
+test_files: 
+- spec/friend_model_spec.rb
+- spec/friendship_model_spec.rb
+- spec/spec_helper.rb