concurrently 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c58b0ef45ef3aa5d6e404f75b1592cbb415814e
+  data.tar.gz: bfb763b405d52aa08b52c0a8d423dbf6af9b2186
+SHA512:
+  metadata.gz: 8315e508fca33b19a367f37b38a29e39ace0eab55ad22eb4d0f3ce075b8878ad2066e8487f0cb0f0eec18ab9c93cfaf38dd2e61d9ab812127581535a6ca4ce0d
+  data.tar.gz: 1e3812a1f85bfcedae574ca758fe724af1e67a4377edf685066d9a800b53b8b12225244d0abcb34f00c9b8b1adb2036561dca36567eddb94656274d198072c21

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/.yardoc
+/doc
+/test/mruby/testenv/mruby
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper.rb
+--default-path test/Ruby

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+script: rake $TEST_RUBY:test
+sudo: false
+
+rvm:
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
+
+env:
+  - TEST_RUBY=ruby
+
+matrix:
+  include:
+  - env: TEST_RUBY=mruby

data/.yardopts

@@ -0,0 +1,7 @@
+lib/all/**/*.rb
+--private
+--no-private
+--markup markdown
+-
+RELEASE_NOTES.md
+guides/*

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "rake", "~> 12.0"
+  gem "rspec", "~> 3.0"
+  gem "rspec-is_expected_block", "~> 3.0"
+end
+
+group :doc do
+  gem "yard", "~> 0.9"
+end
+
+group :perf do
+  gem "ruby-prof", "~> 0.16.2"
+end

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,129 @@
+# Concurrently
+
+[![Build Status](https://secure.travis-ci.org/christopheraue/m-ruby-concurrently.svg?branch=master)](http://travis-ci.org/christopheraue/m-ruby-concurrently)
+
+Concurrently is a concurrency framework for Ruby and mruby. With it, concurrent
+code can be written sequentially similar to async/await.
+
+The concurrency primitive of Concurrently is the concurrent proc. It is very
+similar to a regular proc. Calling a concurrent proc creates a concurrent
+evaluation which is kind of a lightweight thread: It can wait for stuff without
+blocking other concurrent evaluations.
+
+Under the hood, concurrent procs are evaluated inside fibers. They can wait for
+readiness of I/O or a period of time (or the result of other concurrent
+evaluations). The interface is comparable to plain Ruby:
+
+<table>
+  <tr>
+    <th>Plain Ruby</th>
+    <th>Concurrently</th>
+  </tr>
+  <tr>
+    <td><code>Fiber.new(&block).resume</code></td>
+    <td><code>concurrent_proc(&block).call</code></td>
+  </tr>
+  <tr>
+    <td><code>IO.select([io])</code></td>
+    <td><code>io.await_readable</code></td>
+  </tr>
+  <tr>
+    <td><code>IO.select(nil, [io])</code></td>
+    <td><code>io.await_writable</code></td>
+  </tr>
+  <tr>
+    <td><code>IO.select(nil, nil, nil, seconds)</code></td>
+    <td><code>wait(seconds)</code></td>
+  </tr>
+</table>
+
+Beyond the mere beautification of the interface, Concurrently also takes care
+of the management of the event loop and the coordination between all concurrent
+evaluations.
+
+
+## A Basic Example
+
+This is a little server reading from an IO and printing the received messages:
+
+```ruby
+server = concurrent_proc do |io|
+  while true
+    begin
+      puts io.read_nonblock 32
+    rescue IO::WaitReadable
+      io.await_readable
+      retry
+    end
+  end
+end
+```
+
+Now, we create a pipe and start the server with the read end of it:
+
+```ruby
+r,w = IO.pipe
+server.call_detached r
+```
+
+Finally, we write messages to the write end of the pipe every 0.5 seconds:
+
+```ruby
+puts "#{Time.now.strftime('%H:%M:%S.%L')} (Start time)"
+
+while true
+  wait 0.5
+  w.write Time.now.strftime('%H:%M:%S.%L')
+end
+```
+
+The evaluation of the root fiber is effectively blocked by waiting or writing
+messages. But since the server runs concurrently it is not affected by this and
+happily prints its received messages.
+
+This is the output:
+
+```
+23:20:42.357 (Start time)
+23:20:42.858
+23:20:43.359
+23:20:43.860
+23:20:44.360
+...
+```
+
+
+## Documentation
+
+* [Installation][installation]
+* [An Overview of Concurrently][overview]
+* [API documentation][documentation]
+* [Troubleshooting][troubleshooting]
+* [Performance][performance]
+
+
+## Supported Ruby Versions
+
+* Ruby 2.2.7+
+* mruby 1.3+ (or mruby-head until mruby 1.3 is released)
+
+
+## Development
+
+[Release Notes][release_notes]
+
+
+## License
+
+Copyright 2016-present Christopher Aue
+
+Concurrently is licensed under the Apache License, Version 2.0. Please see the
+file called LICENSE.
+
+
+[installation]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/file/guides/Installation.md
+[overview]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/file/guides/Overview.md
+[documentation]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/index
+[troubleshooting]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/file/guides/Troubleshooting.md
+[performance]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/file/guides/Performance.md
+[release_notes]: http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/file/RELEASE_NOTES.md

data/RELEASE_NOTES.md

@@ -0,0 +1,49 @@
+# Release Notes
+ 
+## 1.0.0 (2017-06-26)
+
+### Added Support for
+* Ruby 2.2.7+
+* mruby 1.3
+
+### Extended [IO](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/IO) interface
+* [#await_readable](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/IO#await_readable-instance_method)
+* [#await_writable](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/IO#await_writable-instance_method)
+* [#concurrently_read](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/IO#concurrently_read-instance_method)
+* [#concurrently_write](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/IO#concurrently_write-instance_method)
+
+### Extended [Kernel](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Kernel) interface
+* [#concurrently](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Kernel#concurrently-instance_method)
+* [#concurrent_proc](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Kernel#concurrent_proc-instance_method)
+* [#wait](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Kernel#wait-instance_method)
+* [#await_resume!](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Kernel#await_resume!-instance_method)
+
+### Added (Root) Evaluation ([Concurrently::Evaluation](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation))
+* [.current](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation#current-class_method)
+* [#waiting?](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation#waiting%3F-instance_method)
+* [#resume!](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation#resume!-instance_method)
+ 
+### Added Concurrent Proc ([Concurrently::Proc](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc))
+* [#call, #[]](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc#call-instance_method)
+* [#call_nonblock](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc#call_nonblock-instance_method)
+* [#call_detached](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc#call_detached-instance_method)
+* [#call_and_forget](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc#call_and_forget-instance_method)
+ 
+### Added Proc Evaluation ([Concurrently::Proc::Evaluation](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc/Evaluation))
+* [#await_result](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc/Evaluation#await_result-instance_method)
+* [#conclude_to](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc/Evaluation#conclude_to-instance_method)
+* [#concluded?](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc/Evaluation#concluded%3F-instance_method)
+* [#data](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Proc/Evaluation#data-instance_method)
+
+### Added Event Loop ([Concurrently::EventLoop](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/EventLoop))
+* [.current](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/EventLoop#current-class_method)
+* [#lifetime](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/EventLoop#lifetime-instance_method)
+* [#reinitialize!](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/EventLoop#reinitialize!-instance_method)
+
+### Added Errors
+* [Concurrently::Error](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Error)
+* [Concurrently::Evaluation::Error](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation/Error)
+* [Concurrently::Evaluation::TimeoutError](http://www.rubydoc.info/github/christopheraue/m-ruby-concurrently/Concurrently/Evaluation/TimeoutError)
+
+
+## 0.0.0 (~13.8 billion years ago)

data/Rakefile

@@ -0,0 +1,28 @@
+Dir.chdir File.dirname __FILE__
+
+namespace :ruby do
+  task :test do
+    sh "rspec"
+  end
+end
+
+namespace :mruby do
+  mruby_env = File.expand_path "test/mruby/testenv"
+  mruby_dir = "#{mruby_env}/mruby"
+  
+  file mruby_dir do
+    sh "git clone --depth=1 git://github.com/mruby/mruby.git #{mruby_dir}"
+  end
+
+  task test: mruby_dir do
+    sh "cd #{mruby_dir} && MRUBY_CONFIG=#{mruby_env}/build_config.rb rake test"
+  end
+
+  task clean: mruby_dir do
+    sh "cd #{mruby_dir} && rake deep_clean"
+  end
+end
+
+task test: %w(ruby:test mruby:test)
+
+task default: :test