tmtms_timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23aec65ce6dc7f5c2b6d4159d37233880ad036b20279cf72397a0e7418e2142c
+  data.tar.gz: '009f5abbf0e98ad066ae26bd024ad946d2998a4d31f557859e89d5f65411bfa3'
+SHA512:
+  metadata.gz: 10432a3fe57222646eb21f312af33fce7666b4a33e3af78f46ebd3e89e901437ce52bf3e424ca34ca199d628e76a4d90402f1944b0699a2ec5414acec8436f6d
+  data.tar.gz: a01bd1219031563cbab3169db528686b63f88dfea75a236ec7b08ae52034cea656b12f94a2ad6a994d3457bc6f6ce406e64dee05ee13c6fb67257e499dabf92d

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tmtms_timer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TOMITA Masahiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Tmtms::Timer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmtms_timer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tmtms-timer
+
+## Usage
+
+```ruby
+require 'tmtms_timer'
+timer = Tmtms::Timer.new
+timer.set(10){puts "hoge"}
+sleep 20
+# puts "hoge" after 10 seconds
+timer.at(Time.local(2022,7,18,12,34,56)){puts "fuga"}
+sleep
+# puts "fuga" at 2022-07-18 12:34:56
+```
+
+To cancel timer:
+
+```ruby
+id = timer.set(10){puts "hoge"}
+timer.cancel(id)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/tmtms/timer.rb

@@ -0,0 +1,71 @@
+require 'io/wait'
+
+module Tmtms
+  # Usage
+  # @example
+  #   t = Tmtms::Timer.new
+  #   t.set(1){puts "hoge"}
+  #   sleep 5  # puts "hoge" after 1 second.
+  class Timer
+    Job = Struct.new(:id, :time, :block, keyword_init: true)
+
+    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
+    def set(sec, &block)
+      at(Time.now + sec, &block)
+    end
+
+    # execute block at the specified time.
+    # @param time [Time]
+    # @return [Integer] timer ID
+    def at(time, &block)
+      @mutex.synchronize do
+        @id += 1
+        @jobs.push Job.new(id: @id, time: time, block: block)
+        @jobs.sort_by!(&:time)
+      end
+      @wfd.syswrite('.')
+      @id
+    end
+
+    # cancle the timer.
+    # @param id [Integer] timer ID
+    def cancel(id)
+      @mutex.synchronize do
+        @jobs.delete_if{|job| job.id == id}
+      end
+    end
+
+    private
+
+    def do_loop
+      Thread.new do
+        loop do
+          tout = @mutex.synchronize do
+            @jobs.empty? ? nil : @jobs[0].time - Time.now
+          end
+          tout = 0 if tout&.negative?
+          if @rfd.wait_readable(tout)
+            @rfd.sysread(1)
+          end
+          loop do
+            block = @mutex.synchronize do
+              @jobs.shift.block if @jobs[0] && @jobs[0].time <= Time.now
+            end
+            break unless block
+            block.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tmtms_timer/version.rb

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

data/lib/tmtms_timer.rb

@@ -0,0 +1,2 @@
+require_relative "tmtms/timer"
+require_relative "tmtms_timer/version"

data/sig/tmtms_timer.rbs

@@ -0,0 +1,4 @@
+module TmtmsTimer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/tmtms_timer.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/tmtms_timer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "tmtms_timer"
+  spec.version = TmtmsTimer::VERSION
+  spec.authors = ["TOMITA Masahiro"]
+  spec.email = ["tommy@tmtm.org"]
+
+  spec.summary = "Timer"
+  spec.description = "Timer"
+  spec.homepage = "https://gitlab.com/tmtms/tmtms_timer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://gitlab.com/tmtms/tmtms_timer/blob/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: tmtms_timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOMITA Masahiro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-18 00:00:00.000000000 Z
+dependencies: []
+description: Timer
+email:
+- tommy@tmtm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tmtms/timer.rb
+- lib/tmtms_timer.rb
+- lib/tmtms_timer/version.rb
+- sig/tmtms_timer.rbs
+- tmtms_timer.gemspec
+homepage: https://gitlab.com/tmtms/tmtms_timer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/tmtms/tmtms_timer
+  source_code_uri: https://gitlab.com/tmtms/tmtms_timer
+  changelog_uri: https://gitlab.com/tmtms/tmtms_timer/blob/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Timer
+test_files: []