Skip to content

mikutterに使われているプラグインとイベントによる通信を実現するライブラリ

License

Notifications You must be signed in to change notification settings

toshia/pluggaloid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pluggaloid

mikutterのプラグイン機構です。 登録したプラグイン同士がイベントを使って通信できるようになります。

toshia

Installation

Add this line to your application's Gemfile:

gem 'pluggaloid'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pluggaloid

Usage

require 'pluggaloid'

main = Pluggaloid.new(Delayer.generate_class(priority: %i<high normal low>, default: :normal))

main.Plugin.create(:write_to_stdout) do
  on_logging do |message|
    puts "logging: #{message}"
  end
end

main.Plugin.call(:logging, "boot.")
main.Plugin.call(:logging, "event test.")
main.Plugin.call(:logging, "exit.")

main.Delayer.run while not main.Delayer.empty?

Pluggaloid::new

Pluggaloid::newは、プラグイン機構を制御するためのDelayer, Plugin, Event, Listener, Filterのサブクラスを新しく作って返すメソッドです。 戻り値はStructで、それぞれのクラス名がメンバの名前になっています。

Member Description
Delayer Pluggaloid::new に渡したDelayer
Plugin Pluggaloid::Plugin のサブクラス
Event Pluggaloid::Event のサブクラス
Listener Pluggaloid::Listener のサブクラス
Filter Pluggaloid::Filter のサブクラス

コンストラクタの唯一の引数には Delayer.generate_class(priority: %i<high normal low>, default: :normal)のように、優先順位付きでデフォルト優先度が設定されたDelayerを渡します。

Reactive Filter

each_slice(times)

times 要素ずつブロックに渡して繰り返します。 要素数が times で割り切れないときは、要素が times 個になるまで待ちます。

throttle(sec)

最後に要素を受信してから、 sec 秒の間に受信した要素を捨てます。

debounce(sec)

sec 秒要素を受信しなかった場合、最後の要素を送信する。

buffer(sec)

sec 秒の間に受信した要素を、 sec 秒ごとに配列にまとめて送信する。

Contributing

  1. Fork it ( https://github.com/toshia/pluggaloid/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

mikutterに使われているプラグインとイベントによる通信を実現するライブラリ

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages