has_followers 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+script: "rspec spec"
+env:
+  - DB=sqlite
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+gemfile:
+  - Gemfile
+notifications:
+  email:
+    - fabianoalmeida@gmail.com

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :test do
+  gem "sqlite3"
+  gem "rspec"
+  gem "rspec-rails", "~> 2.4"
+  gem "activerecord", "~> 3.1.3"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.5)
+    multi_json (1.0.4)
+    rack (1.3.6)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1.3)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec
+  rspec-rails (~> 2.4)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Fabiano Almeida
+
+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,65 @@
+= has_followers {<img src="https://secure.travis-ci.org/fabianoalmeida/has_followers.png" />}[http://travis-ci.org/fabianoalmeida/has_followers]
+
+*ATTENTION:* This is a Rails 3 implementation.
+
+NOTE: It's necessary there's a *User* model. When is executing the migration this gem will create two columns in users' table: <code>followeds_count</code> and <code>followers_count</code>.
+
+== Instalation
+* The first step is add this gem to your Gemfile <code>gem 'has_followers'</code>
+* After that, install the gem in your development environment <code>bundle install</code>
+* Execute the migration generator to create tables and columns necessary <code>rails g has_followers:migration</code>
+* Run the migrations with <code>rake db:migrate</code>
+
+== Usage
+It's very simple to use this gem. See the examples below.
+
+To follow someone you need only do this
+ you.follow(someone)
+This action automatically increment your <code>followeds_count</code> column and his (someone) <code>followers_count</code> column too.
+
+Cause you want to unfollow someone, no problem. It's similar to follow someone
+ you.unfollow(someone)
+When you <code>unfollow</code> someone, this automatically decrement your <code>followeds_count</code> column and his (someone) <code>followers_count</code> column too.
+
+You can check how many users you is following
+ you.followeds_count
+
+Or how many users are following you
+ you.follwers_count
+
+If you want to know who are your followeds users
+ you.followeds
+
+And your followers
+ you.followers
+
+Check if the user is you
+ you.is?(someone) # => true if someone is you
+
+If you want to know if you is following someone
+ you.following?(someone) # => Follow object if you already following someone
+
+There's a user that you want to know whether he is following you
+ you.follow_me?(someone) # => Follow object if he is following you
+
+Or cause you want to know which relationship between you and your followed or follower
+ you.following_for(someone)
+Or
+ you.followed_for(someone)
+
+The first one will finding on your followeds list, however the second one will find on your followers list.
+
+== Contributing to has_followers
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Fabiano Almeida. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "has_followers"
+  gem.homepage = "http://github.com/fabianoalmeida/has_followers"
+  gem.license = "MIT"
+  gem.summary = "Add followers support to Rails 3 apps"
+  gem.description = "Add followers support to Rails 3 apps"
+  gem.email = "fabianoalmeida@gmail.com"
+  gem.authors = ["Fabiano Almeida"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_followers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/models/follow.rb

@@ -0,0 +1,6 @@
+class Follow < ActiveRecord::Base
+  
+  belongs_to :follower, :class_name => "User", :foreign_key => "user_id"
+  belongs_to :followed, :class_name => "User", :foreign_key => "followed_id"
+  
+end

data/has_followers.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_followers}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Fabiano Almeida}]
+  s.date = %q{2012-01-24}
+  s.description = %q{Add followers support to Rails 3 apps}
+  s.email = %q{fabianoalmeida@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/models/follow.rb",
+    "has_followers.gemspec",
+    "lib/generators/has_followers.rb",
+    "lib/generators/has_followers/migration/migration_generator.rb",
+    "lib/generators/has_followers/migration/templates/create_has_followers_tables.rb",
+    "lib/has_followers.rb",
+    "lib/has_followers/engine.rb",
+    "lib/has_followers/has_followers.rb",
+    "spec/has_followers_spec.rb",
+    "spec/schema.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/fabianoalmeida/has_followers}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.9}
+  s.summary = %q{Add followers support to Rails 3 apps}
+
+  if s.respond_to? :specification_version then
+    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_followers.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/migration'
+
+module HasFollowers
+  module Generators
+    class Base < Rails::Generators::Base
+      
+      include Rails::Generators::Migration
+      
+      def self.source_root
+        @_has_followers_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'has_followers', 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/generators/has_followers/migration/migration_generator.rb

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

data/lib/generators/has_followers/migration/templates/create_has_followers_tables.rb

@@ -0,0 +1,21 @@
+class CreateHasFollowersTables < ActiveRecord::Migration
+  def self.up
+    create_table :follows, :force => true do |t|
+      t.references :followed, :user
+      t.timestamps
+    end
+    
+    add_index :follows, :followed_id
+    add_index :follows, :user_id
+    
+    add_column :users, :followers_count, :integer, :default => 0, :null => false
+    add_column :users, :followeds_count, :integer, :default => 0, :null => false
+  end
+
+  def self.down
+    remove_column :users, :followers_count
+    remove_column :users, :followeds_count
+    
+    drop_table :follows
+  end
+end

data/lib/has_followers.rb

@@ -0,0 +1,4 @@
+require 'has_followers/engine'
+require 'has_followers/has_followers'
+
+ActiveRecord::Base.send(:include, Has::Followers)

data/lib/has_followers/engine.rb

@@ -0,0 +1,8 @@
+require 'has_followers'
+require 'rails'
+
+module Has
+  module Followers
+    class Engine < Rails::Engine; end
+  end
+end

data/lib/has_followers/has_followers.rb

@@ -0,0 +1,72 @@
+module Has
+  module Followers
+    def self.included(base)
+      base.extend Has::Followers::ClassMethods
+    end
+    
+    module ClassMethods
+      def has_followers
+        include Has::Followers::InstanceMethods
+        
+        has_many :followed_to, :class_name => 'Follow', :foreign_key => 'user_id'
+        has_many :follower_to, :class_name => 'Follow', :foreign_key => 'followed_id'
+        has_many :followeds, :through => :followed_to, :source => :followed
+        has_many :followers, :through => :follower_to, :source => :follower
+      end
+    end
+    
+    module InstanceMethods
+      def follow(followed)
+        unless following?(followed) || is?(followed)
+          ActiveRecord::Base.transaction do
+            Follow.create(:user_id => self.id, :followed_id => followed.id)
+            increment_counters(followed)
+          end
+        end
+      end
+      
+      def unfollow(followed)
+        if following?(followed) && ! is?(followed)
+          ActiveRecord::Base.transaction do
+            follow = following_for(followed)
+            unless follow.nil?
+              follow.destroy
+              decrement_counters(followed)
+            end
+          end
+        end
+      end
+      
+      def following?(followed)
+        return follow = following_for(followed)
+      end
+      
+      def following_for(followed)
+        self.followeds.where( :id => followed.id ).first
+      end
+      
+      def follow_me?(follower)
+        return follow = followed_for(follower)
+      end
+      
+      def followed_for(follower)
+        self.followers.where( :id => follower.id ).first
+      end
+      
+      def is?(followed)
+        self.id.eql?( followed.id )
+      end
+      
+      private
+      def increment_counters(follower)
+        self.update_attributes( { :followeds_count => self.followeds_count + 1 } )
+        follower.update_attributes( { :followers_count => follower.followers_count + 1 } )
+      end
+      
+      def decrement_counters(followed)
+        self.update_attributes( { :followeds_count => self.followeds_count - 1 } )
+        followed.update_attributes( { :followers_count => followed.followers_count - 1 } )
+      end
+    end
+  end
+end

data/spec/has_followers_spec.rb

@@ -0,0 +1,137 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HasFollowers" do
+  before (:each) do
+    User.delete_all
+    
+    @josh   = User.create(:login => "josh")
+    @stuart = User.create(:login => "stuart")
+    @kevin  = User.create(:login => "kevin")
+    @bill   = User.create(:login => "bill")
+  end
+  
+  describe "methods" do
+    it "should respond to has_followers method" do
+      User.should respond_to(:has_followers)
+    end
+    
+    it "should respond to follow method" do
+      @josh.should respond_to(:follow)
+    end
+    
+    it "should respond to unfollow method" do
+      @stuart.should respond_to(:unfollow)
+    end
+    
+    it "should respond to following? method" do
+      @kevin.should respond_to(:following?)
+    end
+    
+    it "should respond to following_for method" do
+      @bill.should respond_to(:following_for)
+    end
+    
+    it "should respond to follow_me? method" do
+      @josh.should respond_to(:follow_me?)
+    end
+    
+    it "should respond to followed_for method" do
+      @stuart.should respond_to(:followed_for)
+    end
+    
+    it "should respond to followeds method" do
+      @bill.should respond_to(:followeds)
+    end
+    
+    it "should respond to followers method" do
+      @josh.should respond_to(:followers)
+    end
+    
+    it "should respond to is? method" do
+      @stuart.should respond_to(:is?)
+    end
+  end
+  
+  describe "user" do
+    before (:each) do
+      @josh.follow(@stuart)
+      @josh.follow(@kevin)
+      @kevin.follow(@bill)
+      @stuart.follow(@josh)
+    end
+    
+    describe "'josh'" do
+      it "should be yourself" do
+        @josh.is?(@josh).should be_true
+      end
+      
+      it "should not can follow yourself" do
+        @josh.follow(@josh).should be_false
+      end
+
+      it "should have followeds count equals two" do
+        @josh.followeds_count.should be(2)
+      end
+
+      it "should have followers count equals zero" do
+        @josh.followers_count.should be(1)
+      end
+
+      it "should have two followeds" do
+        @josh.followeds.should have(2).items
+      end
+
+      it "should have empty followers" do
+        @josh.followers.should have(1).items
+      end
+
+      it "should be following 'stuart'" do
+        @josh.following?(@stuart).should be_true
+      end
+
+      it "should not be following 'bill'" do
+        @josh.following?(@bill).should be_false
+      end
+
+      it "should be been followed for 'stuart'" do
+        @josh.followed_for(@stuart).should_not be_nil
+      end
+
+      it "should be been followed for 'stuart'" do
+        @josh.follow_me?(@stuart).should be_true
+      end
+
+      it "should not be been followed for 'kevin'" do
+        @josh.follow_me?(@kevin).should be_false
+      end
+    end
+    
+    describe "'kevin'" do
+      describe "unfollowing 'bill'" do
+        before (:each) do
+          @kevin.unfollow(@bill)
+        end
+        
+        after (:each) do
+          @kevin.follow(@bill)
+        end
+
+        it "should have no followeds" do
+          @kevin.followeds.should have(0).items
+        end
+        
+        it "should have no followers" do
+          @kevin.followers.should have(1).items
+        end
+        
+        it "should have followers count equals zero" do
+          @kevin.followers_count.should be(1)
+        end
+        
+        it "should have followers count equals zero" do
+          @kevin.followeds_count.should be(0)
+        end
+      end
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+  begin
+    drop_table :users
+    drop_table :follows
+  rescue
+  end
+  
+  create_table :users do |t|
+    t.string :login
+    t.integer :followeds_count, :default => 0, :null => false
+    t.integer :followers_count, :default => 0, :null => false
+  end
+  
+  create_table :follows do |t|
+    t.references :followed, :user
+    t.timestamps
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'has_followers'
+
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ":memory:"}}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations["test"])
+
+load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+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_followers
+end
+
+class Follow < ActiveRecord::Base  
+  belongs_to :follower, :class_name => "User", :foreign_key => "user_id"
+  belongs_to :followed, :class_name => "User", :foreign_key => "followed_id"
+  
+  # callback
+  after_destroy do |f|
+    User.decrement_counter(:followeds_count, f.user_id)
+    User.decrement_counter(:followers_count, f.follower_id)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: has_followers
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Fabiano Almeida
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-24 00:00:00 Z
+dependencies: []
+
+description: Add followers support to Rails 3 apps
+email: fabianoalmeida@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- app/models/follow.rb
+- has_followers.gemspec
+- lib/generators/has_followers.rb
+- lib/generators/has_followers/migration/migration_generator.rb
+- lib/generators/has_followers/migration/templates/create_has_followers_tables.rb
+- lib/has_followers.rb
+- lib/has_followers/engine.rb
+- lib/has_followers/has_followers.rb
+- spec/has_followers_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fabianoalmeida/has_followers
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4085056179445136315
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Add followers support to Rails 3 apps
+test_files: []
+