swift 1.0.3 → 1.1.0

data/README.md

@@ -303,6 +303,26 @@ or use the `em-synchrony` api for `swift`
   end
 ```
 
+### Fibers and Connection Pools
+
+If you intend to use `Swift::Record` with `em-synchrony` you will need to use a fiber aware connection pool.
+
+```ruby
+require 'swift/fiber_connection_pool'
+
+EM.run do
+  Swift.setup(:default) do
+    Swift::FiberConnectionPool.new(size: 5) {Swift::Adapter::Postgres.new(db: 'swift')}
+  end
+
+  5.times do
+    EM.synchrony do
+      p User.execute("select * from users").entries
+    end
+  end
+end
+```
+
 ## Performance
 
 Swift prefers performance when it doesn't compromise the Ruby-ish interface. It's unfair to compare Swift to DataMapper

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.1.0

data/lib/swift.rb

@@ -67,11 +67,15 @@ module Swift
     # @return [Swift::Adapter]
     #
     # @see Swift::Adapter
-    def setup name, type, options = {}
-      unless type.kind_of?(Class) && type < Swift::Adapter
-        raise TypeError, "Expected +type+ Swift::Adapter subclass but got #{type.inspect}"
+    def setup name, type = nil, options = {}
+      if block_given?
+        repositories[name] = yield
+      else
+        unless type.kind_of?(Class) && type < Swift::Adapter
+          raise TypeError, "Expected +type+ Swift::Adapter subclass but got #{type.inspect}"
+        end
+        repositories[name] = type.new(options)
       end
-      (@repositories ||= {})[name] = type.new(options)
     end
 
     # Fetch or scope a block to a specific DB by name.
@@ -90,14 +94,9 @@ module Swift
     # @param  [Symbol] name     Adapter name.
     # @param  [Proc]   block    Scope this block to the named adapter instead of <tt>:default</tt>.
     # @return [Swift::Adapter]
-    #--
-    # I pilfered the logic from DM but I don't really understand what is/isn't thread safe.
     def db name = nil, &block
-      repository = if name || scopes.empty?
-        @repositories[name || :default] or raise "Unknown db '#{name || :default}', did you forget to #setup ?"
-      else
-        scopes.last
-      end
+      repository = name || scopes.size < 1 ? repositories[name ||= :default] : scopes.last
+      repository or raise "Unknown db '#{name}', did you forget to #setup ?"
 
       if block_given?
         begin
@@ -119,10 +118,22 @@ module Swift
       @schema ||= []
     end
 
+    # Trace the command execution in currently scoped adapter
+    #
+    # @example
+    #   Swift.trace { Swift.db.execute("select * from users") }
+    #
+    # @see Swift::Adapter#trace
     def trace io = $stdout, &block
       Swift.db.trace(io, &block)
     end
 
+    # @private
+    def repositories
+      @repositories ||= {}
+    end
+
+    # @private
     def scopes
       Thread.current[:swift_db] ||= []
     end

data/lib/swift/adapter.rb

@@ -219,8 +219,7 @@ module Swift
       log_command(start, command, bind) if @trace
     end
 
-    private
-
+    # :nodoc:
     def log_command start, command, bind
       @trace.print Time.now.strftime('%F %T.%N'), ' - %.9f' % (Time.now - start).to_f, ' - ', command
       @trace.print ' ', bind if bind && bind.size > 0

data/lib/swift/eventmachine.rb

@@ -10,6 +10,7 @@ module Swift
 
     class EMHandler < EM::Connection
       def initialize adapter, record, defer
+        @started = Time.now
         @adapter = adapter
         @record  = record
         @defer   = defer
@@ -17,7 +18,9 @@ module Swift
 
       def notify_readable
         detach
-        @adapter.pending.shift
+        start, command, bind = @adapter.pending.shift
+        @adapter.log_command(start, command, bind) if @adapter.trace?
+
         begin
           @defer.succeed(@record ? Result.new(@record, @adapter.result) : @adapter.result)
         rescue Exception => e
@@ -41,9 +44,9 @@ module Swift
     def execute command, *bind
       raise RuntimeError, 'Command already in progress' unless pending.empty?
 
-      pending << command
-      start    = Time.now
+      start = Time.now
       record, command = command, bind.shift if command.kind_of?(Class) && command < Record
+      pending << [start, command, bind]
       query(command, *bind)
 
       EM::DefaultDeferrable.new.tap do |defer|

data/lib/swift/fiber_connection_pool.rb

@@ -0,0 +1,94 @@
+# Based on EM::Synchrony::ConnectionPool
+
+require 'swift/synchrony'
+
+module Swift
+  class FiberConnectionPool
+
+    def initialize opts, &block
+      @reserved  = {}   # map of in-progress connections
+      @available = []   # pool of free connections
+      @pending   = []   # pending reservations (FIFO)
+      @trace     = nil
+
+      opts[:size].times do
+        @available.push(block.call)
+      end
+    end
+
+    def trace io = $stdout
+      if block_given?
+        begin
+          _io, @trace = @trace, io
+          yield
+        ensure
+          @trace = _io
+        end
+      else
+        @trace = io
+      end
+    end
+
+    private
+      # Choose first available connection and pass it to the supplied
+      # block. This will block indefinitely until there is an available
+      # connection to service the request.
+      def __reserve__
+        id    = "#{Fiber.current.object_id}:#{rand}"
+        fiber = Fiber.current
+        begin
+          yield acquire(id, fiber)
+        ensure
+          release(id)
+        end
+      end
+
+      # Acquire a lock on a connection and assign it to executing fiber
+      # - if connection is available, pass it back to the calling block
+      # - if pool is full, yield the current fiber until connection is available
+      def acquire id, fiber
+        if conn = @available.pop
+          @reserved[id] = conn
+        else
+          Fiber.yield @pending.push(fiber)
+          acquire(id, fiber)
+        end
+      end
+
+      # Release connection assigned to the supplied fiber and
+      # resume any other pending connections (which will
+      # immediately try to run acquire on the pool)
+      def release(id)
+        @available.push(@reserved.delete(id))
+        if pending = @pending.shift
+          pending.resume
+        end
+      end
+
+      # Allow the pool to behave as the underlying connection
+      def method_missing method, *args, &blk
+        __reserve__ do |conn|
+          if @trace
+            conn.trace(@trace) {conn.__send__(method, *args, &blk)}
+          else
+            conn.__send__(method, *args, &blk)
+          end
+        end
+      end
+  end # FiberConnectionPool
+
+  class Adapter::Sql
+    def serialized_transaction &block
+      Swift.scopes.push(self)
+      execute('begin')
+      res = yield(self)
+      execute('commit')
+      res
+    rescue => e
+      execute('rollback')
+      raise e
+    ensure
+      Swift.scopes.pop
+    end
+  end # Adapter::Sql
+end # Swift

data/lib/swift/synchrony.rb

@@ -27,7 +27,10 @@ module Swift
     # @see [Swift::Adapter]
     def execute *args
       res = EM::Synchrony.sync aexecute(*args)
-      raise res if res.kind_of?(Error)
+      if res.kind_of?(Error)
+        res.set_backtrace caller.reject {|subject| subject =~ %r{swift/fiber_connection_pool}}
+        raise res
+      end
       yield res if block_given?
       res
     end

data/swift.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "swift"
-  s.version = "1.0.3"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Hanna", "Bharanee 'Barney' Rathna"]
-  s.date = "2012-09-21"
+  s.date = "2013-02-18"
   s.description = "A rational rudimentary database abstraction."
   s.email = ["shane.hanna@gmail.com", "deepfryed@gmail.com"]
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/swift/adapter/sqlite3.rb",
     "lib/swift/attribute.rb",
     "lib/swift/eventmachine.rb",
+    "lib/swift/fiber_connection_pool.rb",
     "lib/swift/header.rb",
     "lib/swift/identity_map.rb",
     "lib/swift/migrations.rb",
@@ -52,6 +53,7 @@ Gem::Specification.new do |s|
     "test/test_io.rb",
     "test/test_record.rb",
     "test/test_swift.rb",
+    "test/test_synchrony.rb",
     "test/test_timestamps.rb",
     "test/test_transactions.rb",
     "test/test_types.rb",

data/test/test_synchrony.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe 'fiber connection pool' do
+  before do
+    skip 'swift/synchrony re-defines Adapter#execute' unless ENV['TEST_SWIFT_SYNCHRONY']
+
+    require 'swift/fiber_connection_pool'
+    EM.synchrony do
+      Swift.setup(:default, Swift::Adapter::Postgres, db: 'swift_test')
+      Swift.db.execute('drop table if exists users')
+      Swift.db.execute('create table users(id serial primary key, name text)')
+
+      @user = Class.new(Swift::Record) do
+        store :users
+        attribute :id,   Swift::Type::Integer, key: true, serial: true
+        attribute :name, Swift::Type::String
+      end
+
+      10.times { @user.create(name: 'test') }
+      EM.stop
+    end
+  end
+
+  it 'can synchronize queries across fibers' do
+    EM.run do
+      Swift.setup(:default) { Swift::FiberConnectionPool.new(size: 2) {Swift::Adapter::Postgres.new(db: 'swift_test')}}
+
+      @counts = []
+      5.times do
+        EM.synchrony do
+          @counts << @user.execute('select * from users').selected_rows
+        end
+      end
+
+      EM.add_timer(0.2) { EM.stop }
+    end
+
+    assert_equal 5,    @counts.size
+    assert_equal [10], @counts.uniq
+  end
+
+  it 'sets appropriate backtrace for errors' do
+    EM.synchrony do
+      error = nil
+      Swift.setup(:default) { Swift::FiberConnectionPool.new(size: 2) {Swift::Adapter::Postgres.new(db: 'swift_test')}}
+
+      begin
+        Swift.db.execute 'foo bar baz'
+      rescue => e
+        error = e
+      end
+
+      assert error
+      assert_match %r{test/test_synchrony.rb:48}, error.backtrace.first
+      EM.stop
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swift
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.0
+    none: false
+  name: minitest
+  prerelease: false
+  type: :development
 description: A rational rudimentary database abstraction.
 email:
 - shane.hanna@gmail.com
@@ -51,6 +51,7 @@ files:
 - lib/swift/adapter/sqlite3.rb
 - lib/swift/attribute.rb
 - lib/swift/eventmachine.rb
+- lib/swift/fiber_connection_pool.rb
 - lib/swift/header.rb
 - lib/swift/identity_map.rb
 - lib/swift/migrations.rb
@@ -73,6 +74,7 @@ files:
 - test/test_io.rb
 - test/test_record.rb
 - test/test_swift.rb
+- test/test_synchrony.rb
 - test/test_timestamps.rb
 - test/test_transactions.rb
 - test/test_types.rb
@@ -84,17 +86,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      hash: -3874151873791212661
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      segments:
+      - 0
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -102,4 +107,3 @@ signing_key:
 specification_version: 3
 summary: A rational rudimentary database abstraction.
 test_files: []
-has_rdoc: