fractor 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d15481939349c5d4ad4f3b09368d0221b690cf06a737007b5f247a20cda6e6
-  data.tar.gz: 66aca66a7c4b1ac1559a77fa97d20917bd52b3a9cf3c4da04906f2a6295ded75
+  metadata.gz: b51bfbe1d8aac8575dcd85deb88b286b8f3b26e391a228e01d43f3a466d91f26
+  data.tar.gz: '08198a0b664d2ddfa9cbef0a173f1672f9584dba1700f82374b0b9916cad91a6'
 SHA512:
-  metadata.gz: 205fbcb518ea078314f5964e3e60a61212c95e3f2959bb3420e6a060bb17f8bbcef0fbd7a74e27ec5304718ead2c8defd41591f4707757f7ce25bcb22374d0c0
-  data.tar.gz: c66a1af867247746dfd5d63bd30348ae0cf18bb13186b549ccd1380eb3829dd4aa662f4dc359a9479d7666f418cb0e586e6d0b0caf0b74c45f17f29282048326
+  metadata.gz: af7c2e42e19b28ced53b9e3aecf37409b9aff3c92d8829a0835312a4a5852069530b36f57c01c84727d09ad9de3b308ecfa05a5a812454402a300219938bce19
+  data.tar.gz: e08de69150ff8d528d481fcb1e872cd2d274e6b332f6d2ad3ad3b879e13328d50af3fae3294aecd81851dc7d6f3f6cc317570a7978b0f1a8adcd142d4b18a8f5

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-06 11:12:48 UTC using RuboCop version 1.75.5.
+# on 2025-05-08 09:25:37 UTC using RuboCop version 1.75.5.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,6 +14,11 @@ Lint/ConstantDefinitionInBlock:
     - 'spec/fractor/integration_spec.rb'
     - 'spec/fractor/work_spec.rb'
 
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/fractor/supervisor.rb'
+
 # Offense count: 1
 Lint/HashCompareByIdentity:
   Exclude:
@@ -30,36 +35,41 @@ Lint/RescueException:
   Exclude:
     - 'lib/fractor/wrapped_ractor.rb'
 
-# Offense count: 15
+# Offense count: 18
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 83
+  Max: 98
 
-# Offense count: 8
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 78
+  Max: 101
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 155
+  Max: 159
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 25
+  Max: 37
 
-# Offense count: 32
+# Offense count: 33
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 60
+  Max: 67
+
+# Offense count: 1
+# Configuration parameters: Max, CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 25
+  Max: 37
 
 # Offense count: 1
 Security/Eval:
@@ -74,7 +84,13 @@ Style/Documentation:
     - 'test/**/*'
     - 'examples/hierarchical_hasher/hierarchical_hasher.rb'
 
-# Offense count: 8
+# Offense count: 13
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/fractor/supervisor.rb'
+
+# Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

data/lib/fractor/result_aggregator.rb

@@ -13,10 +13,10 @@ module Fractor
 
     def add_result(result)
       if result.success?
-        puts "Work completed successfully: Result: #{result.result}"
+        puts "Work completed successfully: Result: #{result.result}" if ENV["FRACTOR_DEBUG"]
         @results << result
       else
-        puts "Error processing work: #{result}"
+        puts "Error processing work: #{result}" if ENV["FRACTOR_DEBUG"]
         @errors << result
       end
 

data/lib/fractor/supervisor.rb

@@ -37,9 +37,7 @@ module Fractor
     # Adds a single work item to the queue.
     # The item must be an instance of Fractor::Work or a subclass.
     def add_work_item(work)
-      unless work.is_a?(Fractor::Work)
-        raise ArgumentError, "#{work.class} must be an instance of Fractor::Work"
-      end
+      raise ArgumentError, "#{work.class} must be an instance of Fractor::Work" unless work.is_a?(Fractor::Work)
 
       @work_queue << work
       @total_work_count += 1
@@ -90,19 +88,32 @@ module Fractor
 
     # Sets up a signal handler for graceful shutdown (Ctrl+C).
     def setup_signal_handler
-      # Need access to @workers within the trap block
+      # Store instance variables in local variables for the signal handler
       workers_ref = @workers
+
+      # Trap INT signal (Ctrl+C)
       Signal.trap("INT") do
-        puts "\nCtrl+C received. Initiating immediate shutdown..."
-        puts "Attempting to close worker Ractors..."
+        puts "\nCtrl+C received. Initiating immediate shutdown..." if ENV["FRACTOR_DEBUG"]
+
+        # Set running to false to break the main loop
+        @running = false
+
+        puts "Sending shutdown message to all Ractors..." if ENV["FRACTOR_DEBUG"]
+
+        # Send shutdown message to each worker Ractor
         workers_ref.each do |w|
-          w.close # Use the close method of WrappedRactor
-          puts "Closed Ractor: #{w.name}"
+          w.send(:shutdown)
+          puts "Sent shutdown to Ractor: #{w.name}" if ENV["FRACTOR_DEBUG"]
         rescue StandardError => e
-          puts "Error closing Ractor #{w.name}: #{e.message}"
+          puts "Error sending shutdown to Ractor #{w.name}: #{e.message}" if ENV["FRACTOR_DEBUG"]
         end
-        puts "Exiting now."
-        exit(1) # Exit immediately
+
+        puts "Exiting now." if ENV["FRACTOR_DEBUG"]
+        exit!(1) # Use exit! to exit immediately without running at_exit handlers
+      rescue Exception => e
+        puts "Error in signal handler: #{e.class}: #{e.message}" if ENV["FRACTOR_DEBUG"]
+        puts e.backtrace.join("\n") if ENV["FRACTOR_DEBUG"]
+        exit!(1)
       end
     end
 
@@ -139,9 +150,7 @@ module Fractor
 
         # Break if no active workers and queue is empty, but work remains (indicates potential issue)
         if active_ractors.empty? && @work_queue.empty? && !@continuous_mode && processed_count < @total_work_count
-          if ENV["FRACTOR_DEBUG"]
-            puts "Warning: No active workers and queue is empty, but not all work is processed. Exiting loop."
-          end
+          puts "Warning: No active workers and queue is empty, but not all work is processed. Exiting loop." if ENV["FRACTOR_DEBUG"]
           break
         end
 
@@ -160,30 +169,22 @@ module Fractor
         # Find the corresponding WrappedRactor instance
         wrapped_ractor = @ractors_map[ready_ractor_obj]
         unless wrapped_ractor
-          if ENV["FRACTOR_DEBUG"]
-            puts "Warning: Received message from unknown Ractor: #{ready_ractor_obj}. Ignoring."
-          end
+          puts "Warning: Received message from unknown Ractor: #{ready_ractor_obj}. Ignoring." if ENV["FRACTOR_DEBUG"]
           next
         end
 
-        if ENV["FRACTOR_DEBUG"]
-          puts "Selected Ractor: #{wrapped_ractor.name}, Message Type: #{message[:type]}"
-        end
+        puts "Selected Ractor: #{wrapped_ractor.name}, Message Type: #{message[:type]}" if ENV["FRACTOR_DEBUG"]
 
         # Process the received message
         case message[:type]
         when :initialize
-          if ENV["FRACTOR_DEBUG"]
-            puts "Ractor initialized: #{message[:processor]}"
-          end
+          puts "Ractor initialized: #{message[:processor]}" if ENV["FRACTOR_DEBUG"]
           # Send work immediately upon initialization if available
           send_next_work_if_available(wrapped_ractor)
         when :result
           # The message[:result] should be a WorkResult object
           work_result = message[:result]
-          if ENV["FRACTOR_DEBUG"]
-            puts "Completed work: #{work_result.inspect} in Ractor: #{message[:processor]}"
-          end
+          puts "Completed work: #{work_result.inspect} in Ractor: #{message[:processor]}" if ENV["FRACTOR_DEBUG"]
           @results.add_result(work_result)
           if ENV["FRACTOR_DEBUG"]
             puts "Result processed. Total processed: #{@results.results.size + @results.errors.size}"
@@ -194,9 +195,7 @@ module Fractor
         when :error
           # The message[:result] should be a WorkResult object containing the error
           error_result = message[:result]
-          if ENV["FRACTOR_DEBUG"]
-            puts "Error processing work #{error_result.work&.inspect} in Ractor: #{message[:processor]}: #{error_result.error}"
-          end
+          puts "Error processing work #{error_result.work&.inspect} in Ractor: #{message[:processor]}: #{error_result.error}" if ENV["FRACTOR_DEBUG"]
           @results.add_result(error_result) # Add error to aggregator
           if ENV["FRACTOR_DEBUG"]
             puts "Error handled. Total processed: #{@results.results.size + @results.errors.size}"
@@ -205,17 +204,13 @@ module Fractor
           # Send next piece of work even after an error
           send_next_work_if_available(wrapped_ractor)
         else
-          if ENV["FRACTOR_DEBUG"]
-            puts "Unknown message type received: #{message[:type]} from #{wrapped_ractor.name}"
-          end
+          puts "Unknown message type received: #{message[:type]} from #{wrapped_ractor.name}" if ENV["FRACTOR_DEBUG"]
         end
         # Update processed count for the loop condition
         processed_count = @results.results.size + @results.errors.size
       end
 
-      if ENV["FRACTOR_DEBUG"]
-        puts "Main loop finished."
-      end
+      puts "Main loop finished." if ENV["FRACTOR_DEBUG"]
       return if @continuous_mode
 
       return unless ENV["FRACTOR_DEBUG"]
@@ -226,7 +221,7 @@ module Fractor
     # Stop the supervisor (for continuous mode)
     def stop
       @running = false
-      puts "Stopping supervisor..."
+      puts "Stopping supervisor..." if ENV["FRACTOR_DEBUG"]
     end
 
     private
@@ -238,17 +233,11 @@ module Fractor
         if !@work_queue.empty?
           work_item = @work_queue.pop # Now directly a Work object
 
-          if ENV["FRACTOR_DEBUG"]
-            puts "Sending next work #{work_item.inspect} to Ractor: #{wrapped_ractor.name}"
-          end
+          puts "Sending next work #{work_item.inspect} to Ractor: #{wrapped_ractor.name}" if ENV["FRACTOR_DEBUG"]
           wrapped_ractor.send(work_item) # Send the Work object
-          if ENV["FRACTOR_DEBUG"]
-            puts "Work sent to #{wrapped_ractor.name}."
-          end
+          puts "Work sent to #{wrapped_ractor.name}." if ENV["FRACTOR_DEBUG"]
         else
-          if ENV["FRACTOR_DEBUG"]
-            puts "Work queue empty. Not sending new work to Ractor #{wrapped_ractor.name}."
-          end
+          puts "Work queue empty. Not sending new work to Ractor #{wrapped_ractor.name}." if ENV["FRACTOR_DEBUG"]
           # In continuous mode, don't close workers as more work may come
           unless @continuous_mode
             # Consider closing the Ractor if the queue is empty and no more work is expected.
@@ -260,9 +249,7 @@ module Fractor
           end
         end
       else
-        if ENV["FRACTOR_DEBUG"]
-          puts "Attempted to send work to an invalid or closed Ractor: #{wrapped_ractor&.name || "unknown"}."
-        end
+        puts "Attempted to send work to an invalid or closed Ractor: #{wrapped_ractor&.name || "unknown"}." if ENV["FRACTOR_DEBUG"]
         # Remove from map if found but closed
         @ractors_map.delete(wrapped_ractor.ractor) if wrapped_ractor && @ractors_map.key?(wrapped_ractor.ractor)
       end

data/lib/fractor/version.rb

@@ -2,5 +2,5 @@
 
 module Fractor
   # Fractor version
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/fractor/worker.rb

@@ -4,6 +4,11 @@ module Fractor
   # Base class for defining work processors.
   # Subclasses must implement the `process` method.
   class Worker
+    def initialize(name: nil, **options)
+      @name = name
+      @options = options
+    end
+
     def process(work)
       raise NotImplementedError, "Subclasses must implement the 'process' method."
     end

data/lib/fractor/wrapped_ractor.rb

@@ -9,7 +9,7 @@ module Fractor
     # Initializes the WrappedRactor with a name and the Worker class to instantiate.
     # The worker_class parameter allows flexibility in specifying the worker type.
     def initialize(name, worker_class)
-      puts "Creating Ractor #{name} with worker #{worker_class}"
+      puts "Creating Ractor #{name} with worker #{worker_class}" if ENV["FRACTOR_DEBUG"]
       @name = name
       @worker_class = worker_class # Store the worker class
       @ractor = nil # Initialize ractor as nil
@@ -17,31 +17,38 @@ module Fractor
 
     # Starts the underlying Ractor.
     def start
-      puts "Starting Ractor #{@name}"
+      puts "Starting Ractor #{@name}" if ENV["FRACTOR_DEBUG"]
       # Pass worker_class to the Ractor block
       @ractor = Ractor.new(@name, @worker_class) do |name, worker_cls|
-        puts "Ractor #{name} started with worker class #{worker_cls}"
+        puts "Ractor #{name} started with worker class #{worker_cls}" if ENV["FRACTOR_DEBUG"]
         # Yield an initialization message
         Ractor.yield({ type: :initialize, processor: name })
 
         # Instantiate the specific worker inside the Ractor
-        worker = worker_cls.new
+        worker = worker_cls.new(name: name)
 
         loop do
           # Ractor.receive will block until a message is received
-          puts "Waiting for work in #{name}"
+          puts "Waiting for work in #{name}" if ENV["FRACTOR_DEBUG"]
           work = Ractor.receive
-          puts "Received work #{work.inspect} in #{name}"
+
+          # Handle shutdown message
+          if work == :shutdown
+            puts "Received shutdown message in Ractor #{name}, terminating..." if ENV["FRACTOR_DEBUG"]
+            break
+          end
+
+          puts "Received work #{work.inspect} in #{name}" if ENV["FRACTOR_DEBUG"]
 
           begin
             # Process the work using the instantiated worker
             result = worker.process(work)
-            puts "Sending result #{result.inspect} from Ractor #{name}"
+            puts "Sending result #{result.inspect} from Ractor #{name}" if ENV["FRACTOR_DEBUG"]
             # Yield the result back
             Ractor.yield({ type: :result, result: result, processor: name })
           rescue StandardError => e
             # Handle errors during processing
-            puts "Error processing work #{work.inspect} in Ractor #{name}: #{e.message}\n#{e.backtrace.join("\n")}"
+            puts "Error processing work #{work.inspect} in Ractor #{name}: #{e.message}\n#{e.backtrace.join("\n")}" if ENV["FRACTOR_DEBUG"]
             # Yield an error message back
             # Ensure the original work object is included in the error result
             error_result = Fractor::WorkResult.new(error: e.message, work: work)
@@ -49,14 +56,14 @@ module Fractor
           end
         end
       rescue Ractor::ClosedError
-        puts "Ractor #{name} closed."
+        puts "Ractor #{name} closed." if ENV["FRACTOR_DEBUG"]
       rescue StandardError => e
-        puts "Unexpected error in Ractor #{name}: #{e.message}\n#{e.backtrace.join("\n")}"
+        puts "Unexpected error in Ractor #{name}: #{e.message}\n#{e.backtrace.join("\n")}" if ENV["FRACTOR_DEBUG"]
         # Optionally yield a critical error message if needed
       ensure
-        puts "Ractor #{name} shutting down."
+        puts "Ractor #{name} shutting down." if ENV["FRACTOR_DEBUG"]
       end
-      puts "Ractor #{@name} instance created: #{@ractor}"
+      puts "Ractor #{@name} instance created: #{@ractor}" if ENV["FRACTOR_DEBUG"]
     end
 
     # Sends work to the Ractor if it's active.
@@ -66,11 +73,11 @@ module Fractor
           @ractor.send(work)
           true
         rescue Exception => e
-          puts "Warning: Error sending work to Ractor #{@name}: #{e.message}"
+          puts "Warning: Error sending work to Ractor #{@name}: #{e.message}" if ENV["FRACTOR_DEBUG"]
           false
         end
       else
-        puts "Warning: Attempted to send work to nil Ractor #{@name}"
+        puts "Warning: Attempted to send work to nil Ractor #{@name}" if ENV["FRACTOR_DEBUG"]
         false
       end
     end
@@ -108,7 +115,7 @@ module Fractor
 
         true
       rescue Exception => e
-        puts "Warning: Error closing Ractor #{@name}: #{e.message}"
+        puts "Warning: Error closing Ractor #{@name}: #{e.message}" if ENV["FRACTOR_DEBUG"]
         # Consider it closed even if there was an error
         @ractor = nil
         true
@@ -131,7 +138,7 @@ module Fractor
         false
       rescue Exception => e
         # If we get an exception, the Ractor is likely terminated
-        puts "Ractor #{@name} appears to be terminated: #{e.message}"
+        puts "Ractor #{@name} appears to be terminated: #{e.message}" if ENV["FRACTOR_DEBUG"]
         @ractor = nil
         true
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fractor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ronald Tse
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-07 00:00:00.000000000 Z
+date: 2025-05-08 00:00:00.000000000 Z
 dependencies: []
 description: Fractor is a lightweight Ruby framework designed to simplify the process
   of distributing computational work across multiple Ractors.