Skip to content

Commit

Permalink
[#102] Release 2.0.0 (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonhue authored and probot-auto-merge[bot] committed Jun 4, 2019
1 parent 3c3d719 commit 5875d1b
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 34 deletions.
32 changes: 1 addition & 31 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,7 @@ Notifications Rails follows Semantic Versioning 2.0 as defined at http://semver.

### Breaking Changes

* Change Pusher/DeliveryMethod API to not push immediately when initialized. **Important**: If you have any custom
pushers, you need to add a `call` method to it and *move* any code out of `initialize` (except
code that is just doing initialization) and into the `call` method. [#49] (#55)

* Groups should now be defined using callables like `-> { where(subscriber: true) }`. [#44] (#84)

* `notification_subscribers`/`notification_subscribables` now return `Subscription` instances instead of actual subscribers/subscribables. [#70] (#87)

* Pushers/Delivery methods should now be in the `NotificationPusher::DeliveryMethod` namespace. [#58] (#88)

* Introduced a base class for pushers/delivery methods. Your custom pushers should now extend `NotificationPusher::DeliveryMethod::Base`. The class already implements the necessary initialization of instance vars. From your `call` method, you can access `notification` and `options`. [#58] (#88)

* Renamed the `define_pusher` configuration option to `register_delivery_method`. [#58] (#88)

* Renamed the `push` method to `deliver` and the pusher/delivery method attributes from `:pusher` to `:delivery_method` and from `:pusher_options` to `:delivery_options`. [#58] (#88)

* `register_delivery_method` (formerly `define_pusher`) now takes a `name:symbol`, the class name of the delivery method `class_name:symbol` and an options hash (optional). [#51] (#89)

```ruby
NotificationPusher.configure do |config|
config.register_delivery_method :email, :ActionMailer, from: 'my@email.com'
end
```

* Removed the `NotificationSettings::Settings` class (& database table) that held settings & status of a target/subscription. This information is now stored directly in the target/subscription records. The new `settings` field uses [`Hashi::Mash`](https://github.com/intridea/hashie#how-does-the-wrapping-of-mash-sub-hashes-work). Therefore, its [API changed dramatically](https://github.com/jonhue/notifications-rails/tree/master/notification-settings#settings). [#38] (#95)

* Added [form objects](https://github.com/jonhue/notifications-rails/tree/master/notification-settings#form-objects) that significantly reduce the work required to build a settings form. [#38] (#95)

* All used statuses & notification categories must now be configured in the NotificationSettings initializer. [#38] (#95)

* When using the ActionMailer delivery method with NotificationRenderer, `'notification-renderer'` must be required explicitly. Otherwise the delivery method expects `:mailer` and `:action` options that specify a custom mailer. [#53] (#101)
* None

### Deprecated

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Tests are written with RSpec. Integration tests are located in `/spec`, unit tes
2. Change the gem version [here](VERSION)
3. Publish to https://rubygems.org

`$ release <version>`
`$ scripts/release <version>`

4. Create a new release and include breaking changes and deprecations from CHANGELOG.md
5. Reset CHANGELOG.md
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.2.6
2.0.0
2 changes: 1 addition & 1 deletion release → scripts/release
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cd ../notification-pusher
gem build notification-pusher.gemspec
gem push notification-pusher-$1.gem

cd ../notification-pusher-actionmailer
cd notification-pusher-actionmailer
gem build notification-pusher-actionmailer.gemspec
gem push notification-pusher-actionmailer-$1.gem

Expand Down

0 comments on commit 5875d1b

Please sign in to comment.