acts-as-messageable 0.4.11 → 1.0.0

data/lib/acts-as-messageable.rb

@@ -1,18 +1,4 @@
-module ActsAsMessageable
-  autoload :Model,    'acts-as-messageable/model'
-  autoload :Scopes,   'acts-as-messageable/scopes'
-  autoload :Message,  'acts-as-messageable/message'
-  autoload :Relation, 'acts-as-messageable/relation'
-  autoload :Rails3,   'acts-as-messageable/rails3'
-  autoload :Rails4,   'acts-as-messageable/rails4'
+# typed: strong
+# frozen_string_literal: true
 
-  def self.rails_api
-    if Rails::VERSION::MAJOR >= 4
-      Rails4
-    else
-      Rails3
-    end
-  end
-end
-
-require 'acts-as-messageable/railtie'
+require 'acts_as_messageable'

data/lib/acts_as_messageable/message.rb

@@ -0,0 +1,136 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  class Message < ::ActiveRecord::Base
+    extend T::Sig
+
+    include ActsAsMessageable::Scopes
+    include Ancestry::InstanceMethods
+
+    has_ancestry
+
+    belongs_to :received_messageable, polymorphic: true
+    belongs_to :sent_messageable, polymorphic: true
+
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_accessor :removed, :restored
+
+    cattr_accessor :required
+
+    sig { params(args: T.untyped, kwargs: T.untyped).void }
+    def initialize(*args, **kwargs)
+      @removed = T.let(false, T.nilable(T::Boolean))
+      @restored = T.let(false, T.nilable(T::Boolean))
+
+      super
+    end
+
+    ActsAsMessageable.rails_api.new(self).attr_accessible(
+      :topic, :body, :opened, :opened_at, :recipient_permanent_delete,
+      :recipient_delete, :sender_permanent_delete, :sender_delete
+    )
+    ActsAsMessageable.rails_api.new(self).default_scope('created_at desc')
+
+    # @return [Boolean] whether the message has been read
+    sig { returns(T::Boolean) }
+    def open?
+      opened?
+    end
+
+    # @return [Boolean] whether the message has been read
+    # @see open?
+    sig { returns(T::Boolean) }
+    def opened?
+      opened_at.present? || super
+    end
+
+    # Method open message (will mark message as read)
+    # @return [Boolean] whether the message has been open
+    sig { returns(T::Boolean) }
+    def open
+      ActsAsMessageable.rails_api.new(self).update_attributes!(opened_at: DateTime.now)
+      ActsAsMessageable.rails_api.new(self).update_attributes!(opened: true)
+    end
+
+    alias mark_as_read open
+    alias read open
+
+    # Method close message (will mark message as unread)
+    # @return [Boolean] whether the message has been closed
+    sig { returns(T::Boolean) }
+    def close
+      ActsAsMessageable.rails_api.new(self).update_attributes!(opened_at: nil)
+      ActsAsMessageable.rails_api.new(self).update_attributes!(opened: false)
+    end
+
+    alias mark_as_unread close
+    alias unread close
+
+    sig { returns(ActiveRecord::Base) }
+    def from
+      sent_messageable
+    end
+
+    sig { returns(ActiveRecord::Base) }
+    def to
+      received_messageable
+    end
+
+    # @param [ActiveRecord::Base] user
+    # @return [ActiveRecord::Base] real receiver of the mssage
+    sig { params(user: ActiveRecord::Base).returns(ActiveRecord::Base) }
+    def real_receiver(user)
+      user == from ? to : from
+    end
+
+    # @return [Boolean] whether user is participant of group message
+    # @param [ActiveRecord::Base] user
+    sig { params(user: T.untyped).returns(T::Boolean) }
+    def participant?(user)
+      user.class.group_messages || (to == user) || (from == user)
+    end
+
+    # @return [Object] conversation tree
+    sig { returns(T.untyped) }
+    def conversation
+      root.subtree
+    end
+
+    # Method will mark message as removed
+    # @return [TrueClass]
+    sig { returns(TrueClass) }
+    def delete
+      self.removed = true
+    end
+
+    # Method will mark message as removed
+    # @return [TrueClass]
+    sig { returns(TrueClass) }
+    def restore
+      self.restored = true
+    end
+
+    # Reply to given message
+    # @param [Hash] args
+    # @option args [String] topic Topic of the message
+    # @option args [String] body Body of the message
+    # @return [ActsAsMessageable::Message] a message that is a response to a given message
+    # @return [Boolean] when user is not participant of the message
+    # @see ActsAsMessageable::Model::InstanceMethods#reply_to
+    sig do
+      params(args: T.any(T::Hash[String, String],
+                         String)).returns(T.any(ActsAsMessageable::Message, T::Boolean, ActiveRecord::Base))
+    end
+    def reply(*args)
+      T.unsafe(to).reply_to(self, *args)
+    end
+
+    # Method will return list of users in the conversation
+    # @return [Array<ActiveRecord::Base>] users
+    sig { returns(T::Array[ActiveRecord::Base]) }
+    def people
+      conversation.map(&:from).uniq!
+    end
+  end
+end

data/lib/acts_as_messageable/model.rb

@@ -0,0 +1,229 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  module Model
+    extend T::Sig
+
+    # @return [Object]
+    # @param [Object] base
+    sig { params(base: Module).returns(T.untyped) }
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      extend T::Helpers
+      extend T::Sig
+
+      requires_ancestor { T.class_of(ActiveRecord::Base) }
+
+      # Method make ActiveRecord::Base object messageable
+      # @option options [Symbol] :table_name table name for messages
+      # @option options [String] :class_name message class name
+      # @option options [Array, Symbol] :required required fields in message
+      # @option options [Symbol] :dependent dependent option from ActiveRecord has_many method
+      # @option options [Symbol] :search_scope name of a scope for a full text search
+      # @param [Hash] options
+      # @return [Object]
+      sig do
+        params(options: T::Hash[Symbol,
+                                T.any(String, Symbol, T::Array[Symbol],
+                                      T::Array[String])]).returns(ActsAsMessageable::Model::ClassMethods)
+      end
+      def acts_as_messageable(options = {})
+        default_options = {
+          table_name: 'messages',
+          class_name: 'ActsAsMessageable::Message',
+          required: %i[topic body],
+          dependent: :nullify,
+          group_messages: false,
+          search_scope: :search
+        }
+        options = default_options.merge(options)
+
+        mattr_accessor(:messages_class_name, :group_messages)
+
+        has_many :received_messages_relation,
+                 as: :received_messageable,
+                 class_name: options[:class_name],
+                 dependent: options[:dependent]
+        has_many :sent_messages_relation,
+                 as: :sent_messageable,
+                 class_name: options[:class_name],
+                 dependent: options[:dependent]
+
+        self.messages_class_name = options[:class_name].constantize
+        messages_class_name.has_ancestry
+
+        messages_class_name.table_name = options[:table_name]
+        messages_class_name.initialize_scopes(options[:search_scope])
+
+        messages_class_name.required = Array.wrap(options[:required])
+        messages_class_name.validates_presence_of messages_class_name.required
+        self.group_messages = options[:group_messages]
+
+        include ActsAsMessageable::Model::InstanceMethods
+      end
+
+      # Method recognize real object class
+      # @return [ActiveRecord::Base] class or relation object
+      sig { returns(T.class_of(ActiveRecord::Base)) }
+      def resolve_active_record_ancestor
+        reflect_on_association(:received_messages_relation).active_record
+      end
+    end
+
+    module InstanceMethods
+      extend T::Helpers
+      extend T::Sig
+
+      requires_ancestor { Kernel }
+      requires_ancestor { CustomSearchUser }
+
+      # @return [ActiveRecord::Relation] all messages connected with user
+      # @param [Boolean] trash Show deleted messages
+      sig { params(trash: T::Boolean).returns(ActiveRecord::Relation) }
+      def messages(trash = false)
+        result = self.class.messages_class_name.connected_with(self, trash)
+        result.relation_context = self
+
+        result
+      end
+
+      # @return [ActiveRecord::Relation] returns all messages from inbox
+      sig { returns(ActiveRecord::Relation) }
+      def received_messages
+        result = ActsAsMessageable.rails_api.new(received_messages_relation)
+        result = T.unsafe(result).scoped.where(recipient_delete: false)
+        result.relation_context = self
+
+        result
+      end
+
+      # @return [ActiveRecord::Relation] returns all messages from outbox
+      sig { returns(ActiveRecord::Relation) }
+      def sent_messages
+        result = ActsAsMessageable.rails_api.new(sent_messages_relation)
+        result = T.unsafe(result).scoped.where(sender_delete: false)
+        result.relation_context = self
+
+        result
+      end
+
+      # @return [ActiveRecord::Relation] returns all messages from trash
+      sig { returns(ActiveRecord::Relation) }
+      def deleted_messages
+        messages(true)
+      end
+
+      # Method sends message to another user
+      # @param [ActiveRecord::Base] to
+      # @param [Hash] args
+      # @option args [String] topic Topic of the message
+      # @option args [String] body Body of the message
+      # @return [ActsAsMessageable::Message] the message object
+      sig do
+        params(to: ActiveRecord::Base,
+               args: T.any(String, T::Hash[T.any(String, Symbol), String])).returns(ActsAsMessageable::Message)
+      end
+      def send_message(to, *args)
+        message_attributes = {}
+
+        case args.first
+        when String
+          self.class.messages_class_name.required.each_with_index do |attribute, index|
+            message_attributes[attribute] = args[index]
+          end
+        when Hash
+          message_attributes = args.first
+        end
+
+        message = self.class.messages_class_name.new message_attributes
+        message.received_messageable = to
+        message.sent_messageable = self
+        message.save!
+
+        message
+      end
+
+      # Method send message to another user
+      # and raise exception in case of validation errors
+      # @param [ActiveRecord::Base] to
+      # @param [Hash] args
+      # @option [String] topic Topic of the message
+      # @option [String] body Body of the message
+      #
+      # @return [ActsAsMessageable::Message] the message object
+      sig do
+        params(to: ActiveRecord::Base,
+               args: T.any(String, T::Hash[T.any(String, Symbol), String])).returns(ActsAsMessageable::Message)
+      end
+      def send_message!(to, *args)
+        T.unsafe(self).send_message(to, *T.unsafe(args)).tap(&:save!)
+      end
+
+      # Reply to given message
+      # @param [ActsAsMessageable::Message] message
+      # @param [Hash] args
+      # @option args [String] topic Topic of the message
+      # @option args [String] body Body of the message
+      #
+      # @return [ActsAsMessageable::Message] a message that is a response to a given message
+      sig do
+        params(message: ActsAsMessageable::Message,
+               args: T.any(String,
+                           T::Hash[T.any(String, Symbol), String])).returns(T.nilable(ActsAsMessageable::Message))
+      end
+      def reply_to(message, *args)
+        current_user = T.cast(self, ActiveRecord::Base)
+
+        return unless message.participant?(current_user)
+
+        reply_message = T.unsafe(self).send_message(message.real_receiver(current_user), *args)
+        reply_message.parent = message
+        reply_message.save
+
+        reply_message
+      end
+
+      # Mark message as deleted
+      # @param [ActsAsMessageable::Message] message to delete
+      # @return [ActsAsMessageable::Message] deleted message
+      sig { params(message: ActsAsMessageable::Message).returns(T::Boolean) }
+      def delete_message(message)
+        current_user = self
+
+        case current_user
+        when message.to
+          attribute = message.recipient_delete ? :recipient_permanent_delete : :recipient_delete
+        when message.from
+          attribute = message.sender_delete ? :sender_permanent_delete : :sender_delete
+        else
+          raise "#{current_user} can't delete this message"
+        end
+
+        ActsAsMessageable.rails_api.new(message).update_attributes!(attribute => true)
+      end
+
+      # Mark message as restored
+      # @param [ActsAsMessageable::Message] message to restore
+      # @return [ActsAsMessageable::Message] restored message
+      sig { params(message: ActsAsMessageable::Message).returns(T::Boolean) }
+      def restore_message(message)
+        current_user = self
+
+        case current_user
+        when message.to
+          attribute = :recipient_delete
+        when message.from
+          attribute = :sender_delete
+        else
+          raise "#{current_user} can't restore this message"
+        end
+
+        ActsAsMessageable.rails_api.new(message).update_attributes!(attribute => false)
+      end
+    end
+  end
+end

data/lib/acts_as_messageable/rails3.rb

@@ -0,0 +1,46 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  class Rails3
+    extend T::Sig
+
+    delegate :attr_accessible, :update_attributes!, to: :@subject
+
+    # @return [ActsAsMessageable::Rails3] api wrapper object
+    # @param [ActiveRecord::Base] subject
+    sig { params(subject: T.untyped).void }
+    def initialize(subject)
+      @subject = subject
+    end
+
+    # @return [Object]
+    # @param [String, Symbol] order_by
+    # @see ActiveRecord::Base#default_scope
+    sig { params(order_by: T.any(String, Symbol)).void }
+    def default_scope(order_by)
+      # T.unsafe is needed here because the default_scope method is defined in
+      # different ways in different versions of Rails. In Rails 3, it is a
+      # class method, but in Rails 4, it is an instance method. We can't
+      # statically determine which version of Rails is being used, so we have
+      # to use T.unsafe here.
+      @subject.send(:default_scope, T.unsafe(@subject).order(order_by))
+    end
+
+    # @return [Object]
+    # @param [Symbol] name
+    # @param [Array] args
+    sig { params(name: Symbol, args: T.untyped).returns(T.untyped) }
+    def method_missing(name, *args)
+      T.unsafe(@subject).send(name, *args) || super
+    end
+
+    # @return [Boolean]
+    # @param [Object] method_name
+    # @param [FalseClass] include_private
+    sig { params(method_name: Symbol, include_private: T::Boolean).returns(T::Boolean) }
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s == 'default_scope' || super
+    end
+  end
+end

data/lib/acts_as_messageable/rails4.rb

@@ -0,0 +1,54 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  class Rails4
+    extend T::Sig
+
+    delegate :update_attributes!, to: :@subject
+
+    # @return [ActsAsMessageable::Rails4] api wrapper object
+    # @param [ActiveRecord::Base] subject
+    sig { params(subject: T.untyped).void }
+    def initialize(subject)
+      @subject = subject
+    end
+
+    # Empty method for Rails 4.x
+    # @return [NilClass]
+    # @param [Array] _args
+    sig { params(_args: T.any(String, Symbol)).void }
+    def attr_accessible(*_args); end
+
+    # Default scope for Rails 4.x with block support
+    # @return [Object]
+    # @param [String, Symbol] order_by
+    sig { params(order_by: T.any(String, Symbol)).returns(Object) }
+    def default_scope(order_by)
+      @subject.send(:default_scope) { T.unsafe(self).order(order_by) }
+    end
+
+    # Rename of the method
+    # @return [Object]
+    sig { returns(Object) }
+    def scoped
+      T.unsafe(@subject).scope
+    end
+
+    # @return [Object]
+    # @param [Symbol] name
+    # @param [Array] args
+    sig { params(name: Symbol, args: T.untyped).returns(T.untyped) }
+    def method_missing(name, *args)
+      T.unsafe(@subject).send(name, *args) || super
+    end
+
+    # @return [Boolean]
+    # @param [String] method_name
+    # @param [Boolean] include_private
+    sig { params(method_name: Symbol, include_private: T::Boolean).returns(T::Boolean) }
+    def respond_to_missing?(method_name, include_private = false)
+      %w[default_scope scoped attr_accessible].include?(method_name) || super
+    end
+  end
+end

data/lib/acts_as_messageable/rails6.rb

@@ -0,0 +1,63 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  class Rails6
+    extend T::Sig
+
+    # @return [ActsAsMessageable::Rails4] api wrapper object
+    # @param [ActiveRecord::Base] subject
+    sig { params(subject: T.untyped).void }
+    def initialize(subject)
+      @subject = subject
+    end
+
+    # Empty method from Rails 3.x
+    # @return [NilClass]
+    # @param [Array] _args
+    sig { params(_args: T.any(String, Symbol)).void }
+    def attr_accessible(*_args); end
+
+    # Default scope for Rails 6.x with block support
+    # @return [Object]
+    # @param [String, Symbol] order_by
+    sig { params(order_by: T.any(String, Symbol)).returns(Object) }
+    def default_scope(order_by)
+      @subject.send(:default_scope) do
+        T.bind(self, ActiveRecord::Relation)
+        order(order_by)
+      end
+    end
+
+    # Rename of the method
+    # @return [Object]
+    sig { returns(Object) }
+    def scoped
+      @subject.scope
+    end
+
+    # Use new method #update! in Rails 6.x
+    # @return [Object]
+    # @param [Array] args
+    sig { params(args: T::Hash[String, String]).returns(T::Boolean) }
+    def update_attributes!(*args)
+      @subject.update!(*args)
+    end
+
+    # @return [Object]
+    # @param [Symbol] name
+    # @param [Array] args
+    sig { params(name: Symbol, args: T.untyped).returns(T.untyped) }
+    def method_missing(name, *args)
+      @subject.send(name, *args) || super
+    end
+
+    # @return [Boolean]
+    # @param [String] method_name
+    # @param [Boolean] include_private
+    sig { params(method_name: Symbol, include_private: T::Boolean).returns(T::Boolean) }
+    def respond_to_missing?(method_name, include_private = false)
+      %w[attr_accessible default_scope scoped update_attributes!].include?(method_name) || super
+    end
+  end
+end

data/lib/acts_as_messageable/railtie.rb

@@ -0,0 +1,12 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'active_record/railtie'
+
+module ActsAsMessageable
+  class Railtie < Rails::Railtie
+    ActiveRecord::Base.include ActsAsMessageable::Model if defined?(ActiveRecord::Base)
+
+    ActiveRecord::Relation.include ActsAsMessageable::Relation if defined?(ActiveRecord::Relation)
+  end
+end

data/lib/acts_as_messageable/relation.rb

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+module ActsAsMessageable
+  module Relation
+    extend T::Sig
+    extend T::Helpers
+
+    sig { returns(ActsAsMessageable::Model::InstanceMethods) }
+    attr_accessor :relation_context
+
+    requires_ancestor { ActiveRecord::Relation }
+
+    # @yield [ActsAsMessageable::Message] message
+    # @param [ActiveRecord::Base] context of relation (most of the time current_user object)
+    # @return [ActiveRecord::Relation]
+    sig { params(context: ActsAsMessageable::Model::InstanceMethods).returns(T.untyped) }
+    def process(context = relation_context)
+      relation = T.cast(self, ActiveRecord::Relation)
+
+      relation.each do |message|
+        yield(message) if block_given?
+        context.delete_message(message) if message.removed
+        context.restore_message(message) if message.restored
+      end
+    end
+
+    # @return [Array<ActsAsMessageable::Message>]
+    # @return [ActiveRecord::Relation]
+    def conversations
+      relation = T.cast(self, ActiveRecord::Relation)
+      relation.map { |message| message.root.subtree.order('id desc').first }.uniq
+    end
+  end
+end

data/lib/acts_as_messageable/scopes.rb

@@ -0,0 +1,53 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActsAsMessageable
+  module Scopes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # @return [Object]
+      # @param [String, Symbol] search_scope
+      extend T::Helpers
+      extend T::Sig
+
+      requires_ancestor { T.class_of(ActiveRecord::Base) }
+
+      include Kernel
+
+      sig { params(search_scope: T.any(String, Symbol)).void }
+      def initialize_scopes(search_scope)
+        scope :are_from, lambda { |*args|
+          where(sent_messageable_id: args.first, sent_messageable_type: args.first.class.name)
+        }
+        scope :are_to, lambda { |*args|
+          where(received_messageable_id: args.first, received_messageable_type: args.first.class.name)
+        }
+        scope search_scope, lambda { |*args|
+          where('body like :search_txt or topic like :search_txt', search_txt: "%#{args.first}%")
+        }
+        scope :connected_with, lambda { |*args|
+          where("(sent_messageable_type = :sent_type and
+                        sent_messageable_id = :sent_id and
+                        sender_delete = :s_delete and sender_permanent_delete = :s_perm_delete) or
+                        (received_messageable_type = :received_type and
+                        received_messageable_id = :received_id and
+                        recipient_delete = :r_delete and recipient_permanent_delete = :r_perm_delete)",
+                sent_type: args.first.class.resolve_active_record_ancestor.to_s,
+                sent_id: args.first.id,
+                received_type: args.first.class.resolve_active_record_ancestor.to_s,
+                received_id: args.first.id,
+                r_delete: args.last,
+                s_delete: args.last,
+                r_perm_delete: false,
+                s_perm_delete: false)
+        }
+        scope :readed, -> { where('opened_at is not null OR opened = ?', true) }
+        scope :unreaded, -> { where('opened_at is null OR opened = ?', false) }
+        scope :deleted, -> { where(recipient_delete: true, sender_delete: true) }
+      end
+    end
+  end
+end

data/lib/acts_as_messageable.rb

@@ -0,0 +1,41 @@
+# typed: strong
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'sorbet-rails'
+require 'ancestry'
+
+module ActsAsMessageable
+  autoload :Model, 'acts_as_messageable/model'
+  autoload :Scopes, 'acts_as_messageable/scopes'
+  autoload :Message, 'acts_as_messageable/message'
+  autoload :Relation, 'acts_as_messageable/relation'
+  autoload :Rails3, 'acts_as_messageable/rails3'
+  autoload :Rails4, 'acts_as_messageable/rails4'
+  autoload :Rails6, 'acts_as_messageable/rails6'
+
+  extend T::Sig
+
+  # @return [Class<ActsAsMessageable::Rails4>, Class<ActsAsMessageable::Rails6>, Class<ActsAsMessageable::Rails3>]
+  #  API wrapper
+  sig do
+    returns(
+      T.any(
+        T.class_of(ActsAsMessageable::Rails4),
+        T.class_of(ActsAsMessageable::Rails6),
+        T.class_of(ActsAsMessageable::Rails3)
+      )
+    )
+  end
+  def self.rails_api
+    if Rails::VERSION::MAJOR >= 6
+      Rails6
+    elsif Rails::VERSION::MAJOR >= 4
+      Rails4
+    else
+      Rails3
+    end
+  end
+end
+
+require 'acts_as_messageable/railtie'