procrastinate 0.4.0 → 0.4.1

data/HISTORY.txt

@@ -1,4 +1,8 @@
-= 0.4.0 / ???
+= 0.4.1 / 23Jan2012
+
+  + Replaces the custom IPC implementation with the cod gem.
+
+= 0.4.0 / 16Dez2011
 
   + Schedules blocks as well (Scheduler#schedule).
 

data/lib/procrastinate.rb

@@ -7,7 +7,6 @@ module Procrastinate
   
   autoload :Lock,     'procrastinate/lock'
   autoload :Runtime,  'procrastinate/runtime'
-  autoload :IPC,      'procrastinate/ipc'
   autoload :Task,     'procrastinate/task'
 end
 

data/lib/procrastinate/process_manager.rb

@@ -1,14 +1,12 @@
 
 require 'state_machine'
+require 'cod'
 
 # Dispatches and handles tasks and task completion. Only low level unixy
 # manipulation here, no strategy. The only methods you should call from the
 # outside are #setup, #step, #wakeup and #shutdown. 
 #
 class Procrastinate::ProcessManager
-  include Procrastinate::IPC
-  
-  autoload :ObjectEndpoint, 'procrastinate/process_manager/object_endpoint'
   autoload :ChildProcess,   'procrastinate/process_manager/child_process'
   
   # This pipe is used to wait for events in the master process. 
@@ -25,11 +23,9 @@ class Procrastinate::ProcessManager
     
     # All presently running children
     @children = {}
-    
-    # Child Master Communication (cmc)
-    endpoint = Endpoint.anonymous
-    @cmc_server = endpoint.server
-    @cmc_client = endpoint.client
+
+    # Master should read from @master, Children write to @child
+    @master, @child = Cod.pipe.split
   end
   
   # Sets up resource usage for dispatcher. You must call this before dispatcher
@@ -99,16 +95,19 @@ class Procrastinate::ProcessManager
     cp_read_end = control_pipe.first
     
     loop do # until we have input in the cp_read_end (control_pipe)
-      ready = Endpoint.select([cp_read_end, @cmc_server])
+      # TODO Why does procrastinate (cod) hang sometimes when there is no
+      # timeout here? What messages are we missing?
+      ready = Cod.select(1, 
+        :child_msgs => @master, :control_pipe => cp_read_end)
       
-      read_child_messages if ready.include? @cmc_server
+      read_child_messages if ready.has_key?(:child_msgs)
 
       # Send the tracking code for the child processes the final notifications
       # and remove them from the children hash. At this point we know that
       # no messages are waiting in the child queue.
       finalize_children
       
-      if ready.include? cp_read_end
+      if ready.has_key?(:control_pipe)
         # Consume the data (not important)
         cp_read_end.read_nonblock(1024)
         return
@@ -125,28 +124,20 @@ class Procrastinate::ProcessManager
       child.removable? }
   end
 
-  # Once the @cmc_server endpoint is ready, loops and reads all child
-  # communication. 
-  #
   def read_child_messages
     loop do
-      msg = @cmc_server.receive
-      decode_and_handle_message(msg)
+      ready = Cod.select(0.1, @master)
+      break unless ready
       
-      break unless @cmc_server.waiting?
+      handle_message @master.get
     end
   end
   
   # Called for every message sent from a child. The +msg+ param here is a string
   # that still needs decoding. 
   #
-  def decode_and_handle_message(msg)
-    pid, obj = begin
-      Marshal.load(msg)
-    rescue => b
-      # Messages that cannot be unmarshalled will be ignored. 
-      warn "Can't unmarshal child communication: #{b}"
-    end
+  def handle_message(msg)
+    pid, obj = msg
     
     if child=children[pid]
       child.incoming_message(obj)
@@ -192,7 +183,7 @@ class Procrastinate::ProcessManager
       cleanup
             
       if result
-        endpoint = ObjectEndpoint.new(@cmc_client, Process.pid)
+        endpoint = lambda { |obj| @child.put [Process.pid, obj] }
         task.run(endpoint)
       else
         task.run(nil)
@@ -227,9 +218,10 @@ class Procrastinate::ProcessManager
   #
   def wait_for_all_childs
     # TODO Maybe signal KILL to children after some time. 
-    until children.all? { |p, c| c.dead? }
+    until children.empty?
       wait_for_event
       reap_childs
+      finalize_children
     end
   end
 end

data/lib/procrastinate/task/callable.rb

@@ -21,7 +21,7 @@ module Procrastinate::Task
     #
     def run(endpoint)
       r = @b.call
-      endpoint.send r if endpoint
+      endpoint.call(r) if endpoint
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: procrastinate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000 Z
+date: 2012-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &70314600072220 !ruby/object:Gem::Requirement
+  requirement: &70180063938160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,32 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70314600072220
+  version_requirements: *70180063938160
+- !ruby/object:Gem::Dependency
+  name: cod
+  requirement: &70180063966580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70180063966580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70180063963140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180063963140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70314600070260 !ruby/object:Gem::Requirement
+  requirement: &70180063959700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314600070260
+  version_requirements: *70180063959700
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &70314600069360 !ruby/object:Gem::Requirement
+  requirement: &70180063973380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +66,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314600069360
+  version_requirements: *70180063973380
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70180063972060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180063972060
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70180063970680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180063970680
 description: 
 email:
 - kaspar.schiess@absurd.li
@@ -59,11 +103,8 @@ files:
 - Rakefile
 - README
 - lib/procrastinate/implicit.rb
-- lib/procrastinate/ipc/endpoint.rb
-- lib/procrastinate/ipc.rb
 - lib/procrastinate/lock.rb
 - lib/procrastinate/process_manager/child_process.rb
-- lib/procrastinate/process_manager/object_endpoint.rb
 - lib/procrastinate/process_manager.rb
 - lib/procrastinate/proxy.rb
 - lib/procrastinate/runtime.rb
@@ -99,13 +140,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4532369798177350543
+      hash: 3407763989240963082
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3407763989240963082
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10

data/lib/procrastinate/ipc.rb

@@ -1,6 +0,0 @@
-
-# Holds classes for interprocess communication. 
-#
-module Procrastinate::IPC
-  autoload :Endpoint, 'procrastinate/ipc/endpoint'
-end

data/lib/procrastinate/ipc/endpoint.rb

@@ -1,106 +0,0 @@
-
-# A communication endpoint. This acts as a factory and hub for the whole 
-# IPC library.
-#
-module Procrastinate::IPC::Endpoint
-  def anonymous
-    Anonymous.new
-  end
-  module_function :anonymous
-  
-  # Works the same as IO.select, only that it doesn't care about write and 
-  # error readiness, only read. You can mix IPC::Endpoints and normal IO
-  # instances freely. 
-  #
-  def select(read_array, timeout=nil)
-    # This maps real system IO instances to wrapper objects. Return the thing
-    # to the right if IO.select returns the thing to the left. 
-    mapping = Hash.new
-    waiting = []
-    
-    read_array.each { |io_or_endpoint| 
-      if io_or_endpoint.respond_to?(:select_ios)
-        waiting << io_or_endpoint if io_or_endpoint.waiting?
-        
-        io_or_endpoint.select_ios.each do |io|
-          mapping[io] = io_or_endpoint
-        end
-      else
-        mapping[io_or_endpoint] = io_or_endpoint
-      end
-    }
-    
-    return waiting unless waiting.empty?
-    
-    system_io = IO.select(mapping.keys, nil, nil, timeout)
-    if system_io
-      return system_io.first.
-        # Map returned selectors to their object counterparts and then only
-        # return once (if more than one was returned).
-        map { |e| mapping[e] }.uniq   
-    end
-  end
-  module_function :select
-  
-  class Anonymous
-    def initialize
-      @re, @we = IO.pipe
-    end
-    
-    def server
-      Server.new(@re)
-    end
-    def client
-      Client.new(@we)
-    end
-  end
-  
-  class Anonymous::Server
-    attr_reader :pipe
-    attr_reader :waiting
-    def initialize(pipe)
-      @pipe = pipe
-      @waiting = Array.new
-    end
-    
-    def receive(timeout=nil)
-      return waiting.shift if waiting?
-      
-      loop do
-        buffer = pipe.read_nonblock(1024*1024*1024)
-      
-        while buffer.size > 0
-          size = buffer.slice!(0...4).unpack('l').first
-          waiting << buffer.slice!(0...size)
-        end
-      
-        return waiting.shift if waiting?
-      end
-    end
-    
-    # True if there are queued messages in the Endpoint stack. If this is 
-    # false, a receive might block. 
-    #
-    def waiting?
-      not waiting.empty?
-    end
-    
-    # Return underlying IOs for select.
-    #
-    def select_ios
-      [@pipe]
-    end
-  end
-  
-  class Anonymous::Client
-    attr_reader :pipe
-    def initialize(pipe)
-      @pipe = pipe
-    end
-    
-    def send(msg)
-      buffer = [msg.size].pack('l') + msg
-      pipe.write(buffer)
-    end
-  end
-end

data/lib/procrastinate/process_manager/object_endpoint.rb

@@ -1,10 +0,0 @@
-# A class that acts as a filter between ProcessManager and the endpoint it
-# uses to communicate with its children. This converts Ruby objects into
-# Strings and also sends process id. 
-#
-class Procrastinate::ProcessManager::ObjectEndpoint < Struct.new(:endpoint, :pid)
-  def send(obj)
-    msg = Marshal.dump([pid, obj])
-    endpoint.send(msg)
-  end
-end