futuroscope 0.0.1 → 0.0.2

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.rbx
 .bundle
 .config
 .yardoc

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/README.md

@@ -7,6 +7,9 @@
 Futursocope is a simple library that implements futures in ruby. Futures are a
 concurrency pattern meant to help you deal with concurrency in a simple way.
 
+It's specially useful when working in Service Oriented Architectures where HTTP
+calls can take a long time and you only expect a value from them.
+
 [![The awesome Futuroscope park](http://europe.eurostar.com/wp-content/uploads/2011/06/Futuroscope10-59-of-107.jpg)](http://futuroscope.com)
 
 You can learn more about futures here in this excellent article from @jpignata:
@@ -66,6 +69,10 @@ puts x + y + z
 => 6
 ```
 
+## Ideas for the future
+
+* Having a thread pool so you can limit maximum concurrency.
+
 ## Contributing
 
 1. Fork it

data/lib/futuroscope/convenience.rb

@@ -1,7 +1,14 @@
 require 'futuroscope/future'
+require 'futuroscope/map'
 
 module Kernel
   def future(&block)
     Futuroscope::Future.new(&block)
   end
 end
+
+module Enumerable
+  def future_map(&block)
+    Futuroscope::Map.new(self).map(&block)
+  end
+end

data/lib/futuroscope/future.rb

@@ -1,6 +1,12 @@
 module Futuroscope
+  # A Future is an object that gets initialized with a block and will behave
+  # exactly like the block's result, but being able to "borrow" its result from
+  # the future. That is, will block when the result is not ready until it is,
+  # and will return it instantly if the thread's execution already finished.
+  #
   class Future
     attr_writer :__value
+    extend Forwardable
 
     # Initializes a future with a block and starts its execution.
     #
@@ -37,6 +43,8 @@ module Futuroscope
       @__value
     end
 
+    def_delegators :__value, :to_s, :==
+
     private
 
     def method_missing(method, *args)

data/lib/futuroscope/map.rb

@@ -0,0 +1,39 @@
+require 'futuroscope/future'
+
+module Futuroscope
+  # A futuroscope map behaves like a regular map but performs all operations
+  # using futures so they're effectively parallel.
+  #
+  class Map
+    # Initializes a map with a set of items.
+    #
+    # items - Items in which to perform the mapping
+    #
+    def initialize(items)
+      @items = items
+    end
+
+    # Maps each item with a future.
+    #
+    # block - A block that will be executed passing each element as a parameter
+    #
+    # Returns an array of futures that behave like the original objects.
+    def map(&block)
+      @items.map do |item|
+        Future.new do
+          block.call(item)
+        end
+      end
+    end
+
+    private
+
+    def method_missing(method, *args)
+      @map.send(method, *args)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @map.respond_to?(method, include_private)
+    end
+  end
+end

data/lib/futuroscope/version.rb

@@ -1,3 +1,3 @@
 module Futuroscope
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/futuroscope/convenience_spec.rb

@@ -8,8 +8,24 @@ describe "Kernel#future" do
     y = future{ sleep(1); 2 }
     z = future{ sleep(1); 3 }
 
-    Timeout::timeout(1.5) do
+    Timeout::timeout(2.5) do
       expect(x + y + z).to eq(6)
     end
   end
 end
+
+describe "Enumerable#future_map" do
+  it "adds a future_map method do Enumerable" do
+    items = [1, 2, 3]
+    map = items.future_map do |i|
+      sleep(1)
+      i + 1
+    end
+
+    Timeout::timeout(2.5) do
+      expect(map.first).to eq(2)
+      expect(map[1]).to eq(3)
+      expect(map.last).to eq(4)
+    end
+  end
+end

data/spec/futuroscope/future_spec.rb

@@ -8,15 +8,15 @@ module Futuroscope
       future = Future.new{ :edballs }
       sleep(0.1)
 
-      expect(future.to_sym).to eq(:edballs)
+      expect(future).to eq(:edballs)
     end
 
     it "will execute the future in the background and wait for it" do
-      future = Future.new{ sleep(0.1); :edballs }
+      future = Future.new{ sleep(1); :edballs }
 
-      Timeout::timeout(0.15) do
-        sleep(0.1)
-        expect(future.to_sym).to eq(:edballs)
+      sleep(1)
+      Timeout::timeout(0.9) do
+        expect(future).to eq(:edballs)
       end
     end
   end

data/spec/futuroscope/map_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'futuroscope/map'
+
+module Futuroscope
+  describe Map do
+    it "behaves like a normal map" do
+      items = [1, 2, 3]
+      result = Map.new(items).map do |item|
+        sleep(item)
+        "Item #{item}"
+      end
+      
+      Timeout::timeout(4) do
+        expect(result.first).to eq("Item 1")
+        expect(result[1]).to eq("Item 2")
+        expect(result.last).to eq("Item 3")
+      end
+    end
+  end
+end

metadata

@@ -1,57 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: futuroscope
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  type: :development
 description: Futuroscope is yet another simple gem that implements the Futures concurrency
   pattern.
 email:
@@ -60,49 +67,84 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
-- Gemfile
-- Guardfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- futuroscope.gemspec
-- lib/futuroscope.rb
-- lib/futuroscope/convenience.rb
-- lib/futuroscope/future.rb
-- lib/futuroscope/version.rb
-- spec/futuroscope/convenience_spec.rb
-- spec/futuroscope/future_spec.rb
-- spec/spec_helper.rb
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJzcGVj
+- !binary |-
+  LnJ1YnktZ2Vtc2V0
+- !binary |-
+  LnJ1YnktdmVyc2lvbg==
+- !binary |-
+  LnRyYXZpcy55bWw=
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  R3VhcmRmaWxl
+- !binary |-
+  TElDRU5TRS50eHQ=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  ZnV0dXJvc2NvcGUuZ2Vtc3BlYw==
+- !binary |-
+  bGliL2Z1dHVyb3Njb3BlLnJi
+- !binary |-
+  bGliL2Z1dHVyb3Njb3BlL2NvbnZlbmllbmNlLnJi
+- !binary |-
+  bGliL2Z1dHVyb3Njb3BlL2Z1dHVyZS5yYg==
+- !binary |-
+  bGliL2Z1dHVyb3Njb3BlL21hcC5yYg==
+- !binary |-
+  bGliL2Z1dHVyb3Njb3BlL3ZlcnNpb24ucmI=
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9jb252ZW5pZW5jZV9zcGVjLnJi
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9mdXR1cmVfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9tYXBfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
 homepage: ''
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2002549777813010636
+  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2002549777813010636
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Futuroscope is yet another simple gem that implements the Futures concurrency
   pattern.
 test_files:
-- spec/futuroscope/convenience_spec.rb
-- spec/futuroscope/future_spec.rb
-- spec/spec_helper.rb
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9jb252ZW5pZW5jZV9zcGVjLnJi
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9mdXR1cmVfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9mdXR1cm9zY29wZS9tYXBfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 702932e991c91726ce5ff65ff9a673261c227e6d
-  data.tar.gz: ae1f97ea456347b722cbd7b41c3038a799a29f77
-SHA512:
-  metadata.gz: 87cd6524f383af41f7ee3443115398cf3de5c8014a343bfcc33651d45535ff8947576cd2a098aba38011d53d5dca4f710e776ff0ae065400f8dc06f314ad4be8
-  data.tar.gz: be014a3a3dfe04124b54ea31555ca12d75be30cf39a8ba10824d5569da88eb6655b018973f921451273e0ab8fa73c62df2c617a717cc31df309bd18409c8a10c