notification-renderer 1.2.5 → 1.2.6

data/app/helpers/notification_renderer_helper.rb

@@ -1,63 +1,80 @@
-module NotificationRendererHelper
-
-    def render_notification notification, options = {}
-        defaults = {
-            renderer: NotificationRenderer.configuration.default_renderer,
-            attributes: nil,
-            notifications: nil
-        }
-        options = defaults.merge options
-
-        notification.update_attributes read: true if NotificationRenderer.configuration.auto_read
-        render "notifications/#{notification.type}/#{options[:renderer]}", notification: notification, attributes: options[:attributes], notifications: options[:notifications]
-    end
-
-    def render_notifications notifications, options = {}
-        defaults = {
-            renderer: NotificationRenderer.configuration.default_renderer
-        }
-        options = defaults.merge options
-
-        content_tag :div, class: 'notification-renderer notifications' do
-            notifications.each do |notification|
-                render_notification notification, renderer: options[:renderer]
-            end
-        end
-    end
-
-    def render_notifications_grouped notifications, group_by, options = {}
-        defaults = {
-            renderer: NotificationRenderer.configuration.default_renderer,
-            group_by_date: false,
-            group_by_type: false
-        }
-        options = defaults.merge options
-
-        group_by.unshift :type if options[:group_by_type]
-        group_by.unshift "created_at.beginning_of_#{options[:group_by_date]}" if options[:group_by_date]
-
-        content_tag :div, class: 'notification-renderer notifications' do
-            recursive_render_notifications_grouped notifications.grouping(options[:group_by]), options
-        end
-    end
-
-    def notification_grouped?
-        local_assigns[:attributes] && local_assigns[:notifications]
-    end
-
-    private
-
-    def recursive_render_notifications_grouped notifications, i = 0, options = {}
-        options[:attributes] = {} unless options.has_key? :attributes
-        notifications.each_pair do |k, v|
-            options[:attributes][options[:group_by][i]] = k
-            i += 1
-            if v.is_a? Hash
-                recursive_render_notifications_grouped v, options
-            else
-                render_notification v.last, renderer: options[:renderer], attributes: options[:attributes], notifications: v
-            end
-        end
-    end
-
-end
+# frozen_string_literal: true
+
+module NotificationRendererHelper
+  def render_notification(notification,
+                          renderer: default_renderer,
+                          attributes: nil,
+                          notifications: nil)
+    notification.update(read: true) if auto_read
+    render(
+      partial: "notifications/#{notification.type}/#{renderer}",
+      locals: {
+        notification: notification,
+        attributes: attributes,
+        notifications: notifications
+      }
+    )
+  end
+
+  def render_notifications(notifications, renderer: default_renderer)
+    content_tag :div, class: 'notification-renderer notifications' do
+      notifications&.each do |notification|
+        render_notification(notification, renderer: renderer)
+      end
+    end
+  end
+
+  def render_notifications_grouped(notifications, group_by,
+                                   renderer: default_renderer,
+                                   group_by_date: false,
+                                   group_by_type: false)
+    group_by.unshift(:type) if group_by_type
+    if group_by_date
+      group_by.unshift("created_at.beginning_of_#{group_by_date}")
+    end
+
+    content_tag :div, class: 'notification-renderer notifications' do
+      recursive_notification_grouping(
+        notifications.grouping(group_by), group_by, renderer
+      )
+    end
+  end
+
+  def notification_grouped?
+    local_assigns[:attributes] && local_assigns[:notifications]
+  end
+
+  private
+
+  def recursive_notification_grouping(notifications, group_by, renderer,
+                                      attributes)
+    i = 0
+    notifications.each do |k, v|
+      attributes[group_by[i]] = k
+      i += 1
+      recursive_render_notifications_grouped(v, renderer, attributes)
+    end
+  end
+
+  def recursive_render_notifications_grouped(notifications, renderer,
+                                             attributes)
+    if notifications.is_a?(Hash)
+      recursive_notification_grouping(
+        notifications, group_by, renderer, attributes
+      )
+    else
+      render_notification(notifications.last,
+                          renderer: renderer,
+                          attributes: attributes,
+                          notifications: notifications)
+    end
+  end
+
+  def auto_read
+    NotificationRenderer.configuration.auto_read
+  end
+
+  def default_renderer
+    NotificationRenderer.configuration.default_renderer
+  end
+end

data/lib/generators/notification_renderer/install_generator.rb

@@ -1,47 +1,44 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
 module NotificationRenderer
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root(File.join(File.dirname(__FILE__), '../templates/install'))
+    desc 'Install NotificationRenderer'
+
+    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
 
-    class InstallGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
-
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install NotificationRenderer'
-
-        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-renderer.rb'
-        end
-
-        def create_notifications_migration_file
-            migration_template 'notifications_migration.rb.erb', 'db/migrate/notification_renderer_migration.rb', migration_version: migration_version
-        end
-
-        def create_templates
-            system 'rails g notification_renderer:type -t notification'
-        end
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/notification-renderer.rb'
+    end
 
-        def show_readme
-            readme 'README.md'
-        end
+    def create_notifications_migration_file
+      migration_template(
+        'notifications_migration.rb.erb',
+        'db/migrate/notification_renderer_migration.rb',
+        migration_version: migration_version
+      )
+    end
 
-        private
+    def create_templates
+      system 'rails g notification_renderer:type -t notification'
+    end
 
-        def migration_version
-            if Rails.version >= '5.0.0'
-                "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-            end
-        end
+    private
 
+    def migration_version
+      return unless Rails.version >= '5.0.0'
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
     end
-
+  end
 end

data/lib/generators/notification_renderer/type_generator.rb

@@ -1,21 +1,30 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
 module NotificationRenderer
+  class TypeGenerator < Rails::Generators::Base
+    source_root(File.join(File.dirname(__FILE__), '../templates/type'))
+    desc 'Create a new notification type'
+    class_option :type,
+                 desc: 'Specify the notification type',
+                 type: :string,
+                 default: NotificationRenderer.configuration.default_type,
+                 aliases: '-t'
+    class_option :renderers,
+                 desc: 'Specify the renderer templates',
+                 type: :string,
+                 default: NotificationRenderer.configuration.default_renderer,
+                 aliases: '-r'
 
-    class TypeGenerator < Rails::Generators::Base
-
-        source_root File.join File.dirname(__FILE__), '../templates/type'
-        desc 'Create a new notification type'
-        class_option :type, desc: 'Specify the notification type', type: :string, default: NotificationRenderer.configuration.default_type, aliases: '-t'
-        class_option :renderers, desc: 'Specify the renderer templates', type: :string, default: NotificationRenderer.configuration.default_renderer, aliases: '-r'
-
-        def create_templates
-            options[:renderers].split(' ')&.each do |template|
-                template '_template.html', "app/views/notifications/#{options[:type]}/_#{template}.html.erb"
-            end
-        end
-
+    def create_templates
+      options[:renderers].split(' ')&.each do |template|
+        template(
+          '_template.html',
+          "app/views/notifications/#{options[:type]}/_#{template}.html.erb"
+        )
+      end
     end
-
+  end
 end

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

@@ -1,12 +1,12 @@
-NotificationRenderer.configure do |config|
-
-    # Choose your default notification type. Takes a string.
-    # config.default_type = 'notification'
-
-    # Choose your default renderer. Takes a string.
-    # config.default_renderer = 'index'
-
-    # Automatically mark rendered notifications as read. Takes a boolean.
-    # config.auto_read = true
-
-end
+# frozen_string_literal: true
+
+NotificationRenderer.configure do |config|
+  # Choose your default notification type. Takes a string.
+  # config.default_type = 'notification'
+
+  # Choose your default renderer. Takes a string.
+  # config.default_renderer = 'index'
+
+  # Automatically mark rendered notifications as read. Takes a boolean.
+  # config.auto_read = true
+end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class NotificationRendererMigration < ActiveRecord::Migration<%= migration_version %>
-    def change
-        add_column :notifications, :type, :string, index: true
-    end
+  def change
+    add_column :notifications, :type, :string, index: true
+  end
 end

data/lib/generators/templates/type/_template.html

@@ -1,7 +1,7 @@
-<!--
-In your renderers you can access the `Notification` record through the `notification` variable. This is how a renderer could look like:
-
-<%#= notification.target.name %> commented on <%#= notification.object.article.title %>
-
-Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-renderer#renderers
--->
+<!--
+In your renderers you can access the `Notification` record through the `notification` variable. This is how a renderer could look like:
+
+<%#= notification.target.name %> commented on <%#= notification.object.article.title %>
+
+Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-renderer#renderers
+-->

data/lib/notification-renderer.rb

@@ -1,10 +1,10 @@
-module NotificationRenderer
-
-    require 'notification_renderer/configuration'
-
-    require 'notification_renderer/engine'
-
-    autoload :NotificationLibrary, 'notification_renderer/notification_library'
-    autoload :NotificationScopes, 'notification_renderer/notification_scopes'
-
-end
+# frozen_string_literal: true
+
+module NotificationRenderer
+  require 'notification_renderer/configuration'
+
+  require 'notification_renderer/engine'
+
+  autoload :NotificationLibrary, 'notification_renderer/notification_library'
+  autoload :NotificationScopes, 'notification_renderer/notification_scopes'
+end

data/lib/notification_renderer/configuration.rb

@@ -1,26 +1,24 @@
-module NotificationRenderer
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :default_type
-        attr_accessor :default_renderer
-        attr_accessor :auto_read
-
-        def initialize
-            @default_type = 'notification'
-            @default_renderer = 'index'
-            @auto_read = true
-        end
-
-    end
-
-end
+# frozen_string_literal: true
+
+module NotificationRenderer
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :default_type
+    attr_accessor :default_renderer
+    attr_accessor :auto_read
+
+    def initialize
+      @default_type = 'notification'
+      @default_renderer = 'index'
+      @auto_read = true
+    end
+  end
+end

data/lib/notification_renderer/engine.rb

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

data/lib/notification_renderer/notification_library.rb

@@ -1,45 +1,49 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationRenderer
-    module NotificationLibrary
-
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-
-            def grouping group_by
-                notifications = all
-                group_by.each do |method|
-                    notifications = recursive_grouping notifications, method
-                end
-                notifications
-            end
-
-            def grouping_by group_by
-                all.group_by{ |notification| notification.send(group_by) }
-            end
-
-            def recursive_grouping notifications, group_by
-                if notifications.is_a? Hash
-                    notifications.each_pair do |k, v|
-                        if v.is_a? Hash
-                            recursive_grouping v, group_by
-                        else
-                            k = v.grouping_by group_by
-                        end
-                    end
-                else
-                    notifications.grouping_by group_by
-                end
-                notifications
-            end
-
-        end
-
-        def type
-            self[:type] || NotificationRenderer.configuration.default_type
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'active_support'
+
+module NotificationRenderer
+  module NotificationLibrary
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def grouping(group_by)
+        notifications = all
+        group_by.each do |method|
+          notifications = recursive_grouping(notifications, method)
+        end
+        notifications
+      end
+
+      def grouping_by(group_by)
+        all.group_by { |notification| notification.send(group_by) }
+      end
+
+      def recursive_grouping(notifications, group_by)
+        if notifications.is_a?(Hash)
+          recursive_hash_grouping(notifications, group_by)
+        else
+          notifications.grouping_by(group_by)
+        end
+        notifications
+      end
+    end
+
+    def type
+      self[:type] || NotificationRenderer.configuration.default_type
+    end
+
+    private
+
+    def recursive_hash_grouping(notifications, group_by)
+      notifications.each_pair do |k, v|
+        if v.is_a?(Hash)
+          recursive_hash_grouping(v, group_by)
+        else
+          notifications[k] = v.grouping_by(group_by)
+        end
+      end
+    end
+  end
+end

data/lib/notification_renderer/notification_scopes.rb

@@ -1,26 +1,24 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationRenderer
-    module NotificationScopes
-
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-
-            def method_missing m, *args
-                if m.to_s[/(.+)_type/]
-                    where type: $1.singularize.classify
-                else
-                    super
-                end
-            end
-
-            def respond_to? m, include_private = false
-                super || m.to_s[/(.+)_type/]
-            end
-
-        end
-
-    end
-end
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'active_support'
+
+module NotificationRenderer
+  module NotificationScopes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def method_missing(method, *args)
+        if method.to_s[/(.+)_type/]
+          where(type: $1.singularize.classify)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        super || method.to_s[/(.+)_type/]
+      end
+    end
+  end
+end