u-observers 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7ebc064f3e8384d9322c640d3d52b1bf70bf6d5159ae67bf3cd34bdf67482eb
-  data.tar.gz: 398d1ab0fc5852a42416c5bc16c377c4a55d760e1e327e2149b58b7db23cae73
+  metadata.gz: 55ea9f6a206dba9526be1d7777969b26311f725652b3020344db33563a5835c8
+  data.tar.gz: d8a6e1bf2e73d15fadbd71e82aa17e0c511fb11d97a7839ba165c50589324b66
 SHA512:
-  metadata.gz: 0d805d69fb5cb7d08d1ef5aec34742d08845d2d544cec1262ec63d99788adb5053ed87558957849f1b9843b772929e9490f1ae243ee3c568d87b94e1b432a8c5
-  data.tar.gz: 932bfa8189f162fea8160779d521168fdebe253d36414c0b05fbccf2a8c661dc94e127fb5a942523e0ae415142d6090cd8a361124f60f550b7d2166c87106c0e
+  metadata.gz: c9b907879c02a2071b6c194af9f5c1a6e50a3bd17655beaed0f9dfb7858c892f657c9a57666d320d23d0055a48625d168d625fbae19ca7a560722b8c1b475d31
+  data.tar.gz: 4a551b0a43d15b5968d843d2a3b737ae245e177da3ac0c595f9265be887ff3b2b1205a3544c368973cae993869a9083fbffdc2cf64dab9b18c5d6d17eae5282b

data/README.md

@@ -45,6 +45,10 @@ Because of this issue, I decided to create a gem that encapsulates the pattern w
     - [Defining observers that execute only once](#defining-observers-that-execute-only-once)
       - [`observers.attach(*args, perform_once: true)`](#observersattachargs-perform_once-true)
       - [`observers.once(event:, call:, ...)`](#observersonceevent-call-)
+    - [Defining observers using blocks](#defining-observers-using-blocks)
+      - [order.observers.on()](#orderobserverson)
+      - [order.observers.on()](#orderobserverson-1)
+      - [Replacing a block by a `lambda`/`proc`](#replacing-a-block-by-a-lambdaproc)
     - [Detaching observers](#detaching-observers)
     - [ActiveRecord and ActiveModel integrations](#activerecord-and-activemodel-integrations)
       - [notify_observers_on()](#notify_observers_on)
@@ -67,7 +71,7 @@ gem 'u-observers'
 | u-observers | branch  | ruby     | activerecord  |
 | ----------- | ------- | -------- | ------------- |
 | unreleased  | main    | >= 2.2.0 | >= 3.2, < 6.1 |
-| 2.2.0       | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |
+| 2.3.0       | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |
 | 1.0.0       | v1.x    | >= 2.2.0 | >= 3.2, < 6.1 |
 
 > **Note**: The ActiveRecord isn't a dependency, but you could add a module to enable some static methods that were designed to be used with its [callbacks](https://guides.rubyonrails.org/active_record_callbacks.html).
@@ -375,6 +379,83 @@ order.cancel!         # Nothing will happen because there aren't observers.
 
 [⬆️ &nbsp; Back to Top](#table-of-contents-)
 
+### Defining observers using blocks
+
+The methods `#on()` and `#once()` can receive the event name (a `symbol`) and a block to define observers.
+
+#### order.observers.on()
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+order = Order.new
+order.observers.on(:canceled) do |event|
+  puts "The order #(#{event.subject.object_id}) has been canceled."
+end
+
+order.observers.some? # true
+
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # true
+```
+
+#### order.observers.on()
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+order = Order.new
+order.observers.once(:canceled) do |event|
+  puts "The order #(#{event.subject.object_id}) has been canceled."
+end
+
+order.observers.some? # true
+
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # false
+```
+
+#### Replacing a block by a `lambda`/`proc`
+
+Ruby allows you to replace any block with a `lambda`/`proc`. e.g.
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+NotifyAfterCancel = -> event { puts "The order #(#{event.subject.object_id}) has been canceled." }
+
+order = Order.new
+order.observers.once(:canceled, &NotifyAfterCancel)
+
+order.observers.some? # true
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # false
+order.cancel!         # Nothing will happen because there aren't observers.
+```
+
+[⬆️ &nbsp; Back to Top](#table-of-contents-)
+
 ### Detaching observers
 
 As shown in the first example, you can use the `observers.detach()` to remove observers.

data/README.pt-BR.md

@@ -44,6 +44,10 @@ Por causa desse problema, decidi criar uma gem que encapsula o padrão sem alter
     - [Definindo observers que executam apenas uma vez](#definindo-observers-que-executam-apenas-uma-vez)
       - [`observers.attach(*args, perform_once: true)`](#observersattachargs-perform_once-true)
       - [`observers.once(event:, call:, ...)`](#observersonceevent-call-)
+    - [Definindo observers com blocos](#definindo-observers-com-blocos)
+      - [order.observers.on()](#orderobserverson)
+      - [order.observers.on()](#orderobserverson-1)
+      - [Substituindo um bloco por um `lambda`/`proc`](#substituindo-um-bloco-por-um-lambdaproc)
     - [Desanexando observers](#desanexando-observers)
     - [Integrações ActiveRecord e ActiveModel](#integrações-activerecord-e-activemodel)
       - [notify_observers_on()](#notify_observers_on)
@@ -66,7 +70,7 @@ gem 'u-observers'
 | u-observers | branch  | ruby     | activerecord  |
 | ----------- | ------- | -------- | ------------- |
 | unreleased  | main    | >= 2.2.0 | >= 3.2, < 6.1 |
-| 2.2.1       | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |
+| 2.3.0       | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |
 | 1.0.0       | v1.x    | >= 2.2.0 | >= 3.2, < 6.1 |
 
 > **Nota**: O ActiveRecord não é uma dependência, mas você pode adicionar um módulo para habilitar alguns métodos estáticos que foram projetados para serem usados ​​com seus [callbacks](https://guides.rubyonrails.org/active_record_callbacks.html).
@@ -373,7 +377,84 @@ order.observers.some? # false
 order.cancel!         # Nothing will happen because there aren't observers.
 ```
 
-[⬆️ &nbsp; Back to Top](#table-of-contents-)
+[⬆️ Voltar para o índice](#índice-)
+
+### Definindo observers com blocos
+
+Os métodos `#on()` e `#once()` podem receber um evento (a `symbol`) e um bloco para definir observers.
+
+#### order.observers.on()
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+order = Order.new
+order.observers.on(:canceled) do |event|
+  puts "The order #(#{event.subject.object_id}) has been canceled."
+end
+
+order.observers.some? # true
+
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # true
+```
+
+#### order.observers.on()
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+order = Order.new
+order.observers.once(:canceled) do |event|
+  puts "The order #(#{event.subject.object_id}) has been canceled."
+end
+
+order.observers.some? # true
+
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # false
+```
+
+#### Substituindo um bloco por um `lambda`/`proc`
+
+Ruby permite que você substitua qualquer bloco com um `lambda`/`proc`. Exemplo:
+
+```ruby
+class Order
+  include Micro::Observers
+
+  def cancel!
+    observers.notify!(:canceled)
+  end
+end
+
+NotifyAfterCancel = -> event { puts "The order #(#{event.subject.object_id}) has been canceled." }
+
+order = Order.new
+order.observers.once(:canceled, &NotifyAfterCancel)
+
+order.observers.some? # true
+order.cancel!         # The order #(70301497466060) has been canceled.
+
+order.observers.some? # false
+order.cancel!         # Nothing will happen because there aren't observers.
+```
+
+[⬆️ Voltar para o índice](#índice-)
 
 ### Desanexando observers
 
@@ -409,7 +490,7 @@ order.observers.some? # false
 order.observers.count # 0
 ```
 
-[⬆️ &nbsp; Back to Top](#table-of-contents-)
+[⬆️ Voltar para o índice](#índice-)
 
 ### Integrações ActiveRecord e ActiveModel
 

data/lib/micro/observers/set.rb

@@ -42,13 +42,20 @@ module Micro
       def attach(*args); @subscribers.attach(args) and self; end
       def detach(*args); @subscribers.detach(args) and self; end
 
-      def on(options = Utils::EMPTY_HASH); @subscribers.on(options) and self; end
-      def once(options = Utils::EMPTY_HASH); @subscribers.once(options) and self; end
+      CallableOptions = -> (arg, block) do
+        arg.is_a?(Symbol) && block ? { event: arg, call: block } : arg
+      end
+
+      def on(arg = Utils::EMPTY_HASH, &block)
+        @subscribers.on(CallableOptions[arg, block]) and self
+      end
 
-      def off(*args)
-        @subscribers.off(args) and self
+      def once(arg = Utils::EMPTY_HASH, &block)
+        @subscribers.once(CallableOptions[arg, block]) and self
       end
 
+      def off(*args); @subscribers.off(args) and self; end
+
       def notify(*events, data: nil)
         broadcast_if_subject_changed(Event::Names.fetch(events), data)
       end
@@ -93,7 +100,7 @@ module Micro
           self
         end
 
-      private_constant :INVALID_BOOLEAN_MSG, :CALL_EVENT
+      private_constant :INVALID_BOOLEAN_MSG, :CALL_EVENT; :CallableOptions
     end
 
   end

data/lib/micro/observers/version.rb

@@ -1,5 +1,5 @@
 module Micro
   module Observers
-    VERSION = '2.2.1'
+    VERSION = '2.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-observers
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler