sinatra-synchrony 0.1.0.beta.2 → 0.1.0.beta.4

data/Gemfile

@@ -1,3 +1,3 @@
 source :rubygems
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-synchrony (0.0.3)
-      async-rack (= 0.5.1)
+    sinatra-synchrony (0.1.0.beta.2)
       em-http-request (= 0.3.0)
       em-resolv-replace (= 1.1.1)
       em-synchrony (= 0.2.0)
@@ -18,9 +17,7 @@ GEM
     RubyInline (3.9.0)
       ZenTest (~> 4.3)
     ZenTest (4.5.0)
-    addressable (2.2.5)
-    async-rack (0.5.1)
-      rack (~> 1.1)
+    addressable (2.2.6)
     diff-lcs (1.1.2)
     em-http-request (0.3.0)
       addressable (>= 2.0.0)
@@ -55,7 +52,7 @@ GEM
       ruby_parser (>= 2.0.5)
       sexp_processor (>= 3.0.5)
     spruz (0.2.6)
-    tilt (1.3)
+    tilt (1.3.2)
     wrong (0.5.0)
       ParseTree (~> 3.0)
       diff-lcs (~> 1.1.2)

data/README.markdown

@@ -43,14 +43,31 @@ If you are developing with a classic style app, just require the gem and it will
       'Sinatra::Synchrony is loaded automatically in classic mode, nothing needed'
     end
 
+Net::HTTP / TCPSocket
+---
+If you're using anything based on TCPSocket (such as Net::HTTP, which is used by many things), you can replace the native Ruby TCPSocket with one that supports EventMachine and allows for concurrency:
+
+    Sinatra::Synchrony.overload_tcpsocket!
+
+This will allow you to use things like [RestClient](https://github.com/archiloque/rest-client) without any changes:
+
+    RestClient.get 'http://google.com'
+
+This is not perfect though - the TCPSocket overload doesn't currently support SSL and will throw an exception. This is more for when you have ruby libraries that use Net::HTTP and you want to try something. If you intend to do HTTP requests, I strongly recommend using [Faraday](https://github.com/technoweenie/faraday) instead, which has support for [EM-HTTP-Request](https://github.com/igrigorik/em-http-request).
+
+Please encourage Ruby library developers to use (or at least support) Faraday instead of Net::HTTP. Aside from the inability to be concurrent natively, it's a pretty weird and crappy interface, which makes it harder to replace it with something better.
+
 Tests
 ---
+Add this to the top of your test file:
 
-Just write your tests as usual, my Rack::Test patch fixes the "outside of EventMachine" errors. You must be in the __test__ environment so that Sinatra will not load Rack::FiberPool. My patch admittedly needs some work.
+    Sinatra::Synchrony.patch_tests!
+
+Then just write your tests as usual, and all tests will be run within EventMachine. You must be in the __test__ environment so that Sinatra will not load Rack::FiberPool.
 
 Benchmarks
 ---
-It's pretty fast!
+Despite enabling synchronous programming without callbacks, there is no performance hit to your application! All the performance benefits you expect from Thin/Rainbows and EventMachine are still there:
 
     class App < Sinatra::Base
       register Sinatra::Synchrony
@@ -59,7 +76,7 @@ It's pretty fast!
       end
     end
 
-run with rackup -s thin:
+Benchmarked with rackup -s thin:
 
     $ ab -c 50 -n 2000 http://127.0.0.1:9292/
     ...
@@ -76,24 +93,22 @@ run with rackup -s thin:
 
 Let's try a simple blocking IO example to prove it works. 100 hits to google.com:
 
+    require 'sinatra'
+    require 'sinatra/synchrony'
     require 'rest-client'
-    
-    class App < Sinatra::Base
-      register Sinatra::Synchrony
-      get '/' do
-        # Using EventMachine::HttpRequest
-        # EM::Synchrony.sync(EventMachine::HttpRequest.new('http://google.com').get).response
+    require 'faraday'
+    Faraday.default_adapter = :em_synchrony
 
-        # Using RestClient, which gets concurrency via patched TCPSocket, no changes required!
-        RestClient.get 'http://google.com'
-      end 
+    get '/' do
+      Faraday.get 'http://google.com'
     end
 
+
     $ ab -c 100 -n 100 http://127.0.0.1:9292/
     ...
-    Time taken for tests:   1.270 seconds
-    
-For a perspective, this operation takes __33 seconds__ without this extension. That's __26x__ faster!
+    Time taken for tests:   0.256 seconds
+
+For a perspective, this operation takes __33 seconds__ without this extension.
 
 Geoloqi
 ---
@@ -101,9 +116,7 @@ This gem was designed to help us develop faster games and internal applications
 
 TODO / Thoughts
 ---
-* This is fairly new, though we are using it in production without any problems. Test before deploying anything with it.
-* Provide better method for patching Rack::Test that's less fragile to version changes. This is a big priority and I intend to improve this. Pull requests here welcome!
-* Research way to run tests with Rack::FiberPool enabled.
+* We are using this in production without any problems, and it's very stable for us. But you should test before deploying anything with it.
 * There is work underway to make this a Rack middleware, and integrate that middleware with this plugin. That way, many other frameworks can take advantage of this. There is also work exploratory work to provide support for non-EventMachine Reactor pattern implementations with this approach, but it's beyond the scope of this extension.
 
 Author

data/lib/sinatra/synchrony.rb

@@ -4,7 +4,6 @@ require 'eventmachine'
 require 'em-http-request'
 require 'em-synchrony'
 require 'em-resolv-replace'
-require 'net/http'
 
 module Sinatra
   module Synchrony
@@ -12,6 +11,16 @@ module Sinatra
       builder.use Rack::FiberPool unless test?
       super
     end
+
+    class << self
+      def patch_tests!
+        require 'sinatra/synchrony/mock_session'
+      end
+
+      def overload_tcpsocket!
+        require 'sinatra/synchrony/tcpsocket'
+      end
+    end
   end
   register Synchrony
-end
+end

data/lib/sinatra/synchrony/mock_session.rb

@@ -0,0 +1,13 @@
+require 'rack/test'
+
+module Rack
+  class MockSession
+    alias_method :request_original, :request
+    def request(uri, env)
+      EM.synchrony do
+        request_original uri, env
+        EM.stop
+      end
+    end
+  end
+end

data/lib/sinatra/synchrony/tcpsocket.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+
+original_verbosity = $VERBOSE
+$VERBOSE = nil
+TCPSocket = EventMachine::Synchrony::TCPSocket
+$VERBOSE = original_verbosity

data/spec/synchrony_spec.rb

@@ -1,8 +1,9 @@
 ENV['RACK_ENV'] = 'test'
 require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'sinatra', 'synchrony')
-require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'rack', 'test_synchrony')
+require 'rack/test'
 require 'minitest/autorun'
 require 'wrong/adapters/minitest'
+Sinatra::Synchrony.patch_tests!
 Wrong.config.alias_assert :expect
 
 def mock_app(base=Sinatra::Base, &block)
@@ -40,4 +41,4 @@ describe 'A mock app' do
     expect { last_response.ok? }
     expect { last_response.headers['Set-Cookie'] }
   end
-end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-synchrony
 version: !ruby/object:Gem::Version 
-  hash: 62196407
+  hash: 62196411
   prerelease: 6
   segments: 
   - 0
   - 1
   - 0
   - beta
-  - 2
-  version: 0.1.0.beta.2
+  - 4
+  version: 0.1.0.beta.4
 platform: ruby
 authors: 
 - Kyle Drake
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-11 00:00:00 Z
+date: 2011-08-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
@@ -168,8 +168,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/sinatra/synchrony/mock_session.rb
+- lib/sinatra/synchrony/tcpsocket.rb
 - lib/sinatra/synchrony.rb
-- lib/rack/test_synchrony.rb
 - spec/synchrony_spec.rb
 - Gemfile
 - Gemfile.lock

data/lib/rack/test_synchrony.rb

@@ -1,25 +0,0 @@
-require 'rack/test'
-# Monkeypatch to provide EM within tests.
-# If you have a better approach, please send a pull request!
-
-module Rack
-  class MockSession
-    def request(uri, env)
-      env["HTTP_COOKIE"] ||= cookie_jar.for(uri)
-      @last_request = Rack::Request.new(env)
-      EM.synchrony do
-        status, headers, body = @app.call(@last_request.env)
-        @last_response = MockResponse.new(status, headers, body, env["rack.errors"].flush)
-        body.close if body.respond_to?(:close)
-        cookie_jar.merge(last_response.headers["Set-Cookie"], uri)
-        @after_request.each { |hook| hook.call }
-        if @last_response.respond_to?(:finish)
-          @last_response.finish
-        else
-          @last_response
-        end
-        EM.stop
-      end
-    end
-  end
-end