raktr 0.0.1

data/lib/raktr/tasks/base.rb

@@ -0,0 +1,57 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+class Tasks
+
+# {#call Callable} task.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Base
+
+    # @return   [Tasks]
+    #   List managing this task.
+    attr_accessor :owner
+
+    # @param    [Block] task
+    def initialize( &task )
+        fail ArgumentError, 'Missing block.' if !block_given?
+
+        @task = task
+    end
+
+    # Calls the {#initialize configured} task and passes `args` and self` to it.
+    #
+    # @abstract
+    def call( *args )
+        fail NotImplementedError
+    end
+
+    # {Tasks#delete Removes} the task from the {#owner}'s list.
+    def done
+        @owner.delete self
+    end
+
+    def to_proc
+        @task
+    end
+
+    def hash
+        @task.hash
+    end
+
+    private
+
+    def call_task( *args )
+        @task.call *([self] + args)
+    end
+
+end
+
+end
+end

data/lib/raktr/tasks/delayed.rb

@@ -0,0 +1,33 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+class Tasks
+
+# @note {#interval Time} accuracy cannot be guaranteed.
+#
+# {Base Task} occurring after {#interval} seconds.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Delayed < Periodic
+
+    # @note Will call {#done} right after.
+    #
+    # @return   [Object, nil]
+    #   Return value of the configured task or `nil` if it's not
+    #   {#interval time} yet.
+    def call( *args )
+        return if !call?
+
+        call_task( *args ).tap { done }
+    end
+
+end
+
+end
+end

data/lib/raktr/tasks/one_off.rb

@@ -0,0 +1,30 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+class Tasks
+
+# {Base Task} occurring at the next tick and then marking itself as {#done}.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class OneOff < Base
+
+    # Performs the task and marks it as {#done}.
+    #
+    # @return   [Object]
+    #   Return value of the task.
+    def call( *args )
+        call_task( *args )
+    ensure
+        done
+    end
+
+end
+
+end
+end

data/lib/raktr/tasks/periodic.rb

@@ -0,0 +1,58 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+class Tasks
+
+# @note {#interval Time} accuracy cannot be guaranteed.
+#
+# {Base Task} occurring every {#interval} seconds.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Periodic < Persistent
+
+    # @return   [Float]
+    attr_reader :interval
+
+    # @param    [Float] interval
+    #   Needs to be greater than `0.0`.
+    # @param    [#call] task
+    def initialize( interval, &task )
+        interval = interval.to_f
+        fail ArgumentError, 'Interval needs to be greater than 0.' if interval <= 0
+
+        super( &task )
+
+        @interval = interval
+        calculate_next
+    end
+
+    # @return   [Object, nil]
+    #   Return value of the configured task or `nil` if it's not
+    #   {#interval time} yet.
+    def call( *args )
+        return if !call?
+        calculate_next
+
+        super( *args )
+    end
+
+    private
+
+    def call?
+        Time.now >= @next
+    end
+
+    def calculate_next
+        @next = Time.now + @interval
+    end
+
+end
+
+end
+end

data/lib/raktr/tasks/persistent.rb

@@ -0,0 +1,29 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+class Tasks
+
+# {Base Task} which does not cancel itself once called and occurs at every
+# tick.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Persistent < Base
+
+    # Performs the task and marks it as {#done}.
+    #
+    # @return   [Object]
+    #   Return value of the task.
+    def call( *args )
+        call_task( *args )
+    end
+
+end
+
+end
+end

data/lib/raktr/tasks.rb

@@ -0,0 +1,105 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+require 'mutex_m'
+
+require_relative 'tasks/base'
+require_relative 'tasks/persistent'
+require_relative 'tasks/one_off'
+require_relative 'tasks/periodic'
+require_relative 'tasks/delayed'
+
+class Raktr
+
+# {Tasks::Base Task} list.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Tasks
+    include Mutex_m
+
+    def initialize
+        super
+
+        @tasks = []
+    end
+
+    # @note Only {Base#hash unique} tasks will be included.
+    # @note Will assign `self` as the task's {Base#owner owner}.
+    #
+    # @param    [Base]  task
+    #   Task to add to the list.
+    # @return   [Tasks] `self`
+    def <<( task )
+        synchronize do
+            task.owner = self
+            @tasks << task
+        end
+
+        self
+    end
+
+    # @param    [Base]  task
+    #   Task to check.
+    # @return   [Bool]
+    def include?( task )
+        @tasks.include? task
+    end
+
+    # @param    [Base]  task
+    #   Task to remove from the list.
+    # @return   [Base,nil]
+    #   The task if it was included, `nil` otherwise.
+    def delete( task )
+        synchronize do
+            task = @tasks.delete( task )
+            task.owner = nil if task
+            task
+        end
+    end
+
+    # @return   [Integer]
+    def size
+        @tasks.size
+    end
+
+    # @return   [Bool]
+    def empty?
+        @tasks.empty?
+    end
+
+    # @return   [Bool]
+    def any?
+        !empty?
+    end
+
+    # Removes all tasks.
+    #
+    # @return   [Tasks] `self`
+    def clear
+        synchronize do
+            @tasks.clear
+        end
+
+        self
+    end
+
+    # {Base#call Calls} all tasks.
+    #
+    # @return   [Tasks] `self`
+    def call( *args )
+        @tasks.dup.each { |t| t.call *args }
+        self
+    end
+
+    def hash
+        @tasks.hash
+    end
+
+end
+
+end

data/lib/raktr/version.rb

@@ -0,0 +1,13 @@
+=begin
+
+    This file is part of the Raktr project and may be subject to
+    redistribution and commercial restrictions. Please see the Raktr
+    web site for more information on licensing and terms of use.
+
+=end
+
+class Raktr
+
+    VERSION = '0.0.1'
+
+end