time_scheduler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a0c224d56eceb03eb15fcded9eb2780b71cf16cdecdf45d578b39c5f53bfed0
+  data.tar.gz: 07edc8b9301dc8e3ac27fed5d8015c548fb884800b7d292db3f815cfbd92d2d3
+SHA512:
+  metadata.gz: 19a5f1d79e7a42779255271f06f7fe64e9ac938e1a3aa9344968de957ae9b9cb488fa07d5b35d4ea50f6ba56ef3776fcabf431abdc8f9deacd012e3a2c5ad7e4
+  data.tar.gz: fd75200695a4d318653261a3e45907b93d48f8c86f7a85fa3ca424a4dcfd7f3d0e0a45b54a4034d399f77189161f7b0418ce70b37380492a7e52e3fb5d15a401

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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in schedule_handler.gemspec
+gemspec

data/README.adoc

@@ -0,0 +1,200 @@
+= TimeScheduler
+
+TimeScheduler is yet another library for single/periodical event scheduler.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'time_scheduler'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install time_scheduler
+    or
+    $ gem install -l time_scheduler-x.x.x.gem
+
+== Usage
+
+=== Example 1
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+Signal.trap( :INT ) do
+  exit
+end
+
+goal  =  Time.now + 5
+while  time  =  Scheduler.wait( sec: "*" )
+  p time
+  break    if time > goal
+end
+
+goal  =  Time.now + 5
+Scheduler.wait( :check, sec: "*" ) do |time|
+  p time
+  Scheduler.cancel( :check )    if time > goal
+end
+
+sleep  10
+----
+
+=== Example 2
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+Signal.trap( :INT ) do
+  exit
+end
+
+Scheduler.wait( sec: "*/5" ) do |time|
+  p [time, :sec5]
+end
+
+Scheduler.wait( cron: "*/2 * * * *" ) do |time|
+  p [time, :cron]
+end
+
+Scheduler.wait( at: Time.now + 30 ) do |time|
+  p [time, :quit]
+  exit
+end
+
+sleep
+----
+
+== Reference
+
+=== Create a new TimeScheduler.
+
+[source,ruby]
+----
+TimeScheduler.new
+----
+
+* Result:
+  ** TimeScheduler object.
+
+* Parameter:
+  ** None.
+
+=== Schedule event.
+
+[source,ruby]
+----
+TimeScheduler=wait( topic = Time.now.iso8601(6),
+                      at: nil, cron: nil, year: nil, month: nil, day: nil, wday: nil, hour: nil, min: nil, sec: 0, msec: nil,
+                      &block )
+----
+
+* Result:
+  ** with block:
+    *** topic string.
+  ** without block:
+    *** event time.
+
+* Parameter:
+  ** topic:  topic for setup/reset operation. (default: nil)
+  ** at:  time. Time or String object. (default: nil)
+  ** cron:  set of min, hour, day, month, wday pattern. (default: nil)
+  ** year:  year. unlimited range is denied. (default: nil)
+  ** month:  month. 1..12, jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec. (default: nil)
+  ** day:  day of month. 1..31. (default: nil)
+  ** wday:  day of week. 0..7, sun, mon, tue, wed, thr, fri, sat. (default: nil)
+  ** hour:  minute. 0..23. (default: nil)
+  ** min:  minute. 0..59. (default: nil)
+  ** sec:  second. 0..59. (default: 0)
+  ** msec:  millisecond. 0..999. (default: nil), If msec is assigned, then other parameters are ignored.
+    In detail, it can use "*" as wildcard.
+
+=== Get event topics.
+
+[source,ruby]
+----
+TimeScheduler#topics
+----
+
+* Result:
+  ** array of topics.
+
+* Parameter:
+  ** none.
+
+=== Cancel event.
+
+[source,ruby]
+----
+TimeScheduler#cancel( *topics )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topic:  topic for stop operation.
+
+=== Check activity.
+
+[source,ruby]
+----
+TimeScheduler#active?
+----
+
+* Result:
+  ** false/true.
+
+* Parameter:
+  ** none.
+
+=== Suspend all events.
+
+[source,ruby]
+----
+TimeScheduler#suspend
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** none.
+
+=== Resume all events.
+
+[source,ruby]
+----
+TimeScheduler#resume
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** none.
+
+== Caution
+
+Because it is calculated in local time, it does not work as expected when switching to daylight saving time.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/time_scheduler.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/README.ja.adoc

@@ -0,0 +1,199 @@
+= TimeScheduler
+
+TimeScheduler は一度の/周期的なイベントスケジューラのライブラリのひとつ。
+
+== 導入
+
+アプリの Gemfile にこの行を追加
+
+[source,ruby]
+----
+gem 'time_scheduler'
+----
+
+それから実行
+
+    $ bundle install
+
+または次のように手動で導入
+
+    $ gem install time_scheduler
+    or
+    $ gem install -l time_scheduler-x.x.x.gem
+
+== 使い方
+
+=== Example 1
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+Signal.trap( :INT ) do
+  exit
+end
+
+goal  =  Time.now + 5
+while  time  =  Scheduler.wait( sec: "*" )
+  p time
+  break    if time > goal
+end
+
+goal  =  Time.now + 5
+Scheduler.wait( :check, sec: "*" ) do |time|
+  p time
+  Scheduler.cancel( :check )    if time > goal
+end
+
+sleep  10
+----
+
+=== Example 2
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+Signal.trap( :INT ) do
+  exit
+end
+
+Scheduler.wait( sec: "*/5" ) do |time|
+  p [time, :sec5]
+end
+
+Scheduler.wait( cron: "*/2 * * * *" ) do |time|
+  p [time, :cron]
+end
+
+Scheduler.wait( at: Time.now + 30 ) do |time|
+  p [time, :quit]
+  exit
+end
+
+sleep
+----
+
+== リファレンス
+
+=== 新たな TimeScheduler を作成する.
+
+[source,ruby]
+----
+TimeScheduler.new
+----
+
+* Result:
+  ** TimeScheduler オブジェクト.
+
+* Parameter:
+  ** なし.
+
+=== イベントを計画する.
+
+[source,ruby]
+----
+TimeScheduler#wait( topic = Time.now.iso8601(6),
+                      at: nil, cron: nil, year: nil, month: nil, day: nil, wday: nil, hour: nil, min: nil, sec: 0, msec: nil,
+                      &block )
+----
+
+* Result:
+  ** with block:
+    *** topic string.
+  ** without block:
+    *** event time.
+
+* Parameter:
+  ** at:  日時. Time または String オブジェクト. (default: nil)
+  ** cron:  分、時、日、月、曜パターンのセット. (default: nil)
+  ** year:  年. 範囲制限なしは拒否される. (default: nil)
+  ** month:  月. 1..12, jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec. (default: nil)
+  ** day:  日. 1..31. (default: nil)
+  ** wday:  曜. 0..7, sun, mon, tue, wed, thr, fri, sat. (default: nil)
+  ** hour:  時. 0..23. (default: nil)
+  ** min:  分. 0..59. (default: nil)
+  ** sec:  秒. 0..59. (default: 0)
+  ** msec:  ミリ秒. 0..999. (default: nil), ミリ秒が指定されたとき, 他のパラメータは無視される.
+    詳細では, ワイルドカードとして "*" を使用できる.
+
+=== トピック名を得る.
+
+[source,ruby]
+----
+TimeScheduler#topics
+----
+
+* Result:
+  ** array of topics.
+
+* Parameter:
+  ** なし.
+
+=== イベントを解除する.
+
+[source,ruby]
+----
+TimeScheduler#cancel( *topics )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** topic:  topic for stop operation.
+
+=== 稼働中か調べる.
+
+[source,ruby]
+----
+TimeScheduler#active?
+----
+
+* Result:
+  ** false/true.
+
+* Parameter:
+  ** なし.
+
+=== すべてのイベントを一時停止する.
+
+[source,ruby]
+----
+TimeScheduler#suspend
+----
+
+* Result:
+  * nil.
+
+* Parameter:
+  ** なし.
+
+=== すべてのイベントを再開する.
+
+[source,ruby]
+----
+TimeScheduler#resume
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** なし.
+
+== 注意
+
+地域時刻で計算しているため、夏時間の切り替わりにおいて期待しない挙動となる.
+
+== 貢献
+
+不具合報告とプルリクエストは GitHub https://github.com/arimay/time_cursor まで. 
+
+== ライセンス
+
+この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.