abstract_notifier 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36463d0a1ed93c6f48229bed9135f6c1ec3e301c76dc5b9edcc28f19d75cc3e
-  data.tar.gz: 7c56ec837be932967f22c592018b2210912fb2e53a40e5b8526b619dff70c4b1
+  metadata.gz: 13fab6c214c70888c9977a9e924d3ede95c09de3b9f0207285967af0c20a5db2
+  data.tar.gz: 922c76000a77862e8a3cbf1fe5d6dad49656f39fd8ad8df30cbcc6b0ea705a6a
 SHA512:
-  metadata.gz: 4a191cf257f1691d8df1b395ed14610246e2ae8614bde594abd359fea8104fe3c903a9332060545563e289652b45716d76c89d2f763a8bd0c911d305641c594d
-  data.tar.gz: 888f89197efafc92cbbfffc220959c449fcd405c8fea6932ab3f1dde4ed4f1d726e2c19ce4c43e68ca2021a8cc040a53831506c05a5272ce7f43330e4b054364
+  metadata.gz: d58c62166442f76b74b077d85219eb853b83a8453b8e7da9e465e7e6b3217c10f78c1f1bf6a7ce6e7c50d8a12d4274e3fd7fccb592e26ca8d2206b1da0c13437
+  data.tar.gz: 37b900f7210fcee8f5201658f6a2ec42e5e81eec289cd5a60537df71b945f9b5d293304b75f70ce2a64fd4e56ce69a5bb03bccd8bcb674b07b1afac082c32e8e

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## master
 
+## 0.3.2 (2022-06-02)
+
+- Added Minitest assertions. ([@komagata][])
+
+## 0.3.1 (2020-04-09)
+
+- Fix loading testing utils. ([@brovikov][])
+
+Change the RSpec check to `defined?(RSpec::Core)` to prevent from
+loading testing utils when only `RSpec` module is defined.
+
+## 0.3.0 (2020-03-02)
+
+- **Drop Ruby 2.4 support**. ([@palkan][])
+
 ## 0.2.0 (2018-01-11)
 
 - Add class-level defaults. ([@palkan][])
@@ -13,3 +28,5 @@
 Initial version.
 
 [@palkan]: https://github.com/palkan
+[@brovikov]: https://github.com/brovikov
+[@komagata]: https://github.com/komagata

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/abstract_notifier.svg)](https://badge.fury.io/rb/abstract_notifier)
-[![Build Status](https://travis-ci.org/palkan/abstract_notifier.svg?branch=master)](https://travis-ci.org/palkan/abstract_notifier)
+[![Build](https://github.com/palkan/abstract_notifier/workflows/Build/badge.svg)](https://github.com/palkan/abstract_notifier/actions)
 
 # Abstract Notifier
 
@@ -7,11 +7,13 @@ Abstract Notifier is a tool which allows you to describe/model any text-based no
 
 Abstract Notifier (as the name states) doesn't provide any specific implementation for sending notifications. Instead, it offers tools to organize your notification-specific code and make it easily testable.
 
+📖 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>
 
 Requirements:
-- Ruby ~> 2.3
+- Ruby ~> 2.4
 
 **NOTE**: although most of the examples in this readme are Rails-specific, this gem could be used without Rails/ActiveSupport.
 
@@ -20,7 +22,7 @@ Requirements:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'abstract_notifier'
+gem "abstract_notifier"
 ```
 
 And then execute:
@@ -103,10 +105,9 @@ You can also specify a block or a method name as the default params _generator_.
 This could be useful in combination with the `#notification_name` method to generate dynamic payloads:
 
 ```ruby
-class ApplicationNotifier < AbstractNofitier::Base
+class ApplicationNotifier < AbstractNotifier::Base
   default :build_defaults_from_locale
 
-
   private
 
   def build_defaults_from_locale
@@ -159,15 +160,14 @@ For test/development purposes there are two special _global_ delivery modes:
 # config/environments/test.rb
 AbstractNotifier.delivery_mode = :test
 
-
 # If you don't want to trigger notifications in development,
 # you can make Abstract Notifier no-op.
 #
 # config/environments/development.rb
-ActionNotifier.delivery_mode = :noop
+AbstractNotifier.delivery_mode = :noop
 
 # Default delivery mode is "normal"
-ActionNotifier.delivery_mode = :normal
+AbstractNotifier.delivery_mode = :normal
 ```
 
 **NOTE:** we set `delivery_mode = :test` if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test".
@@ -181,14 +181,36 @@ Abstract Notifier provides two convinient RSpec matchers:
 
 ```ruby
 # for testing sync notifications (sent with `notify_now`)
-expect { EventsNotifier.with(profile: profile).canceled(event).notify_now }.
-  to have_sent_notification(identify: '123', body: 'Alarma!')
+expect { EventsNotifier.with(profile: profile).canceled(event).notify_now }
+  .to have_sent_notification(identify: "123", body: "Alarma!")
 
 # for testing async notifications (sent with `notify_later`)
-expect { EventsNotifier.with(profile: profile).canceled(event).notify_later}.
-  to have_enqueued_notification(identify: '123', body: 'Alarma!')
+expect { EventsNotifier.with(profile: profile).canceled(event).notify_later }
+  .to have_enqueued_notification(identify: "123", body: "Alarma!")
+```
+
+Abstract Notifier provides two convinient minitest assertions:
+
+```ruby
+require 'abstract_notifier/testing/minitest'
+
+class EventsNotifierTestCase < Minitest::Test
+  include AbstractNotifier::TestHelper
+
+  test 'canceled' do
+    assert_notifications_sent 1, identify: "123", body: "Alarma!" do
+      EventsNotifier.with(profile: profile).canceled(event).notify_now
+    end
+
+    assert_notifications_enqueued 1, identify: "123", body: "Alarma!" do
+      EventsNotifier.with(profile: profile).canceled(event).notify_later
+    end
+  end
+end
 ```
 
+**NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise add `require "abstract_notifier/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually. This is also required if you're using Spring in test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
+
 ## Related projects
 
 ### [`active_delivery`](https://github.com/palkan/active_delivery)
@@ -203,7 +225,7 @@ class ApplicationDelivery < ActiveDelivery::Base
   register_line :notifier, ActiveDelivery::Lines::Notifier,
                 # you may provide a resolver, which infers notifier class
                 # from delivery name (resolver is a callable).
-                resolver: ->(name) { resolve_somehow(name) }
+    resolver: ->(name) { resolve_somehow(name) }
 end
 ```
 

data/lib/abstract_notifier/async_adapters.rb

@@ -7,7 +7,7 @@ module AbstractNotifier
         return adapter unless adapter.is_a?(Symbol)
 
         adapter_class_name = adapter.to_s.split("_").map(&:capitalize).join
-        AsyncAdapters.const_get(adapter_class_name).new(options || {})
+        AsyncAdapters.const_get(adapter_class_name).new(**(options || {}))
       rescue NameError => e
         raise e.class, "Notifier async adapter :#{adapter} haven't been found", e.backtrace
       end

data/lib/abstract_notifier/base.rb

@@ -34,8 +34,12 @@ module AbstractNotifier
       end
 
       # rubocop:disable Style/MethodMissingSuper
-      def method_missing(method_name, *args)
-        notifier_class.new(method_name, params).public_send(method_name, *args)
+      def method_missing(method_name, *args, **kwargs)
+        if kwargs.empty?
+          notifier_class.new(method_name, **params).public_send(method_name, *args)
+        else
+          notifier_class.new(method_name, **params).public_send(method_name, *args, **kwargs)
+        end
       end
       # rubocop:enable Style/MethodMissingSuper
 
@@ -75,8 +79,8 @@ module AbstractNotifier
           end
       end
 
-      def default(method_name = nil, **hargs)
-        return @defaults_generator = Proc.new if block_given?
+      def default(method_name = nil, **hargs, &block)
+        return @defaults_generator = block if block
 
         return @defaults_generator = proc { send(method_name) } unless method_name.nil?
 

data/lib/abstract_notifier/testing/minitest.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AbstractNotifier
+  module TestHelper
+    def assert_notifications_sent(count, params)
+      yield
+      assert_equal deliveries.count, count
+      count.times do |i|
+        delivery = deliveries[0 - i]
+        msg = message(msg) { "Expected #{mu_pp(delivery)} to include #{mu_pp(params)}" }
+        assert hash_include?(delivery, params), msg
+      end
+    end
+
+    def assert_notifications_enqueued(count, params)
+      yield
+      assert_equal enqueued_deliveries.count, count
+      count.times do |i|
+        delivery = enqueued_deliveries[0 - i]
+        msg = message(msg) { "Expected #{mu_pp(delivery)} to include #{mu_pp(params)}" }
+        assert hash_include?(delivery, params), msg
+      end
+    end
+
+    private
+
+    def deliveries
+      AbstractNotifier::Testing::Driver.deliveries
+    end
+
+    def enqueued_deliveries
+      AbstractNotifier::Testing::Driver.enqueued_deliveries
+    end
+
+    def hash_include?(haystack, needle)
+      needle.all? do |k, v|
+        haystack.key?(k) && haystack[k] == v
+      end
+    end
+  end
+end

data/lib/abstract_notifier/testing/rspec.rb

@@ -129,7 +129,7 @@ module AbstractNotifier
     end
   end
 
-  class HaveEqueuedNotification < HaveSentNotification
+  class HaveEnqueuedNotification < HaveSentNotification
     private
 
     def deliveries
@@ -153,7 +153,7 @@ RSpec.configure do |config|
     end
 
     def have_enqueued_notification(*args)
-      AbstractNotifier::HaveEqueuedNotification.new(*args)
+      AbstractNotifier::HaveEnqueuedNotification.new(*args)
     end
   end)
 end

data/lib/abstract_notifier/testing.rb

@@ -45,4 +45,5 @@ end
 
 AbstractNotifier::Notification.prepend AbstractNotifier::Testing::Notification
 
-require "abstract_notifier/testing/rspec" if defined?(RSpec)
+require "abstract_notifier/testing/rspec" if defined?(RSpec::Core)
+require "abstract_notifier/testing/minitest" if defined?(Minitest::Assertions)

data/lib/abstract_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbstractNotifier
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
 end

data/lib/active_delivery/lines/notifier.rb

@@ -11,9 +11,9 @@ module ActiveDelivery
     class Notifier < ActiveDelivery::Lines::Base
       DEFAULT_RESOLVER = ->(name) { name.gsub(/Delivery$/, "Notifier").safe_constantize }
 
-      def initialize(*)
+      def initialize(**opts)
         super
-        @resolver = options[:resolver]
+        @resolver = opts[:resolver]
       end
 
       def resolve_class(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_delivery
@@ -28,58 +28,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '4.0'
 description: ActionMailer-like interface for any type of notifications
 email:
 - dementiev.vm@gmail.com
@@ -87,33 +73,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- abstract_notifier.gemspec
 - bin/console
 - bin/setup
-- gemfiles/rails42.gemfile
-- gemfiles/railsmaster.gemfile
 - lib/abstract_notifier.rb
 - lib/abstract_notifier/async_adapters.rb
 - lib/abstract_notifier/async_adapters/active_job.rb
 - lib/abstract_notifier/base.rb
 - lib/abstract_notifier/testing.rb
+- lib/abstract_notifier/testing/minitest.rb
 - lib/abstract_notifier/testing/rspec.rb
 - lib/abstract_notifier/version.rb
 - lib/active_delivery/lines/notifier.rb
 homepage: https://github.com/palkan/abstract_notifier
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: http://github.com/palkan/abstract_notifier/issues
+  changelog_uri: https://github.com/palkan/abstract_notifier/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/abstract_notifier
+  homepage_uri: http://github.com/palkan/abstract_notifier
+  source_code_uri: http://github.com/palkan/abstract_notifier
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,16 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: ActionMailer-like interface for any type of notifications
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-Gemfile.local

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,29 +0,0 @@
-require:
-  - standard/cop/semantic_blocks
-
-inherit_gem:
-  standard: config/base.yml
-
-AllCops:
-  Exclude:
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'Gemfile'
-    - 'node_modules/**/*'
-    - 'vendor/**/*'
-  DisplayCopNames: true
-
-Standard/SemanticBlocks:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Layout/AlignParameters:
-  EnforcedStyle: with_first_parameter

data/.travis.yml

@@ -1,26 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-
-notifications:
-  email: false
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.5.1
-      gemfile: Gemfile
-    - rvm: 2.5.1
-      gemfile: Gemfile
-      env:
-        - NO_RAILS=1
-    - rvm: 2.4.3
-      gemfile: Gemfile
-    - rvm: 2.3.1
-      gemfile: gemfiles/rails42.gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile

data/Gemfile

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in abstract_notifier.gemspec
-gemspec
-
-gem "pry-byebug"
-gem "rspec-rails"
-
-local_gemfile = File.join(__dir__, "Gemfile.local")
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-else
-  gem "rails", "~> 5.2"
-end

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:rubocop, :spec]

data/abstract_notifier.gemspec

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "abstract_notifier/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "abstract_notifier"
-  spec.version       = AbstractNotifier::VERSION
-  spec.authors       = ["Vladimir Dementyev"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = "ActionMailer-like interface for any type of notifications"
-  spec.description   = "ActionMailer-like interface for any type of notifications"
-  spec.homepage      = "https://github.com/palkan/abstract_notifier"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "active_delivery"
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 0.0.12"
-end

data/gemfiles/rails42.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2"
-
-gemspec path: ".."

data/gemfiles/railsmaster.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "rails", github: "rails/rails"
-gem "rubocop", github: "rubocop-hq/rubocop"
-
-gemspec path: ".."