mongoid_follow 0.0.1 → 0.0.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alec Guintu
+
+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.rdoc

@@ -0,0 +1,58 @@
+= Follow stuff for Mongoid
+
+== Installation
+
+In Gemfile:
+  gem 'mongoid_follow""
+
+== To use
+
+To make mongoid_follow usable you need to include Mongoid::Followee into your document
+Meanwhile, you also need to include Mongoid::Follower in your follower model:
+
+  class User
+    include Mongoid::Document
+    include Mongoid::Followee
+    include Mongoid::Follower
+  end
+
+  class Group
+    include Mongoid::Document
+    include Mongoid::Followee
+  end
+
+You can then follow a model using:
+
+  @bonnie = User.new
+  @bonnie.save
+
+  current_user.follow(@clyde)
+  current_user.unfollow?(@clyde)
+
+You can also see whether a model is a follower of another model or a model is a followee of another model:
+
+    current_user.follower?(@clyde)
+    current_user.followee?(@clyde)
+
+Of course, you can get a list of followers/followees:
+
+    @clyde.followers
+    @bonnie.followees
+
+* Any bug or issue, please send me an email: aeguintu@gmail.com
+
+== TODO
+
+* finish up todo's
+* count of followers/followees
+* common followers (or maybe followees)
+* maybe... (un)authorization of who can follow (model)
+* most/least followed/following #FINISHED
+
+== Thanks
+
+Thanks the mongoid_followable for 
+
+== Copyright
+
+Copyright (c) Alec Guintu. See LICENSE.txt for further details.

data/app/models/follow.rb

@@ -0,0 +1,9 @@
+class Follow
+  include Mongoid::Document
+
+  field :ff_type
+  field :ff_id
+
+  belongs_to :follower, :polymorphic => true
+  belongs_to :followee, :polymorphic => true
+end

data/lib/mongoid_follow/followee.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module Followee
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.has_many :followers, :class_name => 'Follow', :as => :follower, :dependent => :destroy
+    end
+
+    # see if this model is followed of some model
+    #
+    # Example:
+    # >> @clyde.follower?(@bonnie)
+    # => true
+    def follower?(model)
+      0 < self.followers.find(:all, conditions: {ff_id: model.id}).limit(1).count
+    end
+
+    # view all selfs followers
+    #
+    # Example:
+    # >> @clyde.follower?(@bonnie)
+    # => true
+    def followers(model)
+      #TODO
+    end
+  end
+end

data/lib/mongoid_follow/follower.rb

@@ -0,0 +1,46 @@
+module Mongoid
+  module Follower
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.has_many :followees, :class_name => 'Follow', :as => :followee, :dependent => :destroy
+    end
+
+    # follow a model
+    #
+    # Example:
+    # >> @bonnie.follow(@clyde)
+    def follow(model)
+      model.followers.create!(:ff_type => self.class.name, :ff_id => self.id)
+
+      self.followees.create!(:ff_type => model.class.name, :ff_id => model.id)
+    end
+
+    # unfollow a model
+    #
+    # Example:
+    # >> @bonnie.unfollow(@clyde)
+    def unfollow(model)
+      model.followers.where(:ff_type => self.class.name, :ff_id => self.id).destroy
+
+      self.followees.where(:ff_type => model.class.name, :ff_id => model.id).destroy
+    end
+
+    # follow a model
+    #
+    # Example:
+    # >> @bonnie.follows?(@clyde)
+    # => true
+    def follows?(model)
+      0 < self.followees.find(:all, conditions: {ff_id: model.id}).limit(1).count
+    end
+
+    # view all selfs followees
+    #
+    # Example:
+    # >> @alec.followees
+    def followees(model)
+      # TODO
+    end
+  end
+end

data/lib/mongoid_follow/version.rb

@@ -1,3 +1,3 @@
 module MongoidFollow
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mongoid_follow.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Alec Guintu"]
   s.email       = ["animerei12@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{Add basic "follow" features to rails3/mongoid}
-  s.description = %q{A gem to add a basic "follow" feature if you're using rails3 with mongoid}
+  s.homepage    = "https://github.com/alecguintu/mongoid_follow"
+  s.summary     = %q{ Add basic "follow" features to rails3/mongoid }
+  s.description = %q{ A gem to add a basic "follow" feature if you're using rails3 with mongoid }
 
   s.rubyforge_project = "mongoid_follow"
 

data/spec/models/group.rb

@@ -0,0 +1,4 @@
+class Group
+  include Mongoid::Document
+  include Mongoid::Followee
+end

data/spec/models/user.rb

@@ -0,0 +1,5 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Followee
+  include Mongoid::Follower
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+
+require "database_cleaner"
+require "mongoid"
+require "rspec"
+
+Mongoid.configure do |config|
+  name = "mongoid_follow_test"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+require File.expand_path("../../lib/mongoid_follow", __FILE__)
+require File.expand_path("../models/user", __FILE__)
+require File.expand_path("../models/group", __FILE__)
+
+RSpec.configure do |c|
+  c.before(:all) { DatabaseCleaner.strategy = :truncation }
+  c.before(:each) { DatabaseCleaner.clean }
+end

data/spec/specs/follow_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Mongoid::Follower do
+
+  describe User do
+
+    before do
+      @bonnie = User.new
+      @bonnie.save
+
+      @clyde = User.new
+      @clyde.save
+
+      @alec = User.new
+      @alec.save
+
+      @gang = Group.new
+      @gang.save
+    end
+
+    it "should have no follows or followers" do
+      @bonnie.follows?(@clyde).should be_false
+
+      @bonnie.follow(@clyde)
+      @clyde.follower?(@alec).should be_false
+      @alec.follows?(@clyde).should be_false
+    end
+
+    it "can follow another User" do
+      @bonnie.follow(@clyde)
+
+      @bonnie.follows?(@clyde).should be_true
+      @clyde.follower?(@bonnie).should be_true
+    end
+
+    it "can unfollow another User" do
+      @bonnie.follows?(@clyde).should be_false
+      @clyde.follower?(@bonnie).should be_false
+
+      @bonnie.follow(@clyde)
+      @bonnie.follows?(@clyde).should be_true
+      @clyde.follower?(@bonnie).should be_true
+
+      @bonnie.unfollow(@clyde)
+      @bonnie.follows?(@clyde).should be_false
+      @clyde.follower?(@bonnie).should be_false
+    end
+
+    it "can follow a group" do
+      @bonnie.follow(@gang)
+
+      @bonnie.follows?(@gang).should be_true
+      @gang.follower?(@bonnie).should be_true
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: mongoid_follow
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alec Guintu
@@ -57,7 +57,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: A gem to add a basic "follow" feature if you're using rails3 with mongoid
+description: " A gem to add a basic \"follow\" feature if you're using rails3 with mongoid "
 email: 
 - animerei12@gmail.com
 executables: []
@@ -69,12 +69,21 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE.txt
+- README.rdoc
 - Rakefile
+- app/models/follow.rb
 - lib/mongoid_follow.rb
+- lib/mongoid_follow/followee.rb
+- lib/mongoid_follow/follower.rb
 - lib/mongoid_follow/version.rb
 - mongoid_follow.gemspec
+- spec/models/group.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/specs/follow_spec.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/alecguintu/mongoid_follow
 licenses: []
 
 post_install_message: 
@@ -101,5 +110,8 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Add basic "follow" features to rails3/mongoid
-test_files: []
-
+test_files: 
+- spec/models/group.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/specs/follow_spec.rb