activity_notification 1.7.1 → 2.0.0

data/spec/models/subscription_spec.rb

@@ -1,3 +1,6 @@
+# To run as single test for debugging
+# require Rails.root.join('../../spec/concerns/apis/subscription_api_spec.rb').to_s
+
 describe ActivityNotification::Subscription, type: :model do
 
   it_behaves_like :subscription_api
@@ -92,16 +95,22 @@ describe ActivityNotification::Subscription, type: :model do
 
         context 'with custom_filter options' do
           it "works with filtered_by_options scope" do
-            if ActivityNotification.config.orm == :active_record
-              subscriptions = ActivityNotification::Subscription.filtered_by_options({ custom_filter: ["subscriptions.key = ?", @key_1] })
-              expect(subscriptions.size).to eq(1)
-              expect(subscriptions.first).to eq(@subscription_1)
-            end
-
             subscriptions = ActivityNotification::Subscription.filtered_by_options({ custom_filter: { key: @key_2 } })
             expect(subscriptions.size).to eq(1)
             expect(subscriptions.first).to eq(@subscription_2)
           end
+
+          it "works with filtered_by_options scope with filter depending on ORM" do
+            options =
+              case ActivityNotification.config.orm
+              when :active_record then { custom_filter: ["subscriptions.key = ?", @key_1] }
+              when :mongoid       then { custom_filter: { key: {'$eq': @key_1} } }
+              when :dynamoid      then { custom_filter: {'key.begins_with': @key_1} }
+              end
+            subscriptions = ActivityNotification::Subscription.filtered_by_options(options)
+            expect(subscriptions.size).to eq(1)
+            expect(subscriptions.first).to eq(@subscription_1)
+          end
         end
   
         context 'with no options' do
@@ -116,21 +125,67 @@ describe ActivityNotification::Subscription, type: :model do
     context "to make order by created_at" do
       before do
         ActivityNotification::Subscription.delete_all
-        @subscription_1 = create(:subscription, key: 'key.1')
-        @subscription_2 = create(:subscription, key: 'key.2', created_at: @subscription_1.created_at + 10.second)
-        @subscription_3 = create(:subscription, key: 'key.3', created_at: @subscription_1.created_at + 20.second)
-        @subscription_4 = create(:subscription, key: 'key.4', created_at: @subscription_1.created_at + 30.second)
+        @target = create(:confirmed_user)
+        @subscription_1 = create(:subscription, target: @target, key: 'key.1')
+        @subscription_2 = create(:subscription, target: @target, key: 'key.2', created_at: @subscription_1.created_at + 10.second)
+        @subscription_3 = create(:subscription, target: @target, key: 'key.3', created_at: @subscription_1.created_at + 20.second)
+        @subscription_4 = create(:subscription, target: @target, key: 'key.4', created_at: @subscription_1.created_at + 30.second)
+      end
+
+      unless ActivityNotification.config.orm == :dynamoid
+        context "using ORM other than dynamoid, you can directly call latest/earliest order method from class objects" do
+
+          it "works with latest_order scope" do
+            subscriptions = ActivityNotification::Subscription.latest_order
+            expect(subscriptions.size).to eq(4)
+            expect(subscriptions.first).to eq(@subscription_4)
+            expect(subscriptions.last).to eq(@subscription_1)
+          end
+
+          it "works with earliest_order scope" do
+            subscriptions = ActivityNotification::Subscription.earliest_order
+            expect(subscriptions.size).to eq(4)
+            expect(subscriptions.first).to eq(@subscription_1)
+            expect(subscriptions.last).to eq(@subscription_4)
+          end
+
+        end
+      else
+        context "using dynamoid, you can call latest/earliest order method only with query using partition key of Global Secondary Index" do
+
+          it "works with latest_order scope" do
+            subscriptions = ActivityNotification::Subscription.filtered_by_target(@target).latest_order
+            expect(subscriptions.size).to eq(4)
+            expect(subscriptions.first).to eq(@subscription_4)
+            expect(subscriptions.last).to eq(@subscription_1)
+          end
+
+          it "works with earliest_order scope" do
+            subscriptions = ActivityNotification::Subscription.filtered_by_target(@target).earliest_order
+            expect(subscriptions.size).to eq(4)
+            expect(subscriptions.first).to eq(@subscription_1)
+            expect(subscriptions.last).to eq(@subscription_4)
+          end
+
+        end
       end
 
-      it "works with latest_order scope" do
-        subscriptions = ActivityNotification::Subscription.latest_order
+      it "works with latest_order! scope" do
+        subscriptions = ActivityNotification::Subscription.latest_order!
         expect(subscriptions.size).to eq(4)
         expect(subscriptions.first).to eq(@subscription_4)
         expect(subscriptions.last).to eq(@subscription_1)
       end
 
-      it "works with earliest_order scope" do
-        subscriptions = ActivityNotification::Subscription.earliest_order
+      it "works with latest_order!(reverse=true) scope" do
+        subscriptions = ActivityNotification::Subscription.latest_order!(true)
+        expect(subscriptions.size).to eq(4)
+        expect(subscriptions.first).to eq(@subscription_1)
+        expect(subscriptions.last).to eq(@subscription_4)
+      end
+
+      it "works with earliest_order! scope" do
+        subscriptions = ActivityNotification::Subscription.earliest_order!
         expect(subscriptions.size).to eq(4)
         expect(subscriptions.first).to eq(@subscription_1)
         expect(subscriptions.last).to eq(@subscription_4)

data/spec/orm/dynamoid_spec.rb

@@ -0,0 +1,115 @@
+if ActivityNotification.config.orm == :dynamoid
+  describe Dynamoid::Criteria::None do
+    let(:none) { ActivityNotification::Notification.none }
+
+    it "is a Dynamoid::Criteria::None" do
+      expect(none).to be_a(Dynamoid::Criteria::None)
+    end
+
+    context "== operator" do
+      it "returns true against other None object" do
+        expect(none).to eq(ActivityNotification::Notification.none)
+      end
+
+      it "returns false against other objects" do
+        expect(none).not_to eq(1)
+      end
+    end
+
+    context "records" do
+      it "returns empty array" do
+        expect(none.records).to eq([])
+      end
+    end
+
+    context "all" do
+      it "returns empty array" do
+        expect(none.all).to eq([])
+      end
+    end
+
+    context "count" do
+      it "returns 0" do
+        expect(none.count).to eq(0)
+      end
+    end
+
+    context "delete_all" do
+      it "does nothing" do
+        expect(none.delete_all).to be_nil
+      end
+    end
+
+    context "empty?" do
+      it "returns true" do
+        expect(none.empty?).to be_truthy
+      end
+    end
+  end
+
+  describe Dynamoid::Criteria::Chain do
+    let(:chain) { ActivityNotification::Notification.scan_index_forward(true) }
+
+    before do
+      ActivityNotification::Notification.delete_all
+    end
+
+    it "is a Dynamoid::Criteria::None" do
+      expect(chain).to be_a(Dynamoid::Criteria::Chain)
+    end
+
+    context "none" do
+      it "returns Dynamoid::Criteria::None" do
+        expect(chain.none).to be_a(Dynamoid::Criteria::None)
+      end
+    end
+
+    context "limit" do
+      before do
+        create(:notification)
+        create(:notification)
+      end
+
+      it "returns limited records by record_limit" do
+        expect(chain.count).to eq(2)
+        expect(chain.limit(1).count).to eq(1)
+      end
+    end
+
+    context "exists?" do
+      it "returns false when the record does not exist" do
+        expect(chain.exists?).to be_falsy
+      end
+
+      it "returns true when the record exists" do
+        create(:notification)
+        expect(chain.exists?).to be_truthy
+      end
+    end
+
+    context "size" do
+      it "returns same value as count" do
+        expect(chain.count).to eq(0)
+        expect(chain.size).to  eq(0)
+        create(:notification)
+        expect(chain.count).to eq(1)
+        expect(chain.size).to  eq(1)
+      end
+    end
+
+    context "update_all" do
+      before do
+        create(:notification)
+        create(:notification)
+      end
+
+      it "updates all records" do
+        expect(ActivityNotification::Notification.where(key: "default.default").count).to eq(2)
+        expect(ActivityNotification::Notification.where(key: "updated.all").count).to     eq(0)
+        chain.update_all(key: "updated.all")
+        expect(ActivityNotification::Notification.where(key: "default.default").count).to eq(0)
+        expect(ActivityNotification::Notification.where(key: "updated.all").count).to     eq(2)
+      end
+    end
+  end
+end

data/spec/rails_app/app/assets/javascripts/application.js

@@ -1,2 +1,3 @@
 //= require jquery
-//= require jquery_ujs
+//= require jquery_ujs
+//= require_tree .

data/spec/rails_app/app/assets/javascripts/cable.js

@@ -0,0 +1,12 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/rails_app/app/controllers/comments_controller.rb

@@ -7,10 +7,9 @@ class CommentsController < ApplicationController
     @comment.user = current_user
 
     if @comment.save
-      @comment.notify_later :users, key: 'comment.create.later'
-      # @comment.notify       :users, key: 'comment.create.later', notify_later: true
-      @comment.notify_now   :users, key: 'comment.create.now'
-      # @comment.notify       :users, key: 'comment.create.now'
+      @comment.notify_now   :users, key: 'comment.create', parameters: { notifier_name: @comment.user.printable_notifier_name, article_title: @comment.article.title }
+      # @comment.notify_later :users, key: 'comment.create', parameters: { notifier_name: @comment.user.printable_notifier_name, article_title: @comment.article.title }
+      # @comment.notify       :users, key: 'comment.create', notify_later: true, parameters: { notifier_name: @comment.user.printable_notifier_name, article_title: @comment.article.title }
       redirect_to @comment.article, notice: 'Comment was successfully created.'
     else
       redirect_to @comment.article

data/spec/rails_app/app/models/admin.rb

@@ -7,8 +7,9 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
       subscription_allowed: true,
       devise_resource: :user,
       current_devise_target: ->(current_user) { current_user.admin },
-      printable_name: ->(admin) { "admin (#{admin.user.name})" }
-  end
+      printable_name: ->(admin) { "admin (#{admin.user.name})" },
+      action_cable_allowed: true, action_cable_with_devise: true
+    end
 else
   require 'mongoid'
   class Admin
@@ -27,6 +28,7 @@ else
       subscription_allowed: true,
       devise_resource: :user,
       current_devise_target: ->(current_user) { current_user.admin },
-      printable_name: ->(admin) { "admin (#{admin.user.name})" }
-  end
+      printable_name: ->(admin) { "admin (#{admin.user.name})" },
+      action_cable_allowed: true, action_cable_with_devise: true
+    end
 end

data/spec/rails_app/app/models/article.rb

@@ -7,7 +7,7 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
 
     acts_as_notifiable :users,
       targets: ->(article) { User.all.to_a - [article.user] },
-      notifier: :user, email_allowed: true,
+      notifier: :user, email_allowed: true, action_cable_allowed: true,
       printable_name: ->(article) { "new article \"#{article.title}\"" },
       dependent_notifications: :delete_all
     acts_as_notification_group printable_name: ->(article) { "article \"#{article.title}\"" }
@@ -33,7 +33,7 @@ else
     include ActivityNotification::Models
     acts_as_notifiable :users,
       targets: ->(article) { User.all.to_a - [article.user] },
-      notifier: :user, email_allowed: true,
+      notifier: :user, email_allowed: true, action_cable_allowed: true,
       printable_name: ->(article) { "new article \"#{article.title}\"" },
       dependent_notifications: :delete_all
     acts_as_notification_group printable_name: ->(article) { "article \"#{article.title}\"" }

data/spec/rails_app/app/models/comment.rb

@@ -8,13 +8,14 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
     acts_as_notifiable :users,
       targets: ->(comment, key) { ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq },
       group: :article, notifier: :user, email_allowed: true,
+      action_cable_allowed: true,
       parameters: { 'test_default_param' => '1' },
       notifiable_path: :article_notifiable_path,
       printable_name: ->(comment) { "comment \"#{comment.body}\"" },
       dependent_notifications: :update_group_and_delete_all
 
     require 'custom_optional_targets/console_output'
-    optional_targets = { CustomOptionalTarget::ConsoleOutput => {} }
+    # optional_targets = { CustomOptionalTarget::ConsoleOutput => {} }
     if ENV['OPTIONAL_TARGET_AMAZON_SNS']
       require 'activity_notification/optional_targets/amazon_sns'
       if ENV['OPTIONAL_TARGET_AMAZON_SNS_TOPIC_ARN']
@@ -37,13 +38,18 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
         }
       )
     end
-    acts_as_notifiable :admins, targets: [Admin.first].compact,
+    acts_as_notifiable :admins,
+      targets: Admin.all.to_a,
       group: :article, notifier: :user, notifiable_path: :article_notifiable_path,
-      tracked: { only: [:create] },
+      action_cable_allowed: true,
+      tracked: { only: [:create], action_cable_rendering: { fallback: :default } },
       printable_name: ->(comment) { "comment \"#{comment.body}\"" },
       dependent_notifications: :delete_all,
       optional_targets: optional_targets
 
+    # For testing
+    acts_as_group
+
     def article_notifiable_path
       article_path(article)
     end
@@ -69,6 +75,7 @@ else
     acts_as_notifiable :users,
       targets: ->(comment, key) { ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq },
       group: :article, notifier: :user, email_allowed: true,
+      action_cable_allowed: true,
       parameters: { 'test_default_param' => '1' },
       notifiable_path: :article_notifiable_path,
       printable_name: ->(comment) { "comment \"#{comment.body}\"" },
@@ -98,13 +105,18 @@ else
         }
       )
     end
-    acts_as_notifiable :admins, targets: [Admin.first].compact,
+    acts_as_notifiable :admins,
+      targets: Admin.all.to_a,
       group: :article, notifier: :user, notifiable_path: :article_notifiable_path,
-      tracked: { only: [:create] },
+      action_cable_allowed: true,
+      tracked: { only: [:create], action_cable_rendering: { fallback: :default } },
       printable_name: ->(comment) { "comment \"#{comment.body}\"" },
       dependent_notifications: :delete_all,
       optional_targets: optional_targets
 
+    # For testing
+    acts_as_group
+
     def article_notifiable_path
       article_path(article)
     end

data/spec/rails_app/app/models/user.rb

@@ -6,7 +6,8 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
     has_one :admin, dependent: :destroy
 
     acts_as_target email: :email, email_allowed: :confirmed_at, batch_email_allowed: :confirmed_at,
-                   subscription_allowed: true, printable_name: :name
+                   subscription_allowed: true, printable_name: :name,
+                   action_cable_allowed: true, action_cable_with_devise: true
     acts_as_notifier printable_name: :name
 
     def admin?
@@ -37,8 +38,9 @@ else
 
     include ActivityNotification::Models
     acts_as_target email: :email, email_allowed: :confirmed_at, batch_email_allowed: :confirmed_at,
-                   subscription_allowed: true, printable_name: :name
-    acts_as_notifier printable_name: :name
+                   subscription_allowed: true, printable_name: :name,
+                   action_cable_allowed: true, action_cable_with_devise: true
+acts_as_notifier printable_name: :name
 
     def admin?
       admin.present?

data/spec/rails_app/app/views/activity_notification/notifications/users/overridden/custom/_test.html.erb

@@ -0,0 +1 @@
+Overridden custom template root for user target: <%= notification.id %>

data/spec/rails_app/config/application.rb

@@ -7,6 +7,10 @@ if ENV['AN_ORM'] == 'mongoid'
   if Rails.env != 'test'
     Mongoid.load!(File.expand_path("config/mongoid.yml"), :development)
   end
+elsif ENV['AN_ORM'] == 'dynamoid'
+  require 'dynamoid'
+  require 'rails'
+  require File.expand_path('../dynamoid', __FILE__)
 end
 
 # Pick the frameworks you want:
@@ -17,7 +21,7 @@ require "action_controller/railtie"
 require "action_mailer/railtie"
 require "action_view/railtie"
 require "sprockets/railtie"
-# require "rails/test_unit/railtie"
+require 'action_cable/engine' if Rails::VERSION::MAJOR >= 5
 
 Bundler.require(*Rails.groups)
 require "activity_notification"
@@ -34,3 +38,4 @@ module Dummy
   end
 end
 
+puts "ActivityNotification test parameters: AN_ORM=#{ENV['AN_ORM'] || 'active_record(default)'} AN_TEST_DB=#{ENV['AN_TEST_DB'] || 'sqlite(default)'}"

data/spec/rails_app/config/cable.yml

@@ -0,0 +1,8 @@
+production:
+  adapter: async
+
+development:
+  adapter: async
+
+test:
+  adapter: test

data/spec/rails_app/config/dynamoid.rb

@@ -0,0 +1,5 @@
+Dynamoid.configure do |config|
+  config.namespace = "activity_notification_#{Rails.env}"
+  config.endpoint = 'http://localhost:8000'
+  # config.store_datetime_as_string = true
+end

data/spec/rails_app/config/environment.rb

@@ -1,6 +1,9 @@
 # Load the Rails application.
 require File.expand_path('../application', __FILE__)
 
+# Demo application uses Devise
+require 'devise'
+
 # Initialize the Rails application.
 Rails.application.initialize!
 
@@ -15,7 +18,7 @@ def silent_stdout(&block)
 end
 
 # Load database schema
-if Rails.env.test? && ENV['AN_TEST_DB'] != 'mongodb'
+if Rails.env.test? && ['mongodb', 'dynamodb'].exclude?(ENV['AN_TEST_DB'])
   silent_stdout do
     load "#{Rails.root}/db/schema.rb"
   end