yuuki 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e60a7be44a24d27a3340b1a0bf86df33927e32cd855dd9b99df4faa2bc1685
-  data.tar.gz: '055829249f336c32e1f88f73984bbd465c037ad6b6edb5a3e2bce68139b25976'
+  metadata.gz: fbc6115f9c7818a9c171c7c8928321bdd7c5fd737ce7f1cbed4024c56dfd2d91
+  data.tar.gz: 148536d6a0e91a93994f12cb4672b8cdafe1e77e476b89532455bbcf47f3aaa4
 SHA512:
-  metadata.gz: b44ff4617ffaaf0e18e0654d67113308518b04575bc74ced15b3afa1418c479e5a577fcbac30de3aa9ff32a6bdcf007c4669a742df0da03a5ce684f271936a58
-  data.tar.gz: 9decda81bcfc32138478d91015590d0da49734e7e3d246a87bc40101daa7691a883118f8ad09d889b94dd9ce225f286a40635c2f94a6b84d3b1035431c8064e5
+  metadata.gz: 89b3a2e35810e21a94a096debaa2d709806702340ef23a0fcbe55cc73656cf263f8bef4ddbc4fbacf47c62516821dc94d11ad23948bdb0911bfcb49cb0271527
+  data.tar.gz: 7b67f83e432c5da9d028fbd417c2f08b6c4007dc0bdb31e836c4ad4aa691c98f3c64d02e54b0c9c8f2141d40f64332d97e71b6f3f5ea8559442a1b796b57828b

data/README.md

@@ -21,7 +21,11 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require 'yuuki'
+
 class HogeClass
+  extend Yuuki::Runner
+
   add :a
   def a
     puts 'a'

data/lib/yuuki/caller.rb

@@ -5,37 +5,46 @@ require 'yuuki/runner'
 
 module Yuuki
   class Caller
-    def self.require_dir(_dir, recursive: false)
+    # 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,38 @@ module Yuuki
       list.sort_by{|_method, meta| -(meta[:priority] || 0)}
     end
 
+    # returns all tags defined
+    def tags
+      @instances.flat_map do |instance|
+        methods = instance.class.instance_variable_get(:@yuuki_methods)
+        methods.select{|_sig, meta| meta[:enabled]}.flat_map{|_sig, meta| meta[:tags]}
+      end
+    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 +94,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.1'
+  VERSION = '0.1.4'
 end

data/sig/yuuki/caller.rbs

@@ -0,0 +1,25 @@
+# TypeProf 0.21.2
+
+# Classes
+module Yuuki
+  class Caller
+    @instances: Set[untyped]
+    @threads: Array[Thread]
+
+    def self.require_dir: (String require_dir, ?recursive: bool) -> void
+    def initialize: (*untyped instances) -> void
+    def add: (*untyped instances) -> void
+    def runners: -> Array[untyped]
+    def run: (**untyped) -> void
+    def run_select: (^(Method, Hash[Symbol, untyped]) -> bool proc_select, **untyped) -> void
+    def run_tag: (*Symbol tags, **untyped) -> void
+    def run_method: (Class klass, Symbol method_sig, **untyped) -> void
+    def join: -> void
+    def alive?: -> bool
+    alias running? alive?
+
+    private
+    def run_internal: (Array[untyped] runners, Hash[Symbol, untyped] args) -> void
+    def run_method_internal: (Method method, Hash[Symbol, untyped] args) -> void
+  end
+end

data/sig/yuuki/error.rbs

@@ -0,0 +1,7 @@
+# TypeProf 0.21.2
+
+# Classes
+module Yuuki
+  class Error < StandardError
+  end
+end

data/sig/yuuki/periodic.rbs

@@ -0,0 +1,19 @@
+# TypeProf 0.21.2
+
+# Classes
+module Yuuki
+  module Runner
+    def periodic: (Symbol method, Integer interval) -> void
+    def first_run: (Symbol method, ?enabled: bool) -> void
+  end
+
+  class PeriodicCaller < Caller
+    @on_error: Proc
+
+    attr_reader first_run: bool
+    attr_reader current_time: Float
+    def initialize: (*untyped instances) -> void
+    def on_error: {(Exception) -> void} -> void
+    def run: (?Integer gmtoff, **untyped) -> void
+  end
+end

data/sig/yuuki/runner.rbs

@@ -0,0 +1,14 @@
+# TypeProf 0.21.2
+
+# Classes
+module Yuuki
+  module Runner
+    @yuuki_methods: Hash[Symbol, Hash[Symbol, untyped]]
+
+    def add: (*Symbol methods) -> void
+    def delete: (*Symbol methods) -> void
+    def tag: (Symbol method, *Symbol tags) -> void
+    def thread: (*Symbol methods, ?enabled: bool) -> void
+    def priority: (*Symbol methods, Numeric priority) -> void
+  end
+end

data/sig/yuuki/version.rbs

@@ -0,0 +1,6 @@
+# TypeProf 0.21.2
+
+# Classes
+module Yuuki
+  VERSION: String
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yuuki
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Ishotihadus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-05-01 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
@@ -72,6 +73,11 @@ files:
 - lib/yuuki/periodic.rb
 - lib/yuuki/runner.rb
 - lib/yuuki/version.rb
+- sig/yuuki/caller.rbs
+- sig/yuuki/error.rbs
+- sig/yuuki/periodic.rbs
+- sig/yuuki/runner.rbs
+- sig/yuuki/version.rbs
 - yuuki.gemspec
 homepage: https://github.com/ishotihadus/yuuki
 licenses: