rails_friends 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16d732621008d42394463d60062d252e9ff5b722cd37b89f02aa05c9366d19f4
+  data.tar.gz: fd7493df09797d9d0ce2f24570252335642986f5fdfb3bb8bcef00b56367a9c9
+SHA512:
+  metadata.gz: c88b1f09c4ebd5ec234a4ae7bee9d33743705259995773af9fc01c8ed73ed728e28b0c60689379b1af2631b460753d6869a58efcd1da4cab117202a9e0158099
+  data.tar.gz: f0ca8788c617650ca46f6e7b5467dfb50b781d4dd6da524ec4ce35fa72371f1b5a68720f58f1543fa66111b37ff94b55ca1e1ab18f44c73bebb96e40ca5061bc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Sung Won Cho
+
+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,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsFriends'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs'
+task default: :spec

data/lib/generators/rails_friends/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsFriends
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      # include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Copies the migrations for RailsFriends'
+
+      def copy_migrations
+        directory 'migrations', 'db/migrate'
+      end
+    end
+  end
+end

data/lib/generators/rails_friends/templates/migrations/20240518023302_create_friendships.rb

@@ -0,0 +1,21 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class CreateFriendships < ActiveRecord::Migration[4.2]; end
+else
+  class CreateFriendships < ActiveRecord::Migration; end
+end
+
+CreateFriendships.class_eval do
+  def self.up
+    create_table :friendships do |t|
+      t.references :friendable, polymorphic: true
+      t.integer  :friend_id
+      t.string   :status
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :friendships
+  end
+end

data/lib/generators/rails_friends/templates/migrations/20240518023303_add_blocker_id_to_friendships.rb

@@ -0,0 +1,15 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddBlockerIdToFriendships < ActiveRecord::Migration[4.2]; end
+else
+  class AddBlockerIdToFriendships < ActiveRecord::Migration; end
+end
+
+AddBlockerIdToFriendships.class_eval do
+  def self.up
+    add_column :friendships, :blocker_id, :integer, default: nil
+  end
+
+  def self.down
+    remove_column :friendships, :blocker_id
+  end
+end

data/lib/generators/rails_friends/templates/migrations/20240518023304_update_friendships.rb

@@ -0,0 +1,31 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class UpdateFriendships < ActiveRecord::Migration[4.2]; end
+else
+  class UpdateFriendships < ActiveRecord::Migration; end
+end
+
+UpdateFriendships.class_eval do
+  def self.up
+    add_column :friendships, :status_temp, :integer, index: true
+
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 0 WHERE status = 'pending'")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 1 WHERE status = 'requested'")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 2 WHERE status = 'accepted'")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 3 WHERE status = 'blocked'")
+
+    remove_column :friendships, :status
+    rename_column :friendships, :status_temp, :status
+  end
+
+  def self.down
+    add_column :friendships, :status_temp, :string
+
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 'pending' WHERE status = 0")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 'requested' WHERE status = 1")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 'accepted' WHERE status = 2")
+    ActiveRecord::Base.connection.execute("UPDATE friendships SET status_temp = 'blocked' WHERE status = 3")
+
+    remove_column :friendships, :status
+    rename_column :friendships, :status_temp, :status
+  end
+end

data/lib/generators/rails_friends/templates/migrations/20240518023305_add_unique_index_to_friendships.rb

@@ -0,0 +1,21 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddUniqueIndexToFriendships < ActiveRecord::Migration[4.2]; end
+else
+  class AddUniqueIndexToFriendships < ActiveRecord::Migration; end
+end
+
+AddUniqueIndexToFriendships.class_eval do
+  disable_ddl_transaction!
+
+  def self.up
+    return if index_exists?(:friendships, %i[friendable_id friend_id])
+
+    add_index :friendships, %i[friendable_id friend_id], unique: true, algorithm: :concurrently
+  end
+
+  def self.down
+    return unless index_exists?(:friendships, %i[friendable_id friend_id])
+
+    remove_index :friendships, %i[friendable_id friend_id]
+  end
+end

data/lib/rails_friends/engine.rb

@@ -0,0 +1,9 @@
+module RailsFriends
+  class Engine < ::Rails::Engine
+    # Do not isolate namespace to avoid issues
+    initializer 'rails_friends.load_generators' do
+      Rails.application.config.generators.templates << RailsFriends::Engine.root.join('lib', 'generators',
+                                                                                      'rails_friends', 'templates')
+    end
+  end
+end

data/lib/rails_friends/extender.rb

@@ -0,0 +1,13 @@
+module RailsFriends
+  module Extender
+    def self.included(base)
+
+      # Dynamically define the Friendship's association based on where the module is included.
+      RailsFriends::Friendship.class_eval do
+        belongs_to :friendable, polymorphic: true
+        belongs_to :friend, class_name: "#{base.to_s}", foreign_key: :friend_id
+      end
+
+    end
+  end
+end

data/lib/rails_friends/friendable.rb

@@ -0,0 +1,117 @@
+module RailsFriends
+  module Friendable
+    def friendable?
+      false
+    end
+
+    def has_friendship
+      class_eval do
+        has_many :friendships, as: :friendable,
+                               class_name: 'RailsFriends::Friendship', dependent: :destroy
+
+        has_many :blocked_friends,
+                 -> { where friendships: { status: 3 } },
+                 through: :friendships,
+                 source: :friend
+
+        has_many :friends,
+                 -> { where friendships: { status: 2 } },
+                 through: :friendships
+
+        has_many :requested_friends,
+                 -> { where friendships: { status: 1 } },
+                 through: :friendships,
+                 source: :friend
+
+        has_many :pending_friends,
+                 -> { where friendships: { status: 0 } },
+                 through: :friendships,
+                 source: :friend
+
+        def self.friendable?
+          true
+        end
+      end
+
+      include RailsFriends::Friendable::InstanceMethods
+      include RailsFriends::Extender
+    end
+
+    module InstanceMethods
+      CALLBACK_METHOD_NAMES = %i[
+        on_friendship_created
+        on_friendship_accepted
+        on_friendship_blocked
+        on_friendship_destroyed
+      ].freeze
+
+      CALLBACK_METHOD_NAMES.each do |method_name|
+        define_method(method_name) do |*args|
+          super(*args) if defined?(super)
+        end
+      end
+
+      def friend_request(friend)
+        return if self == friend || RailsFriends::Friendship.exist?(self, friend)
+
+        transaction do
+          RailsFriends::Friendship.create_relation(self, friend, status: 0)
+          RailsFriends::Friendship.create_relation(friend, self, status: 1)
+        end
+      end
+
+      def accept_request(friend)
+        on_relation_with(friend) do |one, other|
+          friendship = RailsFriends::Friendship.find_unblocked_friendship(one, other)
+          friendship.accept! if can_accept_request?(friendship)
+        end
+      end
+
+      def decline_request(friend)
+        on_relation_with(friend) do |one, other|
+          RailsFriends::Friendship.find_unblocked_friendship(one, other).destroy
+        end
+      end
+
+      alias remove_friend decline_request
+
+      def block_friend(friend)
+        on_relation_with(friend) do |one, other|
+          RailsFriends::Friendship.find_unblocked_friendship(one, other).block_by(self)
+        end
+      end
+
+      def unblock_friend(friend)
+        return unless has_blocked(friend)
+
+        on_relation_with(friend) do |one, other|
+          RailsFriends::Friendship.find_blocked_friendship(one, other).destroy
+        end
+      end
+
+      def on_relation_with(friend)
+        transaction do
+          yield(self, friend)
+          yield(friend, self)
+        end
+      end
+
+      def friends_with?(friend)
+        RailsFriends::Friendship.find_relation(self, friend, status: 2).any?
+      end
+
+      private
+
+      def has_blocked(friend)
+        RailsFriends::Friendship.find_one_side(self, friend).blocker_id == id
+      end
+
+      def can_accept_request?(friendship)
+        return if friendship.pending? && self == friendship.friendable
+        return if friendship.requested? && self == friendship.friend
+
+        true
+      end
+    end
+  end
+end

data/lib/rails_friends/friendship.rb

@@ -0,0 +1,89 @@
+module RailsFriends
+  class Friendship < ActiveRecord::Base
+    validate :satisfy_custom_conditions
+
+    after_create do |record|
+      friend.on_friendship_created(record)
+    end
+
+    after_destroy do |record|
+      friendable.try(:on_friendship_destroyed, record)
+    end
+
+    attr_reader :status_was
+
+    enum status: { pending: 0, requested: 1, accepted: 2, blocked: 3 } do
+      event :accept do
+        before do
+          @status_was = status
+        end
+
+        transition %i[pending requested] => :accepted
+
+        after do
+          friendable.on_friendship_accepted(self)
+        end
+      end
+
+      event :block do
+        after do
+          friendable.on_friendship_blocked(self)
+        end
+        transition all - [:blocked] => :blocked
+      end
+    end
+
+    def block_by(blocker)
+      self.blocker_id = blocker.id
+      block!
+    end
+
+    def self.relation_attributes(one, other, status: nil)
+      attr = {
+        friendable_id: one.id,
+        friendable_type: one.class.base_class.name,
+        friend_id: other.id
+      }
+
+      attr[:status] = status if status
+
+      attr
+    end
+
+    def self.create_relation(one, other, options)
+      relation = new relation_attributes(one, other)
+      relation.attributes = options
+      relation.save
+    end
+
+    def self.find_relation(friendable, friend, status: nil)
+      where relation_attributes(friendable, friend, status: status)
+    end
+
+    def self.exist?(friendable, friend)
+      find_relation(friendable, friend).any? && find_relation(friend, friendable).any?
+    end
+
+    def self.find_unblocked_friendship(friendable, friend)
+      find_relation(friendable, friend).where.not(status: 3).first
+    end
+
+    def self.find_blocked_friendship(friendable, friend)
+      find_relation(friendable, friend).where(status: 3).first
+    end
+
+    def self.find_one_side(one, other)
+      find_by(relation_attributes(one, other))
+    end
+
+    private
+
+    def satisfy_custom_conditions
+      return unless friend.respond_to?(:friendship_errors)
+
+      friend.friendship_errors(friendable).to_a.each do |friendship_error|
+        errors.add(:base, friendship_error)
+      end
+    end
+  end
+end

data/lib/rails_friends/version.rb

@@ -0,0 +1,3 @@
+module RailsFriends
+  VERSION = '0.1.0'
+end

data/lib/rails_friends.rb

@@ -0,0 +1,18 @@
+require 'stateful_enum'
+
+require 'active_support'
+require 'active_record'
+require 'rails/engine'
+require 'rails_friends/engine'
+
+module RailsFriends
+  extend ActiveSupport::Autoload
+
+  autoload :Friendable
+  autoload :Friendship
+  autoload :Extender
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend RailsFriends::Friendable
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: rails_friends
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Carey
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: stateful_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- timcarey1989@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/rails_friends/install_generator.rb
+- lib/generators/rails_friends/templates/migrations/20240518023302_create_friendships.rb
+- lib/generators/rails_friends/templates/migrations/20240518023303_add_blocker_id_to_friendships.rb
+- lib/generators/rails_friends/templates/migrations/20240518023304_update_friendships.rb
+- lib/generators/rails_friends/templates/migrations/20240518023305_add_unique_index_to_friendships.rb
+- lib/rails_friends.rb
+- lib/rails_friends/engine.rb
+- lib/rails_friends/extender.rb
+- lib/rails_friends/friendable.rb
+- lib/rails_friends/friendship.rb
+- lib/rails_friends/version.rb
+- lib/tasks/rails_friends_tasks.rake
+homepage: https://github.com/tim-carey-code/rails_friends
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Add social network friendship features to your Active Record models.
+test_files: []