pluggaloid 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670ba6d6f6ed8b67776d57d76f9954d67e3b85a65b500220230f028568024c6e
-  data.tar.gz: 69f51e222382308669431a9bb7d60829b930f29ed5040b0c44ea230ba71fde67
+  metadata.gz: cb97cc313e04d222f6f4513ce075cffb211337e5d4bda1f95b6be810d6faeee5
+  data.tar.gz: af791c5310e60264c2e0ea17591bd9e5baf65e57a5c2c97e8d0ba282c751cf11
 SHA512:
-  metadata.gz: 960b96120d905ae85cb11248607ca0e09442298641a23e37fcc6e9a8feea2295c9b9bf56e615f93a7a3005a1f7daabf07992026fa4f597f24b371615efb20815
-  data.tar.gz: c2966163091558506da0a11c82f30524a169ec554c23c0ed50d970bc6ae3d080af599be3764b27439b11dd3d933408ae7db935ee6f3fd5edf3267398a0bf6db7
+  metadata.gz: 36d56d8c824ec9e6f5486316aaf928bb9cd5a5a9966ec621150dac344cc8c3b9180e7ba51299aeb65b8332ce587e7ba9a82a963aa05024878247ef0000a40335
+  data.tar.gz: 937450b9967accb7197a16b4a1815aa11ed7bd7e86d933302392d04b32c6e7e055978a5878d4974bd45e610929def0e66bfaf27c0c3c9255a96233a4f7f9eef4

data/lib/pluggaloid.rb

@@ -8,13 +8,14 @@ require "pluggaloid/handler"
 require 'pluggaloid/listener'
 require 'pluggaloid/subscriber'
 require 'pluggaloid/filter'
+require 'pluggaloid/stream_generator'
 require "pluggaloid/handler_tag"
 require 'pluggaloid/error'
 
 require 'delayer'
 
 module Pluggaloid
-  VM = Struct.new(*%i<Delayer Plugin Event Listener Filter HandlerTag Subscriber>, keyword_init: true)
+  VM = Struct.new(*%i<Delayer Plugin Event Listener Filter HandlerTag Subscriber StreamGenerator>, keyword_init: true)
 
   class PrototypeStream; end
   class PrototypeCollect; end
@@ -28,7 +29,8 @@ module Pluggaloid
                 Listener: Class.new(Listener),
                 Filter: Class.new(Filter),
                 HandlerTag: Class.new(HandlerTag),
-                Subscriber: Class.new(Subscriber))
+                Subscriber: Class.new(Subscriber),
+                StreamGenerator: Class.new(StreamGenerator))
     vm.Plugin.vm = vm.Event.vm = vm
   end
 end

data/lib/pluggaloid/error.rb

@@ -15,4 +15,6 @@ module Pluggaloid
   class UndefinedStreamIndexError < Error; end
 
   class UndefinedCollectionIndexError < Error; end
+
+  class NoReceiverError < Error; end
 end

data/lib/pluggaloid/event.rb

@@ -18,7 +18,8 @@ class Pluggaloid::Event
     @options = {}
     @listeners = [].freeze
     @filters = [].freeze
-    @subscribers = {}
+    @subscribers = Hash.new { |h, k| h[k] = [] }
+    @stream_generators = Hash.new { |h, k| h[k] = Set.new }
   end
 
   def prototype
@@ -89,19 +90,29 @@ class Pluggaloid::Event
         end
         @listeners = [*@listeners, listener].freeze
       end
+      @stream_generators.values.each do |generators|
+        generators.each(&:on_subscribed)
+      end
     when Pluggaloid::Subscriber
+      accepted_hash = listener.accepted_hash
       Lock.synchronize do
-        @subscribers[listener.accepted_hash] ||= []
-        @subscribers[listener.accepted_hash] << listener
+        @subscribers[accepted_hash] << listener
       end
+      @stream_generators.fetch(accepted_hash, nil)&.each(&:on_subscribed)
     else
       raise Pluggaloid::ArgumentError, "First argument must be Pluggaloid::Listener or Pluggaloid::Subscriber, but given #{listener.class}."
     end
     self
   end
 
-  def subscribe?(*args)
-    !@listeners.empty? || @subscribers.key?(argument_hash(args, stream_index))
+  # subscribe(_*specs_) で、ストリームの受信をしようとしているリスナが定義されていればtrueを返す。
+  # on_* で通常のイベントリスナが登録されて居る場合は、 _*specs_ の内容に関わらず常にtrueを返す。
+  def subscribe?(*specs)
+    !@listeners.empty? || @subscribers.key?(argument_hash(specs, nil))
+  end
+
+  def subscribe_hash?(hash)   # :nodoc:
+    !@listeners.empty? || @subscribers.key?(hash)
   end
 
   def delete_listener(listener)
@@ -121,6 +132,18 @@ class Pluggaloid::Event
         @subscribers.delete(listener.accepted_hash)
       end
     end
+    @stream_generators.fetch(listener.accepted_hash, nil)&.each(&:on_unsubscribed)
+    self
+  end
+
+  def delete_stream_generator(listener)
+    Lock.synchronize do
+      ss = @stream_generators[listener.accepted_hash]
+      ss.delete(listener)
+      if ss.empty?
+        @stream_generators.delete(listener.accepted_hash)
+      end
+    end
     self
   end
 
@@ -193,6 +216,11 @@ class Pluggaloid::Event
     end
   end
 
+  def register_stream_generator(stream_generator)
+    @stream_generators[stream_generator.accepted_hash] << stream_generator
+    self
+  end
+
   def collection_add_event
     self.class['%{name}__add' % {name: name}]
   end

data/lib/pluggaloid/plugin.rb

@@ -24,7 +24,8 @@ module Pluggaloid
                     Listener: Pluggaloid::Listener,
                     Filter: Pluggaloid::Filter,
                     HandlerTag: Pluggaloid::HandlerTag,
-                    Subscriber: Pluggaloid::Subscriber
+                    Subscriber: Pluggaloid::Subscriber,
+                    StreamGenerator: Pluggaloid::StreamGenerator
                   )
                   vm.Event.vm = vm end end
 
@@ -139,6 +140,10 @@ module Pluggaloid
       @filters << result
       result end
 
+    def generate(event_name, *specs, **kwrest, &block)
+      vm.StreamGenerator.new(vm.Event[event_name], *specs, plugin: self, **kwrest, &block)
+    end
+
     def subscribe(event_name, *specs, **kwrest, &block)
       if block
         result = vm.Subscriber.new(vm.Event[event_name], *specs, **kwrest, &block)

data/lib/pluggaloid/stream_generator.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+require 'securerandom'
+require 'set'
+
+class Pluggaloid::StreamGenerator < Pluggaloid::Handler
+  attr_reader :accepted_hash
+
+  def initialize(event, *specs, plugin:, **kwrest, &callback)
+    raise Pluggaloid::UndefinedStreamIndexError, 'To call generate(%{event}), it must define prototype arguments include `Pluggaloid::STREAM\'.' % {event: event.name} unless event.stream_index
+    super(event, **kwrest)
+    @callback = callback
+    @specs = specs.freeze
+    @accepted_hash = @event.argument_hash(specs, nil)
+    @last_subscribe_state = @event.subscribe?(*@specs)
+    @plugin = plugin
+    subscribe_start if @last_subscribe_state
+    @event.register_stream_generator(self)
+  end
+
+  def on_subscribed
+    if !@last_subscribe_state
+      @last_subscribe_state = true
+      subscribe_start
+    end
+  end
+
+  def on_unsubscribed
+    subscribe_state = @event.subscribe_hash?(@accepted_hash)
+    if @last_subscribe_state && !subscribe_state
+      @last_subscribe_state = false
+      subscribe_stop
+    end
+  end
+
+  # このリスナを削除する
+  # ==== Return
+  # self
+  def detach
+    @event.delete_stream_generator(self)
+    @yielder&.die
+    @yielder = nil
+    self
+  end
+
+  private
+
+  def subscribe_start
+    @tag = @plugin.handler_tag do
+      @yielder = Yielder.new(@event, args: @specs)
+      @callback.call(@yielder)
+    end
+  end
+
+  def subscribe_stop
+    @plugin.detach(@tag)
+    @yielder.die
+    @yielder = nil
+  end
+
+  class Yielder
+    def initialize(event, args:)
+      @event = event
+      @args = args.freeze
+      @alive = true
+    end
+
+    def bulk_add(lst)
+      raise Pluggaloid::NoReceiverError, "All event listener of #{self.class} already detached." if die?
+      args = @args.dup
+      args.insert(@event.stream_index, lst)
+      @event.call(*args)
+    end
+
+    def add(value)
+      bulk_add([value])
+    end
+    alias_method :<<, :add
+
+    def die?
+      !@alive
+    end
+
+    def die
+      @alive = false
+      freeze
+    end
+  end
+end

data/lib/pluggaloid/subscriber.rb

@@ -12,7 +12,7 @@ class Pluggaloid::Subscriber < Pluggaloid::Handler
   # [tags:] Pluggaloid::HandlerTag|Array リスナのタグ
   # [&callback] コールバック
   def initialize(event, *specs, **kwrest, &callback)
-    raise Pluggaloid::UndefinedStreamIndexError, 'To call subscribe(), it must define prototype arguments include `Pluggaloid::STREAM\'.' unless event.stream_index
+    raise Pluggaloid::UndefinedStreamIndexError, 'To call subscribe(%{event}), it must define prototype arguments include `Pluggaloid::STREAM\'.' % {event: event.name} unless event.stream_index
     super(event, **kwrest)
     @callback = callback
     @accepted_hash = @event.argument_hash(specs, nil)

data/lib/pluggaloid/version.rb

@@ -1,3 +1,3 @@
 module Pluggaloid
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/test/generate_test.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'minitest/autorun'
+
+require 'pluggaloid'
+require_relative 'helper'
+
+describe(Pluggaloid::Plugin) do
+  include PluggaloidTestHelper
+
+  before do
+    Delayer.default = Delayer.generate_class(priority: %i<high normal low>, default: :normal)
+    Pluggaloid::Plugin.clear!
+  end
+
+  describe 'event' do
+    before do
+      log = @log = []
+      Pluggaloid::Plugin.create(:event) do
+        defevent :list, prototype: [Integer, Pluggaloid::STREAM]
+
+        generate(:list, 1) do |yielder|
+          log << [:g1, :start]
+          on_tick do |digit|
+            log << [:g1, digit]
+            yielder << digit
+          end
+        end
+      end
+    end
+
+    it 'does not call generate block in not subscribed' do
+      assert_equal([], @log)
+    end
+
+    it 'does not call generate block in subscribed other caller arguments' do
+      Pluggaloid::Plugin.create(:event) do
+        subscribe(:list, 2) {}
+      end
+      assert_equal([], @log)
+    end
+
+    describe 'after subscribe' do
+      before do
+        listener = nil
+        Pluggaloid::Plugin.create(:event) do
+          listener = subscribe(:list, 1) {}
+        end
+        @listener = listener
+        eval_all_events
+      end
+
+      it 'call generate block' do
+        assert_equal([[:g1, :start]], @log)
+      end
+
+      it 'call once generate block if subscribe twice' do
+        Pluggaloid::Plugin.create(:event) do
+          subscribe(:list, 1) {}
+        end
+        eval_all_events
+        assert_equal([[:g1, :start]], @log)
+      end
+
+      describe 'detach all listeners' do
+        before do
+          Pluggaloid::Plugin.create(:event).detach(@listener)
+          Pluggaloid::Plugin.call(:event, 1, [69])
+          eval_all_events
+        end
+
+        it 'should detach handlers in generate block after unsubscribed' do
+          assert_equal([[:g1, :start]], @log)
+        end
+      end
+
+    end
+
+    describe 'after add_event_listener' do
+      before do
+        listener = nil
+        Pluggaloid::Plugin.create(:event) do
+          listener = on_list { |_num, _lst| ; }
+        end
+        @listener = listener
+        eval_all_events
+      end
+
+      it 'call generate block' do
+        assert_equal([[:g1, :start]], @log)
+      end
+
+      it 'call once generate block if subscribe twice' do
+        Pluggaloid::Plugin.create(:event) do
+          on_list { |_num, _lst| ; }
+        end
+        eval_all_events
+        assert_equal([[:g1, :start]], @log)
+      end
+
+      describe 'detach all listeners' do
+        before do
+          Pluggaloid::Plugin.create(:event).detach(@listener)
+          Pluggaloid::Plugin.call(:event, 1, [105])
+          eval_all_events
+        end
+
+        it 'detach handlers in generate block after unsubscribed' do
+          assert_equal([[:g1, :start]], @log)
+        end
+      end
+
+    end
+  end
+
+end

data/test/handle_in_generate_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'minitest/autorun'
+
+require 'pluggaloid'
+require_relative 'helper'
+
+describe(Pluggaloid::Plugin) do
+  include PluggaloidTestHelper
+
+  before do
+    Delayer.default = Delayer.generate_class(priority: %i<high normal low>, default: :normal)
+    Pluggaloid::Plugin.clear!
+  end
+
+  it 'hoge' do
+    refute Pluggaloid::Event[:tick].subscribe?
+  end
+
+  describe 'event' do
+    before do
+      log = @log = []
+      listener = nil
+      Pluggaloid::Plugin.create(:event) do
+        defevent :list, prototype: [Integer, Pluggaloid::STREAM]
+
+        generate(:list, 1) do |yielder|
+          log << [:g1, :start]
+          on_tick do |digit|
+            log << [:g1, digit]
+            yielder << digit
+          end
+        end
+
+        listener = subscribe(:list, 1) do |stream|
+          ;
+        end
+      end
+      @listener = listener
+      eval_all_events
+    end
+
+    it 'subscribed event which define in generate block' do
+      assert Pluggaloid::Event[:tick].subscribe?
+    end
+
+    describe 'unsubscribe generate stream' do
+      before do
+        Pluggaloid::Plugin.create(:event).detach(@listener)
+        eval_all_events
+      end
+
+      it 'unsubscribed event which define in generate block' do
+        refute Pluggaloid::Event[:tick].subscribe?
+      end
+    end
+  end
+end

data/test/reactive_test.rb

@@ -58,7 +58,7 @@ describe(Pluggaloid::Plugin) do
     end
   end
 
-  it "subscribe?" do
+  it "subscribe? first value" do
     Pluggaloid::Plugin.create(:event) do
       defevent :increase, prototype: [Integer, Pluggaloid::STREAM]
       subscribe(:increase, 1) do |v|
@@ -66,7 +66,16 @@ describe(Pluggaloid::Plugin) do
     end
     assert(Pluggaloid::Plugin[:event].subscribe?(:increase, 1))
     refute(Pluggaloid::Plugin[:event].subscribe?(:increase, 2))
+  end
 
+  it "subscribe? last value" do
+    Pluggaloid::Plugin.create(:event) do
+      defevent :increase, prototype: [Pluggaloid::STREAM, Integer]
+      subscribe(:increase, 1) do |v|
+      end
+    end
+    assert(Pluggaloid::Plugin[:event].subscribe?(:increase, 1))
+    refute(Pluggaloid::Plugin[:event].subscribe?(:increase, 2))
   end
 
   it "subscribe? returns always true if plugin listener exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggaloid
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Toshiaki Asai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayer
@@ -116,10 +116,13 @@ files:
 - lib/pluggaloid/listener.rb
 - lib/pluggaloid/plugin.rb
 - lib/pluggaloid/stream.rb
+- lib/pluggaloid/stream_generator.rb
 - lib/pluggaloid/subscriber.rb
 - lib/pluggaloid/version.rb
 - pluggaloid.gemspec
 - test/collect_test.rb
+- test/generate_test.rb
+- test/handle_in_generate_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
 - test/multi_vm_test.rb
@@ -150,6 +153,8 @@ specification_version: 4
 summary: Extensible plugin system
 test_files:
 - test/collect_test.rb
+- test/generate_test.rb
+- test/handle_in_generate_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
 - test/multi_vm_test.rb