abstract_notifier 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03f0a4930f3a771cd4c4ba112ea3dfb0ad5df8da51d2a355c5588aa4d4d164f7
-  data.tar.gz: cac11a3dc5d86a394ae114aab6b4f751b028e0e582f344611061ebb50903374a
+  metadata.gz: 13fab6c214c70888c9977a9e924d3ede95c09de3b9f0207285967af0c20a5db2
+  data.tar.gz: 922c76000a77862e8a3cbf1fe5d6dad49656f39fd8ad8df30cbcc6b0ea705a6a
 SHA512:
-  metadata.gz: bd0fb71fa422dfaa8309294eff7593561af5d0dde3a45fba0345c1642ae6418f269e5d8d409bfbffafd967897506be2d6aa5990329041ca8d131ea7cf77ede43
-  data.tar.gz: 83c389be95c2d1ee64f5dc1645d80992f08b7ed03a382407c9f869d1cbd079cb4823d4c2924451131d55578d7382dfaaa93131ec52771b303959e9a2b2e15d0d
+  metadata.gz: d58c62166442f76b74b077d85219eb853b83a8453b8e7da9e465e7e6b3217c10f78c1f1bf6a7ce6e7c50d8a12d4274e3fd7fccb592e26ca8d2206b1da0c13437
+  data.tar.gz: 37b900f7210fcee8f5201658f6a2ec42e5e81eec289cd5a60537df71b945f9b5d293304b75f70ce2a64fd4e56ce69a5bb03bccd8bcb674b07b1afac082c32e8e

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.3.2 (2022-06-02)
+
+- Added Minitest assertions. ([@komagata][])
+
 ## 0.3.1 (2020-04-09)
 
 - Fix loading testing utils. ([@brovikov][])
@@ -25,3 +29,4 @@ 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
 
@@ -22,7 +22,7 @@ Requirements:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'abstract_notifier'
+gem "abstract_notifier"
 ```
 
 And then execute:
@@ -105,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
@@ -161,7 +160,6 @@ 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.
 #
@@ -183,14 +181,34 @@ 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
@@ -207,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/base.rb

@@ -80,7 +80,7 @@ module AbstractNotifier
       end
 
       def default(method_name = nil, **hargs, &block)
-        return @defaults_generator = block if block_given?
+        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.rb

@@ -46,3 +46,4 @@ end
 AbstractNotifier::Notification.prepend AbstractNotifier::Testing::Notification
 
 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.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_notifier
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_delivery
@@ -42,44 +42,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '4.0'
 description: ActionMailer-like interface for any type of notifications
 email:
 - dementiev.vm@gmail.com
@@ -87,27 +73,17 @@ 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/activedeliverymaster.gemfile
-- gemfiles/rails42.gemfile
-- gemfiles/rails52.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
@@ -120,7 +96,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.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,28 +0,0 @@
-require:
-  - standard/cop/semantic_blocks
-
-inherit_gem:
-  standard: config/base.yml
-
-AllCops:
-  Exclude:
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'Gemfile'
-    - 'node_modules/**/*'
-    - 'vendor/**/*'
-    - 'gemfiles/**/*'
-  DisplayCopNames: true
-  TargetRubyVersion: 2.5
-
-Standard/SemanticBlocks:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: no_comma

data/.travis.yml

@@ -1,35 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-
-notifications:
-  email: false
-
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.7
-      gemfile: Gemfile
-    - rvm: 2.7
-      gemfile: gemfiles/activedeliverymaster.gemfile
-    - rvm: 2.6
-      gemfile: Gemfile
-    - rvm: 2.5
-      gemfile: Gemfile
-      env:
-        - NO_RAILS=1
-    - rvm: 2.5
-      gemfile: gemfiles/rails52.gemfile
-    - rvm: 2.5
-      gemfile: gemfiles/rails42.gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.7
-      gemfile: gemfiles/activedeliverymaster.gemfile

data/Gemfile

@@ -1,14 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in abstract_notifier.gemspec
-gemspec
-
-gem "pry-byebug"
-
-local_gemfile = File.join(__dir__, "Gemfile.local")
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-else
-  gem "rails", "~> 6.0"
-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,37 +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.required_ruby_version = ">= 2.4"
-
-  spec.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"
-  }
-
-  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", "~> 13.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 0.2.0"
-end

data/gemfiles/activedeliverymaster.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "rails", "~> 6.0"
-gem "active_delivery", github: "palkan/active_delivery"
-
-gemspec path: ".."

data/gemfiles/rails42.gemfile

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

data/gemfiles/rails52.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.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: ".."