futurist 1.0.0

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in futurist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aaron Kuehler
+
+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,50 @@
+# Futurist
+
+[![Build Status](https://travis-ci.org/indiebrain/futurist.svg?branch=master)](https://travis-ci.org/indiebrain/futurist)
+[![Code Climate](https://codeclimate.com/github/indiebrain/futurist/badges/gpa.svg)](https://codeclimate.com/github/indiebrain/futurist)
+[![Test Coverage](https://codeclimate.com/github/indiebrain/futurist/badges/coverage.svg)](https://codeclimate.com/github/indiebrain/futurist/coverage)
+
+An implementation of the [future](https://en.wikipedia.org/wiki/Futures_and_promises) construct which uses Process forking to resolve its Promise. Promise evaluation is eager, and value resolution blocks until the Promise is resolved.
+
+**Note**
+This implementation will only work on OSes which support process forking.
+
+## Installation
+
+    $ gem install futurist
+
+
+or add this line to your application's Gemfile:
+
+```ruby
+gem 'futurist'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Futures also allow you to background the computation of any block.
+
+### Create a future
+
+The call to `Futurist::Future#value` will block until the result of executing the block is available. If an exception occurs during the block's execution, the call to future.value will reraise the same exception.
+
+```ruby
+future = Futurist::Future.new { 3 + 2 }
+future.value # blocks until value is available
+=> 5
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/indiebrain/futurist.

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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "futurist"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application "rspec" is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+rubocop --config ./.rubocop.yml

data/bin/setup

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

data/futurist.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "futurist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "futurist"
+  spec.version       = Futurist::VERSION
+  spec.authors       = ["Aaron Kuehler"]
+  spec.email         = ["aaron.kuehler@gmail.com"]
+
+  spec.license       = "MIT"
+  spec.homepage      = "http://www.github.com/indiebrain/futurist.git"
+  spec.summary       = "A Process based Future"
+  spec.description   = <<-EOS.gsub(/^\s+/, "")
+                         An implementation of the Future construct
+                         (https://en.wikipedia.org/wiki/Futures_and_promises)
+                         which uses system Processes for background value
+                         evaluation
+                       EOS
+
+  spec.files         = `git ls-files -z`.
+                         split("\x0").
+                         reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rubocop", "~> 0.33"
+end

data/lib/futurist.rb

@@ -0,0 +1,9 @@
+require "futurist/forking_resolution_strategy"
+require "futurist/future"
+require "futurist/pipe"
+require "futurist/promise"
+require "futurist/safe_promise"
+require "futurist/version"
+
+module Futurist
+end

data/lib/futurist/forking_resolution_strategy.rb

@@ -0,0 +1,57 @@
+module Futurist
+  class ForkingResolutionStrategy
+    attr_reader :promise_process_id
+    def initialize(forking_method: Process.method(:fork),
+                   process_monitor_constructor: Process.method(:detach),
+                   channel: Futurist::Pipe.new,
+                   process_exit: Process.method(:exit!),
+                   promise:)
+      @promise = promise
+      @channel = channel
+      @forking_method = forking_method
+      @value = :not_retrieved
+      @process_exit = process_exit
+      @promise_process_id = start_promise_evaluation
+      @promise_monitor = process_monitor_constructor.call(@promise_process_id)
+    end
+
+    def resolve
+      if @value == :not_retrieved
+        @value = read_promise_value
+      end
+      @value
+    end
+
+    def resolved?
+      !promise_monitor.alive?
+    end
+
+    private
+
+    attr_reader :promise,
+                :channel,
+                :forking_method,
+                :promise_monitor,
+                :process_exit
+
+    def start_promise_evaluation
+      forking_method.call do
+        channel.close_reader
+        safe_promise = SafePromise.new(promise)
+        channel.write(safe_promise.value)
+        channel.close_writer
+        process_exit.call(0)
+      end
+    end
+
+    def read_promise_value
+      channel.close_writer
+      value = channel.read
+      channel.close_reader
+      if value.is_a?(Exception)
+        raise value
+      end
+      value
+    end
+  end
+end

data/lib/futurist/future.rb

@@ -0,0 +1,21 @@
+module Futurist
+  class Future
+    def initialize(resolution_strategy: ForkingResolutionStrategy,
+                   &block)
+      promise = Futurist::Promise.new(callable: block)
+      @resolution_strategy = resolution_strategy.new(promise: promise)
+    end
+
+    def value
+      @value ||= resolution_strategy.resolve
+    end
+
+    def ready?
+      resolution_strategy.resolved?
+    end
+
+    private
+
+    attr_reader :resolution_strategy
+  end
+end

data/lib/futurist/pipe.rb

@@ -0,0 +1,28 @@
+module Futurist
+  class Pipe
+    def initialize(pipe: IO.pipe)
+      @reader, @writer = pipe
+    end
+
+    def read
+      Marshal.load(reader.read)
+    end
+
+    def write(value)
+      Marshal.dump(value, writer)
+    end
+
+    def close_reader
+      reader.close
+    end
+
+    def close_writer
+      writer.close
+    end
+
+    private
+
+    attr_reader :reader,
+                :writer
+  end
+end

data/lib/futurist/promise.rb

@@ -0,0 +1,15 @@
+module Futurist
+  class Promise
+    def initialize(callable:)
+      @callable = callable
+    end
+
+    def value
+      callable.call
+    end
+
+    private
+
+    attr_reader :callable
+  end
+end

data/lib/futurist/safe_promise.rb

@@ -0,0 +1,17 @@
+module Futurist
+  class SafePromise
+    def initialize(promise)
+      @promise = promise
+    end
+
+    def value
+      promise.value
+    rescue => error
+      error
+    end
+
+    private
+
+    attr_reader :promise
+  end
+end

data/lib/futurist/version.rb

@@ -0,0 +1,3 @@
+module Futurist
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: futurist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Kuehler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+description: |
+  An implementation of the Future construct
+  (https://en.wikipedia.org/wiki/Futures_and_promises)
+  which uses system Processes for background value
+  evaluation
+email:
+- aaron.kuehler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- futurist.gemspec
+- lib/futurist.rb
+- lib/futurist/forking_resolution_strategy.rb
+- lib/futurist/future.rb
+- lib/futurist/pipe.rb
+- lib/futurist/promise.rb
+- lib/futurist/safe_promise.rb
+- lib/futurist/version.rb
+homepage: http://www.github.com/indiebrain/futurist.git
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Process based Future
+test_files: []