time_scheduler 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd3e563565d592dbc78bad3a0c306fa85817dad4b17a615147c04c0daca0fa0
-  data.tar.gz: 324db4ac4818cf66de0f31922f5478892ce510caa791dd904158a2639256d91d
+  metadata.gz: 0e58dc40f89e8573c41d5817583a7146d359d70077761dbbe92fadd6eb8096b3
+  data.tar.gz: 73d28d42cea43c9b96fae6c65b3d032ad2f4c29c5e00396b245e40cf4f872229
 SHA512:
-  metadata.gz: 125b52b655af7eedb23216fd870d19a1a52575afd112efff44636e299b134c31b45b31bb2056f8bc0596fdc6a18df538e3cbb2c97e9beba0fd7510c3159433a7
-  data.tar.gz: 50f132d18ea8faa5cf0bdf7da4e1e65642b13182e0501c3bd1c5a4a071a970bf6395c48010d8648f031b89045cccab56d9ec69dde0290a9afe41b2d3e5aeb312
+  metadata.gz: 469f48427b2a4dc21d4ce6a52f6d744274befe725cad72f79e5996c459419b0c9c4f30d3dcabc5926e012e41f95df4197978c4b7d77b0767b21fee7428edbeef
+  data.tar.gz: 560d58d6fc0ad2e8f54e50df8ceacd0839f37c85a86dab3de68cb3d99660cc74d13d2d8f70494012cb51f12bed5c4dda994d30fb86ea1bf517ece3280cc48638

data/README.adoc

@@ -2,6 +2,15 @@
 
 Yet another library for single/periodical event scheduler.
 
+== Features
+
+* A thread based scheduler that runs once or periodically at a specified datetime.
+* The condition is specified by a format such as crontab or by keyword argument.
+* Time can be specified in less than 1 second. However, the behavior depends on the environment.
+* Suspend/resume function.
+* Function to change the datetime conditions during execution.
+* Runs only once within the specified timelimit.
+
 == Installation
 
 Add this line to your application's Gemfile:
@@ -78,6 +87,28 @@ end
 sleep
 ----
 
+=== Example 3
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+(0..4).each do
+  p [Time.now.iso8601(3), :cycle]
+  Scheduler.first_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :first]
+  end
+  Scheduler.last_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :last]
+  end
+  sleep 1
+end
+
+sleep
+----
+
 == Reference
 
 === Create a new TimeScheduler.
@@ -98,7 +129,8 @@ 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,
+                    at: nil, cron: nil, year: nil, month: nil, day: nil, wday: nil,
+                    hour: nil, min: nil, sec: 0, msec: nil,
                     &block )
 ----
 
@@ -121,6 +153,7 @@ TimeScheduler#wait( topic = Time.now.iso8601(6),
   ** 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.
+  ** block:  Contents to be executed at a datetime that match the condition.
 
 * Block Parameter:
   ** time: event time. time object.
@@ -190,6 +223,40 @@ TimeScheduler#resume
 * Parameter:
   ** none.
 
+=== Invoke the block only once at the beginning, and ignoring recalls within the time limit.
+
+[source,ruby]
+----
+TimeScheduler#first_only( ident = nil, timeout: 1, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** ident:     Additional Identifier.
+  ** timeout:   Monitoring time limit (sec).
+
+* Block Parameter:
+  ** none.
+
+=== When there is no recall within the time limit, invoke the block only once at the end.
+
+[source,ruby]
+----
+TimeScheduler#last_only( ident = nil, timeout: 1, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** ident:     Additional Identifier.
+  ** timeout:   Monitoring time limit (sec).
+
+* Block Parameter:
+  ** none.
+
 == Caution
 
 Because it is calculated in local time, it does not work as expected when switching to daylight saving time.
@@ -201,3 +268,5 @@ 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 http://opensource.org/licenses/MIT[MIT License].
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/README.ja.adoc

@@ -2,6 +2,15 @@
 
 一度の/周期的なイベントスケジューラのライブラリのひとつ。
 
+== 特徴
+
+* 条件指定された日時に一度だけまたは周期的に動作するスレッドベースのスケジューラ.
+* 条件は crontab のような書式や、キーワード引数で指定する.
+* 時刻は1秒未満で指定することが可能. ただし、挙動は環境依存.
+* 一時停止/再開機能.
+* 実行中の日時条件変更機能.
+* 指定された制限時間内に一度だけ実行する.
+
 == 導入
 
 アプリの Gemfile にこの行を追加
@@ -78,6 +87,28 @@ end
 sleep
 ----
 
+=== Example 3
+
+[source,ruby]
+----
+require  "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+(0..4).each do
+  p [Time.now.iso8601(3), :cycle]
+  Scheduler.first_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :first]
+  end
+  Scheduler.last_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :last]
+  end
+  sleep 1
+end
+
+sleep
+----
+
 == リファレンス
 
 === 新たな TimeScheduler を作成する.
@@ -98,7 +129,8 @@ 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,
+                    at: nil, cron: nil, year: nil, month: nil, day: nil, wday: nil,
+                    hour: nil, min: nil, sec: 0, msec: nil,
                     &block )
 ----
 
@@ -121,6 +153,7 @@ TimeScheduler#wait( topic = Time.now.iso8601(6),
   ** sec:  秒. 0..59. (default: 0)
   ** msec:  ミリ秒. 0..999. (default: nil), ミリ秒が指定されたとき, 他のパラメータは無視される.
     詳細では, ワイルドカードとして "*" を使用できる.
+  ** block:  条件に適合する日時に実行する内容.
 
 * Block Parameter:
   ** time: イベント日時. Time オブジェクト.
@@ -190,6 +223,40 @@ TimeScheduler#resume
 * Parameter:
   ** なし.
 
+=== 最初に一度だけブロックを呼び出して、制限時間内の再呼び出しは無視する.
+
+[source,ruby]
+----
+TimeScheduler#first_only( ident = nil, timeout: 1, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** ident:     追加識別子.
+  ** timeout:   監視時間制限（秒）.
+
+* Block Parameter:
+  ** なし.
+
+=== 制限時間内に再呼び出しがないとき、最後に一度だけブロックを呼び出す.
+
+[source,ruby]
+----
+TimeScheduler#last_only( ident = nil, timeout: 1, &block )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** ident:     追加識別子.
+  ** timeout:   監視時間制限（秒）.
+
+* Block Parameter:
+  ** なし.
+
 == 注意
 
 地域時刻で計算しているため、夏時間の切り替わりにおいて期待しない挙動となる.
@@ -201,3 +268,5 @@ TimeScheduler#resume
 == ライセンス
 
 この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/Rakefile

@@ -8,12 +8,12 @@ task :default => :spec
 
 class Bundler::GemHelper
 
-  def git_archive( dir = "../#{Time.now.strftime("%Y%m%d")}" )
+  def git_archive( dir = "../zip" )
     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 )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't archive gem,"  unless  code == 0
 
     Bundler.ui.confirm "#{name} #{version} archived to #{dest_path}."
@@ -23,11 +23,11 @@ class Bundler::GemHelper
     ver  =  version.to_s
 
     cmnd  =  "git push origin  #{ver} "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git push origin."  unless  code == 0
 
     cmnd  =  "git push "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git push."         unless  code == 0
 
     Bundler.ui.confirm "Git Push #{ver}."
@@ -43,15 +43,15 @@ class Bundler::GemHelper
     end
 
     cmnd  =  "git add  #{version_pathname} "
-    out, code = sh_with_status( cmnd )
+    _, 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 )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git commit."  unless  code == 0
 
     cmnd  =  "git tag        #{new_version} "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git tag."          unless  code == 0
 
     Bundler.ui.confirm "Update Tags to #{new_version}."
@@ -80,14 +80,14 @@ Bundler::GemHelper.new(Dir.pwd).instance_eval do
 
   desc "Update Version Minor"
   task 'minor' do
-    major, minor, tiny  =  version.to_s.split('.')
+    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('.')
+    major, _minor, _tiny  =  version.to_s.split('.')
     new_version  =  [major.to_i + 1, 0, 0].join('.')
     update_version( new_version )
   end

data/lib/time_scheduler/scheduler.rb

@@ -179,7 +179,35 @@ class TimeScheduler
     end
   end
 
+  class Counter
+    def initialize
+      @count  =  0
+      @mutex  =  Mutex.new
+    end
+
+    def incr
+      @mutex.synchronize do
+        @count  +=  1
+      end
+    end
+
+    def decr
+      @mutex.synchronize do
+        @count  -=  1    if  @count > 0
+        @count
+      end
+    end
+
+    def reset
+      @mutex.synchronize do
+        @count  =  0
+      end
+    end
+  end
+
   def initialize
+    @first_counter  =  Hash.new{|h,k| h[k] = Counter.new }
+    @last_counter   =  Hash.new{|h,k| h[k] = Counter.new }
   end
 
   def scheduler
@@ -222,5 +250,25 @@ class TimeScheduler
     TimeScheduler::Schedule.resume
   end
 
+  def first_only( ident = nil, timeout: 1, &block )
+    key  =  [ caller[0], ident.to_s ].join(":")
+    count  =  @first_counter[key].incr
+    block.call    if count == 1
+    ::Thread.start( key ) do |key|
+      ::Kernel.sleep  timeout
+      @first_counter[key].decr
+    end
+  end
+
+  def last_only( ident = nil, timeout: 1, &block )
+    key  =  [ caller[0], ident.to_s ].join(":")
+    @last_counter[key].incr
+    ::Thread.start( key ) do |key|
+      ::Kernel.sleep  timeout
+      count  =  @last_counter[key].decr
+      block.call    if count == 0
+    end
+  end
+
 end
 

data/lib/time_scheduler/version.rb

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

data/sample/base_h.rb

@@ -0,0 +1,17 @@
+require "time_scheduler"
+
+Scheduler  =  TimeScheduler.new
+
+(0..4).each do
+  p [Time.now.iso8601(3), :cycle]
+  Scheduler.first_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :first]
+  end
+  Scheduler.last_only( timeout: 10 ) do
+    p [Time.now.iso8601(3), :last]
+  end
+  sleep 1
+end
+
+Scheduler.wait( at: Time.now + 10 )
+p [Time.now.iso8601(3), :quit]

data/time_scheduler.gemspec

@@ -11,9 +11,8 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{ Library for simple event scheduler. }
   spec.description   = %q{ Yet another library for single/periodical event scheduler. }
   spec.homepage      = "https://github.com/arimay/time_scheduler"
+  spec.license       = "MIT"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - arimay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: time_cursor
@@ -88,9 +88,11 @@ files:
 - sample/base_e.rb
 - sample/base_f.rb
 - sample/base_g.rb
+- sample/base_h.rb
 - time_scheduler.gemspec
 homepage: https://github.com/arimay/time_scheduler
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []