tmtms_timer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23aec65ce6dc7f5c2b6d4159d37233880ad036b20279cf72397a0e7418e2142c
-  data.tar.gz: '009f5abbf0e98ad066ae26bd024ad946d2998a4d31f557859e89d5f65411bfa3'
+  metadata.gz: 7df92cefdc4388b0d077292793e1a4753c04a99d8028850d4cd8789af316c86d
+  data.tar.gz: dc09b781bb90b0bcd7042cc4864907bfc54e85437641c5b59282638b66d3501e
 SHA512:
-  metadata.gz: 10432a3fe57222646eb21f312af33fce7666b4a33e3af78f46ebd3e89e901437ce52bf3e424ca34ca199d628e76a4d90402f1944b0699a2ec5414acec8436f6d
-  data.tar.gz: a01bd1219031563cbab3169db528686b63f88dfea75a236ec7b08ae52034cea656b12f94a2ad6a994d3457bc6f6ce406e64dee05ee13c6fb67257e499dabf92d
+  metadata.gz: bbee610f65aac8c6914181fea649029a7ffafc95bb5aa194ead05f40824bd82cebef53408fa82edef2545d51e3b5567ac1d4c11c2faf42efc45fa1aed2a20a24
+  data.tar.gz: 425a26c113c2ada50378a6a8f92f5894e2c75ab1c6cd7e6484811488072cd34f49426125bd35e6e6d3edff13c497506a6abcfadca7f8a405fc6ac994803f9baf

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2022-07-18
+
+- set(), at(), cancel() returns Job.
 
 ## [0.1.0] - 2022-07-18
 

data/README.md

@@ -32,8 +32,8 @@ sleep
 To cancel timer:
 
 ```ruby
-id = timer.set(10){puts "hoge"}
-timer.cancel(id)
+job = timer.set(10){puts "hoge"}
+job.cancel
 ```
 
 ## License

data/lib/tmtms/timer.rb

@@ -7,41 +7,57 @@ module Tmtms
   #   t.set(1){puts "hoge"}
   #   sleep 5  # puts "hoge" after 1 second.
   class Timer
-    Job = Struct.new(:id, :time, :block, keyword_init: true)
+    class Job
+      attr_reader :time, :block
+
+      # @param timer [Tmtms::Timer]
+      # @param time [Time]
+      # @param block [Proc]
+      def initialize(timer:, time:, block:)
+        @timer, @time, @block = timer, time, block
+      end
+
+      # cancel this job.
+      # @return [self]
+      def cancel
+        @timer.cancel(self)
+      end
+    end
 
     def initialize
       @rfd, @wfd = IO.pipe
       @jobs = []  #=> [job, ...]
       @mutex = Mutex.new
-      @id = 0
       do_loop
     end
 
     # execute block after sec seconds.
     # @param sec [Numeric]
-    # @return [Integer] timer ID
+    # @return [Tmtms::Timer::Job] timer job
     def set(sec, &block)
       at(Time.now + sec, &block)
     end
 
     # execute block at the specified time.
     # @param time [Time]
-    # @return [Integer] timer ID
+    # @return [Tmtms::Timer::Job] timer job
     def at(time, &block)
       @mutex.synchronize do
-        @id += 1
-        @jobs.push Job.new(id: @id, time: time, block: block)
+        job = Job.new(timer: self, time: time, block: block)
+        @jobs.push job
         @jobs.sort_by!(&:time)
+        @wfd.syswrite('.')
+        return job
       end
-      @wfd.syswrite('.')
-      @id
     end
 
     # cancle the timer.
-    # @param id [Integer] timer ID
-    def cancel(id)
+    # @param job [Tmtms::Timer::Job] timer job
+    # @return [Tmtms::Timer::Job] if the job was available.
+    # @return [nil] if the job was not available.
+    def cancel(job)
       @mutex.synchronize do
-        @jobs.delete_if{|job| job.id == id}
+        @jobs.delete(job)
       end
     end
 

data/lib/tmtms_timer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TmtmsTimer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmtms_timer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TOMITA Masahiro