oldmoe-neverblock 0.1.0

data/README

@@ -0,0 +1,21 @@
+== NeverBlock
+Never, ever!
+
+NeverBlock is a collection of classes and modules that help you write evented non-blocking applications in a seemingly blocking mannner.
+
+NeverBlock currently provides the following Libraries:
+
+=== FiberExtensions
+A set of extenstions to the standard Fiber implementation
+
+=== NeverBlock::Pool::FiberPool 
+A pool of fibers that can be used to provide an upper limit to the numbers of active fibers in an application
+
+=== NeverBlock::Pool::FiberedConnectionPool
+A generic fibered connection pool for all sorts of connections with support for transactions. This was mostly copied from Sequel::ConnectionPool
+
+NeverBlock should be the basis for providing completely async Ruby application development that does not require the usual twisted style of evented programming. For example, you will be able to develop in Rails in the usual style and deploy to a NeverBlock server which will do all the IO in an evented manner without you even noticing this. 
+
+=== License
+Ruby License, http://www.ruby-lang.org/en/LICENSE.txt.
+

data/lib/never_block.rb

@@ -0,0 +1,15 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'fiber'
+require 'never_block/extensions/fiber_extensions'
+require 'never_block/pool/fiber_pool'
+require 'never_block/pool/fibered_connection_pool'
+
+module NeverBlock
+end
+
+NB = NeverBlock

data/lib/never_block/extensions/fiber_extensions.rb

@@ -0,0 +1,25 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+require 'fiber'
+
+class Fiber
+  
+  #Attribute Reference--Returns the value of a fiber-local variable, using either a symbol or a string name. If the specified variable does not exist, returns nil.
+  def [](key)
+    local_fiber_variables[key]
+  end
+  
+  #Attribute Assignment--Sets or creates the value of a fiber-local variable, using either a symbol or a string. See also Fiber#[].
+  def []=(key,value)
+    local_fiber_variables[key] = value
+  end
+  
+  private
+  
+  def local_fiber_variables
+    @local_fiber_variables ||= {}
+  end    
+end
+

data/lib/never_block/frameworks/activerecord.rb

@@ -0,0 +1,31 @@
+require 'never_block/frameworks/rails'
+require 'activerecord'
+
+# Patch ActiveRecord to store transaction depth information
+# in fibers instead of threads. AR does not support nested
+# transactions which makes the job easy.
+class ActiveRecord::Base
+
+  def self.transaction(&block)
+    increment_open_transactions
+    begin
+      connection.transaction(Fiber.current['start_db_transaction'], &block)
+    ensure
+      decrement_open_transactions
+    end
+  end
+
+  private
+
+  def self.increment_open_transactions #:nodoc:
+    open = Fiber.current['open_transactions'] ||= 0
+    Fiber.current['start_db_transaction'] = open.zero?
+    Fiber.current['open_transactions'] = open + 1
+  end
+
+  def self.decrement_open_transactions #:nodoc:
+    Fiber.current['open_transactions'] -= 1
+  end
+  
+end
+

data/lib/never_block/frameworks/rails.rb

@@ -0,0 +1,21 @@
+require 'actionpack'
+
+# Rails tries to protect dispatched actions
+# by wrapping them in a synchronized code
+# block, since fibers hate synchronized
+# blocks we will trick the guard and
+# transform it (without it knowing) to
+# something more subtle
+
+class ActionController::Dispatcher
+
+  # let's show this guard who is
+  # the man of the house
+  @@guard = Object.new
+
+  # now you synchronize
+  def @@guard.synchronize(&block)
+    # now you don't!
+    block.call
+  end
+end

data/lib/never_block/pool/fiber_pool.rb

@@ -0,0 +1,76 @@
+# we need Fiber.current
+# so we must require
+# fiber
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+require 'fiber'
+
+module NeverBlock
+  module Pool
+
+    # Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+    # Copyright:: Copyright (c) 2008 eSpace, Inc.
+    # License::   Distributes under the same terms as Ruby
+    #
+    #	A pool of initialized fibers
+    #	It does not grow in size or create transient fibers
+    #	It will queue code blocks when needed (if all its fibers are busy)
+    #
+    # This class is particulary useful when you use the fibers 
+    # to connect to evented back ends. It also does not generate
+    # transient objects and thus saves memory.
+    #
+    # Example:
+    # fiber_pool = NeverBlock::Pool::FiberPool.new(150)
+    # 
+    # loop do
+    #   fiber_pool.spawn do
+    #     #fiber body goes here 
+    #   end
+    # end
+    #
+	  class FiberPool
+
+	    # gives access to the currently free fibers
+		  attr_reader :fibers
+
+		  # Prepare a list of fibers 
+		  # that are able to run different
+		  # blocks of code every time
+		  # once a fiber is done with its block
+		  # it attempts to fetch another one
+		  # from the queue. 
+		  def initialize(count = 50)
+			  @fibers,@queue = [],[]
+			  count.times do |i| 
+				  fiber = Fiber.new do |block|
+					  loop do
+						  block.call
+						  unless @queue.empty?
+							  block = @queue.shift
+						  else
+							  block = Fiber.yield @fibers << Fiber.current
+						  end
+					  end
+				  end
+				  fiber[:neverblock] = true
+				  @fibers << fiber
+			  end 
+		  end
+
+		  # If there is an available fiber
+		  # use it, otherwise, leave it to linger in a queue
+		  def spawn(evented = true, &block)
+			  if fiber = @fibers.shift
+			    fiber[:evented] = evented
+				  fiber.resume(block)
+			  else
+				  @queue << block
+			  end
+			  self # we are keen on hiding our queue 
+		  end
+	  end
+	end
+end

data/lib/never_block/pool/fibered_connection_pool.rb

@@ -0,0 +1,114 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+module NeverBlock
+  module Pool
+    
+    # Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+    # Copyright:: Copyright (c) 2008 eSpace, Inc.
+    # License::   Distributes under the same terms as Ruby
+    #
+		# This class represents a pool of connections, 
+		# you hold or release conncetions from the pool
+		# hold requests that cannot be fullfiled will be queued
+		# the fiber will be paused and resumed later when
+		# a connection is avaialble
+		#
+		# Large portions of this class were copied and pasted
+		# form Sequel's threaded connection pool
+    #
+    # Example:
+    #
+    # pool = NeverBlock::Pool::FiberedConnectionPool.new(:size=>16)do
+    #   # connection creation code goes here   
+    # end
+    # 32.times do
+    #   Fiber.new do
+    #     conn = pool.hold # hold will pause the fiber until a connection is available
+    #     conn.execute('something') # you can use the connection normally now 
+    #   end.resume
+    # end
+    # 
+    # The pool has support for transactions, just pass true to the pool#hold method
+    # and the connection will not be released after the block is finished
+    # It is the responsibility of client code to release the connection
+		class FiberedConnectionPool
+       
+      # initialize the connection pool
+      # using the supplied proc to create the connections
+      # you can choose to start them eagerly or lazily (lazy by default)     
+			def initialize(options = {}, &block)
+				@connections, @busy_connections, @queue = [], {},[]
+				@connection_proc = block
+				@size = options[:size] || 8
+				if options[:eager]
+				  @size.times do
+				    @connections << @connection_proc.call
+				  end  
+				end
+			end
+
+      # If a connection is available,
+      # pass it to the block, otherwise 
+      # pass the fiber to the queue
+      # till a connection is available
+      # when done with a connection
+      # try to porcess other fibers in the queue
+      # before releasing the connection
+      # if inside a transaction, don't release the fiber
+			def hold(transactional = false)
+			  fiber = Fiber.current
+			  if conn = @busy_connections[fiber]
+			    return yield(conn)
+			  end
+			  conn = acquire(fiber)
+			  begin
+			    yield conn
+			  ensure
+			    release(fiber, conn) unless transactional
+					process_queue 
+			  end
+			end
+
+      # Give the fiber back to the pool
+      # you have to call this explicitly if
+      # you held a connection for a transaction
+			def release(fiber, conn)
+				@busy_connections.delete(fiber)
+				@connections << conn
+			end
+      
+      private
+
+      # Can we find a connection?
+      # Can we create one?
+      # Wait in the queue then
+			def acquire(fiber)
+				if !@connections.empty?
+					@busy_connections[fiber] = @connections.shift
+				elsif (@connections.length + @busy_connections.length) < @size
+					conn = @connection_proc.call
+					@busy_connections[fiber] = conn
+				else
+					Fiber.yield @queue << fiber
+				end
+			end
+
+      # Check if there are waiting fibers and
+      # try to process them
+			def process_queue
+				while !@connections.empty? and !@queue.empty?
+					fiber = @queue.shift
+					# What is really happening here?
+					# we are resuming a fiber from within
+					# another, should we call transfer insted?
+					fiber.resume @busy_connections[fiber] = @connections.shift
+				end
+			end
+			
+		end #FiberedConnectionPool
+		
+	end #Pool
+
+end #NeverBlock

data/lib/never_block/servers/thin.rb

@@ -0,0 +1,34 @@
+require 'thin'
+
+module Thin
+  
+  # Patch the thin server to use 
+  # NeverBlock::Pool::FiberPool
+  # to be able to wrap requests
+  # in fibers
+  class Server
+
+    DEFAULT_FIBER_POOL_SIZE = 50
+
+    def fiber_pool
+      @fiber_pool ||= NB::Pool::FiberPool.new(DEFAULT_FIBER_POOL_SIZE)
+    end  
+
+  end # Server
+
+  # A request is processed by wrapping it
+  # in a fiber from the fiber pool. If all
+  # the fibers are busy the request will
+  # wait in a queue to be picked up later.
+  # Meanwhile, the server will still be
+  # processing requests
+  class Connection < EventMachine::Connection
+
+    def process
+        @request.threaded = false
+        @backend.server.fiber_pool.spawn{post_process(pre_process)}
+    end
+    
+  end # Connection
+
+end # Thin

data/lib/neverblock.rb

@@ -0,0 +1,8 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'never_block'
+

data/neverblock.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name     = "neverblock"
+  s.version  = "0.1.0"
+  s.date     = "2008-08-13"
+  s.summary  = "Utilities for non-blocking stack components"
+  s.email    = "oldmoe@gmail.com"
+  s.homepage = "http://github.com/oldmoe/neverblock"
+  s.description = "NeverBlock is a collection of classes and modules that help you write evented non-blocking applications in a seemingly blocking mannner."
+  s.has_rdoc = true
+  s.authors  = ["Muhammad A. Ali", "Ahmed Sobhi"]
+  s.files    = [ 
+		"neverblock.gemspec", 
+		"README", 
+		"lib/neverblock.rb", 
+		"lib/never_block.rb", 
+		"lib/never_block/extensions/fiber_extensions.rb", 
+		"lib/never_block/pool/fiber_pool.rb", 
+		"lib/never_block/pool/fibered_connection_pool.rb",
+    "lib/never_block/frameworks/rails.rb",
+    "lib/never_block/frameworks/activerecord.rb",
+    "lib/never_block/servers/thin.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+end
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: oldmoe-neverblock
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Muhammad A. Ali
+- Ahmed Sobhi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: NeverBlock is a collection of classes and modules that help you write evented non-blocking applications in a seemingly blocking mannner.
+email: oldmoe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- neverblock.gemspec
+- README
+- lib/neverblock.rb
+- lib/never_block.rb
+- lib/never_block/extensions/fiber_extensions.rb
+- lib/never_block/pool/fiber_pool.rb
+- lib/never_block/pool/fibered_connection_pool.rb
+- lib/never_block/frameworks/rails.rb
+- lib/never_block/frameworks/activerecord.rb
+- lib/never_block/servers/thin.rb
+has_rdoc: true
+homepage: http://github.com/oldmoe/neverblock
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Utilities for non-blocking stack components
+test_files: []
+