power_of_friendship 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 MISERALIS
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PowerOfFriendship'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/friendship/USAGE

@@ -0,0 +1,9 @@
+Description:
+    This generator creates a migration and model files for friendship representations. 
+
+Example:
+    rails generate friendship <Name of Friend Model, eg: User>
+
+    This will create:
+        friendship model
+        friendship migration

data/lib/generators/friendship/friendship_generator.rb

@@ -0,0 +1,53 @@
+class FriendshipGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "Create a model and migration for friendship. NAME is the model you wish to have a friendship relationship."
+
+  def generate_migration
+    migration_template "friendship_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  def generate_class
+    template "friendship_model.rb.erb", "app/models/#{model_filename}"
+  end
+
+
+
+  def migration_name
+    "create_#{name.underscore}_friendship"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+
+  def orig_class_name_und
+    "#{name.underscore.downcase}"
+  end
+  def orig_class_name_cam
+    "#{name.camelize}"
+  end
+
+  def table_name
+   ":#{orig_class_name_und}_friendships"
+  end
+
+  def class_name
+    "#{orig_class_name_cam}Friendship"
+  end
+
+  def model_filename
+    "#{orig_class_name_und}_friendship.rb"
+  end
+
+
+  def self.next_migration_number(path)
+    require  'rails/generators/active_record'
+    ActiveRecord::Generators::Base.next_migration_number path
+  end
+end

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

@@ -0,0 +1,16 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table <%= table_name %> do |t|
+      t.belongs_to :<%= orig_class_name_und %>, index: true
+      t.belongs_to :friend, index: true
+      t.boolean :pending, :default => true
+
+
+      t.timestamps
+
+    end
+
+    add_index <%= table_name %>, [:<%= orig_class_name_und %>_id, :friend_id], :unique => true
+    
+  end
+end

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

@@ -0,0 +1,19 @@
+class <%= class_name %> < ActiveRecord::Base
+  belongs_to :<%= orig_class_name_und %> 
+
+  belongs_to :friend,
+    :class_name => <%= orig_class_name_cam %> ,
+    :foreign_key => :friend_id
+
+
+  validates_presence_of :friend_id, :<%= orig_class_name_und %>_id
+  validates_uniqueness_of :<%= orig_class_name_und %>_id, :scope => :friend_id
+
+  def approved?
+    !self.pending
+  end
+
+  def pending?
+    self.pending
+  end
+end

data/lib/power_of_friendship.rb

@@ -0,0 +1,254 @@
+require 'squeel'
+
+module PowerOfFriendship
+
+
+  module ActsAsFriend
+    extend ActiveSupport::Concern
+
+    included do
+
+    end
+
+    module ClassMethods
+      def act_as_friend(options = {})
+
+        def self.pow_name_und
+          self.name.underscore.downcase
+        end
+
+        def self.pow_friendship_model
+          "#{self.name}Friendship".constantize
+        end
+
+        def self.pow_friendship_table
+          "#{pow_name_und}_friendships"
+        end
+
+        def self.pow_model_id
+          "#{pow_name_und}_id".to_sym
+
+        end
+
+        has_many :friends, 
+        through: :approved_friendships,
+        :source => :friend
+
+        has_many :approved_friendships,
+        ->(t) {where("#{t.pow_friendship_table}.pending" => false)},
+        :foreign_key => pow_model_id,
+        :class_name => pow_friendship_model
+
+
+        has_many  :friendships,
+        foreign_key: pow_model_id,
+        class_name: pow_friendship_model,
+        dependent: :destroy
+
+        has_many  :followers,
+        :through => :inverse_friendships,
+        source: pow_name_und
+
+        has_many  :invited_friends,
+        :through => :invited_friendships,
+        source: :friend
+
+        has_many :invited_friendships,
+        ->(t) {where("#{t.pow_friendship_table}.pending" => true)},
+        :foreign_key => pow_model_id,
+        :class_name => pow_friendship_model
+
+
+        has_many  :inverse_friendships,
+        :class_name => pow_friendship_model,
+        :foreign_key => :friend_id,
+        dependent: :destroy
+
+        has_many  :inverse_followers,
+        :through => :friendships,
+        source: :friend
+
+        has_many  :pending_friends,
+        ->(t) {where("#{t.pow_friendship_table}.pending" => true)},
+        :through => :pending_friendships,
+        source: pow_name_und
+
+        has_many :pending_friendships,
+        ->(t) {where("#{t.pow_friendship_table}.pending" => true)},
+        :foreign_key => :friend_id,
+        :class_name => pow_friendship_model
+
+
+        include PowerOfFriendship::ActsAsFriend::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      def pow_name_und
+        self.class.pow_name_und
+      end
+
+      def pow_model_id
+        self.class.pow_model_id
+      end
+
+      def pow_friendship_model
+        self.class.pow_friendship_model
+      end
+
+      def pow_friendship_table
+        self.class.pow_friendship_table
+      end
+
+
+
+      def invite(friend)
+        return false if friend == self || find_any_friendship_with(friend)
+        friendship = pow_friendship_model.new( pow_model_id => self.id, :friend_id => friend.id, pending: true ).save
+        friendship
+      end  
+
+      def approve(friend)
+        friendship = pow_friendship_model.where(pow_model_id => friend.id, :friend_id => self.id, pending: true).first
+        return false if friendship.nil?
+        if friendship.update_attribute(:pending, false)
+          create_complimentary_friendship friendship  
+          true    
+        else
+          false 
+        end 
+      end
+
+      def unfriend(friend)
+        friendship = self.find_any_friendship_with friend
+        return true if not friendship
+        friendship.destroy
+        self.destroy_complimentary_friendship friendship
+      end
+
+      def follow(model)
+        return true if self.invite(model)
+        return self.approve model
+      end
+
+      def unfollow(model)
+        followership = pow_friendship_model.where(pow_model_id => self.id, :friend_id => model.id).first
+        return true if not followership
+        followership.destroy
+
+        if followership.approved?
+          other_followership = find_friendship_complement followership
+          other_followership.pending = true
+          other_followership.save
+        end
+        return true
+      end
+
+      def friends_with?(model)
+        self.friends.include?(model)
+      end
+
+      def follows?(model)
+        self.inverse_followers.include?(model)
+      end
+
+      def followed_by?(model)
+        self.followers.include?(model)
+      end
+
+      def connected_with?(model)
+        find_any_friendship_with(model).present?
+      end
+
+      def invited_by?(model)
+        friendship = find_any_friendship_with(model)
+        return false if friendship.nil?
+        return friendship.send(pow_model_id) == model.id if friendship.pending == true
+        inverse_friendship = find_friendship_complement friendship
+        return friendship.send(pow_model_id) == model.id if friendship.created_at <= inverse_friendship.created_at
+        return inverse_friendship.send(pow_model_id) == model.id 
+      end
+
+      def invited?(model)
+        friendship = pow_friendship_model.where(pow_model_id => self.id, :friend_id => model.id).first
+        return false if friendship.nil?
+        return friendship.friend_id == model.id if friendship.pending == true
+        inverse_friendship = find_friendship_complement friendship
+        return friendship.friend_id == model.id if friendship.created_at <= inverse_friendship.created_at
+        return inverse_friendship.friend_id == model.id 
+      end
+
+      def suggested_friends
+        pow_model_id_column = pow_model_id # TODO figure out how to avoid this
+        table = pow_friendship_table # TODO figure out how to avoid this
+        self_table = "#{pow_name_und}s"
+
+        approved_friendships = pow_friendship_model.where{
+          (  __send__(pow_model_id_column) == my{id}) & 
+          ( pending       == false  ) 
+        }
+
+        pending_friendships = pow_friendship_model.where{
+          ( (  __send__(pow_model_id_column) == my{id}) |
+            ( friend_id == my{id}) ) &
+          ( pending      == true  ) 
+        }
+
+        buddies_relations = pow_friendship_model.where{
+          (  __send__(pow_model_id_column).in(approved_friendships.select{friend_id} ) ) & 
+          (  __send__(pow_model_id_column) != my{id} ) 
+        }
+
+        potential = self.class.where{
+          ( __send__(table).__send__(pow_model_id_column).in(buddies_relations.select{friend_id} ) ) &
+          (  __send__(table).pending == false) &
+          (  __send__(table).friend_id.in(approved_friendships.select{friend_id} ) ) &
+          (  __send__(table).__send__(pow_model_id_column)  != my{id} ) &
+          (  __send__(table).__send__(pow_model_id_column).not_in(pending_friendships.select{ __send__(table).__send__(pow_model_id_column)} ) ) &
+          (  __send__(table).__send__(pow_model_id_column).not_in(pending_friendships.select{ __send__(table).friend_id} ) ) & 
+          (  __send__(table).__send__(pow_model_id_column).not_in(approved_friendships.select{ __send__(table).friend_id} ) ) 
+
+        }.select{ 
+          ["#{self_table}.id", "#{self_table}.*", __send__(table).count.as(:jcount)] 
+
+        }.joins(:friendships).group{ 
+          [__send__(table).__send__(pow_model_id_column), "#{self_table}.id"]
+
+        }.order("jcount DESC")
+
+        potential
+      end
+
+
+      def create_complimentary_friendship(friendship)
+        return false if friendship.pending?
+        return pow_friendship_model.create(pow_model_id => friendship.friend_id, 
+          friend_id: friendship.send(pow_model_id), pending: false)
+      end
+
+      def destroy_complimentary_friendship(friendship)
+        return false if friendship.pending?
+        friendship_compliment = find_friendship_complement friendship
+        return friendship_compliment.destroy
+      end
+
+      def find_friendship_complement friendship
+        friendship = pow_friendship_model.where(pow_model_id => friendship.friend_id, :friend_id => friendship.send(pow_model_id)).first
+      end
+
+      def find_any_friendship_with(model)
+        pow_model_id_column = pow_model_id # TODO figure out how to avoid this
+        friendship = pow_friendship_model.where{
+          (( __send__(pow_model_id_column) == my{id} )  & 
+            (  friend_id == my{model.id} )) |
+          (( __send__(pow_model_id_column) == my{model.id} )  & 
+            (  friend_id == my{id} ))
+          }.order(created_at: :desc).first;
+
+        friendship
+      end
+    end
+  end
+end
+
+  ActiveRecord::Base.send :include, PowerOfFriendship::ActsAsFriend

data/lib/power_of_friendship/version.rb

@@ -0,0 +1,3 @@
+module PowerOfFriendship
+  VERSION = "1.0.0"
+end

data/lib/tasks/power_of_friendship_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :power_of_friendship do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: power_of_friendship
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- miseralis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.7
+- !ruby/object:Gem::Dependency
+  name: squeel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Power of Friendship is a friendship library for Rails' Active Records.
+  It allows you to add Facebook style friendships and/or Twitter style followers to
+  any model.
+email:
+- me@miseralis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/friendship/friendship_generator.rb
+- lib/generators/friendship/templates/friendship_migration.rb.erb
+- lib/generators/friendship/templates/friendship_model.rb.erb
+- lib/generators/friendship/USAGE
+- lib/power_of_friendship/version.rb
+- lib/power_of_friendship.rb
+- lib/tasks/power_of_friendship_tasks.rake
+- MIT-LICENSE
+- Rakefile
+homepage: https://github.com/Miseralis/power_of_friendship
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.28
+signing_key: 
+specification_version: 3
+summary: Empower your models with the awesome power of friendship
+test_files: []