goru 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d57e96ef8a7bef1abaf43db02e461af067b60238728379b9a5e48cea91c2f9
-  data.tar.gz: feba54796b8120fe753014a9f904c29c3e379ef50910e6cfde0507ca85d4d695
+  metadata.gz: a1bad5e42a7c84e99e1e75651c62f0c2459497aacafea49319279d8de5251c9c
+  data.tar.gz: 4c6a172e82892ce4301482d42fe03c59b299e6409efbc1bd620aacaf2bc24301
 SHA512:
-  metadata.gz: c65b2730c39ec515c1ab44ee83909c4ea93c53072cb33887aebafaedfeb0131a37c0b3d1bb323b79ce21acdc5248be3fefa3d19c007c9aa5c56217e9a7195541
-  data.tar.gz: f4d7f05d63ad6ce781053946fa0d0e22ec9562b7e20fed83bca8f84441b4f6ec9c30b8b4b79fa7435cc93a76425ec793b6db7ac334aba0fddac84320777226b3
+  metadata.gz: 9dbcc82cce20117208062ac716097982b96ad59bec1fa6a3326f5703ea47529c7afb2ddf9531d81b0b237d77a13aab253494c74da5c8312eb166bde150525707
+  data.tar.gz: a6259dac811fabfd7791319d09e3ddf228b8b8a7f3f73e829fcd1b29630eae52e2c503a5682c7b3ac269068464947da2254343e0f0743ee0111284f87d9a284c

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [v0.4.0](https://github.com/bryanp/goru/releases/tag/v0.4.0)
+
+*released on 2023-07-16*
+
+  * `add` [#22](https://github.com/bryanp/goru/pull/22) Add reactor as a reader to `Goru::Routine` ([bryanp](https://github.com/bryanp))
+  * `add` [#21](https://github.com/bryanp/goru/pull/21) Improve statuses ([bryanp](https://github.com/bryanp))
+  * `add` [#20](https://github.com/bryanp/goru/pull/20) Add observer pattern to routines ([bryanp](https://github.com/bryanp))
+  * `add` [#19](https://github.com/bryanp/goru/pull/19) Add ability to pause and resume a routine ([bryanp](https://github.com/bryanp))
+  * `chg` [#18](https://github.com/bryanp/goru/pull/18) Remove the unused `observer` writer from `Goru::Channel` ([bryanp](https://github.com/bryanp))
+
 ## [v0.3.0](https://github.com/bryanp/goru/releases/tag/v0.3.0)
 
 *released on 2023-07-10*

data/lib/goru/bridge.rb

@@ -11,6 +11,18 @@ module Goru
       update_status
     end
 
+    # [public]
+    #
+    STATUS_READY = :ready
+
+    # [public]
+    #
+    STATUS_FINISHED = :finished
+
+    # [public]
+    #
+    STATUS_IDLE = :idle
+
     # [public]
     #
     attr_reader :status
@@ -30,9 +42,9 @@ module Goru
 
     private def status_changed
       case @status
-      when :ready
+      when :STATUS_READY
         @routine.bridged
-      when :finished
+      when :STATUS_FINISHED
         @channel.remove_observer(self)
         @routine.unbridge
       end

data/lib/goru/bridges/readable.rb

@@ -6,14 +6,14 @@ module Goru
   module Bridges
     class Readable < Bridge
       private def update_status
-        status = if @routine.status == :finished
-          :finished
+        status = if @routine.status == Routine::STATUS_FINISHED
+          Bridge::STATUS_FINISHED
         elsif @channel.full?
-          :idle
+          Bridge::STATUS_IDLE
         elsif @channel.closed?
-          :finished
+          Bridge::STATUS_FINISHED
         else
-          :ready
+          Bridge::STATUS_READY
         end
 
         set_status(status)

data/lib/goru/bridges/writable.rb

@@ -6,14 +6,14 @@ module Goru
   module Bridges
     class Writable < Bridge
       private def update_status
-        status = if @routine.status == :finished
-          :finished
+        status = if @routine.status == Routine::STATUS_FINISHED
+          Bridge::STATUS_FINISHED
         elsif @channel.any?
-          :ready
+          Bridge::STATUS_READY
         elsif @channel.closed?
-          :finished
+          Bridge::STATUS_FINISHED
         else
-          :idle
+          Bridge::STATUS_IDLE
         end
 
         set_status(status)

data/lib/goru/channel.rb

@@ -11,10 +11,6 @@ module Goru
       @observers = Set.new
     end
 
-    # [public]
-    #
-    attr_writer :observer
-
     # [public]
     #
     def <<(message)

data/lib/goru/reactor.rb

@@ -21,6 +21,22 @@ module Goru
       @commands = []
     end
 
+    # [public]
+    #
+    STATUS_RUNNING = :running
+
+    # [public]
+    #
+    STATUS_FINISHED = :finished
+
+    # [public]
+    #
+    STATUS_IDLE = :idle
+
+    # [public]
+    #
+    STATUS_STOPPED = :stopped
+
     # [public]
     #
     attr_reader :status
@@ -28,7 +44,7 @@ module Goru
     # [public]
     #
     def run
-      set_status(:running)
+      set_status(STATUS_RUNNING)
 
       until @stopped
         tick
@@ -36,7 +52,7 @@ module Goru
     ensure
       @timers.cancel
       @selector.close
-      set_status(:finished)
+      set_status(STATUS_FINISHED)
     end
 
     private def tick
@@ -81,10 +97,10 @@ module Goru
       interval = @timers.wait_interval
 
       if interval.nil? && @routines.empty?
-        set_status(:idle)
+        set_status(STATUS_IDLE)
         @scheduler.signal
         wait
-        set_status(:running)
+        set_status(STATUS_RUNNING)
       elsif interval.nil?
         wait unless @routines.any?(&:ready?)
       elsif interval > 0
@@ -103,7 +119,7 @@ module Goru
     # [public]
     #
     def finished?
-      @status == :idle || @status == :stopped
+      @status == STATUS_IDLE || @status == STATUS_STOPPED
     end
 
     # [public]

data/lib/goru/routine.rb

@@ -20,14 +20,35 @@ module Goru
     def initialize(state = nil, &block)
       @state = state
       @block = block
-      set_status(:ready)
+      @observers = Set.new
+      set_status(STATUS_READY)
       @result, @error, @reactor = nil
       @debug = true
     end
 
     # [public]
     #
-    attr_reader :state, :status, :error
+    STATUS_READY = :ready
+
+    # [public]
+    #
+    STATUS_FINISHED = :finished
+
+    # [public]
+    #
+    STATUS_ERRORED = :errored
+
+    # [public]
+    #
+    STATUS_IDLE = :idle
+
+    # [public]
+    #
+    STATUS_PAUSED = :paused
+
+    # [public]
+    #
+    attr_reader :state, :status, :error, :reactor
 
     # [public]
     #
@@ -46,7 +67,7 @@ module Goru
       @block.call(self)
     rescue => error
       @error = error
-      set_status(:errored)
+      set_status(STATUS_ERRORED)
       trigger(error)
     end
 
@@ -54,7 +75,7 @@ module Goru
     #
     def finished(result = nil)
       @result = result
-      set_status(:finished)
+      set_status(STATUS_FINISHED)
 
       throw :continue
     end
@@ -69,7 +90,7 @@ module Goru
     #
     def result
       case @status
-      when :errored
+      when STATUS_ERRORED
         raise @error
       else
         @result
@@ -79,9 +100,9 @@ module Goru
     # [public]
     #
     def sleep(seconds)
-      set_status(:idle)
+      set_status(STATUS_IDLE)
       @reactor.asleep_for(seconds) do
-        set_status(:ready)
+        set_status(STATUS_READY)
       end
 
       throw :continue
@@ -90,7 +111,25 @@ module Goru
     # [public]
     #
     def ready?
-      @status == :ready
+      @status == STATUS_READY
+    end
+
+    # [public]
+    #
+    def finished?
+      @status == STATUS_ERRORED || @status == STATUS_FINISHED
+    end
+
+    # [public]
+    #
+    def pause
+      set_status(STATUS_PAUSED)
+    end
+
+    # [public]
+    #
+    def resume
+      set_status(STATUS_READY)
     end
 
     # [public]
@@ -103,8 +142,10 @@ module Goru
     # [public]
     #
     private def status_changed
+      @observers.each(&:call)
+
       case @status
-      when :errored, :finished
+      when STATUS_ERRORED, STATUS_FINISHED
         @reactor&.routine_finished(self)
       end
     end
@@ -114,5 +155,17 @@ module Goru
     def adopted
       # noop
     end
+
+    # [public]
+    #
+    def add_observer(observer = nil, &block)
+      @observers << (block || observer.method(:routine_status_changed))
+    end
+
+    # [public]
+    #
+    def remove_observer(observer)
+      @observers.delete(observer)
+    end
   end
 end

data/lib/goru/routines/channel.rb

@@ -17,9 +17,9 @@ module Goru
 
       private def status_changed
         case @status
-        when :ready
+        when Routine::STATUS_READY
           @reactor&.wakeup
-        when :finished
+        when Routine::STATUS_FINISHED
           @channel.remove_observer(self)
         end
 

data/lib/goru/routines/channels/readable.rb

@@ -16,11 +16,11 @@ module Goru
 
         private def update_status
           status = if @channel.any?
-            :ready
+            Routine::STATUS_READY
           elsif @channel.closed?
-            :finished
+            Routine::STATUS_FINISHED
           else
-            :idle
+            Routine::STATUS_IDLE
           end
 
           set_status(status)

data/lib/goru/routines/channels/writable.rb

@@ -16,11 +16,11 @@ module Goru
 
         private def update_status
           status = if @channel.full?
-            :idle
+            Routine::STATUS_IDLE
           elsif @channel.closed?
-            :finished
+            Routine::STATUS_FINISHED
           else
-            :ready
+            Routine::STATUS_READY
           end
 
           set_status(status)

data/lib/goru/routines/io.rb

@@ -19,6 +19,10 @@ module Goru
         @monitor = nil
       end
 
+      # [public]
+      #
+      STATUS_IO_READY = :io_ready
+
       # [public]
       #
       attr_reader :io, :intent
@@ -28,7 +32,7 @@ module Goru
       # [public]
       #
       def adopted
-        set_status(:ready)
+        set_status(Routine::STATUS_READY)
       end
 
       # [public]
@@ -39,11 +43,11 @@ module Goru
         #
         @monitor&.interests = nil
 
-        set_status(:io_ready)
+        set_status(STATUS_IO_READY)
       end
 
-      READY_STATUSES = [:io_ready, :ready].freeze
-      READY_BRIDGE_STATUSES = [nil, :ready].freeze
+      READY_STATUSES = [STATUS_IO_READY, Routine::STATUS_READY].freeze
+      READY_BRIDGE_STATUSES = [nil, Bridge::STATUS_READY].freeze
 
       # [public]
       #
@@ -151,7 +155,7 @@ module Goru
 
       private def status_changed
         case @status
-        when :finished
+        when Routine::STATUS_FINISHED
           @reactor&.deregister(self)
         end
 

data/lib/goru/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Goru
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 
   # [public]
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goru
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core-extension