futuroscope 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44424db4bac133c4e8e4009403b02d0ecc750956
+  data.tar.gz: e38c304ced43c047b82c4f9c24d414fb8c5813d3
+SHA512:
+  metadata.gz: 370dd490ff6939491f44c5860caa2c48be493650c3e2ec56d6fed74194da915e20b36e53d8025141ba695e005b102328047c1e259b72c9bd5912ffc6e8b6f98a
+  data.tar.gz: 3e4e2723daaa6c0e088fc71da56149472ced8d4b08220e7ec3acf3bfa2e8e4c870ef32bd1eae6b9a42e7476991cf6fb0156bf1ef8871bef66b6fabeadc9a31a9

data/README.md

@@ -41,6 +41,7 @@ Or install it yourself as:
 
 ## Usage
 
+### Simple futures
 ```Ruby
 require 'futuroscope'
 
@@ -55,6 +56,29 @@ puts x + y + z
 => 6
 ```
 
+### Future map
+```Ruby
+require 'futuroscope'
+
+map = Futuroscope::Map.new([1, 2, 3]).map do |i|
+  sleep(1)
+  i + 1
+end
+
+puts map.first
+=> 2
+
+puts map[1]
+=> 3
+
+puts map.last
+=> 4
+
+# This action will actually only take 1 second.
+```
+
+### Convenience methods
+
 If you don't mind polluting the `Kernel` module, you can also require
 futuroscope's convenience `future` method:
 
@@ -69,6 +93,30 @@ puts x + y + z
 => 6
 ```
 
+Same for a map:
+
+```Ruby
+require 'futuroscope/convenience'
+
+items = [1, 2, 3].future_map do |i|
+  sleep(i)
+  i + 1
+end
+```
+
+## Considerations
+
+You should never add **side-effects** to a future. They have to be thought of 
+like they were a local variable, with the only outcome that they're returning a 
+value. 
+
+You have to take into account that they really run in a different thread, so
+you'll be potentially accessing code in parallel that could not be threadsafe.
+
+If you're looking for other ways to improve your code performance via
+concurrency, you should probably deal directly with [Ruby's
+threads](http://ruby-doc.org/core-2.0/Thread.html).
+
 ## Ideas for the future
 
 * Having a thread pool so you can limit maximum concurrency.

data/lib/futuroscope/future.rb

@@ -5,7 +5,7 @@ module Futuroscope
   # and will return it instantly if the thread's execution already finished.
   #
   class Future
-    attr_writer :__value
+    attr_writer :future_value
     extend Forwardable
 
     # Initializes a future with a block and starts its execution.
@@ -27,7 +27,7 @@ module Futuroscope
 
       @thread = Thread.new do
         result = block.call
-        self.__value = result
+        self.future_value = result
       end
     end
 
@@ -35,29 +35,29 @@ module Futuroscope
     # completed or return its value otherwise. Can be called multiple times.
     #
     # Returns the Future's block execution result.
-    def __value
+    def future_value
       @mutex.synchronize do
-        return @__value if defined?(@__value)
+        return @future_value if defined?(@future_value)
       end
       @thread.join
-      @__value
+      @future_value
     end
 
-    def_delegators :__value, :to_s, :==
+    def_delegators :future_value, :to_s, :==, :kind_of?, :is_a?, :clone, :class
 
     private
 
     def method_missing(method, *args)
-      __value.send(method, *args)
+      future_value.send(method, *args)
     end
 
     def respond_to_missing?(method, include_private = false)
-      __value.respond_to?(method, include_private)
+      future_value.respond_to?(method, include_private)
     end
 
-    def __value=(value)
+    def future_value=(value)
       @mutex.synchronize do
-        @__value = value
+        @future_value = value
       end
     end
   end

data/lib/futuroscope/map.rb

@@ -25,15 +25,5 @@ module Futuroscope
         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.2"
+  VERSION = "0.0.3"
 end

data/spec/futuroscope/future_spec.rb

@@ -19,5 +19,16 @@ module Futuroscope
         expect(future).to eq(:edballs)
       end
     end
+
+    it "delegates some important methods to the original object's" do
+      object = [1, 2, 3]
+      future = Future.new{object}
+
+      expect(future.class).to eq(Array)
+      expect(future).to be_kind_of(Enumerable)
+      expect(future).to be_a(Enumerable)
+      expect(future.clone).to eq(object)
+      expect(future.to_s).to eq(object.to_s)
+    end
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: futuroscope
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -13,52 +12,46 @@ date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    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
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Futuroscope is yet another simple gem that implements the Futures concurrency
   pattern.
 email:
@@ -67,84 +60,53 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !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==
+- .gitignore
+- .rspec
+- .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/map.rb
+- lib/futuroscope/version.rb
+- spec/futuroscope/convenience_spec.rb
+- spec/futuroscope/future_spec.rb
+- spec/futuroscope/map_spec.rb
+- spec/spec_helper.rb
 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: 1.8.25
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Futuroscope is yet another simple gem that implements the Futures concurrency
   pattern.
 test_files:
-- !binary |-
-  c3BlYy9mdXR1cm9zY29wZS9jb252ZW5pZW5jZV9zcGVjLnJi
-- !binary |-
-  c3BlYy9mdXR1cm9zY29wZS9mdXR1cmVfc3BlYy5yYg==
-- !binary |-
-  c3BlYy9mdXR1cm9zY29wZS9tYXBfc3BlYy5yYg==
-- !binary |-
-  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- spec/futuroscope/convenience_spec.rb
+- spec/futuroscope/future_spec.rb
+- spec/futuroscope/map_spec.rb
+- spec/spec_helper.rb