message_channel 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d63211eee4c3d4c78fbc1d29982b911ca0bd3960e34042ac1409058e90764792
+  data.tar.gz: 218e4d678165d4eeb99e9ffe27fc66d4ea665ab9e69af3869b80ce8316c608aa
+SHA512:
+  metadata.gz: 692f1efac0613c714399114381b23bbc41819fee3397274f3cded23b01c8db72f51a68000ad019a0a7e600e304e7529f3f4125ae0746b0a87f225eadee091a12
+  data.tar.gz: 8d9ef41bbf851a7f6b346514531d2bdcd568b7a8370617de1aa0a0cc7c8bf716023cc26f7b1b3971b88fe8fcdf80b6506e8d14de6c2fc96502692fdd20694b2a

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+*.pid
+*.log
+*.log.*
+/var/
+/log/
+*.swp
+/.rspec_status
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in message_channel.gemspec
+gemspec
+

data/README.adoc

@@ -0,0 +1,174 @@
+= MessageChannel
+
+Yet another observer pattern library via Observable, DRb, MQTT, Redis and Mongo.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'message_channel'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install message_channel
+    or
+    $ gem install -l message_channel-x.x.x.gem
+
+== Usage
+
+=== Example 1
+
+[source,ruby]
+----
+require  "message_channel"
+
+Signal.trap( :INT ) do
+  exit
+end
+
+channel  =  MessageChannel.new
+
+channel.listen( "hello" ) do |topic, **items|
+  p [topic, items]
+end
+
+while  true
+  channel.notify  "hello", {at: Time.now.to_s}
+  sleep  1
+end
+----
+
+=== Example 2
+
+[source,ruby]
+----
+require  "message_channel"
+
+Signal.trap( :INT ) do
+  exit
+end
+
+channel  =  MessageChannel.new
+
+Thread.start do
+  while  true
+    topic, items  =  channel.listen( "hello" )
+    p [topic, items]
+  end
+end
+
+Thread.start do
+  while  true
+    channel.notify  "hello", {at: Time.now.to_s}
+    sleep  1
+  end
+end
+
+sleep
+----
+
+== Reference
+
+=== Create a new MessageChannel::* with conditions.
+
+[source,ruby]
+----
+MessageChannel.new( uri = nil, type: nil, host: nil, port: nil, db: nil, size: nil, name: nil )
+----
+
+* Result:
+  ** MessageChannel::* object.
+
+* Parameter:
+  ** uri: scheme://host:port/params (default: nil)
+    *** "observer"
+    *** "druby://127.0.0.1:8787"
+    *** "mqtt://127.0.0.1:1883"
+    *** "redis://127.0.0.1:6379/0"
+    *** "mongodb://127.0.0.1:27017/test?size=4000&name=_event_queue"
+  ** type: Channel type. (default: "observer")
+    *** "observer"
+    *** "druby"
+    *** "mqtt"
+    *** "redis"
+    *** "mongodb"
+  ** host: Service host. (default: nil)
+  ** port: Service port. (default: nil)
+  ** db: Database name. (default: "test")
+  ** size: Queue Size. (default: 4000)
+  ** name: Queue Name. (default: "_event_queue")
+
+=== Notify through the channel.
+
+[source,ruby]
+----
+MessageChannel::Observer#notify( topic, **items )
+MessageChannel::Druby#notify( topic, **items )
+MessageChannel::Mqtt#notify( topic, **items )
+MessageChannel::Redis#notify( topic, **items )
+MessageChannel::Mongodb#notify( topic, **items )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topic: a notification topic.
+  ** items: notification items.
+
+=== Listen to notification through the channel.
+
+[source,ruby]
+----
+MessageChannel::Observer#listen( *patterns, &block )
+MessageChannel::Druby#listen( *patterns, &block )
+MessageChannel::Mqtt#listen( *patterns, &block )
+MessageChannel::Redis#listen( *patterns, &block )
+MessageChannel::Mongodb#listen( *patterns, &block )
+----
+
+* Result:
+  ** with block: (Non-blocing Mode)
+    *** nil.
+  ** without block: (Blocking Mode)
+    *** topic: a notified topic.
+    *** items: notified items.
+
+* Parameter:
+  ** patterns: mask patterns.
+
+* Block Parameter:
+  ** topic: a notified topic.
+  ** items: notified items.
+
+=== Unlisten to notification.
+
+[source,ruby]
+----
+MessageChannel::Observer#unlisten( *patterns )
+MessageChannel::Druby#unlisten( *patterns )
+MessageChannel::Mqtt#unlisten( *patterns )
+MessageChannel::Redis#unlisten( *patterns )
+MessageChannel::Mongodb#unlisten( *patterns )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** patterns: mask patterns.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/message_channel.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].

data/README.ja.adoc

@@ -0,0 +1,175 @@
+= MessageChannel
+
+オブザーバパターンライブラリのひとつ. 
+Observable, DRb, MQTT, Redis and Mongo を用いる.  
+
+== 導入
+
+アプリの Gemfile にこの行を追加
+
+[source,ruby]
+----
+gem 'message_channel'
+----
+
+それから実行
+
+    $ bundle install
+
+または次のように手動で導入
+
+    $ gem install message_channel
+    or
+    $ gem install -l message_channel-x.x.x.gem
+
+== 使い方
+
+=== Example 1
+
+[source,ruby]
+----
+require  "message_channel"
+
+Signal.trap( :INT ) do
+  exit
+end
+
+channel  =  MessageChannel.new
+
+channel.listen( "hello" ) do |topic, **items|
+  p [topic, items]
+end
+
+while  true
+  channel.notify  "hello", {at: Time.now.to_s}
+  sleep  1
+end
+----
+
+=== Example 2
+
+[source,ruby]
+----
+require  "message_channel"
+
+Signal.trap( :INT ) do
+  exit
+end
+
+channel  =  MessageChannel.new
+
+Thread.start do
+  while  true
+    topic, items  =  channel.listen( "hello" )
+    p [topic, items]
+  end
+end
+
+Thread.start do
+  while  true
+    channel.notify  "hello", {at: Time.now.to_s}
+    sleep  1
+  end
+end
+
+sleep
+----
+
+== リファレンス
+
+=== 条件を指定して、新たな MessageChannel::* を作成する.
+
+[source,ruby]
+----
+MessageChannel.new( uri = nil, type: nil, host: nil, port: nil, db: nil, size: nil, name: nil )
+----
+
+* Result:
+  ** MessageChannel::* object.
+
+* Parameter:
+  ** uri: scheme://host:port/params (default: nil)
+    *** "observer"
+    *** "druby://127.0.0.1:8787"
+    *** "mqtt://127.0.0.1:1883"
+    *** "redis://127.0.0.1:6379/0"
+    *** "mongodb://127.0.0.1:27017/test?size=4000&name=_event_queue"
+  ** type: Channel type. (default: "observer")
+    *** "observer"
+    *** "druby"
+    *** "mqtt"
+    *** "redis"
+    *** "mongodb"
+  ** host: サービスホスト. (default: nil)
+  ** port: サービスポート. (default: nil)
+  ** db: データベース名. (default: "test")
+  ** size: キューサイズ. (default: 4000)
+  ** name: キュー名. (default: "_event_queue")
+
+=== チャネル経由で通知.
+
+[source,ruby]
+----
+MessageChannel::Observer#notify( topic, **items )
+MessageChannel::Druby#notify( topic, **items )
+MessageChannel::Mqtt#notify( topic, **items )
+MessageChannel::Redis#notify( topic, **items )
+MessageChannel::Mongodb#notify( topic, **items )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topic: 通知トピック.
+  ** items: 通知アイテム.
+
+=== チャネル経由で通知待機.
+
+[source,ruby]
+----
+MessageChannel::Observer#listen( *patterns, &block )
+MessageChannel::Druby#listen( *patterns, &block )
+MessageChannel::Mqtt#listen( *patterns, &block )
+MessageChannel::Redis#listen( *patterns, &block )
+MessageChannel::Mongodb#listen( *patterns, &block )
+----
+
+* Result:
+  ** ブロック引数あり: (Non-blocing Mode)
+    *** nil.
+  ** ブロック引数なし: (Blocking Mode)
+    *** topic: 通知トピック.
+    *** items: 通知アイテム.
+
+* Parameter:
+  ** patterns: マスクパターンの配列.
+
+* Block Parameter:
+  ** topic: 通知トピック.
+  ** items: 通知アイテム.
+
+=== 通知待機を解除.
+
+[source,ruby]
+----
+MessageChannel::Observer#unlisten( *patterns )
+MessageChannel::Druby#unlisten( *patterns )
+MessageChannel::Mqtt#unlisten( *patterns )
+MessageChannel::Redis#unlisten( *patterns )
+MessageChannel::Mongodb#unlisten( *patterns )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** patterns: マスクパターンの配列.
+
+== 貢献
+
+不具合報告とプルリクエストは GitHub https://github.com/arimay/message_channel まで. 
+
+== ライセンス
+
+この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.

data/Rakefile

@@ -0,0 +1,96 @@
+require "bundler/gem_helper"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+class Bundler::GemHelper
+
+  def git_archive( dir = "../#{Time.now.strftime("%Y%m%d")}" )
+    FileUtils.mkdir_p  dir
+    dest_path  =  File.join(dir, "#{name}-#{version}.zip")
+    cmnd  =  "git archive --format zip --prefix=#{name}/ HEAD > #{dest_path}"
+
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't archive gem,"  unless  code == 0
+
+    Bundler.ui.confirm "#{name} #{version} archived to #{dest_path}."
+  end
+
+  def git_push
+    ver  =  version.to_s
+
+    cmnd  =  "git push origin  #{ver} "
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't git push origin."  unless  code == 0
+
+    cmnd  =  "git push "
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't git push."         unless  code == 0
+
+    Bundler.ui.confirm "Git Push #{ver}."
+  end
+
+  def update_version( new_version )
+    version_filename  =  %x[ find . -type f -name "version.rb" | grep -v vendor | head -1 ].chomp
+    version_pathname  =  File.expand_path( version_filename )
+    lines  =  File.open( version_pathname ).read
+    lines  =  lines.gsub( /VERSION\s*=\s*\"\d+\.\d+\.\d+\"/, "VERSION = \"#{new_version}\"" )
+    File.open( version_pathname, "w" ) do |file|
+      file.write( lines )
+    end
+
+    cmnd  =  "git add  #{version_pathname} "
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't git add,"  unless  code == 0
+
+    cmnd  =  "git commit -m  '#{new_version}' "
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't git commit."  unless  code == 0
+
+    cmnd  =  "git tag        #{new_version} "
+    out, code = sh_with_status( cmnd )
+    raise "Couldn't git tag."          unless  code == 0
+
+    Bundler.ui.confirm "Update Tags to #{new_version}."
+  end
+
+end
+
+Bundler::GemHelper.new(Dir.pwd).instance_eval do
+
+  desc "Archive #{name}-#{version}.zip from repository"
+  task 'zip' do
+    git_archive
+  end
+
+  desc "Git Push"
+  task 'push' do
+    git_push
+  end
+
+  desc "Update Version Tiny"
+  task 'tiny' do
+    major, minor, tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor, tiny.to_i + 1].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Minor"
+  task 'minor' do
+    major, minor, tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor.to_i + 1, 0].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Major"
+  task 'major' do
+    major, minor, tiny  =  version.to_s.split('.')
+    new_version  =  [major.to_i + 1, 0, 0].join('.')
+    update_version( new_version )
+  end
+
+end
+