rails_notice 0.1.0

data/app/models/notification.rb

@@ -0,0 +1,156 @@
+class Notification < ApplicationRecord
+  serialize :cc_emails, Array
+
+  attribute :code, :string, default: 'default'
+  belongs_to :receiver, polymorphic: true
+  belongs_to :sender, polymorphic: true, optional: true
+  belongs_to :notifiable, polymorphic: true, optional: true
+  has_one :notification_setting, ->(o) { where(receiver_type: o.receiver_type) }, primary_key: :receiver_id, foreign_key: :receiver_id
+
+  default_scope -> { order(id: :desc) }
+  scope :unread, -> { where(read_at: nil) }
+  scope :have_read, -> { where.not(read_at: nil) }
+
+  after_create_commit :process_job,
+                      :send_email,
+                      :update_unread_count
+
+  def process_job
+    make_as_unread
+    if sending_at
+      NotificationJob.set(wait_until: sending_at).perform_later id
+    else
+      NotificationJob.perform_later(self.id)
+    end
+  end
+
+  def send_email
+    return unless email_enable?
+
+    if notify_setting[:mailer_class]
+      notify_method = notify_setting[:mailer_method] || 'notify'
+      if sending_at
+        notify_setting[:mailer_class].public_send(notify_method, self.notifiable_id).deliver_later(wait_until: sending_at)
+      else
+        notify_setting[:mailer_class].public_send(notify_method, self.notifiable_id).deliver_later
+      end
+    else
+      if sending_at
+        RailsNoticeMailer.notify(self.id).deliver_later(wait_until: sending_at)
+      else
+        RailsNoticeMailer.notify(self.id).deliver_later
+      end
+    end
+  end
+
+  def email_enable?
+    if receiver.notification_setting&.accept_email
+      return true
+    end
+
+    if receiver.notification_setting&.accept_email.is_a?(FalseClass)
+      return false
+    end
+
+    RailsNotice.config.default_send_email
+  end
+
+  def notifiable_detail
+    r = self.notifiable.as_json(**notify_setting.slice(:only, :except, :include, :methods))
+    Hash(r).with_indifferent_access
+  end
+
+  def notifiable_attributes
+    if verbose
+      r = notifiable_detail
+      r.transform_values! do |i|
+        next i unless i.acts_like?(:time)
+        if self.receiver.respond_to?(:timezone)
+          _zone = self.receiver.timezone
+        else
+          _zone = Time.zone.name
+        end
+        i.in_time_zone(_zone).strftime '%Y-%m-%d %H:%M:%S'
+      end
+      r
+    else
+      {}.with_indifferent_access
+    end
+  end
+
+  def notify_setting
+    notifiable_type.constantize.notifies[self.code] || {}
+  end
+
+  def tr_key(column)
+    "#{self.class.i18n_scope}.notify.#{notifiable.class.base_class.model_name.i18n_key}.#{self.code}.#{column}"
+  end
+
+  def code
+    super ? super.to_sym : :default
+  end
+
+  def title
+    return super unless notifiable
+    tr_values = notifiable_detail.slice *I18nHelper.interpolate_key(I18n.t(tr_key(:title)))
+    tr_values.merge! notify_setting.fetch(:tr_values, {})
+
+    if super.blank?
+      I18n.t tr_key(:title), tr_values
+    else
+      super
+    end
+  end
+
+  def body
+    return super unless notifiable
+    tr_values = notifiable_detail.slice *I18nHelper.interpolate_key(I18n.t(tr_key(:body)))
+    tr_values.merge! notify_setting.fetch(:tr_values, {})
+
+    if super.blank?
+      I18n.t tr_key(:body), tr_values
+    else
+      super
+    end
+  end
+
+  def cc_emails
+    r = notify_setting.fetch(:cc_emails, []).map do |i|
+      next i unless i.respond_to?(:call)
+      i.call(notifiable)
+    end
+    r.flatten.concat super
+  end
+
+  def unread_count
+    Rails.cache.read("#{self.receiver_type}_#{self.receiver_id}_unread") || 0
+  end
+
+  def make_as_unread
+    if read_at.present?
+      self.update(read_at: nil)
+      Rails.cache.increment "#{self.receiver_type}_#{self.receiver_id}_unread"
+    end
+  end
+
+  def make_as_read
+    if read_at.blank?
+      update(read_at: Time.now)
+      Rails.cache.decrement "#{self.receiver_type}_#{self.receiver_id}_unread"
+    end
+  end
+
+  def update_unread_count
+    Rails.cache.write "#{self.receiver_type}_#{self.receiver_id}_unread", Notification.where(receiver_id: self.receiver_id, receiver_type: self.receiver_type, read_at: nil).count, raw: true
+  end
+
+  def self.update_unread_count(receiver)
+    if Rails.cache.write "#{receiver.class.name}_#{receiver.id}_unread", Notification.where(receiver_id: receiver.id, receiver_type: receiver.class.name, read_at: nil).count, raw: true
+      Rails.cache.read "#{receiver.class.name}_#{receiver.id}_unread"
+    end
+  end
+
+end
+
+# notifiable_type:
+# notifiable_id:

data/app/models/notification_setting.rb

@@ -0,0 +1,8 @@
+class NotificationSetting < ApplicationRecord
+  belongs_to :receiver, polymorphic: true
+  serialize :notifiable_types, Array
+
+  def notifiable_types
+    super + RailsNotice.config.default_notifiable_types
+  end
+end

data/app/views/rails_notice/_link.html.erb

@@ -0,0 +1,6 @@
+<% if current_receiver %>
+<%= link_to notifications_path, class: 'item', remote: true, id: 'notify_show' do %>
+  <i class="bell icon"></i>
+  <span id="notice_count" style="padding-left: 5px"><%= current_receiver.unread_count %></span>
+<% end %>
+<% end %>

data/app/views/rails_notice_admin/base/_nav.html.erb

@@ -0,0 +1,16 @@
+<div class="ui vertical fluid icon menu">
+  <div class="header center link item" id="close_side">
+    <i class="content icon"></i>
+  </div>
+  <div class="item ui dropdown">
+    <a class="<%= active_helper(controllers: ['notifications', 'notification_settings', 'notify_settings'], active_class: 'title active', item_class: 'title') %>">
+      <i class="users icon"></i>
+      <span>Notification</span>
+    </a>
+    <div class="<%= active_helper(controllers: ['notifications', 'notification_settings', 'notify_settings'], active_class: 'menu content active', item_class: 'menu content') %>">
+      <%= link_to 'Notification', admin_notifications_path, class: active_helper(controllers: 'notifications') %>
+      <%= link_to 'Receiver Settings', admin_notification_settings_path, class: active_helper(controllers: ['notification_settings']) %>
+    </div>
+  </div>
+</div>
+

data/app/views/rails_notice_admin/notification_settings/_form.html.erb

@@ -0,0 +1,7 @@
+<%= form_with model: [:admin, @notification_setting], local: true do |f| %>
+  <%= render 'shared/error_messages', target: @notification_setting %>
+  <%= f.number_field :showtime %>
+  <%= f.check_box :accept_email %>
+  <%= f.collection_check_boxes :notifiable_types, RailsNotice.notifiable_types, :to_s, :to_s %>
+  <%= f.submit %>
+<% end %>

data/app/views/rails_notice_admin/notification_settings/_search_form.html.erb

@@ -0,0 +1,11 @@
+<%= search_form_with do |f| %>
+  <div class="fields">
+    <div class="ui left action input">
+      <%= f.select :receiver_type, options_for_select(Notification.options_i18n(:receiver_type)), { on: { wrapper_input: false } }, { class: 'ui selection dropdown', id: 'q_receiver_type' } %>
+      <%= f.select :receiver_id, options_for_select([]), { on: { wrapper_input: false } }, { id: 'q_receiver_id', class: 'ui search dropdown' } %>
+    </div>
+    <%= f.submit 'Search' %>
+  </div>
+<% end %>
+
+

data/app/views/rails_notice_admin/notification_settings/edit.html.erb

@@ -0,0 +1,14 @@
+<div>
+
+  <div class="ui segment breadcrumb">
+    <%= link_to 'Back', admin_notification_settings_path, class: 'section' %>
+    <div class="divider"> / </div>
+    <div class="active section">Edit</div>
+  </div>
+
+  <div class="ui segment">
+    <%= render 'form' %>
+  </div>
+
+</div>
+

data/app/views/rails_notice_admin/notification_settings/index.html.erb

@@ -0,0 +1,52 @@
+<div class="ui top attached menu borderless">
+  <div class="header item">Notification Settings</div>
+  <div class="right menu">
+    <div class="item"><%= link_to 'New Notification Setting', new_admin_notification_setting_path, class: 'ui teal button' %></div>
+  </div>
+</div>
+
+<div class="ui attached segment">
+  <%= render 'search_form' %>
+</div>
+
+<table class="ui bottom attached table">
+  <thead>
+    <tr>
+      <th><%= NotificationSetting.human_attribute_name(:id) %></th>
+      <th><%= NotificationSetting.human_attribute_name(:receiver_type) %></th>
+      <th><%= NotificationSetting.human_attribute_name(:receiver_id) %></th>
+      <th><%= NotificationSetting.human_attribute_name(:showtime) %></th>
+      <th><%= NotificationSetting.human_attribute_name(:accept_email) %></th>
+      <th><%= NotificationSetting.human_attribute_name(:notifiable_types) %></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+  <% @notification_settings.each do |notification_setting| %>
+    <tr>
+      <td><%= notification_setting.id %></td>
+      <td><%= notification_setting.receiver_type %></td>
+      <td><%= notification_setting.receiver_id %></td>
+      <td><%= notification_setting.showtime %></td>
+      <td>
+        <%= form_with model: notification_setting, url: admin_notification_setting_path(notification_setting.id), method: :patch, remote: true do |f| %>
+          <%= f.check_box :accept_email, onChange: "Rails.fire(this.form, 'submit')", label: false, on: {wrapper_all: false, offset: false} %>
+        <% end %>
+      </td>
+      <td class="ui labels">
+        <% notification_setting.notifiable_types.each do |notifiable_type| %>
+          <span class="ui label"><%= notifiable_type %></span>
+        <% end %>
+      </td>
+      <td class="ui labels">
+        <%= link_to 'Show', admin_notification_setting_path(notification_setting), class: 'ui blue label' %>
+        <%= link_to 'Edit', edit_admin_notification_setting_path(notification_setting), class: 'ui pink label' %>
+        <%= link_to 'Destroy', admin_notification_setting_path(notification_setting), method: :delete, data: { confirm: 'Are you sure?' }, class: 'ui red label' %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= paginate @notification_settings %>

data/app/views/rails_notice_admin/notification_settings/new.html.erb

@@ -0,0 +1,13 @@
+<div>
+
+  <div class="ui segment breadcrumb">
+    <%= link_to 'Back', admin_notification_settings_path, class: 'section' %>
+    <div class="divider"> / </div>
+    <div class="active section">Add</div>
+  </div>
+
+  <div class="ui segment">
+    <%= render 'form' %>
+  </div>
+
+</div>

data/app/views/rails_notice_admin/notifications/_form.html.erb

@@ -0,0 +1,6 @@
+<%= default_form_with model: [:admin, @user, @notification] do |f| %>
+  <%= f.text_field :title, label: '标题:' %>
+  <%= f.text_area :body, label: '内容:' %>
+  <%= f.text_field :link, label: 'Link:' %>
+  <%= f.submit %>
+<% end %>

data/app/views/rails_notice_admin/notifications/_menu.html.erb

@@ -0,0 +1,6 @@
+<div class="ui top attached borderless menu">
+  <div class="header item">Notification List</div>
+  <div class="right menu">
+    <div class="item"><%= link_to 'New', new_admin_notification_path, class: 'ui teal button' %></div>
+  </div>
+</div>

data/app/views/rails_notice_admin/notifications/_search_form.html.erb

@@ -0,0 +1,11 @@
+<%= search_form_with scope: :q do |f| %>
+  <div class="fields">
+    <div class="ui left action input">
+      <%= f.select :receiver_type, options_for_select(Notification.options_i18n(:receiver_type)), { on: { wrapper_input: false } }, { class: 'ui selection dropdown', id: 'q_receiver_type' } %>
+      <%= f.select :receiver_id, options_for_select([]), { on: { wrapper_input: false } }, { id: 'q_receiver_id', class: 'ui search dropdown' } %>
+    </div>
+    <%= f.text_field :'body-like' %>
+    <%= f.submit 'Search' %>
+  </div>
+<% end %>
+

data/app/views/rails_notice_admin/notifications/edit.html.erb

@@ -0,0 +1,14 @@
+<div class="sixteen wide column">
+
+  <div class="ui breadcrumb">
+    <%= link_to '返回', admin_user_notifications_path, class: 'section' %>
+    <div class="divider"> / </div>
+    <div class="active section">编辑</div>
+  </div>
+
+  <div>
+    <%= render 'form' %>
+  </div>
+
+</div>
+

data/app/views/rails_notice_admin/notifications/index.html.erb

@@ -0,0 +1,44 @@
+<%= render 'menu' %>
+
+<div class="ui attached segment">
+  <%= render 'search_form' %>
+</div>
+
+<table class="ui table">
+  <thead>
+  <tr>
+    <th>ID</th>
+    <th>Receiver Type</th>
+    <th>Receiver ID</th>
+    <th>Title</th>
+    <th>Body</th>
+    <th>Link</th>
+    <th>Read At</th>
+    <th>Sent Result</th>
+    <th>Operation</th>
+  </tr>
+  </thead>
+
+  <tbody>
+  <% @notifications.each do |notification| %>
+    <tr>
+      <td><%= notification.id %></td>
+      <td><%= notification.receiver_type %></td>
+      <td><%= notification.receiver_id %></td>
+      <td><%= notification.title %></td>
+      <td><%= notification.body %></td>
+      <td><%= notification.link %></td>
+      <td><%= notification.read_at %></td>
+      <td>
+        <code><%= notification.sent_result %></code>
+      </td>
+      <td class="ui labels">
+        <%= link_to 'Push', push_admin_notification_path(notification), method: :patch, remote: true, data: { confirm: 'Are you sure?' }, class: 'ui mini green label' %>
+        <%= link_to 'Email', email_admin_notification_path(notification), method: :patch, remote: true, data: { confirm: 'Are you sure?' }, class: 'ui mini green label' %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= paginate @notifications %>

data/app/views/rails_notice_admin/notifications/new.html.erb

@@ -0,0 +1,15 @@
+<div class="three wide column">
+  <%= render 'admin/users/nav' %>
+</div>
+
+<div class="thirteen wide column">
+  <div class="ui breadcrumb">
+    <%= link_to 'Back', admin_user_notifications_path(@user), class: 'section' %>
+    <div class="divider"> / </div>
+    <div class="active section">New</div>
+  </div>
+
+  <div>
+    <%= render 'form' %>
+  </div>
+</div>

data/app/views/rails_notice_mailer/notify.html.erb

@@ -0,0 +1,35 @@
+<p>Dear <%= @notification.receiver.endearing_name %>,</p>
+
+<p><%= @notification.body %></p>
+
+<% if @notification.notifiable && @notification.verbose %>
+
+<table class="ui very basic table">
+  <tbody>
+    <% @notification.notifiable_attributes.each do |key, value| %>
+    <tr>
+      <td class="right aligned">
+        <%= @notification.notifiable.class.human_attribute_name(key) %>
+      </td>
+      <td>
+        <% if value.is_a?(Hash) %>
+          <%= simple_format_hash(value) %>
+        <% elsif value.is_a?(String) && @notification.notifiable.column_for_attribute(key).limit.to_i > 255 %>
+          <%= simple_format(value) %>
+        <% else %>
+          <%= value %>
+        <% end %>
+      </td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<% end %>
+
+<p><%= t('rails_notice.detail') %>: <%= link_to @notification.link, @notification.link %></p>
+
+<% if @notification.sender %>
+<p>Best,<br>
+<%= @notification.sender.endearing_name %></p>
+<% end %>

data/app/views/rails_notice_my/base/_nav_my.html.erb

@@ -0,0 +1,4 @@
+<div class="ui menu vertical fluid">
+  <%= link_to t('rails_notice.unread'), notifications_path(receiver: params[:receiver]), class: active_params(scope: '', active_class: 'item active', item_class: 'item') %>
+  <%= link_to t('rails_notice.readed'), notifications_path(receiver: params[:receiver], scope: 'have_read'), class: active_params(scope: 'have_read', active_class: 'item active', item_class: 'item') %>
+</div>