amistad 0.3.1 → 0.4.0

data/README.markdown

@@ -16,12 +16,12 @@ Then in your Gemfile add the following line :
 
 First generate a friendship model :
 
-    rails generate friendship  
+    rails generate amistad:install  
     
 This commands create a new model called __friendship__ in *'app/models'* :
 
     class Friendship < ActiveRecord::Base
-      acts_as_friendship
+      include Amistad::FriendshipModel
     end
 
 It also creates a new migration for the friendship model so don't forget to migrate your database :
@@ -31,7 +31,7 @@ It also creates a new migration for the friendship model so don't forget to migr
 Then activate __amistad__ in your user model :
 
     class User < ActiveRecord::Base  
-      acts_as_friend  
+      include Amistad::FriendModel
     end
     
 ## Friendships management ##

data/Rakefile

@@ -15,15 +15,14 @@ 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')
-    
-    Dir.mkdir('spec/db') if not File.directory?('spec/db')
-  end
-rescue LoadError
-  puts "Rspec not available. Install it with: gem install rspec"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+Rspec::Core::RakeTask.new(:spec) do |spec|
 end
+
+Rspec::Core::RakeTask.new(:rcov) do |spec|
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/amistad/friend_model.rb

@@ -1,11 +1,9 @@
 module Amistad
   module FriendModel
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def acts_as_friend
+    def self.included(receiver)
+      receiver.class_exec do
+        include InstanceMethods
+        
         has_many  :friendships
         
         has_many  :pending_invited,
@@ -29,14 +27,11 @@ module Amistad
                   :through => :inverse_friendships,
                   :source => :user,
                   :conditions => {:'friendships.pending' => false}
-        
-        class_eval <<-EOV
-          include Amistad::FriendModel::InstanceMethods
-        EOV
       end
     end
 
     module InstanceMethods
+      # suggest a user to become a friend. If the operation succeeds, the method returns true, else false
       def invite(user)
         return false if user == self
         
@@ -47,6 +42,7 @@ module Amistad
         friendship.save
       end
       
+      # approve a friendship invitation. If the operation succeeds, the method returns true, else false
       def approve(user)
         friendship = find_any_friendship_with(user)
         return false if friendship.nil?
@@ -54,10 +50,12 @@ module Amistad
         friendship.save
       end
       
+      # returns the list of approved friends
       def friends
         self.invited(true) + self.invited_by(true)
       end
       
+      # deletes a friendship
       def remove(user)
         friendship = find_any_friendship_with(user)
         return false if friendship.nil?
@@ -65,10 +63,12 @@ module Amistad
         friendship.destroyed?
       end
       
+      # checks if a user is a friend
       def is_friend_with?(user)
         friends.include?(user)
       end
       
+      # checks if a user send a friendship's invitation
       def was_invited_by?(user)
         inverse_friendships.each do |friendship|
           return true if friendship.user == user
@@ -76,6 +76,7 @@ module Amistad
         false
       end
       
+      # return the list of the ones among its friends which are also friend with the given use
       def common_friends_with(user)
         self.friends & user.friends
       end
@@ -94,6 +95,3 @@ module Amistad
   end
 end
 
-class ActiveRecord::Base
-  include Amistad::FriendModel
-end

data/lib/amistad/friendship_model.rb

@@ -1,24 +1,19 @@
 module Amistad
   module FriendshipModel
     
-    def self.included(base)
-      base.extend ClassMethods
-    end
-    
-    module ClassMethods
-      def acts_as_friendship
+    def self.included(receiver)
+      receiver.class_exec do
+        include InstanceMethods
+        
         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
+      # returns true if a friendship has not been approved, else false
       def pending?
         self.pending
       end
@@ -26,7 +21,3 @@ module Amistad
     
   end
 end
-
-class ActiveRecord::Base
-  include Amistad::FriendshipModel
-end

data/lib/generators/amistad/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Amistad
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      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
+  end
+end

data/lib/generators/{friendship → amistad/install}/templates/friendship.rb

@@ -1,3 +1,3 @@
 class Friendship < ActiveRecord::Base
-  acts_as_friendship
+  include Amistad::FriendshipModel
 end

data/spec/friend_model_spec.rb

@@ -13,12 +13,12 @@ describe Amistad::FriendModel do
       Friendship.delete_all
     end
     
-    it "requests frienships with other users" do
+    it "requests friendships with other users" do
       @john.invite(@jane).should == true
       @victoria.invite(@john).should == true
     end
 
-    it "approves frienships requested by other users" do
+    it "approves friendships requested by other users" do
       @john.invite(@jane).should == true
       @victoria.invite(@john).should == true
 

data/spec/spec_helper.rb

@@ -1,12 +1,14 @@
-require 'rubygems'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec/core'
+require 'rspec/autorun'
 require 'active_record'
 require 'logger'
-
-require File.join(File.dirname(__FILE__), '../lib/amistad')
+require 'amistad'
 
 ActiveRecord::Base.establish_connection(
   :adapter => "sqlite3",
-  :database => "spec/db/amistad.sqlite3.db"
+  :database => ":memory:"
 )
 
 ActiveRecord::Migration.verbose = false
@@ -23,12 +25,10 @@ ActiveRecord::Schema.define do
   end
 end
 
-ActiveRecord::Base.logger = Logger.new(File.open('spec/db/database.log', 'a'))
-
 class User < ActiveRecord::Base
-  acts_as_friend
+  include Amistad::FriendModel
 end
 
 class Friendship < ActiveRecord::Base
-  acts_as_friendship
+  include Amistad::FriendshipModel
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Rawane ZOSSOU
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-16 00:00:00 +02:00
+date: 2010-09-11 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -35,9 +35,12 @@ files:
 - 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
+- lib/generators/amistad/install/install_generator.rb
+- lib/generators/amistad/install/templates/create_friendships.rb
+- lib/generators/amistad/install/templates/friendship.rb
+- spec/friend_model_spec.rb
+- spec/friendship_model_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/raw1z/amistad
 licenses: []
@@ -48,6 +51,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -55,6 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -64,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Adds friendships management into a rails 3.0 application

data/lib/generators/friendship/friendship_generator.rb

@@ -1,21 +0,0 @@
-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