active_delivery 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cedb82b0e98de0ae19e5035da765b9ccdac620a1d06a278b078bd5154931f47
-  data.tar.gz: 29f91381de756f4b4ae8d67a4cc86e060fab9401c2f47926b4e9a3ad396301c3
+  metadata.gz: b0f3637c02e517255d0d91c59b1dd3abf61f6ffd1aaf34f28723a3be0e3209cf
+  data.tar.gz: 48bd825dab16b2937d6275ff21ec04868a5a97bd3b98cfcc9a297bfc6c064d76
 SHA512:
-  metadata.gz: 1b0c9deef2835eddf0513893908c3a97320e4b883b3a3b96dde6026a7c96b4eb3330ec58ff6d294c3b319a3af09192d6f317af511a7ba171343847146898bad4
-  data.tar.gz: f13926f59dc414091d36b3a7b8fd238e1119fcc1a4da8b4c4070b0819b2c3015ff247d70bc663f653dcf85c4472bbd00069fb7a363fbf9488097eec9b9f22cc7
+  metadata.gz: 5284e71b7e9e84747f71bf78476536c50e16e912959fd0c2f97c9a533f86e4a589c47766f09890324459003b36113f677461c8a1e406c58e1b4263c2fcf71f21
+  data.tar.gz: 4d14d2914d4beec54d73cf9c08a4342b6775ee4941530394cd827d09ae4f7dfbd5f28c659e4c76be2dc193697e4d6ea3d86ca6956c2d7dfc241103b5558ff0fe

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 0.3.0 (2019-12-25)
+
+- Add support of :only, :except params for callbacks. ([@curpeng][])
+
+- Add negation rspec matcher: `have_not_delivered_to`. ([@StanisLove][])
+
+- Improve RSpec matcher's failure message. ([@iBublik][])
+
 ## 0.2.1 (2018-01-15)
 
 - Backport `ActionMailer::Paremeterized` for Rails <5. ([@palkan][])
@@ -17,3 +25,4 @@
 Initial version.
 
 [@palkan]: https://github.com/palkan
+[@curpeng]: https://github.com/curpeng

data/README.md

@@ -5,7 +5,7 @@
 
 Framework providing an entry point (single _interface_) for all types of notifications: mailers, push notifications, whatever you want.
 
-📖 Read the introduction post: ["Crafting user notifications in Rails with Active Delivery"](https://dev.to/evilmartians/crafting-user-notifications-in-rails-with-active-delivery-5cn6")
+📖 Read the introduction post: ["Crafting user notifications in Rails with Active Delivery"](https://evilmartians.com/chronicles/crafting-user-notifications-in-rails-with-active-delivery)
 
 <a href="https://evilmartians.com/?utm_source=action_policy">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -109,9 +109,15 @@ See [Rails docs](https://api.rubyonrails.org/classes/ActionMailer/Parameterized.
 # NOTE: when `false` is returned the execution is halted
 before_notify :do_something
 
-# You can specify a notification method (to run callback only for that method)
+# You can specify a notification line (to run callback only for that line)
 before_notify :do_mail_something, on: :mailer
 
+# You can specify a notification name (to run callback only for specific notification)
+after_notify :mark_user_as_notified, only: %i[user_reminder]
+
+# if and unless options are also at your disposal
+after_notify :mark_user_as_notified, if: -> { params[:user].present? }
+
 # after_ and around_ callbacks are also supported
 after_notify :cleanup
 
@@ -158,7 +164,7 @@ it "delivers to RSVPed members via .notify" do
 end
 ```
 
-If you want to test that no notification is delivered you can use negation:
+If you want to test that no notification is delivered you can use negation
 
 ```ruby
 specify "when event is not found" do
@@ -168,6 +174,16 @@ specify "when event is not found" do
 end
 ```
 
+or use matcher
+
+```ruby
+specify "when event is not found" do
+  expect do
+    described_class.perform_now(profile.id, "123", "one_hour_before")
+  end.to have_not_delivered_to(Community::EventsDelivery)
+end
+```
+
 *NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise add `require "active_delivery/testing"` to your `spec_helper.rb` / `rails_helper.rb` manually.
 
 ## Custom "lines"
@@ -190,7 +206,7 @@ class EventPigeon
 
     # delegate delivery action to the instance
     def message_arrived(*args)
-      new.message_arrived(*arsg)
+      new.message_arrived(*args)
     end
   end
 
@@ -204,7 +220,7 @@ class EventPigeon
 end
 ```
 
-Now we want to add a _pigeon_ line to our `EventDelivery,` that is we want to send pigeons when 
+Now we want to add a _pigeon_ line to our `EventDelivery,` that is we want to send pigeons when
 we call `EventDelivery.notify(:message_arrived, "ping-pong!")`.
 
 Line class has the following API:
@@ -220,7 +236,7 @@ class PigeonLine < ActiveDelivery::Lines::Base
 
   # This method should return true if the sender recognizes the delivery action
   def notify?(delivery_action)
-    # `handler_class` is available within the line instance 
+    # `handler_class` is available within the line instance
     sender_class.respond_to?(delivery_action)
   end
 
@@ -261,7 +277,7 @@ class EventDelivery < ActiveDelivery::Base
   # under the hood a new instance of PigeonLine is created
   # and used to send pigeons!
   register_line :pigeon, PigeonLine
-  
+
   # you can pass additional options to customize your line
   # (and use multiple pigeons lines with different configuration)
   #
@@ -271,7 +287,7 @@ class EventDelivery < ActiveDelivery::Base
   # pigeon MyCustomPigeon
   #
   # or define pigeon specific callbacks
-  # 
+  #
   # before_notify :ensure_pigeon_is_not_dead, on: :pigeon
 end
 ```

data/active_delivery.gemspec

@@ -17,6 +17,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.4"
 
+  spec.metadata = {
+    "bug_tracker_uri" => "http://github.com/palkan/active_delivery/issues",
+    "changelog_uri" => "https://github.com/palkan/active_delivery/blob/master/CHANGELOG.md",
+    "documentation_uri" => "http://github.com/palkan/active_delivery",
+    "homepage_uri" => "http://github.com/palkan/active_delivery",
+    "source_code_uri" => "http://github.com/palkan/active_delivery"
+  }
+
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 

data/lib/active_delivery/callbacks.rb

@@ -58,25 +58,41 @@ module ActiveDelivery
     end
 
     class_methods do
+      def _normalize_callback_options(options)
+        _normalize_callback_option(options, :only, :if)
+        _normalize_callback_option(options, :except, :unless)
+      end
+
+      def _normalize_callback_option(options, from, to)
+        if (from = options[from])
+          from_set = Array(from).map(&:to_s).to_set
+          from = proc { |c| from_set.include? c.notification_name.to_s }
+          options[to] = Array(options[to]).unshift(from)
+        end
+      end
+
       def define_line_callbacks(name)
         define_callbacks name,
                          terminator: CALLBACK_TERMINATOR,
                          skip_after_callbacks_if_terminated: true
       end
 
-      def before_notify(method_or_block = nil, on: :notify)
+      def before_notify(method_or_block = nil, on: :notify, **options)
         method_or_block ||= Proc.new
-        set_callback on, :before, method_or_block
+        _normalize_callback_options(options)
+        set_callback on, :before, method_or_block, options
       end
 
-      def after_notify(method_or_block = nil, on: :notify)
+      def after_notify(method_or_block = nil, on: :notify, **options)
         method_or_block ||= Proc.new
-        set_callback on, :after, method_or_block
+        _normalize_callback_options(options)
+        set_callback on, :after, method_or_block, options
       end
 
-      def around_notify(method_or_block = nil, on: :notify)
+      def around_notify(method_or_block = nil, on: :notify, **options)
         method_or_block ||= Proc.new
-        set_callback on, :around, method_or_block
+        _normalize_callback_options(options)
+        set_callback on, :around, method_or_block, options
       end
     end
   end

data/lib/active_delivery/lines/base.rb

@@ -41,7 +41,7 @@ module ActiveDelivery
         return @handler_class = nil if owner.abstract_class?
 
         @handler_class = resolve_class(owner.name) ||
-                         superclass_handler
+          superclass_handler
       end
 
       private

data/lib/active_delivery/testing/rspec.rb

@@ -97,14 +97,12 @@ module ActiveDelivery
         msg << "\n#{message_expectation_modifier}, but"
 
         if @unmatching_deliveries.any?
-          msg << " delivered the following notifications:"
-          @unmatching_deliveries.each do |(delivery, event, args, options)|
-            msg << "\n  :#{event} via #{delivery.class}" \
-                  "#{options[:sync] ? " (sync)" : ""}" \
-                  " with:" \
-                  "\n   - params: #{delivery.params.empty? ? "<none>" : delivery.params.to_s}" \
-                  "\n   - args: #{args}"
-          end
+          msg << " delivered the following unexpected notifications:"
+          msg << deliveries_description(@unmatching_deliveries)
+        elsif @matching_count.positive?
+          msg << " delivered #{@matching_count} matching notifications" \
+                 " (#{count_failure_message}):"
+          msg << deliveries_description(@matching_deliveries)
         else
           msg << " haven't delivered anything"
         end
@@ -137,6 +135,25 @@ module ActiveDelivery
       end
     end
 
+    def count_failure_message
+      diff = @matching_count - @expected_number
+      if diff.positive?
+        "#{diff} extra item(s)"
+      else
+        "#{diff} missing item(s)"
+      end
+    end
+
+    def deliveries_description(deliveries)
+      deliveries.each.with_object(+"") do |(delivery, event, args, options), msg|
+        msg << "\n  :#{event} via #{delivery.class}" \
+              "#{options[:sync] ? " (sync)" : ""}" \
+              " with:" \
+              "\n   - params: #{delivery.params.empty? ? "<none>" : delivery.params.to_s}" \
+              "\n   - args: #{args}"
+      end
+    end
+
     def params_description(data)
       if data.is_a?(RSpec::Matchers::Composable)
         data.description
@@ -154,3 +171,5 @@ RSpec.configure do |config|
     end
   end)
 end
+
+RSpec::Matchers.define_negated_matcher :have_not_delivered_to, :have_delivered_to

data/lib/active_delivery/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveDelivery
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_delivery
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,12 @@ files:
 homepage: https://github.com/palkan/active_delivery
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/palkan/active_delivery/issues
+  changelog_uri: https://github.com/palkan/active_delivery/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/active_delivery
+  homepage_uri: http://github.com/palkan/active_delivery
+  source_code_uri: http://github.com/palkan/active_delivery
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -115,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails framework for managing all types of notifications in one place