observers 1.0.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/models/key.rb +14 -4
- data/lib/models/observer.rb +10 -0
- data/lib/observers.rb +19 -4
- data/lib/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6a159d42b8b830178206543808a5c720b849f1105316634e4c4b3677cf9c4388
|
|
4
|
+
data.tar.gz: de95c647e6e85bc641afac06fddc4133c048f9923dbcd8d7215e74a77662b8f6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e51ebee0017bf9c496980bc32c2041c730df747e1eacd9f0a8b475c39ac73a3b464790e1863c366c434288909a6c38bfefbec5adecd406c751a38f1cb3a4686e
|
|
7
|
+
data.tar.gz: 061a1a365c054e58bd8741a68b0ffe7a4f2ac5936ea55db611f4ed1295ef2c081dcb9b1f50a25ea5af5306e72de7a32475b151e9b130b2fd992fac955971de7f
|
data/lib/models/key.rb
CHANGED
|
@@ -17,6 +17,11 @@ module Observers
|
|
|
17
17
|
@observers << Observer.new(object:, action:)
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
+
# The observers in a new order. Each is an observer already, which keeps its action, or an object to observe.
|
|
21
|
+
def replace(objects:)
|
|
22
|
+
@observers = objects.map { |object| object.is_a?(Observer) ? object : Observer.new(object:, action: nil) }
|
|
23
|
+
end
|
|
24
|
+
|
|
20
25
|
# @returns: The result of the last observer with a non-nil value.
|
|
21
26
|
def trigger(action: nil, event: nil)
|
|
22
27
|
# TODO: Breaks some tests... should it? Yes. Should it be disabled when testing? Yes.
|
|
@@ -34,18 +39,23 @@ module Observers
|
|
|
34
39
|
end
|
|
35
40
|
|
|
36
41
|
# @returns: The result of the first observer and the first action with a non-nil value.
|
|
37
|
-
|
|
42
|
+
# With "returning: :action", each observer the take passed, last first, is then given that result on its way back
|
|
43
|
+
# out, with "action(event:, result:)", when it has that action.
|
|
44
|
+
def take(action: nil, event: nil, returning: nil)
|
|
38
45
|
# TODO: Breaks some tests... should it? Yes. Should it be disabled when testing? Yes.
|
|
39
46
|
# raise NoObserversError, "No observers configured for #{@key}" if @observers.empty?
|
|
40
47
|
|
|
48
|
+
passed = []
|
|
49
|
+
result = nil
|
|
41
50
|
per_observer_per_action(action:, event:) do |observer, action|
|
|
51
|
+
passed |= [observer]
|
|
42
52
|
result = observer.trigger(action:, event:)
|
|
43
53
|
yield if block_given?
|
|
44
|
-
|
|
54
|
+
break unless result.nil?
|
|
45
55
|
end
|
|
46
56
|
|
|
47
|
-
|
|
48
|
-
|
|
57
|
+
passed.reverse_each { |observer| observer.pass_back(action: returning, event:, result:) } if returning
|
|
58
|
+
result
|
|
49
59
|
end
|
|
50
60
|
|
|
51
61
|
private
|
data/lib/models/observer.rb
CHANGED
|
@@ -27,5 +27,15 @@ module Observers
|
|
|
27
27
|
# "RequestEvent -> Rain::Router#route_request -> StatusEvent -> Error404Node.render -> unknown keyword: :props"
|
|
28
28
|
raise ObserverError.new(e.message, object:, event:, action:, previous_error: e)
|
|
29
29
|
end
|
|
30
|
+
|
|
31
|
+
# Gives the object a take's result on its way back out. The observer's own action doesn't apply, as it's for the
|
|
32
|
+
# way in.
|
|
33
|
+
def pass_back(action:, event:, result:)
|
|
34
|
+
return unless @object.respond_to?(action)
|
|
35
|
+
|
|
36
|
+
@object.send(action, event:, result:)
|
|
37
|
+
rescue StandardError => e
|
|
38
|
+
raise ObserverError.new(e.message, object:, event:, action:, previous_error: e)
|
|
39
|
+
end
|
|
30
40
|
end
|
|
31
41
|
end
|
data/lib/observers.rb
CHANGED
|
@@ -34,19 +34,34 @@ module Observers
|
|
|
34
34
|
def count
|
|
35
35
|
Keys[key].observers.count
|
|
36
36
|
end
|
|
37
|
+
|
|
38
|
+
# The observers in order, so a list can be made from them, like [MyLogger, *observers].
|
|
39
|
+
def to_a
|
|
40
|
+
Keys[key].observers.dup
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Puts the observers in a new order, like replace([MyLogger, *observers]), keeping each one's action.
|
|
44
|
+
def replace(objects)
|
|
45
|
+
Keys[key].replace(objects:)
|
|
46
|
+
end
|
|
37
47
|
end.new(key)
|
|
38
48
|
end
|
|
39
49
|
|
|
40
|
-
|
|
41
|
-
|
|
50
|
+
# Observe a key with "observe key, action: :action", or keys and their actions with "observe key => :action".
|
|
51
|
+
# Ruby passes "key => :action" as keyword arguments when the key isn't a symbol, so they arrive in key_actions.
|
|
52
|
+
def observe(key = nil, action: nil, **key_actions)
|
|
53
|
+
key_actions = key.is_a?(Hash) ? key : { key => action } unless key.nil?
|
|
54
|
+
raise ArgumentError, 'Missing key to observe' if key_actions.empty?
|
|
55
|
+
|
|
56
|
+
key_actions.each { |each_key, each_action| Keys[each_key].observe(object: self, action: each_action) }
|
|
42
57
|
end
|
|
43
58
|
|
|
44
59
|
def trigger(key: self, action: nil, event: nil)
|
|
45
60
|
Keys[key].trigger(action:, event:)
|
|
46
61
|
end
|
|
47
62
|
|
|
48
|
-
def take(key: self, action: nil, event: nil)
|
|
49
|
-
Keys[key].take(action:, event:)
|
|
63
|
+
def take(key: self, action: nil, event: nil, returning: nil)
|
|
64
|
+
Keys[key].take(action:, event:, returning:)
|
|
50
65
|
end
|
|
51
66
|
|
|
52
67
|
# TODO: Provide a "pipe/port/take" method that uses ractors to be concurrent... if supplied with immutable Data?
|
data/lib/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: observers
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- maedi
|
|
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
41
41
|
- !ruby/object:Gem::Version
|
|
42
42
|
version: '0'
|
|
43
43
|
requirements: []
|
|
44
|
-
rubygems_version: 4.0.
|
|
44
|
+
rubygems_version: 4.0.20
|
|
45
45
|
specification_version: 4
|
|
46
46
|
summary: Observe objects of any kind
|
|
47
47
|
test_files: []
|