follow_system 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bb5f4c3e1b5fac7f89133975eed0675d3df87df
+  data.tar.gz: 13191b7027a9273d2715c2a3c251096bcb0be5f6
+SHA512:
+  metadata.gz: 4520134d84b88e0b494f6ae0d1185a6eca9f9d832408ad4615e331e1fa966dabfd295cbab2c866a8491ee483c375a0abb27d7e16ee7f0d6a8112b7b0469fd8f4
+  data.tar.gz: 6ca7a689ac9511fe4c34b6ccdf25fdcb348bb73c8fa61e14283e8c266e6547cce6c543a63cbe161a752c298d1b7e5c3bcdaaf35d4f328ba47a43a236040896da

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/gemfiles/*.lock
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+follow_system

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,23 @@
+language:
+  - ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - 2.2.1
+
+gemfile:
+  - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
+
+install:
+  - "travis_retry bundle install"
+
+before_script:
+
+script:
+  - "bundle exec rake"
+
+branches:
+  only:
+    - master

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails4.1" do
+  gem "rails", "4.1.10"
+end
+
+appraise "rails4.2" do
+  gem "rails", "4.2.1"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in follow_system.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pablo Martin Viva
+
+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/README.md

@@ -0,0 +1,93 @@
+# FollowSystem
+
+[![Build Status](https://travis-ci.org/pmviva/follow_system.png?branch=master)](https://travis-ci.org/pmviva/follow_system)
+[![Gem Version](https://badge.fury.io/rb/follow_system.svg)](http://badge.fury.io/rb/follow_system)
+
+An active record follow system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.
+
+This gem is heavily influenced by cmer/socialization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'follow_system'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install follow_system
+```
+
+## Usage
+
+### Run the generator
+
+```ruby
+$ rails g follow_system
+```
+
+Let's suppose for a moment that you have a celebrity news application and a User can follow a Celebrity or several Celebrity models.
+The user model becomes the follower and the celebrity model becomes the followee.
+
+### Celebrity object
+```ruby
+class Celebrity < ActiveRecord::Base
+  act_as_followee
+
+  validates :name, { presence: true, uniqueness: true }
+end
+```
+
+### User object
+```ruby
+class User < ActiveRecord::Base
+  act_as_follower
+
+  validates :username, { presence: true, uniqueness: true }
+end
+```
+
+### Followee object methods
+```ruby
+celebrity.is_followee? # returns true
+
+celebrity.followed_by?(user) # returns true if user follows the celebrity object, false otherwise
+
+celebrity.followers_by(User) # returns a scope of FollowSystem::Follow join model that belongs to the celebrity object and belongs to follower objects of type User
+```
+
+
+### Follower object methods
+```ruby
+user.is_follower? # returns true
+
+user.follow(celebrity) # Creates an instance of FollowSystem::Follow join model associating the user object and the celebrity object, returns true if succeded, false otherwise
+
+user.unfollow(celebrity) # Destroys an instance of FollowSystem::Follow join model that associates the user object and the celebrity object, returns true if succeded, false otherwise
+
+user.toggle_follow(celebrity) # Follows / unfollows the celebrity
+
+user.follows?(celebrity) # returns true if the user object follows the celebrity object, false otherwise
+
+user.followees_by(Celebrity) # returns a scope of FollowSystem::Follow join model that belongs to the user object and belongs to followee objects of type Celebrity
+```
+
+For more information read the [api documentation](http://rubydoc.info/gems/follow_system).
+
+## Contributing
+
+1. Fork it ( https://github.com/pmviva/follow_system/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end
+

data/follow_system.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'follow_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "follow_system"
+  spec.version       = FollowSystem::VERSION
+  spec.authors       = ["Pablo Martin Viva"]
+  spec.email         = ["pmviva@gmail.com"]
+  spec.summary       = %q{An active record follow system.}
+  spec.description   = %q{An active record follow system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.}
+  spec.homepage      = "http://github.com/pmviva/follow_system"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.add_dependency "rails", [ ">= 4.1", "< 5" ]
+
+  spec.add_development_dependency "appraisal", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.7"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end
+

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.10"
+
+gemspec :path => "../"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.1"
+
+gemspec :path => "../"

data/lib/follow_system/follow.rb

@@ -0,0 +1,155 @@
+###
+# FollowSystem module
+#
+# This module defines common behavior in follow system
+###
+module FollowSystem
+  ###
+  # Follow class
+  #
+  # This class defines the follow model in follow system
+  ###
+  class Follow < ActiveRecord::Base
+    ###
+    # Belongs to followee association configuration
+    ###
+    belongs_to :followee, polymorphic: :true
+
+    ###
+    # Belongs to follower association configuration
+    ###
+    belongs_to :follower, polymorphic: :true
+
+    ###
+    # Creates a {Follow} relationship between a {Follower} object and a {Followee} object
+    #
+    # @param [Follower] follower - the {Follower} of the relationship
+    # @param [Followee] followee - the {Followee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.follow(follower, followee)
+      validate_followee(followee)
+      validate_follower(follower)
+
+      if follows?(follower, followee)
+        false
+      else
+        follow = scope_by_follower(follower).scope_by_followee(followee).build
+        follow.save
+        true
+      end
+    end
+
+    ###
+    # Destroys a {Follow} relationship between a {Follower} object and a {Followee} object
+    #
+    # @param [Follower] follower - the {Follower} of the relationship
+    # @param [Followee] followee - the {Followee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.unfollow(follower, followee)
+      validate_followee(followee)
+      validate_follower(follower)
+
+      if follows?(follower, followee)
+        follow = scope_by_follower(follower).scope_by_followee(followee).take
+        follow.destroy
+        true
+      else
+        false
+      end
+    end
+
+    ###
+    # Toggles a {Follow} relationship between a {Follower} object and a {Followee} object
+    #
+    # @param [Follower] follower - the {Follower} of the relationship
+    # @param [Followee] followee - the {Followee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.toggle_follow(follower, followee)
+      validate_followee(followee)
+      validate_follower(follower)
+
+      if follows?(follower, followee)
+        unfollow(follower, followee)
+      else
+        follow(follower, followee)
+      end
+    end
+
+    ###
+    # Specifies if a {Follower} object follows a {Followee} object
+    #
+    # @param [Follower] follower - the {Follower} object to test against
+    # @param [Followee] followee - the {Followee} object to test against
+    # @return [Boolean]
+    ###
+    def self.follows?(follower, followee)
+      validate_followee(followee)
+      validate_follower(follower)
+
+      scope_by_follower(follower).scope_by_followee(followee).exists?
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects filtered by a {Followee} object
+    #
+    # @param [Followee] followee - the {Followee} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_followee(followee)
+      where(followee: followee)
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects filtered by a {Followee} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_followee_type(klass)
+      where(followee_type: klass.to_s.classify)
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects filtered by a {Follower} object
+    #
+    # @param [Follower] follower - the {Follower} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_follower(follower)
+      where(follower: follower)
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects filtered by a {Follower} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_follower_type(klass)
+      where(follower_type: klass.to_s.classify)
+    end
+
+    private
+      ###
+      # Validates a followee object
+      #
+      # @raise [ArgumentError] if the followee object is invalid
+      ###
+      def self.validate_followee(followee)
+        raise ArgumentError.new unless followee.respond_to?(:is_followee?) && followee.is_followee?
+      end
+
+      ###
+      # Validates a follower object
+      #
+      # @raise [ArgumentError] if the follower object is invalid
+      ###
+      def self.validate_follower(follower)
+        raise ArgumentError.new unless follower.respond_to?(:is_follower?) && follower.is_follower?
+      end
+  end
+end
+

data/lib/follow_system/followee.rb

@@ -0,0 +1,58 @@
+###
+# FollowSystem module
+#
+# This module defines common behavior in follow system
+###
+module FollowSystem
+  ###
+  # Followee module
+  #
+  # This module defines followee behavior in follow system
+  ###
+  module Followee
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many followers association configuration
+      ###
+      has_many :followers, class_name: "FollowSystem::Follow", as: :followee, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can be followed by {Follower} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_followee?
+      true
+    end
+
+    ###
+    # Specifies if self is followed by a {Follower} object
+    #
+    # @param [Follower] follower - the {Follower} object to test against
+    # @return [Boolean]
+    ###
+    def followed_by?(follower)
+      Follow.follows?(follower, self)
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects that follows self filtered {Follower} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def followers_by(klass)
+      Follow.scope_by_followee(self).scope_by_follower_type(klass)
+    end
+  end
+end
+

data/lib/follow_system/follower.rb

@@ -0,0 +1,88 @@
+###
+# FollowSystem module
+#
+# This module defines common behavior in follow system
+###
+module FollowSystem
+  ###
+  # Follower module
+  #
+  # This module defines follower behavior in follow system
+  ###
+  module Follower
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many followees association configuration
+      ###
+      has_many :followees, class_name: "FollowSystem::Follow", as: :follower, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can follow {Followee} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_follower?
+      true
+    end
+
+    ###
+    # Creates a {Follow} relationship between self and a {Followee} object
+    #
+    # @param [Followee] followee - the followee of the {Follow} relationship
+    # @return [Boolean]
+    ###
+    def follow(followee)
+      Follow.follow(self, followee)
+    end
+
+    ###
+    # Destroys a {Follow} relationship between self and a {Followee} object
+    #
+    # @param [Followee] followee - the followee of the {Follow} relationship
+    # @return [Boolean]
+    ###
+    def unfollow(followee)
+      Follow.unfollow(self, followee)
+    end
+
+    ###
+    # Toggles a {Follow} relationship between self and a {Followee} object
+    #
+    # @param [Followee] followee - the followee of the {Follow} relationship
+    # @return [Boolean]
+    ###
+    def toggle_follow(followee)
+      Follow.toggle_follow(self, followee)
+    end
+
+    ###
+    # Specifies if self follows a {Follower} object
+    #
+    # @param [Followee] followee - the {Followee} object to test against
+    # @return [Boolean]
+    ###
+    def follows?(followee)
+      Follow.follows?(self, followee)
+    end
+
+    ###
+    # Retrieves a scope of {Follow} objects that are followed by self
+    #
+    # @param [Class] klass - the {Class} to include
+    # @return [ActiveRecord::Relation]
+    ###
+    def followees_by(klass)
+      Follow.scope_by_follower(self).scope_by_followee_type(klass)
+    end
+  end
+end
+

data/lib/follow_system/version.rb

@@ -0,0 +1,12 @@
+###
+# FollowSystem module
+#
+# This module defines common behavior in follow system
+###
+module FollowSystem
+  ###
+  # Version constant definition
+  ###
+  VERSION = "0.0.6"
+end
+

data/lib/follow_system.rb

@@ -0,0 +1,45 @@
+require 'follow_system/follow'
+require 'follow_system/followee'
+require 'follow_system/follower'
+
+###
+# FollowSystem module
+#
+# This module defines common behavior in follow system
+###
+module FollowSystem
+  ###
+  # Specifies if self can be followed by {Follower} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_followee?
+    false
+  end
+
+  ###
+  # Specifies if self can follow {Followee} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_follower?
+    false
+  end
+
+  ###
+  # Instructs self to act as followee
+  ###
+  def act_as_followee
+    include Followee
+  end
+
+  ###
+  # Instructs self to act as follower
+  ###
+  def act_as_follower
+    include Follower
+  end
+end
+
+ActiveRecord::Base.extend FollowSystem
+