yuuki 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3d8f9e2aa09bcc0a19661a400c20d5efbc522d5f116e7cc8fd0ce6cf9a7212
-  data.tar.gz: 5b1724b25b7ca140eda2e70eabf39c1a748aae79464199f2bcba06687afe6767
+  metadata.gz: 49851d0c15f259e4c54568ff173a45b9ae9316e25c4120fd3d12926f2560fcfb
+  data.tar.gz: f17a0f2ec8d4de59becb43c9f6e4de08de3b38534583250f1899da127576188c
 SHA512:
-  metadata.gz: 2de44a625ca13e0d1e290996b7e02ec30725ed5c463ce33894490a797eea4603242aa9e735479a8ef01613030815c6cd3f9bdb544760ca397d84fc52059875df
-  data.tar.gz: 351c404e1a6ab8939cb93f944da4d3ba4742a2e147a7e1ae59490a4f43b51a20f1c9df1df5aa78184131dc1b8fdf7c99d84ead60de1a3622efc6017e9477b89f
+  metadata.gz: a2ef440f3446c5d737abfa611f81731b06905189013c3220560a00a9f0e23d6422180a699934a9161711390a49d2e5bbf61f5178bd4316c6c1bcc2e1bad33889
+  data.tar.gz: 895d9874e7455840667ea75a90bb02c669d5b384a88b0412ee3bd4be58082465489317b483d2b8e28de81d6d2224f5819bb6af5b34fb1bb9a907b1db053e4164

data/lib/yuuki/caller.rb

@@ -5,37 +5,46 @@ require 'yuuki/runner'
 
 module Yuuki
   class Caller
+    # requires all the rb files in the given directory
+    # @param [String] require_dir directory
+    # @param [Boolean] recursive
     def self.require_dir(require_dir, recursive: false)
       Dir.glob(recursive ? "#{require_dir}/**/*.rb" : "#{require_dir}/*.rb"){|file| require file}
     end
 
+    # @param [Object] instances
     def initialize(*instances)
       @instances = Set.new
       @threads = []
       add(*instances)
     end
 
+    # adds instances to yuuki
+    # @param [Object] instances
     def add(*instances)
       instances.each do |instance|
         # create instance if class is given
         if instance.is_a?(Class)
           klass = instance
-          instance = instance.new
+          # check the klass is extended
+          raise Yuuki::Error, 'Runner instance must be extend Yuuki::Runner' unless klass.singleton_class.include?(Yuuki::Runner)
+          instance = instance.allocate
+          instance.instance_variable_set(:@yuuki, self)
+          instance.send(:initialize)
         else
-          klass = instance.class
+          # check the klass is extended
+          raise Yuuki::Error, 'Runner instance must be extend Yuuki::Runner' unless instance.class.singleton_class.include?(Yuuki::Runner)
+          # add @yuuki to the instance
+          instance.instance_variable_set(:@yuuki, self)
         end
 
-        # check the klass is extended
-        raise Yuuki::Error, 'Runner instance must be extend Yuuki::Runner' unless klass.singleton_class.include?(Yuuki::Runner)
-
-        # add @yuuki to the instance
-        instance.instance_variable_set(:@yuuki, self)
-
         # regist
         @instances << instance
       end
     end
 
+    # returns runners
+    # @return [Array<[Method, Hash<Symbol, Object>]>]
     def runners
       list = @instances.flat_map do |instance|
         methods = instance.class.instance_variable_get(:@yuuki_methods)
@@ -44,18 +53,30 @@ module Yuuki
       list.sort_by{|_method, meta| -(meta[:priority] || 0)}
     end
 
+    # runs all methods
+    # @param [Object] args arguments
     def run(**args, &block)
       run_internal(runners, args, &block)
     end
 
+    # runs all selected methods
+    # @param [Proc] proc_select
+    # @param [Object] args arguments
     def run_select(proc_select, **args, &block)
       run_internal(runners.select(&proc_select), args, &block)
     end
 
+    # runs all methods with the specified tags
+    # @param [Symbol] tags
+    # @param [Object] args arguments
     def run_tag(*tags, **args, &block)
       run_select(proc{|_method, meta| meta[:tags]&.intersect?(tags)}, **args, &block)
     end
 
+    # runs the specific method
+    # @param [Class, nil] klass
+    # @param [Symbol, nil] method_sig method name
+    # @param [Object] args arguments
     def run_method(klass, method_sig, **args, &block)
       select_proc = proc do |method, _meta|
         flag_klass = klass ? method.receiver.instance_of?(klass) : true
@@ -65,11 +86,14 @@ module Yuuki
       run_select(select_proc, **args, &block)
     end
 
+    # joins all runnning threads
     def join
       @threads.each(&:join)
       @threads.select!(&:alive?)
     end
 
+    # returns whether any thread is alive
+    # @return [Boolean]
     def alive?
       @threads.select!(&:alive?)
       !@threads.empty?

data/lib/yuuki/periodic.rb

@@ -5,23 +5,33 @@ require 'yuuki/runner'
 
 module Yuuki
   module Runner
-    # set interval to the method
-    def periodic(method, interval)
+    # sets interval to the method
+    # @param [Symbol] methods method names
+    # @param [Integer] interval
+    def periodic(*methods, interval)
       @yuuki_methods ||= {}
-      @yuuki_methods[method] ||= {}
-      @yuuki_methods[method][:periodic] = interval
+      methods.each do |method|
+        @yuuki_methods[method] ||= {}
+        @yuuki_methods[method][:periodic] = interval
+      end
     end
 
-    # set whether the method run at the first time
-    def first_run(method, enabled: true)
+    # sets whether the method run at the first time
+    # @param [Symbol] methods method names
+    # @param [Boolean] enabled
+    def first_run(*methods, enabled: true)
       @yuuki_methods ||= {}
-      @yuuki_methods[method] ||= {}
-      @yuuki_methods[method][:first_run] = enabled
+      methods.each do |method|
+        @yuuki_methods[method] ||= {}
+        @yuuki_methods[method][:first_run] = enabled
+      end
     end
   end
 end
 
 module Yuuki
+  # @attr_reader [Boolean] first_run
+  # @attr_reader [Float] current_time
   class PeriodicCaller < Caller
     attr_reader :first_run, :current_time
 
@@ -30,10 +40,16 @@ module Yuuki
       @first_run = true
     end
 
+    # sets error callback
+    # @yield [error]
+    # @yieldparam [Exception] error
     def on_error(&block)
       @on_error = block
     end
 
+    # runs the periodic caller
+    # @param [Numeric] gmtoff GMT Offset
+    # @param [Object] args arguments
     def run(gmtoff = Time.now.gmtoff, **args, &block)
       last_time = nil
       loop do

data/lib/yuuki/runner.rb

@@ -4,7 +4,8 @@ require 'set'
 
 module Yuuki
   module Runner
-    # add method
+    # adds methods to yuuki
+    # @param [Symbol] methods method names
     def add(*methods)
       @yuuki_methods ||= {}
       methods.each do |method|
@@ -13,7 +14,8 @@ module Yuuki
       end
     end
 
-    # delete method
+    # deletes methods from yuuki
+    # @param [Symbol] methods method names
     def delete(*methods)
       @yuuki_methods ||= {}
       methods.each do |method|
@@ -22,7 +24,9 @@ module Yuuki
       end
     end
 
-    # add tags to the method
+    # adds tags to the method
+    # @param [Symbol] method method name
+    # @param [Symbol] tags tag names
     def tag(method, *tags)
       @yuuki_methods ||= {}
       @yuuki_methods[method] ||= {}
@@ -30,7 +34,9 @@ module Yuuki
       @yuuki_methods[method][:tags].merge(tags)
     end
 
-    # enable threading to the method
+    # enables threading for the methods
+    # @param [Symbol] methods method names
+    # @param [Boolean] enabled
     def thread(*methods, enabled: true)
       @yuuki_methods ||= {}
       methods.each do |method|
@@ -39,7 +45,9 @@ module Yuuki
       end
     end
 
-    # set priority to the method
+    # sets priority to the method
+    # @param [Symbol] methods method names
+    # @param [Numeric] priority
     def priority(*methods, priority)
       @yuuki_methods ||= {}
       methods.each do |method|

data/lib/yuuki/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yuuki
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yuuki
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ishotihadus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt