pluggaloid 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd795f27416c6cff9155f4adbfa97cb04192a48e891d387a1a5c37a04b5b681c
-  data.tar.gz: 82a3a43fa8f01c34b879c2d85d19f0193d54e8fa3e9989040559c5b40b70e9f4
+  metadata.gz: 076d2f155418730ea29519ce8d7281343146dab271b2db4458fbf2c6db600ef9
+  data.tar.gz: 42e8f0dcb752dcc4535a4d7c797f99f3864c738d06cb4f55a99ec15dadb92212
 SHA512:
-  metadata.gz: b943be558a442022cd1d3ca2fec636ec6f6b8a9498cd2a8cc2fb8a3227df8675fc06f50d90d19af0c3db648703952c37123b0d41e2fc3ff4f686d0a87726d6c6
-  data.tar.gz: 3f1b7c5fcfa142ad280c3a1c67405ae42536bdcca32b9e2d1ed05a34d394602509bada0001657bfc1eaa48b1aa6465f941513119508179d61feeca52fdd3441e
+  metadata.gz: 2b6ad3377a18ea67c24c063a1c844f098401844cb46bda2df9db4db51ca3d8e225344d4703ba90ce622b9f1dbf99245ae6fb33c4dd4cf8cf77385dac6e0be222
+  data.tar.gz: 5e45e8b7eb9dbfd2335502ddd225cea420dfd980593ebdb1fc830840274a3d2442da05c5ca06a774a74202a0465428276b1f7a7eb8d7ad468a7af59e9765b100

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+version: '2.1'
+
+executors:
+  ruby:
+    parameters:
+      tag:
+        type: string
+    docker:
+      - image: circleci/ruby:<< parameters.tag >>
+
+jobs:
+  build:
+    parameters:
+       ruby-version:
+         type: string
+    executor:
+      name: ruby
+      tag: << parameters.ruby-version >>
+    steps:
+    - checkout
+    - run:
+        name: Which bundler?
+        command: bundle -v
+    - run:
+        command: bundle install --path vendor/bundle
+    - run:
+        name: test
+        command: bundle exec rake test
+workflows:
+  build:
+    jobs:
+      - build:
+          name: 'ruby-2.5'
+          ruby-version: '2.5.7'
+      - build:
+          name: 'ruby-2.6'
+          ruby-version: '2.6.5'
+      - build:
+          name: 'ruby-2.7'
+          ruby-version: '2.7.0'

data/README.md

@@ -3,6 +3,8 @@
 mikutterのプラグイン機構です。
 登録したプラグイン同士がイベントを使って通信できるようになります。
 
+[![toshia](https://circleci.com/gh/toshia/pluggaloid.svg?style=svg)](https://circleci.com/gh/toshia/pluggaloid)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/pluggaloid.rb

@@ -1,4 +1,5 @@
 require "pluggaloid/version"
+require 'pluggaloid/collection'
 require "pluggaloid/plugin"
 require 'pluggaloid/stream'
 require 'pluggaloid/event'
@@ -16,7 +17,9 @@ module Pluggaloid
   VM = Struct.new(*%i<Delayer Plugin Event Listener Filter HandlerTag Subscriber>, keyword_init: true)
 
   class PrototypeStream; end
+  class PrototypeCollect; end
   STREAM = PrototypeStream.new.freeze
+  COLLECT = PrototypeCollect.new.freeze
 
   def self.new(delayer)
     vm = VM.new(Delayer: delayer,

data/lib/pluggaloid/collection.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Pluggaloid
+  class Collection
+    attr_reader :values
+
+    def initialize(event, *args)
+      @event = event
+      args[event.collect_index] = nil
+      @args = args.freeze
+      @spec = argument_hash(args)
+      @values = [].freeze
+    end
+
+    def add(*v)
+      rewind do |privitive|
+        privitive + v
+      end
+    end
+    alias_method :<<, :add
+
+    def delete(*v)
+      rewind do |privitive|
+        privitive - v
+      end
+    end
+
+    def rewind(&block)
+      new_values = block.(@values.dup)
+      added, deleted = new_values - @values, @values - new_values
+      @values = new_values.freeze
+      unless added.empty?
+        args = @args.dup
+        args[@event.collect_index] = added
+        @event.collection_add_event.call(*args)
+      end
+      unless deleted.empty?
+        args = @args.dup
+        args[@event.collect_index] = deleted
+        @event.collection_delete_event.call(*args)
+      end
+      self
+    end
+
+    def argument_hash_same?(specs)
+      @spec == argument_hash(specs)
+    end
+
+    private
+
+    def argument_hash(specs)
+      @event.argument_hash(specs, @event.collect_index)
+    end
+  end
+end

data/lib/pluggaloid/error.rb

@@ -11,4 +11,6 @@ module Pluggaloid
   class NoDefaultDelayerError < Error; end
 
   class DuplicateListenerSlugError < Error; end
+
+  class UndefinedCollectionIndexError < Error; end
 end

data/lib/pluggaloid/event.rb

@@ -21,6 +21,24 @@ class Pluggaloid::Event
     @subscribers = {}
   end
 
+  def prototype
+    @options[:prototype]
+  end
+
+  # イベント _event_name_ を宣言する
+  # ==== Args
+  # [new_options] イベントの定義
+  def defevent(new_options)
+    @options.merge!(new_options)
+    if collect_index
+      new_proto = self.prototype.dup
+      new_proto[self.collect_index] = Pluggaloid::STREAM
+      collection_add_event.defevent(prototype: new_proto)
+      collection_delete_event.defevent(prototype: new_proto)
+    end
+    self
+  end
+
   def vm
     self.class.vm end
 
@@ -83,7 +101,7 @@ class Pluggaloid::Event
   end
 
   def subscribe?(*args)
-    !@listeners.empty? || @subscribers.key?(argument_hash(args))
+    !@listeners.empty? || @subscribers.key?(argument_hash(args, stream_index))
   end
 
   def delete_listener(listener)
@@ -132,25 +150,61 @@ class Pluggaloid::Event
     self
   end
 
-  def argument_hash(args)
+  def argument_hash(args, exclude_index)
     args.each_with_index.map do |item, i|
-      if i != yield_index
+      if i != exclude_index
         item.hash
       end
     end.compact.freeze
   end
 
-  def yield_index
-    unless defined?(@yield_index)
-      @yield_index = self.options[:prototype]&.index(Pluggaloid::STREAM)
+  def stream_index
+    unless defined?(@stream_index)
+      @stream_index = self.prototype&.index(Pluggaloid::STREAM)
     end
-    @yield_index
+    @stream_index
+  end
+
+  def collect_index
+    unless defined?(@collect_index)
+      @collect_index = self.prototype&.index(Pluggaloid::COLLECT)
+    end
+    @collect_index
+  end
+
+  # defeventで定義されたprototype引数に _Pluggaloid::COLLECT_ を含むイベントに対して使える。
+  # フィルタの _Pluggaloid::COLLECT_ 引数に空の配列を渡して実行したあと、その配列を返す。
+  # ==== Args
+  # [*args] Pluggaloid::COLLECT 以外の引数のリスト
+  # ==== Return
+  # [Array] フィルタ実行結果
+  def collect(*args)
+    specified_index = args.index(Pluggaloid::COLLECT)
+    specified_index&.yield_self(&args.method(:delete_at))
+    insert_index = collect_index || specified_index
+    if insert_index
+      Enumerator.new do |yielder|
+        cargs = args.dup
+        cargs.insert(insert_index, yielder)
+        filtering(*cargs)
+      end
+    else
+      raise Pluggaloid::UndefinedCollectionIndexError, 'To call collect(), it must define prototype arguments include `Pluggaloid::COLLECT\'.'
+    end
+  end
+
+  def collection_add_event
+    self.class['%{name}__add' % {name: name}]
+  end
+
+  def collection_delete_event
+    self.class['%{name}__delete' % {name: name}]
   end
 
   private
   def call_all_listeners(args)
-    if yield_index
-      @subscribers[argument_hash(args)]&.each do |subscriber|
+    if stream_index
+      @subscribers[argument_hash(args, stream_index)]&.each do |subscriber|
         subscriber.call(*args)
       end
     end

data/lib/pluggaloid/plugin.rb

@@ -64,6 +64,17 @@ module Pluggaloid
       def filtering(event_name, *args)
         vm.Event[event_name].filtering(*args) end
 
+      # フィルタ _event_name_ を実行し、defeventでPluggaloid::COLLECTと
+      # 宣言されている引数の結果を列挙するEnumeratorを返す
+      # ==== Args
+      # [event_name] イベント名(String | Symbol)
+      # [*specs] Pluggaloid::COLLECT以外の引数
+      # ==== Return
+      # [Enumerator]
+      def collect(event_name, *specs)
+        vm.Event[event_name].collect(*specs)
+      end
+
       # 互換性のため
       def uninstall(plugin_name)
         self[plugin_name].uninstall end
@@ -116,7 +127,7 @@ module Pluggaloid
 
     # イベントフィルタを新しく登録する
     # ==== Args
-    # [event] 監視するEventのインスタンス
+    # [event_name] イベント名(String | Symbol)
     # [name:] 名前(String | nil)
     # [slug:] フィルタスラッグ(Symbol | nil)
     # [tags:] Pluggaloid::HandlerTag|Array フィルタのタグ
@@ -148,6 +159,32 @@ module Pluggaloid
       vm.Event[event_name].subscribe?(*specs)
     end
 
+    def collect(event_name, *specs)
+      self.class.collect(event_name, *specs)
+    end
+
+    # 追加・削除がフィルタに反映されるコレクションオブジェクトを作成する。
+    # 同時に _event_name_ にフィルタが定義され、フィルタが呼ばれると
+    # その時点のコレクションオブジェクトの内容を全て列挙する。
+    # フィルタと対になるコレクションオブジェクトは、 _&block_ の引数として渡される。
+    # ==== Args
+    # [event_name] イベント名(String | Symbol)
+    # [*specs] Pluggaloid::COLLECT以外の引数
+    # [&block] コレクションオブジェクトを受け取って一度だけ実行されるblock
+    # ==== Return
+    # _&block_ の戻り値
+    def collection(event_name, *specs, &block)
+      event = vm.Event[event_name]
+      mutation = Pluggaloid::Collection.new(event, *specs)
+      add_event_filter(event_name) do |*args|
+        if mutation.argument_hash_same?(args)
+          mutation.values.each(&args[event.collect_index].method(:<<))
+        end
+        args
+      end
+      block.call(mutation)
+    end
+
     # このプラグインのHandlerTagを作る。
     # ブロックが渡された場合は、ブロックの中を実行し、ブロックの中で定義された
     # Handler全てにTagを付与する。
@@ -198,7 +235,6 @@ module Pluggaloid
       end
     end
 
-
     # イベントを削除する。
     # 引数は、Pluggaloid::ListenerかPluggaloid::Filterのみ(on_*やfilter_*の戻り値)。
     # 互換性のため、二つ引数がある場合は第一引数は無視され、第二引数が使われる。
@@ -239,7 +275,8 @@ module Pluggaloid
     # [event_name] イベント名
     # [options] イベントの定義
     def defevent(event_name, options={})
-      vm.Event[event_name].options.merge!({plugin: self}.merge(options)) end
+      vm.Event[event_name].defevent({ plugin: self, **options })
+    end
 
     # DSLメソッドを新しく追加する。
     # 追加されたメソッドは呼ぶと &callback が呼ばれ、その戻り値が返される。引数も順番通り全て &callbackに渡される

data/lib/pluggaloid/subscriber.rb

@@ -14,7 +14,7 @@ class Pluggaloid::Subscriber < Pluggaloid::Handler
   def initialize(event, *specs, **kwrest, &callback)
     super(event, **kwrest)
     @callback = callback
-    @accepted_hash = @event.argument_hash(specs)
+    @accepted_hash = @event.argument_hash(specs, @event.stream_index)
     event.add_listener(self)
   end
 
@@ -22,7 +22,7 @@ class Pluggaloid::Subscriber < Pluggaloid::Handler
   # ==== Args
   # [stream] イベントの引数
   def call(*args)
-    @callback.call(args[@event.yield_index])
+    @callback.call(args[@event.stream_index])
   end
 
   # このリスナを削除する

data/lib/pluggaloid/version.rb

@@ -1,3 +1,3 @@
 module Pluggaloid
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/test/collect_test.rb

@@ -0,0 +1,135 @@
+# 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 'collect' do
+    Pluggaloid::Plugin.create(:event) do
+      defevent :list, prototype: [Integer, Pluggaloid::COLLECT]
+
+      filter_list do |i, yielder|
+        i.times(&yielder.method(:<<))
+        [i, yielder]
+      end
+    end
+
+    assert_equal([0, 1, 2], Pluggaloid::Event[:list].collect(3).to_a)
+  end
+
+  it 'fail when collect with undefined' do
+    Pluggaloid::Plugin.create(:event) do
+      filter_list do |i, yielder|
+        i.times(&yielder.method(:<<))
+        [i, yielder]
+      end
+    end
+
+    assert_raises(Pluggaloid::UndefinedCollectionIndexError) do
+      Pluggaloid::Event[:list].collect(3)
+    end
+  end
+
+  it 'success caller arguments include Pluggaloid::COLLECT when collect with undefined' do
+    Pluggaloid::Plugin.create(:event) do
+      filter_list do |i, yielder|
+        i.times(&yielder.method(:<<))
+        [i, yielder]
+      end
+    end
+
+    assert_equal([0, 1, 2], Pluggaloid::Event[:list].collect(3, Pluggaloid::COLLECT).to_a)
+  end
+
+  it 'success different caller argument specific and prototype definition' do
+    Pluggaloid::Plugin.create(:event) do
+      defevent :list, prototype: [Integer, Pluggaloid::COLLECT]
+
+      filter_list do |i, yielder|
+        i.times(&yielder.method(:<<))
+        [i, yielder]
+      end
+    end
+
+    assert_equal([0, 1, 2], Pluggaloid::Event[:list].collect(Pluggaloid::COLLECT, 3).to_a)
+  end
+
+  describe 'collection' do
+    it 'add' do
+      Pluggaloid::Plugin.create(:event) do
+        defevent :list, prototype: [Integer, Pluggaloid::COLLECT]
+        defevent :insert, prototype: [Pluggaloid::STREAM]
+
+        collection(:list, 3) do |collector|
+          subscribe(:insert).each do |i|
+            collector.add(i * 3)
+          end
+        end
+      end
+      eval_all_events do
+        Pluggaloid::Event[:insert].call([2, 5])
+      end
+      assert_equal([6, 15], Pluggaloid::Event[:list].collect(3).to_a)
+    end
+
+    it 'delete' do
+      Pluggaloid::Plugin.create(:event) do
+        defevent :list, prototype: [Integer, Pluggaloid::COLLECT]
+        defevent :destroy, prototype: [Pluggaloid::STREAM]
+
+        collection(:list, 3) do |collector|
+          collector << 1 << 2 << 3
+          subscribe(:destroy).each do |i|
+            collector.delete(i)
+          end
+        end
+      end
+      eval_all_events do
+        Pluggaloid::Event[:destroy].call([2, 4])
+      end
+      assert_equal([1, 3], Pluggaloid::Event[:list].collect(3).to_a)
+    end
+
+    it 'rewind' do
+      added = []
+      deleted = []
+      Pluggaloid::Plugin.create(:event) do
+        defevent :list, prototype: [Integer, Pluggaloid::COLLECT]
+
+        collection(:list, 3) do |collector|
+          collector << 1 << 2 << 3
+          on_rewind do |e|
+            collector.rewind do |lst|
+              e
+            end
+          end
+        end
+
+        subscribe(:list__add, 3) do |elm|
+          added += elm
+        end
+
+        subscribe(:list__delete, 3) do |elm|
+          deleted += elm
+        end
+      end
+      eval_all_events do
+        Pluggaloid::Event[:rewind].call([2, 3, 4])
+      end
+      assert_equal([2, 3, 4], Pluggaloid::Event[:list].collect(3).to_a)
+      assert_equal([1, 2, 3, 4], added)
+      assert_equal([1], deleted)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggaloid
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Toshiaki Asai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayer
@@ -99,12 +99,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/pluggaloid.rb
+- lib/pluggaloid/collection.rb
 - lib/pluggaloid/error.rb
 - lib/pluggaloid/event.rb
 - lib/pluggaloid/filter.rb
@@ -117,6 +119,7 @@ files:
 - lib/pluggaloid/subscriber.rb
 - lib/pluggaloid/version.rb
 - pluggaloid.gemspec
+- test/collect_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
 - test/multi_vm_test.rb
@@ -146,6 +149,7 @@ signing_key:
 specification_version: 4
 summary: Extensible plugin system
 test_files:
+- test/collect_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
 - test/multi_vm_test.rb