notification-settings 1.2.5 → 1.2.6

data/app/models/notification_settings/setting.rb

@@ -1,13 +1,15 @@
-class NotificationSettings::Setting < ActiveRecord::Base
-
-    self.table_name = 'notification_settings_settings'
-
-    include NotificationSettings::SettingLibrary
-
-    serialize :settings, Hash
-    serialize :category_settings, Hash
-
-    belongs_to :object, polymorphic: true, optional: true
-    belongs_to :subscription, optional: true
-
-end
+# frozen_string_literal: true
+
+module NotificationSettings
+  class Setting < ActiveRecord::Base
+    self.table_name = 'notification_settings_settings'
+
+    include NotificationSettings::SettingLibrary
+
+    serialize :settings, Hash
+    serialize :category_settings, Hash
+
+    belongs_to :object, polymorphic: true, optional: true
+    belongs_to :subscription, optional: true
+  end
+end

data/app/models/notification_settings/subscription.rb

@@ -1,13 +1,15 @@
-class NotificationSettings::Subscription < ActiveRecord::Base
-
-    self.table_name = 'notification_settings_subscriptions'
-
-    include NotificationSettings::SubscriptionLibrary
-
-    belongs_to :subscriber, polymorphic: true
-    belongs_to :subscribable, polymorphic: true
-
-    has_many :notifications, class_name: '::Notification'
-    has_one :notification_setting, class_name: 'Setting'
-
-end
+# frozen_string_literal: true
+
+module NotificationSettings
+  class Subscription < ActiveRecord::Base
+    self.table_name = 'notification_settings_subscriptions'
+
+    include NotificationSettings::SubscriptionLibrary
+
+    belongs_to :subscriber, polymorphic: true
+    belongs_to :subscribable, polymorphic: true
+
+    has_many :notifications, class_name: '::Notification'
+    has_one :notification_setting, class_name: 'Setting'
+  end
+end

data/lib/generators/notification_settings/install_generator.rb

@@ -1,43 +1,40 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module NotificationSettings
-
-    class InstallGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
-
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install NotificationSettings'
-
-        def self.next_migration_number dirname
-            if ActiveRecord::Base.timestamped_migrations
-                Time.now.utc.strftime '%Y%m%d%H%M%S'
-            else
-                "%.3d" % ( current_migration_number(dirname) + 1 )
-            end
-        end
-
-        def create_initializer
-            template 'initializer.rb', 'config/initializers/notification-settings.rb'
-        end
-
-        def create_notifications_migration_file
-            migration_template 'notifications_migration.rb.erb', 'db/migrate/notification_settings_migration.rb', migration_version: migration_version
-        end
-
-        def show_readme
-            readme 'README.md'
-        end
-
-        private
-
-        def migration_version
-            if Rails.version >= '5.0.0'
-                "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-            end
-        end
-
-    end
-
-end
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module NotificationSettings
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root(File.join(File.dirname(__FILE__), '../templates/install'))
+    desc 'Install NotificationSettings'
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      else
+        format('%.3d', current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/notification-settings.rb'
+    end
+
+    def create_notifications_migration_file
+      migration_template(
+        'notifications_migration.rb.erb',
+        'db/migrate/notification_settings_migration.rb',
+        migration_version: migration_version
+      )
+    end
+
+    private
+
+    def migration_version
+      return unless Rails.version >= '5.0.0'
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+end

data/lib/generators/templates/install/initializer.rb

@@ -1,24 +1,28 @@
-NotificationSettings.configure do |config|
-
-    # Choose your default notification category. Takes a string.
-    # config.default_category = 'notification'
-
-
-    ### STATUS ###
-
-    # Time duration without activity after which the status defaults to `'idle'`. Takes a time.
-    # config.idle_after = 10.minutes
-
-    # Time duration without activity after which the status defaults to `'offline'`. Takes a time.
-    # config.offline_after = 3.hours
-
-    # Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a string.
-    # config.last_seen = 'last_seen'
-
-    # Array of possible statuses that will prevent creating notifications for a target. Takes an array of strings.
-    # config.do_not_notify_statuses = []
-
-    # Array of possible statuses that will prevent pushing notifications of a target. Takes an array of strings.
-    # config.do_not_push_statuses = ['do not disturb']
-
-end
+# frozen_string_literal: true
+
+NotificationSettings.configure do |config|
+  # Choose your default notification category. Takes a string.
+  # config.default_category = 'notification'
+
+  ### STATUS ###
+
+  # Time duration without activity after which the status defaults to `'idle'`.
+  # Takes a time.
+  # config.idle_after = 10.minutes
+
+  # Time duration without activity after which the status defaults to
+  # `'offline'`. Takes a time.
+  # config.offline_after = 3.hours
+
+  # Stringified datetime attribute name of `object` that defines the time of the
+  # last activity. Takes a string.
+  # config.last_seen = 'last_seen'
+
+  # Array of possible statuses that will prevent creating notifications for a
+  # target. Takes an array of strings.
+  # config.do_not_notify_statuses = []
+
+  # Array of possible statuses that will prevent pushing notifications of a
+  # target. Takes an array of strings.
+  # config.do_not_push_statuses = ['do not disturb']
+end

data/lib/generators/templates/install/notifications_migration.rb.erb

@@ -1,29 +1,27 @@
-class NotificationSettingsMigration < ActiveRecord::Migration<%= migration_version %>
-    def change
-        add_column :notifications, :subscription_id, :bigint, index: true
-        add_column :notifications, :category, :string, index: true
-
-        create_table :notification_settings_settings do |t|
-
-            t.references :object, polymorphic: true, index: { name: 'idx_settings_object_type_object_id' }
-            t.references :subscription, index: true
-
-            t.string :status
-
-            t.text :settings
-            t.text :category_settings
-
-            t.timestamps
-
-        end
-
-        create_table :notification_settings_subscriptions do |t|
-
-            t.references :subscriber, polymorphic: true, index: { name: 'idx_subscriptions_subscriber_type_subscriber_id' }
-            t.references :subscribable, polymorphic: true, index: { name: 'idx_subscriptions_subscribable_type_subscribable_id' }
-
-            t.timestamps
-
-        end
-    end
-end
+# frozen_string_literal: true
+
+class NotificationSettingsMigration < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :notifications, :subscription_id, :bigint, index: true
+    add_column :notifications, :category, :string, index: true
+
+    create_table :notification_settings_settings do |t|
+      t.references :object, polymorphic: true, index: { name: 'idx_settings_object_type_object_id' }
+      t.references :subscription, index: true
+
+      t.string :status
+
+      t.text :settings
+      t.text :category_settings
+
+      t.timestamps
+    end
+
+    create_table :notification_settings_subscriptions do |t|
+      t.references :subscriber, polymorphic: true, index: { name: 'idx_subscriptions_subscriber_type_subscriber_id' }
+      t.references :subscribable, polymorphic: true, index: { name: 'idx_subscriptions_subscribable_type_subscribable_id' }
+
+      t.timestamps
+    end
+  end
+end

data/lib/notification-settings.rb

@@ -1,15 +1,15 @@
-module NotificationSettings
-
-    require 'notification_settings/configuration'
-
-    require 'notification_settings/engine'
-
-    autoload :Target, 'notification_settings/target'
-    autoload :Subscriber, 'notification_settings/subscriber'
-    autoload :Subscribable, 'notification_settings/subscribable'
-    autoload :SettingLibrary, 'notification_settings/setting_library'
-    autoload :SubscriptionLibrary, 'notification_settings/subscription_library'
-    autoload :NotificationLibrary, 'notification_settings/notification_library'
-    autoload :NotificationScopes, 'notification_settings/notification_scopes'
-
-end
+# frozen_string_literal: true
+
+module NotificationSettings
+  require 'notification_settings/configuration'
+
+  require 'notification_settings/engine'
+
+  autoload :Target, 'notification_settings/target'
+  autoload :Subscriber, 'notification_settings/subscriber'
+  autoload :Subscribable, 'notification_settings/subscribable'
+  autoload :SettingLibrary, 'notification_settings/setting_library'
+  autoload :SubscriptionLibrary, 'notification_settings/subscription_library'
+  autoload :NotificationLibrary, 'notification_settings/notification_library'
+  autoload :NotificationScopes, 'notification_settings/notification_scopes'
+end

data/lib/notification_settings/configuration.rb

@@ -1,32 +1,30 @@
-module NotificationSettings
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :default_category
-        attr_accessor :last_seen
-        attr_accessor :idle_after
-        attr_accessor :offline_after
-        attr_accessor :do_not_notify_statuses
-        attr_accessor :do_not_push_statuses
-
-        def initialize
-            @default_category = 'notification'
-            @last_seen = 'last_seen'
-            @idle_after = 10.minutes
-            @offline_after = 3.hours
-            @do_not_notify_statuses = []
-            @do_not_push_statuses = ['do not disturb']
-        end
-
-    end
-
-end
+# frozen_string_literal: true
+
+module NotificationSettings
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :default_category
+    attr_accessor :last_seen
+    attr_accessor :idle_after
+    attr_accessor :offline_after
+    attr_accessor :do_not_notify_statuses
+    attr_accessor :do_not_push_statuses
+
+    def initialize
+      @default_category = 'notification'
+      @last_seen = 'last_seen'
+      @idle_after = 10.minutes
+      @offline_after = 3.hours
+      @do_not_notify_statuses = []
+      @do_not_push_statuses = ['do not disturb']
+    end
+  end
+end

data/lib/notification_settings/engine.rb

@@ -1,7 +1,9 @@
-require 'rails/railtie'
-require 'active_record'
-
-module NotificationSettings
-    class Engine < ::Rails::Engine
-    end
-end
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'active_record'
+
+module NotificationSettings
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/notification_settings/notification_library.rb

@@ -1,72 +1,144 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationSettings
-    module NotificationLibrary
-
-        extend ActiveSupport::Concern
-
-        included do
-            before_create :validate_create
-            belongs_to :subscription, class_name: 'NotificationSettings::Subscription', optional: true
-
-            include NotificationSettings::NotificationLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def category
-                self[:category] || NotificationRenderer.configuration.default_category
-            end
-
-            private
-
-            def validate_create
-                valid = true
-
-                if self.target.notification_setting.present?
-                    # Status
-                    valid = false if NotificationSettings.configuration.do_not_notify_statuses.include?(self.target.notification_setting.status)
-
-                    # Settings
-                    valid = false if !self.target.notification_setting.settings.dig(:enabled)
-                    ## Category
-                    valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, :enabled)
-                end
-
-                valid
-            end
-
-            def validate_push
-                valid = true
-
-                if self.target.notification_setting.present?
-                    # Status
-                    valid = false if NotificationSettings.configuration.do_not_push_statuses.include?(self.target.notification_setting.status)
-
-                    # Settings
-                    if self.push.kind_of?(Array)
-                        self.push.each do |pusher|
-                            valid = false if !self.target.notification_setting.settings.dig(pusher.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(pusher.to_sym).nil? )
-                            ## Category
-                            valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym).nil? )
-                        end
-                    else
-                        valid = false if !self.target.notification_setting.settings.dig(self.push.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(self.push.to_sym).nil? )
-                        ## Category
-                        valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym).nil? )
-                    end
-                end
-
-                valid
-            end
-
-            def initialize_pusher
-                return unless validate_push
-                super
-            end
-
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'active_support'
+
+module NotificationSettings
+  module NotificationLibrary
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :validate_create
+
+      belongs_to :subscription,
+                 class_name: 'NotificationSettings::Subscription',
+                 optional: true
+
+      include NotificationSettings::NotificationLibrary::InstanceMethods
+    end
+
+    module InstanceMethods
+      def category
+        self[:category] || NotificationSettings.configuration.default_category
+      end
+
+      private
+
+      def validate_create
+        throw(:abort) unless can_create?
+      end
+
+      def can_create?
+        if target.notification_setting.present?
+          unless status_allows_create? &&
+                 settings_allow_create? &&
+                 category_settings_allow_create?
+            return false
+          end
+        end
+        true
+      end
+
+      def status_allows_create?
+        !do_not_notify_statuses.include?(target.notification_setting.status)
+      end
+
+      def settings_allow_create?
+        target.notification_setting.settings.dig(:enabled)
+      end
+
+      def category_settings_allow_create?
+        target.notification_setting.category_settings.dig(
+          category.to_sym,
+          :enabled
+        )
+      end
+
+      def initialize_pusher
+        return unless can_push?
+        super
+      end
+
+      def can_push?
+        if target.notification_setting.present?
+          return false unless status_allows_push?
+
+          if push.is_a?(Array)
+            return false unless can_use_pushers?(push)
+          else
+            return false unless can_use_pusher?(push)
+          end
+        end
+        true
+      end
+
+      def can_use_pushers?(pushers)
+        pushers.each do |pusher|
+          return false unless can_use_pusher?(pusher)
+        end
+        true
+      end
+
+      def can_use_pusher?(pusher)
+        unless settings_allow_push?(pusher) &&
+               category_settings_allow_push?(pusher)
+          return false
+        end
+        true
+      end
+
+      def status_allows_push?
+        !do_not_push_statuses.include?(target.notification_setting.status)
+      end
+
+      def settings_allow_push?(pusher)
+        return global_settings_allow_push? unless local_pusher_settings?(pusher)
+        local_settings_allow_push?(pusher)
+      end
+
+      def local_pusher_settings?(pusher)
+        local_settings_allow_push?(pusher).present?
+      end
+
+      def local_settings_allow_push?(pusher)
+        target.notification_setting.settings.dig(pusher.to_sym)
+      end
+
+      def global_settings_allow_push?
+        target.notification_setting.settings.dig(:index)
+      end
+
+      def category_settings_allow_push?(pusher)
+        if local_pusher_category_settings?(pusher)
+          local_category_settings_allow_push?(pusher)
+        else
+          global_category_settings_allow_push?
+        end
+      end
+
+      def local_pusher_category_settings?(pusher)
+        local_category_settings_allow_push?(pusher).present?
+      end
+
+      def local_category_settings_allow_push?(pusher)
+        target.notification_setting.category_settings.dig(
+          category.to_sym, pusher.to_sym
+        )
+      end
+
+      def global_category_settings_allow_push?
+        target.notification_setting.category_settings.dig(
+          category.to_sym, :index
+        )
+      end
+
+      def do_not_notify_statuses
+        NotificationSettings.configuration.do_not_notify_statuses
+      end
+
+      def do_not_push_statuses
+        NotificationSettings.configuration.do_not_push_statuses
+      end
+    end
+  end
+end