eldritch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 421afdae683a86e47b2138e1c5b22ff833a7ef7a
+  data.tar.gz: e364c1a1030cf95dc5a3aa38efac6cf5a44111e2
+SHA512:
+  metadata.gz: 0b558a3aa5e75a0a84f7d58dc292ea9afb49a8991442056d0e8afccbbd321d964d825d3fbab53d2e721a90fbee6722342f360948cf1440e82c9b674de5eb9e97
+  data.tar.gz: b7faec1e5ad653d78669e60a6ba0e11f4c9e16f029fd129b88575da4193edf5af1773ad98d7881d85d05d372bee941b7ed6fa20fded7f277be8b3a263293f569

data/.gitignore

@@ -0,0 +1,75 @@
+# Created by http://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode
+
+## Directory-based project format
+.idea/
+# if you remove the above rule, at least ignore user-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# and these sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+
+## File-based project format
+*.ipr
+*.iws
+*.iml
+
+## Additional for IntelliJ
+out/
+
+# generated by mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# generated by JIRA plugin
+atlassian-ide-plugin.xml
+
+# generated by Crashlytics plugin (for Android Studio and Intellij)
+com_crashlytics_export_strings.xml
+
+# Created by http://www.gitignore.io
+
+### vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+

data/.rspec

@@ -0,0 +1,2 @@
+--format p
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Boris Bera, François Genois
+
+MIT License
+
+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,103 @@
+Eldritch
+========
+
+_The dark arts of concurrent programming._
+
+**This gem is in development and in no way shape or form production ready.**
+
+A ruby gem that adds parallel programming constructs to make your life a little easier.
+
+Features
+--------
+
+### async methods
+
+Async methods run concurrently when called. The caller is returned controlled right away and the method runs in the
+background.
+
+```ruby
+require 'eldritch'
+
+# define an async method
+async def send_email(email)
+  # ...
+end
+
+# ...
+send_email(some_email) # runs in the background
+# ...
+```
+
+### async blocks
+
+Async blocks are run concurrently.
+
+```ruby
+require 'eldritch'
+
+# do some work
+async do
+  # some long running task ...
+end
+# continue working
+```
+
+### tasks
+
+Async blocks and async methods both return tasks. These can be used to interact with the async block/method. As of now,
+you can wait for the task to finish or you can get its return value.
+
+```ruby
+require 'eldritch'
+
+task = async do
+  # calculate something that will take a long time
+end
+
+# ...
+
+# now we need to result of the task
+res = 2 + task.value # waits for the task to finish
+```
+
+### together
+
+Together blocks are used to control all async blocks and methods within them as a group. Right now, the together block
+waits for all async calls be de done before exiting.
+
+```ruby
+require 'eldritch'
+
+together do
+  1000.each do
+    async do
+      # do some work
+    end
+  end
+end
+# all 1000 tasks are done
+```
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'eldritch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eldritch
+
+Code quality
+------------
+
+[![Build Status](http://travis-ci.org/beraboris/eldritch.svg?branch=master)](http://travis-ci.org/beraboris/eldritch)
+
+[![Coverage Status](http://coveralls.io/repos/beraboris/eldritch/badge.png)](http://coveralls.io/r/beraboris/eldritch)
+
+[![Code Climate](http://codeclimate.com/github/beraboris/eldritch.png)](http://codeclimate.com/github/beraboris/eldritch)

data/Rakefile

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

data/eldritch.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eldritch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eldritch'
+  spec.version       = Eldritch::VERSION
+  spec.authors       = ['Boris Bera', 'François Genois']
+  spec.email         = %w(bboris@rsoft.ca frankgenerated@gmail.com)
+  spec.summary       = %q{Adds tools to make parallelism easier.}
+  spec.description   = %q{Adds support for async methods and async blocks. Adds a together block that allows async methods/blocks to be controlled as a group.}
+  spec.homepage      = 'https://github.com/beraboris/eldritch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/examples/async_block.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+async do
+  puts 'starting long running task'
+  sleep(1)
+  puts 'long running task done'
+end
+
+puts 'doing something else'
+
+# waiting for everyone to finish
+(Thread.list - [Thread.current]).each &:join

data/examples/async_method_with_class.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+class BabysFirstClass
+  async def foo(arg)
+    puts "starting long running task with #{arg}"
+    sleep(1)
+    puts 'long running task done'
+  end
+end
+
+obj = BabysFirstClass.new
+
+puts 'calling foo'
+obj.foo('stuff')
+puts 'doing something else'
+
+# waiting for everyone to stop
+(Thread.list - [Thread.current]).each &:join

data/examples/simple_async_method.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+async def foo
+  puts 'starting long running task'
+  sleep(1)
+  puts 'long running task done'
+end
+
+puts 'calling foo'
+foo
+puts 'doing something else'
+
+# waiting for everybody to stop
+(Thread.list - [Thread.current]).each &:join

data/examples/together_simple.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+together do
+  (1..10).each do |i|
+    async { puts i }
+  end
+end
+
+puts 'all done'

data/lib/eldritch.rb

@@ -0,0 +1,3 @@
+require 'eldritch/safe'
+
+Eldritch.inject_dsl

data/lib/eldritch/dsl.rb

@@ -0,0 +1,46 @@
+module Eldritch
+  module DSL
+    def async(method=nil, &block)
+      if block
+        async_block(&block)
+      else
+        async_method(method)
+      end
+    end
+
+    def sync(task)
+      task.value
+    end
+
+    def together
+      t = Together.new
+      Thread.current.together = t
+      yield
+      t.wait_all
+      Thread.current.together = nil
+    end
+
+    private
+
+    def async_block(&block)
+      task = Task.new {|t| t.value = block.call }
+      Thread.current.together << task if Thread.current.together?
+      task.start
+      task
+    end
+
+    def async_method(method)
+      new_method = async_method_name(method)
+      target = self.kind_of?(Module) ? self : self.class
+
+      target.send :alias_method, new_method, method
+      target.send :define_method, method do |*args|
+        async { send(new_method, *args) }
+      end
+    end
+
+    def async_method_name(method)
+      "__async_#{method}".to_sym
+    end
+  end
+end

data/lib/eldritch/ext_core/thread.rb

@@ -0,0 +1,7 @@
+class Thread
+  attr_accessor :together
+
+  def together?
+    !together.nil?
+  end
+end

data/lib/eldritch/safe.rb

@@ -0,0 +1,11 @@
+require 'eldritch/version'
+require 'eldritch/task'
+require 'eldritch/dsl'
+require 'eldritch/ext_core/thread'
+require 'eldritch/together'
+
+module Eldritch
+  def self.inject_dsl
+    Object.include Eldritch::DSL
+  end
+end

data/lib/eldritch/task.rb

@@ -0,0 +1,23 @@
+module Eldritch
+  class Task
+    attr_writer :value
+    attr_reader :thread
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def start
+      @thread = Thread.new self, &@block
+    end
+
+    def wait
+      @thread.join
+    end
+
+    def value
+      wait
+      @value
+    end
+  end
+end

data/lib/eldritch/together.rb

@@ -0,0 +1,15 @@
+module Eldritch
+  class Together
+    def initialize
+      @tasks = []
+    end
+
+    def <<(task)
+      @tasks << task
+    end
+
+    def wait_all
+      @tasks.each {|t| t.wait}
+    end
+  end
+end

data/lib/eldritch/version.rb

@@ -0,0 +1,3 @@
+module Eldritch
+  VERSION = '0.1.0'
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+require 'eldritch/dsl'
+require 'eldritch/task'
+require 'eldritch/together'
+
+describe Eldritch::DSL do
+  let(:klass) do Class.new do
+      extend Eldritch::DSL
+      include Eldritch::DSL
+    end
+  end
+
+  describe '#sync' do
+    it 'should call task.value' do
+      task = double(:task)
+      expect(task).to receive(:value)
+      klass.sync(task)
+    end
+  end
+
+  describe '#together' do
+    it 'should create a new together' do
+      expect(Eldritch::Together).to receive(:new).and_return(double('together').as_null_object)
+
+      klass.together {}
+    end
+
+    it 'should set the current thread together' do
+      together = double('together').as_null_object
+      allow(Eldritch::Together).to receive(:new).and_return(together)
+      allow(Thread.current).to receive(:together=).with(nil)
+
+      expect(Thread.current).to receive(:together=).with(together)
+
+      klass.together {}
+    end
+
+    it 'should wait on all tasks' do
+      together = double('together').as_null_object
+      allow(Eldritch::Together).to receive(:new).and_return(together)
+
+      expect(together).to receive(:wait_all)
+
+      klass.together {}
+    end
+
+    it 'should leave current thread together nil' do
+      together = double('together').as_null_object
+      allow(Eldritch::Together).to receive(:new).and_return(together)
+
+      klass.together {}
+
+      expect(Thread.current.together).to be_nil
+    end
+  end
+
+  describe '#async' do
+    context 'with 0 arguments' do
+
+      it 'should add itself to the together block if together?' do
+        together = double('together')
+        allow(Thread.current).to receive(:together?).and_return(true)
+        allow(Thread.current).to receive(:together).and_return(together)
+
+        expect(together).to receive(:<<).with(kind_of(Eldritch::Task))
+
+        klass.async {}
+      end
+
+      it 'should return a task' do
+        expect(klass.async {}).to be_a(Eldritch::Task)
+      end
+
+      it 'should start a task' do
+        task = double(:task)
+        allow(Eldritch::Task).to receive(:new).and_return(task)
+        expect(task).to receive(:start)
+
+        klass.async {}
+      end
+
+      it 'should set the task value' do
+        task = double(:task)
+        allow(Thread).to receive(:new).and_yield(task)
+        expect(task).to receive(:value=).with('something')
+
+        klass.async { 'something' }
+      end
+    end
+
+    context 'with 1 argument' do
+      before do
+        klass.class_eval do
+          async def foo; end
+        end
+      end
+
+      it 'should create a __async method' do
+        expect(klass.new).to respond_to(:__async_foo)
+      end
+
+      it 'should redefine the method' do
+        expect(klass).to receive(:define_method).with(:foo)
+
+        klass.class_eval do
+          async def foo; end
+        end
+      end
+
+      describe 'async method' do
+        it 'should call the original' do
+          allow(Thread).to receive(:new).and_yield(double(:task).as_null_object)
+
+          instance = klass.new
+          expect(instance).to receive(:__async_foo)
+
+          instance.foo
+        end
+
+        it 'should pass all arguments' do
+          allow(Thread).to receive(:new).and_yield(double(:task).as_null_object)
+
+          klass.class_eval do
+            async def foo(_,_,_); end
+          end
+          instance = klass.new
+          expect(instance).to receive(:__async_foo).with(1,2,3)
+
+          instance.foo(1,2,3)
+        end
+
+        it 'should set the task value' do
+          task = double(:task)
+          expect(task).to receive(:value=).with(42)
+          allow(Thread).to receive(:new).and_yield(task)
+
+          klass.class_eval do
+            async def foo; 42; end
+          end
+          instance = klass.new
+
+          instance.foo
+        end
+
+        it 'should return a task' do
+          allow(Eldritch::DSL).to receive(:new).and_return(double(:task).as_null_object)
+
+          instance = klass.new
+
+          expect(instance.foo).to be_a(Eldritch::Task)
+        end
+
+        it 'should start the task' do
+          task = double(:task)
+          expect(task).to receive(:start).once
+          allow(Eldritch::Task).to receive(:new).and_return(task)
+
+          instance = klass.new
+
+          instance.foo
+        end
+      end
+    end
+  end
+end

data/spec/eldritch_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Eldritch do
+  it 'should have a version number' do
+    Eldritch::VERSION.should_not be_nil
+  end
+
+  describe '#inject_dsl' do
+    it 'should include the dsl in Object' do
+      expect(Object).to receive(:include).with(Eldritch::DSL)
+
+      Eldritch.inject_dsl
+    end
+
+    it 'should allow classes to respond to dsl methods' do
+      Eldritch.inject_dsl
+      klass = Class.new
+
+      expect(klass).to respond_to(:async)
+      expect(klass).to respond_to(:sync)
+      expect(klass).to respond_to(:together)
+    end
+
+    it 'should allow objects to respond to dsl methods' do
+      Eldritch.inject_dsl
+      obj = Object.new
+
+      expect(obj).to respond_to(:async)
+      expect(obj).to respond_to(:sync)
+      expect(obj).to respond_to(:together)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'eldritch/safe'

data/spec/task_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'eldritch/task'
+
+describe Eldritch::Task do
+  let(:task) { Eldritch::Task.new {} }
+
+  it 'should not start a thread on init' do
+    expect(task.thread).to be_nil
+  end
+
+  describe '#start' do
+    it 'should create a thread' do
+      task.start
+
+      expect(task.thread).not_to be_nil
+    end
+
+    it 'should call the block' do
+      allow(Thread).to receive(:new).and_yield
+      expect do |b|
+        task = Eldritch::Task.new &b
+        task.start
+      end.to yield_control
+    end
+
+    it 'should start a thread' do
+      expect(Thread).to receive(:new).with(task)
+
+      task.start
+    end
+  end
+
+  describe '#wait' do
+    it 'should join the thread' do
+      task.start
+
+      expect(task.thread).to receive(:join)
+      task.wait
+    end
+  end
+
+  describe '#value' do
+    it 'should join the thread' do
+      task.start
+
+      expect(task.thread).to receive(:join)
+      task.value
+    end
+
+    it 'should return the value' do
+      task.value = 42
+      task.start
+      expect(task.value).to eql(42)
+    end
+  end
+end

data/spec/thread_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'eldritch/ext_core/thread'
+
+describe Thread do
+  it 'should have together accessor' do
+    t = Thread.new {}
+    expect(t).to respond_to(:together)
+    expect(t).to respond_to(:together=)
+  end
+
+  describe '#together?' do
+    it 'should be false when together is nil' do
+      t = Thread.new {}
+      t.together = nil
+      expect(t.together?).to be_false
+    end
+
+    it 'should be true when together is set' do
+      t = Thread.new {}
+      t.together = 2
+      expect(t.together?).to be_true
+    end
+  end
+end

data/spec/together_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'eldritch/together'
+
+describe Eldritch::Together do
+  describe '#wait_all' do
+    it 'should call wait on all tasks' do
+      together = Eldritch::Together.new
+      task = double('task')
+      together << task
+
+      expect(task).to receive(:wait)
+
+      together.wait_all
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: eldritch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Boris Bera
+- François Genois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Adds support for async methods and async blocks. Adds a together block
+  that allows async methods/blocks to be controlled as a group.
+email:
+- bboris@rsoft.ca
+- frankgenerated@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eldritch.gemspec
+- examples/async_block.rb
+- examples/async_method_with_class.rb
+- examples/simple_async_method.rb
+- examples/together_simple.rb
+- lib/eldritch.rb
+- lib/eldritch/dsl.rb
+- lib/eldritch/ext_core/thread.rb
+- lib/eldritch/safe.rb
+- lib/eldritch/task.rb
+- lib/eldritch/together.rb
+- lib/eldritch/version.rb
+- spec/dsl_spec.rb
+- spec/eldritch_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+- spec/thread_spec.rb
+- spec/together_spec.rb
+homepage: https://github.com/beraboris/eldritch
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds tools to make parallelism easier.
+test_files:
+- spec/dsl_spec.rb
+- spec/eldritch_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+- spec/thread_spec.rb
+- spec/together_spec.rb