promise_pool 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8cdae0e0cfd7f377206d08c5898bc2637a4eca77
-  data.tar.gz: a7a4f91c93b6b81fa4c1472772d445b43ff2764e
+SHA256:
+  metadata.gz: d7d935d5301e4c9b26509720e19768c6c041f17daff13f3a2253e1e568062018
+  data.tar.gz: 3fe5c84f8a1b85779e8f43486f8b54b4c1705cdaa1400c170e5aaa298b2a7a05
 SHA512:
-  metadata.gz: 9d0c873467132e5132e83ecb6f000baed9acc44c282fe02b39455f56a3b6db6222803f65e82e12501e5c7f717c683166bbcfb917a4101736610ceb43bbc98e9d
-  data.tar.gz: 1143bb7a1a4438909b3efe14471012638168cb920a18d00d6644aeafe0ad4652d6e904f33023b97adcc90b66a5c6652d56bb13f5c0714ea10cb88fc25d49e1f7
+  metadata.gz: 2a271da072dd2dcd6819b2e0ca3a70e264e469c6ff140ef1de0a3a9bfe4fdee64893ac1ca2036d75662228a1b3cb3641dd55450633b2a6a653e6779069cf4a31
+  data.tar.gz: 1d8921ad67593e9ebb48eea281eef11d4fea098b70cd0c68de70552126b91fc32f28eb018a81d0ae1ae7f5ebe0578ba54e699d40e3416d72510e9f8fe4e19436

data/.travis.yml

@@ -1,15 +1,18 @@
 sudo: false
 language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - rbx
-  - jruby-9
 
-before_install:
-  - rvm get head
-  - rvm reload
-  - rvm use --install $TRAVIS_RUBY_VERSION --binary --latest
-install: 'bundle install --retry=3'
+install: 'gem install bundler; bundle install --retry=3'
 script: 'ruby -vr bundler/setup -S rake test'
+
+matrix:
+  include:
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: ruby-head
+    - rvm: jruby
+      env: JRUBY_OPTS=--debug
+    - rvm: rbx
+
+  allow_failures:
+    - rvm: rbx

data/CHANGES.md

@@ -1,5 +1,9 @@
 # CHANGES
 
+## promise_pool 0.9.1 -- 2018-03-20
+
+* Introduced PromisePool::Future.resolve to convert nested futures
+
 ## promise_pool 0.9.0 -- 2016-01-29
 
 * First beta!

data/README.md

@@ -1,4 +1,4 @@
-# promise_pool [![Build Status](https://secure.travis-ci.org/godfat/promise_pool.png?branch=master)](http://travis-ci.org/godfat/promise_pool) [![Coverage Status](https://coveralls.io/repos/godfat/promise_pool/badge.png)](https://coveralls.io/r/godfat/promise_pool) [![Join the chat at https://gitter.im/godfat/promise_pool](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/promise_pool)
+# promise_pool [![Build Status](https://secure.travis-ci.org/godfat/promise_pool.png?branch=master)](http://travis-ci.org/godfat/promise_pool) [![Coverage Status](https://coveralls.io/repos/github/godfat/promise_pool/badge.png)](https://coveralls.io/github/godfat/promise_pool) [![Join the chat at https://gitter.im/godfat/promise_pool](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/promise_pool)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 
@@ -7,6 +7,7 @@ by Lin Jen-Shin ([godfat](http://godfat.org))
 * [github](https://github.com/godfat/promise_pool)
 * [rubygems](https://rubygems.org/gems/promise_pool)
 * [rdoc](http://rdoc.info/projects/godfat/promise_pool)
+* [issues](https://github.com/godfat/promise_pool/issues) (feel free to ask for support)
 
 ## DESCRIPTION:
 
@@ -24,7 +25,7 @@ This was extracted from [rest-core][] because rest-core itself is getting
 too complex, and extracting promises from it could greatly reduce complexity
 and improve modularity for both rest-core and promise_pool.
 
-* [rest-core]: https://github.com/godfat/rest-core
+[rest-core]: https://github.com/godfat/rest-core
 
 ## REQUIREMENTS:
 
@@ -122,6 +123,49 @@ Prints:
 nnf
 ```
 
+### Serialization for single future
+
+Sometimes we would like to serialize the result from future, however although
+futures are full-blown proxies, some serializers just can't serialize them.
+
+For example, while `JSON` could dump and load them, `Marshal` can't. So it
+would be great that if we could somehow uncover the future and get the result
+underneath.
+
+For single value future, we could just call `itself` or `tap{}` to do that.
+
+``` ruby
+require 'promise_pool/promise'
+
+future = PromisePool::Promise.new.defer{ 0 }.future
+puts Marshal.load(Marshal.dump(future.itself))
+```
+
+Prints:
+
+```
+0
+```
+
+### Serialization for nested futures
+
+For nested futures, we could use `PromisePool::Future.resolve` to help us.
+
+``` ruby
+require 'promise_pool/promise'
+
+value = PromisePool::Promise.new.defer{ 0 }.future
+array = PromisePool::Promise.new.defer{ [value] }.future
+
+puts Marshal.load(Marshal.dump(PromisePool::Future.resolve(array)))
+```
+
+Prints:
+
+```
+[0]
+```
+
 ### PromisePool::ThreadPool
 
 With a thread pool, we could throttle the process and avoid exhausting
@@ -185,9 +229,9 @@ execution expired
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2016, Lin Jen-Shin (godfat)
+Copyright (c) 2016-2018, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,14 +1,15 @@
 
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
   sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__) do |s|
   require 'promise_pool/version'
   s.name    = 'promise_pool'
   s.version = PromisePool::VERSION
+
   s.add_runtime_dependency('timers', '>=4.0.1')
 end

data/lib/promise_pool/future.rb

@@ -1,6 +1,21 @@
 
 module PromisePool
   class Future < BasicObject
+    def self.resolve future
+      if future.kind_of?(::Array)
+        future.map(&method(:resolve))
+
+      elsif future.kind_of?(::Hash)
+        future.inject({}) do |r, (k, v)|
+          r[k] = resolve(v)
+          r
+        end
+
+      else
+        future.itself
+      end
+    end
+
     def initialize promise
       @promise = promise
     end

data/lib/promise_pool/test.rb

@@ -3,5 +3,5 @@ require 'promise_pool'
 require 'pork/auto'
 require 'muack'
 
-Pork::Executor.include(Muack::API)
+Pork::Suite.include(Muack::API)
 include PromisePool

data/lib/promise_pool/version.rb

@@ -1,4 +1,4 @@
 
 module PromisePool
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/promise_pool.gemspec

@@ -1,61 +1,61 @@
 # -*- encoding: utf-8 -*-
-# stub: promise_pool 0.9.0 ruby lib
+# stub: promise_pool 0.9.1 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "promise_pool"
-  s.version = "0.9.0"
+  s.name = "promise_pool".freeze
+  s.version = "0.9.1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2016-01-29"
-  s.description = "promise_pool is a promise implementation backed by threads or threads pool."
-  s.email = ["godfat (XD) godfat.org"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Lin Jen-Shin (godfat)".freeze]
+  s.date = "2018-03-20"
+  s.description = "promise_pool is a promise implementation backed by threads or threads pool.".freeze
+  s.email = ["godfat (XD) godfat.org".freeze]
   s.files = [
-  ".gitignore",
-  ".gitmodules",
-  ".travis.yml",
-  "CHANGES.md",
-  "Gemfile",
-  "README.md",
-  "Rakefile",
-  "lib/promise_pool.rb",
-  "lib/promise_pool/future.rb",
-  "lib/promise_pool/promise.rb",
-  "lib/promise_pool/queue.rb",
-  "lib/promise_pool/task.rb",
-  "lib/promise_pool/test.rb",
-  "lib/promise_pool/thread_pool.rb",
-  "lib/promise_pool/timer.rb",
-  "lib/promise_pool/version.rb",
-  "promise_pool.gemspec",
-  "task/README.md",
-  "task/gemgem.rb",
-  "test/test_future.rb",
-  "test/test_promise.rb",
-  "test/test_readme.rb",
-  "test/test_thread_pool.rb",
-  "test/test_timer.rb"]
-  s.homepage = "https://github.com/godfat/promise_pool"
-  s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "promise_pool is a promise implementation backed by threads or threads pool."
+  ".gitignore".freeze,
+  ".gitmodules".freeze,
+  ".travis.yml".freeze,
+  "CHANGES.md".freeze,
+  "Gemfile".freeze,
+  "README.md".freeze,
+  "Rakefile".freeze,
+  "lib/promise_pool.rb".freeze,
+  "lib/promise_pool/future.rb".freeze,
+  "lib/promise_pool/promise.rb".freeze,
+  "lib/promise_pool/queue.rb".freeze,
+  "lib/promise_pool/task.rb".freeze,
+  "lib/promise_pool/test.rb".freeze,
+  "lib/promise_pool/thread_pool.rb".freeze,
+  "lib/promise_pool/timer.rb".freeze,
+  "lib/promise_pool/version.rb".freeze,
+  "promise_pool.gemspec".freeze,
+  "task/README.md".freeze,
+  "task/gemgem.rb".freeze,
+  "test/test_future.rb".freeze,
+  "test/test_promise.rb".freeze,
+  "test/test_readme.rb".freeze,
+  "test/test_thread_pool.rb".freeze,
+  "test/test_timer.rb".freeze]
+  s.homepage = "https://github.com/godfat/promise_pool".freeze
+  s.licenses = ["Apache-2.0".freeze]
+  s.rubygems_version = "2.7.6".freeze
+  s.summary = "promise_pool is a promise implementation backed by threads or threads pool.".freeze
   s.test_files = [
-  "test/test_future.rb",
-  "test/test_promise.rb",
-  "test/test_readme.rb",
-  "test/test_thread_pool.rb",
-  "test/test_timer.rb"]
+  "test/test_future.rb".freeze,
+  "test/test_promise.rb".freeze,
+  "test/test_readme.rb".freeze,
+  "test/test_thread_pool.rb".freeze,
+  "test/test_timer.rb".freeze]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<timers>, [">= 4.0.1"])
+      s.add_runtime_dependency(%q<timers>.freeze, [">= 4.0.1"])
     else
-      s.add_dependency(%q<timers>, [">= 4.0.1"])
+      s.add_dependency(%q<timers>.freeze, [">= 4.0.1"])
     end
   else
-    s.add_dependency(%q<timers>, [">= 4.0.1"])
+    s.add_dependency(%q<timers>.freeze, [">= 4.0.1"])
   end
 end

data/task/README.md

@@ -4,16 +4,16 @@
 
 Provided tasks:
 
-    rake clean        # Remove ignored files
+    rake clean        # Trash ignored files
     rake gem:build    # Build gem
     rake gem:install  # Install gem
     rake gem:release  # Release gem
     rake gem:spec     # Generate gemspec
-    rake test         # Run tests in memory
+    rake test         # Run tests
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby), Rubinius and JRuby.
 
 ## INSTALLATION:
 
@@ -23,13 +23,13 @@ And in Rakefile:
 
 ``` ruby
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__, :submodules => %w[your-dep]) do |s|
   s.name    = 'your-gem'
   s.version = '0.1.0'
 end
@@ -37,9 +37,9 @@ end
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+Copyright (c) 2011-2017, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/task/gemgem.rb

@@ -1,7 +1,7 @@
 
 module Gemgem
   class << self
-    attr_accessor :dir, :spec, :spec_create
+    attr_accessor :dir, :spec, :submodules, :spec_create
   end
 
   module_function
@@ -11,12 +11,14 @@ module Gemgem
   def pkg_dir    ; "#{dir}/pkg"                       ; end
   def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
 
-  def init dir, &block
+  def init dir, options={}, &block
     self.dir = dir
-    $LOAD_PATH.unshift("#{dir}/lib")
     ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
     ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.submodules  = options[:submodules] || []
     self.spec_create = block
+
+    $LOAD_PATH.unshift("#{dir}/lib", *submodules_libs)
   end
 
   def create
@@ -26,7 +28,7 @@ module Gemgem
 
       s.description = description.join
       s.summary     = description.first
-      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+      s.license     = license
 
       s.date        = Time.now.strftime('%Y-%m-%d')
       s.files       = gem_files
@@ -115,6 +117,7 @@ module Gemgem
       SimpleCov.start do
         add_filter('test/')
         add_filter('test.rb')
+        submodules_libs.each(&method(:add_filter))
       end
     end
 
@@ -159,11 +162,15 @@ module Gemgem
   end
 
   def strip_home_path path
-    path.sub(ENV['HOME'], '~')
+    path.sub(/\A#{Regexp.escape(ENV['HOME'])}\//, '~/')
   end
 
   def strip_cwd_path path
-    path.sub(Dir.pwd, '.')
+    path.sub(/\A#{Regexp.escape(Dir.pwd)}\//, '')
+  end
+
+  def submodules_libs
+    submodules.map{ |path| "#{dir}/#{path}/lib" }
   end
 
   def git *args
@@ -201,6 +208,11 @@ module Gemgem
     @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
   end
 
+  def license
+    readme['LICENSE'].sub(/.+\n\n/, '').lines.first.
+      split(/[()]/).map(&:strip).reject(&:empty?).last
+  end
+
   def all_files
     @all_files ||= fold_files(glob).sort
   end
@@ -221,7 +233,8 @@ module Gemgem
 
   def gem_files
     @gem_files ||= all_files.reject{ |f|
-      f =~ ignored_pattern && !git_files.include?(f)
+      f =~ submodules_pattern ||
+        (f =~ ignored_pattern && !git_files.include?(f))
     }
   end
 
@@ -253,6 +266,15 @@ module Gemgem
                          end
   end
 
+  def submodules_pattern
+    @submodules_pattern ||= if submodules.empty?
+                              /^$/
+                            else
+                              Regexp.new(submodules.map{ |path|
+                                "^#{Regexp.escape(path)}/" }.join('|'))
+                            end
+  end
+
   def expand_patterns pathes
     # http://git-scm.com/docs/gitignore
     pathes.flat_map{ |path|

data/test/test_future.rb

@@ -23,4 +23,12 @@ describe PromisePool::Future do
   would 'respond_to_missing? properly' do
     [Promise.new.defer{0}.future].flatten.first.should.eq 0
   end
+
+  would 'resolve deep futures so that it could be serialized' do
+    value = Promise.new.defer{ 0 }.future
+    array = Promise.new.defer{ [value] }.future
+    hash = Promise.new.defer{ {:a => array} }.future
+
+    expect(Marshal.load(Marshal.dump(Future.resolve(hash)))).eq(:a => [0])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promise_pool
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timers
@@ -58,7 +58,7 @@ files:
 - test/test_timer.rb
 homepage: https://github.com/godfat/promise_pool
 licenses:
-- Apache License 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: promise_pool is a promise implementation backed by threads or threads pool.