nursery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ace98ee270ca1ae3491ec75e5d93451a9995efcb
+  data.tar.gz: f624c0e55a6a2976dbd620c139c527aa825cc479
+SHA512:
+  metadata.gz: 1a3b4162e2a4cc5a3e1b33d42ebaba9257bad363a1f955b87256d7066174bd487b66f58b7fbd1559e7b45a9fdfe50b08ff7bcfbff1b696d3e532dbbe01b0e821
+  data.tar.gz: c8423525a3c0ab012a1c698293a0adb7bb492c13d2478a215cf7a68306c2fe48d108c3a1a338158e02b772d07e97c6e73aac8c8aae6b07a878562db118bfcbe1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at azinger@grubhub.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nursery.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    nursery (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nursery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# Nursery
+
+[Notes on structured concurrency, or: Go statement considered harmful](https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/) argues for a specific pattern for asynchronous operations: nurseries. A nursery is created within a code block and can spawn children that run asynchronous tasks that are guaranteed to be complete by the time the code block ends, no matter how much indirection you're using. The nursery pattern is implemented in the Python library [Trio](https://trio.readthedocs.io/en/latest/index.html).
+
+If this pattern takes over the world, we'll need it in Ruby too. This gem implements the Nursery pattern at a high level. By default it uses Ruby's native concurrency handling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nursery'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nursery
+
+## Usage
+
+```ruby
+describe "simple parallelism" do
+
+	it "runs blocks in parallel" do
+		start_time = Time.now
+
+		Nursery.with_nursery do |nursery|
+
+			20.times { nursery.run { sleep(0.1) } }
+
+		end
+
+		expect(Time.now).to be_within(0.2).of(start_time)
+	end
+
+	it "can share state naively (but probably shouldn't)" do
+
+		numbers = []
+
+		Nursery.with_nursery do |nursery|
+
+			1.upto(10) do |i|
+				nursery.run do
+					numbers << i
+				end
+			end
+		end
+
+		expect(numbers).to match_array( [*1..10].shuffle )
+
+	end
+
+	it "lets siblings cancel siblings" do
+
+		numbers = [1,2,3]		
+
+		Nursery.with_nursery do |nursery|
+
+			nursery.run { loop { do_something_expensive; Nursery.checkpoint } }
+
+			nursery.run { do_something_expensive; numbers.clear; nursery.cancel }
+		end
+
+		expect(numbers).to be_empty
+
+	end
+
+	it "lets siblings refer to each other" do
+		Nursery.with_nursery do |nursery|
+
+			values = [0, 1, 0, 0, 2, 5, 6]
+
+			cleaner = nursery.run do
+				values.reject! { |i| sleep(0.1); i.zero? }
+			end
+
+			nursery.run do
+				sum = values.inject(:+)
+				cleaner.finish
+				values.each { |x| sum += 1.0/x }
+				expect(15..16).to cover(sum)
+			end
+
+		end
+	end
+
+	it "ensures no task runs after the block finishes" do
+		state_leaker = {}
+
+		Nursery.with_nursery do |nursery|
+
+			state_leaker[:nursery] = nursery
+		
+		end
+
+		expect{ state_leaker[:nursery].run{ do_something_expensive } }
+			.to raise_exception(RuntimeError, "Nursery#run called outside of with_nursery block")
+
+	end
+
+end
+
+describe "composing with other patterns" do
+
+	class AsyncBuilder
+
+		attr_reader :nursery
+		attr_accessor :attributes
+
+		def initialize(nursery, &block)
+			@nursery = nursery
+			@attributes = {}
+			instance_exec(&block)
+		end
+
+		def convert_to_value(*values)
+			do_something_expensive
+			values.join
+		end
+
+		def method_missing(m,*args,&block)
+			nursery.run { attributes[m] = convert_to_value(*args) }
+		end
+
+	end
+
+	it "plays well with instance_exec" do
+
+		builder_obj = Nursery.with_nursery do |nursery|
+
+			thing = 0
+
+			AsyncBuilder.new(nursery) do
+
+				llama 				:hairy
+				other_llama			:hairier
+				third_llama			:shorn
+				thing				thing
+			end
+
+		end
+
+		expect(builder_obj.attributes).to eq ( {llama: 'hairy', other_llama: 'hairier', third_llama: 'shorn', thing: '0'} )
+	end
+
+end
+```
+
+See other specs for more usage examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nursery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nursery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nursery/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nursery"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nursery/annotations.rb

@@ -0,0 +1,13 @@
+class Nursery
+
+	module Annotations
+		def checkpoint(method_name)
+			alias_method(:"#{method_name}_without_checkpoint", method_name)
+			define_method(method_name) do |*args, &blk|
+				Nursery.checkpoint
+				send(:"#{method_name}_without_checkpoint", *args, &blk)
+			end
+		end
+	end
+
+end

data/lib/nursery/child.rb

@@ -0,0 +1,31 @@
+class Nursery
+	class Child
+
+		attr_reader :nursery
+		attr_reader :thread
+		attr_reader :config
+
+		def initialize(nursery, config, job)
+			@nursery = nursery
+			@thread = Thread.new(&job)
+			@thread[:nursery] = nursery
+			@config = config
+		end
+
+		def finish
+			thread.join unless self.thread == Thread.current
+			nil
+		rescue CancelledJob
+			nil
+		rescue Exception
+			raise unless @config[:swallow_exceptions]
+		end
+
+	end
+
+	class <<self
+		attr_accessor :child_class
+	end
+
+	@child_class = Child
+end

data/lib/nursery/nursery.rb

@@ -0,0 +1,59 @@
+class Nursery
+
+	attr_reader :children, :cancelled, :finished, :default_config
+
+	CancelledJob = Class.new(StandardError)
+
+	def initialize(default_config = {})
+		@children = []
+		@cancelled = false
+		@finished = false
+		@default_config = default_config
+	end
+
+	def run(config = default_config, &job)
+		Nursery.checkpoint
+		raise("Nursery#run called outside of with_nursery block") if finished
+		child = self.class.child_class.new(self, config, job)
+		children << child
+		child
+	end
+
+	def finish
+		exceptions = children.map do |child|
+			begin
+				child.finish
+				nil
+			rescue Exception => e
+				e
+			end
+		end.compact
+		exceptions.each { |e| raise(e) }
+		@finished = true
+	end
+
+	def cancel
+		@cancelled = true
+		finish		
+	end
+
+	def self.with_nursery(config = {}, &block)
+		nursery = new(config)
+		begin
+			retval = block.call(nursery)
+		rescue StandardError
+			nursery.cancel
+			raise
+		end
+		nursery.finish
+		retval
+	end
+
+	def self.checkpoint
+		if Thread.current[:nursery] && Thread.current[:nursery].cancelled
+			yield if block_given?
+			raise CancelledJob
+		end
+	end
+
+end

data/lib/nursery/version.rb

@@ -0,0 +1,3 @@
+class Nursery
+  VERSION = "0.1.0"
+end

data/lib/nursery.rb

@@ -0,0 +1,3 @@
+require 'nursery/version'
+require 'nursery/nursery'
+require 'nursery/child'

data/nursery.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nursery/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nursery"
+  spec.version       = Nursery::VERSION
+  spec.authors       = ["Aaron Zinger"]
+  spec.email         = ["histocrat@gmail.com"]
+
+  spec.summary       = %q{Implementation of the nursery async pattern from Trio}
+  spec.description   = %q{A simple API for asynchronous flow control to make it clear when jobs finish.}
+  spec.homepage      = "https://github.com/histocrat/nursery"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: nursery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Zinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple API for asynchronous flow control to make it clear when jobs
+  finish.
+email:
+- histocrat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nursery.rb
+- lib/nursery/annotations.rb
+- lib/nursery/child.rb
+- lib/nursery/nursery.rb
+- lib/nursery/version.rb
+- nursery.gemspec
+homepage: https://github.com/histocrat/nursery
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Implementation of the nursery async pattern from Trio
+test_files: []