time_scheduler 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb64e086c89c9b6dc0502f9c21085980a5489d32161c18664e7f068b28f0c47
-  data.tar.gz: 1234cdfd51ffa3ee8b81a8df05de02f10ae949b193dbf17ca682875688a295c2
+  metadata.gz: 9dd3e563565d592dbc78bad3a0c306fa85817dad4b17a615147c04c0daca0fa0
+  data.tar.gz: 324db4ac4818cf66de0f31922f5478892ce510caa791dd904158a2639256d91d
 SHA512:
-  metadata.gz: c7b5871796a2397e0725af68415a62d55f0af8d0bd85b2014195f679f28296654f88bf3887df391841ce8797fa98193d2ffcb006e5fccbe51fb14a0531ff5274
-  data.tar.gz: 7db26873fe827e7c6078e33f8234db689de41166171886ca13ef1de44059f21b8169a037771719e48e80fee62645ad3beec398b959c157dda489c4aa0d27fcb2
+  metadata.gz: 125b52b655af7eedb23216fd870d19a1a52575afd112efff44636e299b134c31b45b31bb2056f8bc0596fdc6a18df538e3cbb2c97e9beba0fd7510c3159433a7
+  data.tar.gz: 50f132d18ea8faa5cf0bdf7da4e1e65642b13182e0501c3bd1c5a4a071a970bf6395c48010d8648f031b89045cccab56d9ec69dde0290a9afe41b2d3e5aeb312

data/README.adoc

@@ -1,6 +1,6 @@
 = TimeScheduler
 
-TimeScheduler is yet another library for single/periodical event scheduler.
+Yet another library for single/periodical event scheduler.
 
 == Installation
 
@@ -98,18 +98,18 @@ TimeScheduler.new
 [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 )
+                    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.
+  ** with block: (Non-blocing Mode)
+    *** topic: event identify topic for operation.
+  ** without block: (Blocking Mode)
+    *** time: event time. time object.
 
 * Parameter:
-  ** topic:  topic for setup/reset operation. (default: nil)
+  ** topic:  event identify topic for operation. (default: Time.now.iso8601(6))
   ** 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)
@@ -122,6 +122,9 @@ TimeScheduler#wait( topic = Time.now.iso8601(6),
   ** msec:  millisecond. 0..999. (default: nil), If msec is assigned, then other parameters are ignored.
     In detail, it can use "*" as wildcard.
 
+* Block Parameter:
+  ** time: event time. time object.
+
 === Get event topics.
 
 [source,ruby]
@@ -130,7 +133,7 @@ TimeScheduler#topics
 ----
 
 * Result:
-  ** array of topics.
+  ** topics: array of topics.
 
 * Parameter:
   ** none.
@@ -146,7 +149,7 @@ TimeScheduler#cancel( *topics )
   ** nil.
 
 * Parameter:
-  ** topic:  topic for stop operation.
+  ** topic:  topic for cancel operation.
 
 === Check activity.
 
@@ -197,4 +200,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/arimay
 
 == License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].

data/README.ja.adoc

@@ -1,6 +1,6 @@
 = TimeScheduler
 
-TimeScheduler は一度の/周期的なイベントスケジューラのライブラリのひとつ。
+一度の/周期的なイベントスケジューラのライブラリのひとつ。
 
 == 導入
 
@@ -98,17 +98,18 @@ TimeScheduler.new
 [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 )
+                    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.
+  ** ブロック引数あり: (Non-blocing Mode)
+    *** topic. イベント操作用識別トピック.
+  ** ブロック引数なし: (Blocking Mode)
+    *** time. イベント日時. Time オブジェクト.
 
 * Parameter:
+  ** topic: イベント操作用識別トピック (default: Time.now.iso8601(6))
   ** at:  日時. Time または String オブジェクト. (default: nil)
   ** cron:  分、時、日、月、曜パターンのセット. (default: nil)
   ** year:  年. 範囲制限なしは拒否される. (default: nil)
@@ -121,6 +122,9 @@ TimeScheduler#wait( topic = Time.now.iso8601(6),
   ** msec:  ミリ秒. 0..999. (default: nil), ミリ秒が指定されたとき, 他のパラメータは無視される.
     詳細では, ワイルドカードとして "*" を使用できる.
 
+* Block Parameter:
+  ** time: イベント日時. Time オブジェクト.
+
 === トピック名を得る.
 
 [source,ruby]
@@ -129,7 +133,7 @@ TimeScheduler#topics
 ----
 
 * Result:
-  ** array of topics.
+  ** topics: トピック配列.
 
 * Parameter:
   ** なし.
@@ -145,7 +149,7 @@ TimeScheduler#cancel( *topics )
   ** nil.
 
 * Parameter:
-  ** topic:  topic for stop operation.
+  ** topic:  取消対象のトピック.
 
 === 稼働中か調べる.
 
@@ -168,7 +172,7 @@ TimeScheduler#suspend
 ----
 
 * Result:
-  * nil.
+  ** nil.
 
 * Parameter:
   ** なし.

data/lib/time_scheduler/version.rb

@@ -1,3 +1,3 @@
 class TimeScheduler
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/time_scheduler.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["arima.yasuhiro@gmail.com"]
 
   spec.summary       = %q{ Library for simple event scheduler. }
-  spec.description   = %q{ TimeScheduler is yet another library for single/periodical event scheduler. }
+  spec.description   = %q{ Yet another library for single/periodical event scheduler. }
   spec.homepage      = "https://github.com/arimay/time_scheduler"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - arimay
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: " TimeScheduler is yet another library for single/periodical event scheduler. "
+description: " Yet another library for single/periodical event scheduler. "
 email:
 - arima.yasuhiro@gmail.com
 executables: []