rubyuw 0.99.9 → 0.99.10

data/VERSION

@@ -1 +1 @@
-0.99.9
+0.99.10

data/lib/rubyuw/base.rb

@@ -14,6 +14,9 @@ module RubyUW
   #   RubyUW::Base.authenticate("uwnetid", "password")
   class Base
     @@connection = nil
+    
+    # See allow_concurrency=
+    @@allow_concurrency = false
 
     class <<self
       # Authenticate with MyUW. This method sets up and verifies
@@ -68,13 +71,36 @@ module RubyUW
         connection.cookie_jar.clear!
       end
       
+      # Determines whether RubyUW will be thread-safe. If set to true,
+      # each thread will have its own individual connection object.
+      # This also means that each thread is expected to authenticate
+      # with MyUW if necessary.
+      #
+      # If false, the connection object will be shared through a global
+      # class variable.
+      #
+      # Warning: This will reset all connections when the value changes.
+      # Therefore, if you're calling this sometime after using the connection
+      # already (which you shouldn't), you'll have to reauthenticate.
+      def allow_concurrency=(value)
+        return if @@allow_concurrency == !!value
+        
+        # Reset all connections so we don't have any dangling
+        reset_connection!
+        
+        # Forcing boolean value
+        @@allow_concurrency = !!value
+      end
+      
+      def allow_concurrency; @@allow_concurrency; end
+      
       # Returns the connection object. Used by other portions of RubyUW
       # to browse the pages, authenticate, and more. This method will
       # typically *never* be called by non-internal systems.
       #
       # @return [WWW::Mechanize] A WWW::Mechanize object.
       def connection
-        @@connection ||= RubyUW::Connection.new do |browser|
+        connection_thread[:connection] ||= RubyUW::Connection.new do |browser|
           browser.user_agent_alias = 'Mac Safari'
           browser.follow_meta_refresh = true
 
@@ -95,7 +121,7 @@ module RubyUW
       # Resets the connection by clearing out the old. This way,
       # when connection is next called, it will recreate the object.
       def reset_connection!
-        @@connection = nil
+        connection_thread[:connection] = nil
         self
       end
       
@@ -117,6 +143,13 @@ module RubyUW
         
         data
       end
+      
+      protected
+      
+      # Returns the thread on which to store the connections
+      def connection_thread
+        allow_concurrency ? Thread.current : Thread.main
+      end
     end
   end
 end

data/rubyuw.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyuw}
-  s.version = "0.99.9"
+  s.version = "0.99.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]

data/test/mocked/base_test.rb

@@ -1,6 +1,79 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 class BaseTest < Test::Unit::TestCase
+  setup do
+    RubyUW::Base.publicize_singleton_methods
+  end
+  
+  teardown do
+    RubyUW::Base.protect_singleton_methods
+  end
+  
+  context "multithreading" do
+    setup do
+      RubyUW::Base.reset_connection!
+      RubyUW::Base.allow_concurrency = false
+    end
+    
+    should "share a connection if allow_concurrency is set to false" do
+      assert !RubyUW::Base.allow_concurrency
+      connection = RubyUW::Base.connection
+      
+      a = Thread.new { assert_equal connection, RubyUW::Base.connection }
+      b = Thread.new { assert_equal connection, RubyUW::Base.connection }
+      a.join
+      b.join
+    end
+    
+    should "use thread-local connections if allow_concurrency is true" do
+      RubyUW::Base.allow_concurrency = true
+      assert RubyUW::Base.allow_concurrency
+      
+      connection = RubyUW::Base.connection
+      a = Thread.new { assert_not_equal connection, RubyUW::Base.connection }
+      b = Thread.new { assert_not_equal connection, RubyUW::Base.connection }
+      a.join
+      b.join
+      
+      RubyUW::Base.allow_concurrency = false
+    end
+    
+    should "return the main thread to store connection on without concurrency" do
+      assert !RubyUW::Base.allow_concurrency
+      assert_equal Thread.main, RubyUW::Base.connection_thread
+      
+      a = Thread.new { assert_equal Thread.main, RubyUW::Base.connection_thread }
+      b = Thread.new { assert_equal Thread.main, RubyUW::Base.connection_thread }
+      a.join
+      b.join
+    end
+    
+    should "return the current thread to store connection on with concurrency" do
+      RubyUW::Base.allow_concurrency = true
+      assert RubyUW::Base.allow_concurrency
+      assert_equal Thread.current, RubyUW::Base.connection_thread
+      
+      a = Thread.new { assert_equal Thread.current, RubyUW::Base.connection_thread }
+      b = Thread.new { assert_equal Thread.current, RubyUW::Base.connection_thread }
+      a.join
+      b.join
+      
+      RubyUW::Base.allow_concurrency = false
+    end
+    
+    should "reset connections when changing allow_concurrency value" do
+      RubyUW::Base.expects(:reset_connection!).twice
+      RubyUW::Base.allow_concurrency = true
+      RubyUW::Base.allow_concurrency = false
+    end
+    
+    should "not reset connections when not changing allow_concurrency value" do
+      RubyUW::Base.expects(:reset_connection!).never
+      assert !RubyUW::Base.allow_concurrency #sanity
+      RubyUW::Base.allow_concurrency = false
+    end
+  end
+  
   context "with connection" do
     setup do
       RubyUW::Base.reset_connection!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubyuw
 version: !ruby/object:Gem::Version 
-  version: 0.99.9
+  version: 0.99.10
 platform: ruby
 authors: 
 - Mitchell Hashimoto