simple_notifications 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3429c440ecdbb8810066360b76cc3a1ba79ff9fd5ecc108171a052d57fe1a649
-  data.tar.gz: 117ab5c746b2a14f1247cfdd1918e0fb642cf14acb096abc22c56c878128c915
+  metadata.gz: 637fcdccc7f7369aee6e40e286087ac074f5a373fcea81268620e110405542a8
+  data.tar.gz: 04046a239fffa98a0dc094cf5efeaed8cb259b5459e234ab1fa54c5e26f78834
 SHA512:
-  metadata.gz: cc556f64c92b82ed8533185bd67b23a28d6b42dd930ba36e20c8b0ecaa0e0f648b5eeade1b85a3bf4f021ac765e6b9ca529a9c632cd491698c52240009b4dfe5
-  data.tar.gz: 9904cbd9964d6a53315db6650bd354a5533c649a8d84e8c7c0296a55fc97ac7ac6789d20398c6bf0e232f7c08f585c52ad30a73e6a73433f1d63d2f983860dea
+  metadata.gz: 8c95d4692facc8a87180ccbdeaff38cefc1e418c36974fef15a07815ecf729eff29f67a8411c66a88ec5263e8dcbf98b0a5ce169c7ddbb7d51d956b75a8f0663
+  data.tar.gz: d91290995506e71974a2aead19fe7f30c46cf9c2f63c5729974dbb4a35f8be61020f9945d115fd52a36d829a733159c4d3e0542123acffac6d842cee11aabf3c

data/README.md

@@ -39,7 +39,10 @@ rails db:migrate
 Add following line to the model for which notifications functionality is required
 
 ```ruby
-notify sender: :author, receivers: :followers
+notify sender: :author, 
+       receivers: :followers, 
+       before_notify: proc {puts 'Before Notifications actions'},
+       after_notify: proc {puts 'Deliver Push notifications'}
 ``` 
 Or you can provide ActiveRecord::Base object or ActiveRecord::Relation objects as 
 
@@ -120,6 +123,12 @@ Post.create(content: '123', notify: false)
 Post.create(content: '123', message: 'My custom notification message')
 ```
 
+### Generators
+
+```ruby
+rails generate simple_notifications:copy_models
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/aashishgarg/simple_notifications. 

data/lib/generators/simple_notifications/copy_models/USAGE

@@ -0,0 +1,10 @@
+Description:
+    1. Creates an initializer file for simple_notifications.
+    2. Creates a migration file file for recording the data of notifications receiver and sender.
+
+Example:
+    rails generate simple_notifications:install
+
+    This will create:
+        config/simple_notifications.rb
+        db/migrate/{time_stamp}_create_simple_notifications.rb

data/lib/generators/simple_notifications/copy_models/copy_models_generator.rb

@@ -0,0 +1,13 @@
+module SimpleNotifications
+  class CopyModelsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../simple_notifications/app/models', __dir__)
+
+    def copy_notification_model
+      copy_file "simple_notification.rb", "app/models/simple_notification.rb"
+    end
+
+    def copy_delivery_model
+      copy_file "delivery.rb", "app/models/delivery.rb"
+    end
+  end
+end

data/lib/generators/simple_notifications/install/copy_models_generator.rb

@@ -0,0 +1,13 @@
+module SimpleNotifications
+  class CopyModelsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../lib/simple_notifications/app/models', __dir__)
+
+    def copy_notification_model
+      copy_file "simple_notifications.rb", "app/models/simple_notifications.rb"
+    end
+
+    def copy_delivery_model
+      copy_file "deliver.rb", "app/models/deliver.rb"
+    end
+  end
+end

data/lib/simple_notifications/app/models/delivery.rb

@@ -2,8 +2,19 @@ module SimpleNotifications
   class Delivery < ActiveRecord::Base
     self.table_name = 'deliveries'
 
-    # --- Associations --- #
-    belongs_to :simple_notification, class_name: 'SimpleNotifications::Record', inverse_of: :deliveries
+    # Associations
+    belongs_to :simple_notification,
+               class_name: 'SimpleNotifications::Record',
+               inverse_of: :deliveries
     belongs_to :receiver, polymorphic: true
+
+    # Callbacks
+    after_create_commit :after_create_actions
+
+    private
+
+    def after_create_actions
+
+    end
   end
 end

data/lib/simple_notifications/app/models/simple_notification.rb

@@ -2,28 +2,46 @@ module SimpleNotifications
   class Record < ActiveRecord::Base
     self.table_name = 'simple_notifications'
 
-    # --- Associations --- #
+    # Class Attribute Accessors
+    cattr_accessor :before_notify, :after_notify
+
+    # Associations
     belongs_to :sender, polymorphic: true
     belongs_to :entity, polymorphic: true
-    has_many :deliveries, class_name: 'SimpleNotifications::Delivery', inverse_of: :simple_notification,
-             foreign_key: :simple_notification_id, dependent: :destroy
-    has_many :read_deliveries, -> {where(is_read: true)}, class_name: 'SimpleNotifications::Delivery', inverse_of: :simple_notification,
-             foreign_key: :simple_notification_id, dependent: :destroy
-    has_many :unread_deliveries, -> {where(is_read: false)}, class_name: 'SimpleNotifications::Delivery', inverse_of: :simple_notification,
-             foreign_key: :simple_notification_id, dependent: :destroy
+    has_many :deliveries, class_name: 'SimpleNotifications::Delivery',
+             inverse_of: :simple_notification,
+             foreign_key: :simple_notification_id,
+             dependent: :destroy
+    has_many :read_deliveries, -> {where(is_read: true)},
+             class_name: 'SimpleNotifications::Delivery',
+             inverse_of: :simple_notification,
+             foreign_key: :simple_notification_id,
+             dependent: :destroy
+    has_many :unread_deliveries, -> {where(is_read: false)},
+             class_name: 'SimpleNotifications::Delivery',
+             inverse_of: :simple_notification,
+             foreign_key: :simple_notification_id,
+             dependent: :destroy
 
+    # Scopes
     scope :read, -> {where(is_read: true)}
     scope :unread, -> {where.not(is_read: true)}
 
-    # --- validations --- #
+    # Validations
     validates :message, presence: true, length: {minimum: 1, maximum: 199}
 
-    # --- Callbacks --- #
+    # Callbacks
+    before_create :before_actions
     after_create_commit :after_actions
 
     private
 
+    def before_actions
+      SimpleNotifications::Record.before_notify.call if !!SimpleNotifications::Record.before_notify
+    end
+
     def after_actions
+      SimpleNotifications::Record.after_notify.call if !!SimpleNotifications::Record.after_notify
     end
   end
 end

data/lib/simple_notifications/base.rb

@@ -7,12 +7,14 @@ module SimpleNotifications
       !!@@notified_flag
     end
 
-    # Add this method to any model and it starts the notification functionality on the Model.
-    # Expects two parameters :sender and :receiver.
+    #Example
+    #notify(sender: :author, receivers: :followers)
     def notify(options = {})
       @@entity_class = self
       @@sender = options[:sender]
       @@receivers = options[:receivers]
+      SimpleNotifications::Record.before_notify = options[:before_notify] if !!options[:before_notify]
+      SimpleNotifications::Record.after_notify = options[:after_notify] if !!options[:after_notify]
 
       open_sender_class
       open_receiver_class
@@ -21,6 +23,7 @@ module SimpleNotifications
       @@notified_flag = true
     end
 
+    # Opening the class which is defined as sender.
     def open_sender_class
       # Define association for sender model
       sender_class(@@sender).class_eval do
@@ -28,6 +31,7 @@ module SimpleNotifications
       end
     end
 
+    # Opening the classes which are defined as receivers.
     def open_receiver_class
       # Define association for receiver model
       [receivers_class(@@receivers)].flatten.each do |base|
@@ -38,6 +42,7 @@ module SimpleNotifications
       end
     end
 
+    # Opening the class on which the notify functionality is applied.
     def open_notified_class
       class_eval do
         attr_accessor :message, :notify
@@ -45,6 +50,7 @@ module SimpleNotifications
         has_many :notifications, class_name: 'SimpleNotifications::Record', as: :entity
         has_many :notifiers, through: :notifications, source: :sender, source_type: sender_class(@@sender).to_s
 
+        # Opening the Notification class.
         SimpleNotifications::Record.class_eval do
           [@@entity_class.receivers_class(@@receivers)].flatten.each do |receiver_class|
             has_many "#{receiver_class.name.downcase}_receivers".to_sym,
@@ -60,12 +66,13 @@ module SimpleNotifications
                    source: "#{receiver_class.name.downcase}_receivers".to_sym
         end
 
-        # has_many :notificants, through: :notifications, source: :receivers
         has_many :read_deliveries, through: :notifications, source: :read_deliveries
         has_many :unread_deliveries, through: :notifications, source: :unread_deliveries
+        # has_many :notificants, through: :notifications, source: :receivers
         # has_many :read_notificants, through: :read_deliveries, source: :receiver, source_type: 'User'
         # has_many :unread_notificants, through: :unread_deliveries, source: :receiver, source_type: 'User'
 
+        # Callbacks
         after_create_commit :create_notification, if: proc {@notify.nil? || !!@notify}
         after_update_commit :update_notification, if: proc {@notify.nil? || !!@notify}
 
@@ -74,7 +81,9 @@ module SimpleNotifications
           !notifications.blank?
         end
 
-        # Deliver notifications at any time
+        #Example
+        #post.notify(sender: :author, receivers: :followers, message: 'My Custom logic message')
+        #post.create(content: '', notify: false) -> It does not create the notification.
         def notify(options = {})
           raise 'SimpleNotification::SenderReceiverError' unless options[:sender] && options[:receivers]
           @message = options[:message] if options[:message]
@@ -133,6 +142,7 @@ module SimpleNotifications
       end
     end
 
+    # Provides the class of Sender
     def sender_class(sender)
       if sender.kind_of? Symbol
         reflections[sender.to_s].klass
@@ -143,6 +153,7 @@ module SimpleNotifications
       end
     end
 
+    # Provides the classes of Receivers
     def receivers_class(receivers)
       if receivers.kind_of? Symbol
         reflections[receivers.to_s].klass

data/lib/simple_notifications/version.rb

@@ -1,3 +1,3 @@
 module SimpleNotifications
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_notifications
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ashish Garg
@@ -71,7 +71,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/simple_notifications/copy_models/USAGE
+- lib/generators/simple_notifications/copy_models/copy_models_generator.rb
 - lib/generators/simple_notifications/install/USAGE
+- lib/generators/simple_notifications/install/copy_models_generator.rb
 - lib/generators/simple_notifications/install/install_generator.rb
 - lib/generators/simple_notifications/install/templates/initializer.rb
 - lib/generators/simple_notifications/install/templates/migration.rb