Narnach-future 0.2.0 → 0.2.1

data/README.rdoc

@@ -8,8 +8,8 @@ calls.
 An example:
   f = Future.new { sleep 5; 123}
   puts f * 5 #=> 615
-Theis future will take 5 seconds to run, then 123 is returned.
-The call f.*(5) will block until the future is done.
+This future will take 5 seconds to run, then 123 is returned.
+The call to f.* will block until the future has a return value.
 
 Another example:
   f1 = Future.new { sleep 5; 10}
@@ -20,6 +20,11 @@ Here it only takes 5 seconds to calculate the sum instead of the 9 it would take
 
 == Recent changes
 
+=== Version 0.2.1
+* Cleared up the docs a little
+* Futures can take arguments and pass them to their Thread
+* Docfix: fixed typo
+
 === Version 0.2.0
 * Replaced Future Module with Future class. The old syntax is no longer supported.
 * Replaced one-time use of eval with undef_method.

data/future.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.name         = 'future'
   s.summary      = "A naieve implementation of futures"
   s.description  = "A naieve implementation of futures"
-  s.version      = '0.2.0'
+  s.version      = '0.2.1'
   s.date         = '2008-12-10'
   s.platform     = Gem::Platform::RUBY
   s.authors      = ["Wes Oldenbeuving"]

data/lib/future.rb

@@ -5,23 +5,30 @@
 #
 # An example:
 #   f = Future.new { sleep 5; 123}
-#   puts f * 5 #=> 615
-# Theis future will take 5 seconds to run, then 123 is returned.
-# The call f.*(5) will block until the future is done.
+#   f * 5 # => 615
+# This future will take 5 seconds to run, then 123 is returned.
+# The call to f.* will block until the future has a return value.
 #
 # Another example:
 #   f1 = Future.new { sleep 5; 10}
 #   f2 = Future.new { sleep 3; 20}
 #   f3 = Future.new { sleep 1; 30}
-#   puts f3 + f2 + f1
+#   f3 + f2 + f1 # => 60
 # Here it only takes 5 seconds to calculate the sum instead of the 9 it would take when done sequentially.
+#
+# Futures have their own thread and thus don't have access to scope they were created from.
+# If you do require values from outside the future, pass them to the Future when creating it:
+#
+#   one = 1
+#   two = 2
+#   sum = Future.new(one, two) {|a,b| a + b} # => 3
 class Future
   (instance_methods - %w[__send__ __id__ object_id]).each do |meth|
     undef_method meth
   end
 
-  def initialize(&block)
-    @thread = Thread.new(&block)
+  def initialize(*args, &block)
+    @thread = Thread.new(*args, &block)
   end
 
   def method_missing(*args, &block)

data/spec/future_spec.rb

@@ -19,4 +19,16 @@ describe Future, '.new' do
     diff.should < 0.3
     diff.should > 0.1
   end
+
+  it 'should have its own scope' do
+    now = Time.now
+    f1 = Future.new { now }
+    f1.should_not == now
+  end
+
+  it 'should be able to pass variables to scope of the future' do
+    now = Time.now
+    f1 = Future.new(now) { |time| time + 10 }
+    f1.should == now + 10
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Narnach-future
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Wes Oldenbeuving