eldritch 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcbd51f156e97fa93b15dbf1ea64470460156f92
-  data.tar.gz: 6a4463349a3a657c8d528ea74a64d88f8321667a
+  metadata.gz: b580cd9181ade4f4a2a6976341a88b3059ad5670
+  data.tar.gz: a9947d828dfd477bccbed94f5713c1620de2063e
 SHA512:
-  metadata.gz: 911a4fcdac54808756205139c1256c8b63dccd8bcab7c82df3bf27db03c41f3d91df673213b2c200d127516c8c75ff7fbe71f2449e507094032fffa77dc68de5
-  data.tar.gz: b95e77b84bc0458692fb09a150c1bba0c007f7971abfb0fb163b9383077a4704ab304eea5ea6ac1cdd2229913d859a0dba824e6c9ef19cb102e0d6961f2eba44
+  metadata.gz: f336489e6ef818dc9dc92a02b90d94c9b2aa9fb389286f0b80ecaa75ab800c183754bfa43eb2237e2e4c30c229d04e8af354f5dd1a228f61a74a1498847ded4a
+  data.tar.gz: 370a2d8c641f8fda77846fec17ce8e6c7dc0dcc0825952c900e0bbb625dd71e999b64af70ae86453399d8d5936832c96de699cedfe7da992e8f59b61bdc3bb05

data/README.md

@@ -12,6 +12,27 @@ Code quality
 [![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)
 
+Usage
+-----
+
+1. Install it `gem install eldritch`
+2. Require it `require 'eldritch'`
+3. Use it (see features below)
+
+By default eldritch will inject the DSL into the global scope. If you don't want this, you can require `eldritch/safe`
+instead of `eldritch`.
+
+```ruby
+require 'eldricth/safe'
+
+class MyClass
+  include Eldritch::DSL
+  extend Eldritch::DSL
+
+  # The DSL is available in this class
+end
+```
+
 Features
 --------
 
@@ -28,12 +49,10 @@ async def send_email(email)
   # ...
 end
 
-# ...
 send_email(some_email) # runs in the background
-# ...
 ```
 
-#### ruby 1.9.3 and ruby 2.0.0
+#### ruby 1.9.3 and 2.0.0
 
 For all versions of ruby before 2.1.0, you need to define async methods like so:
 
@@ -54,17 +73,14 @@ Async blocks are run concurrently.
 ```ruby
 require 'eldritch'
 
-# do some work
 async do
-  # some long running task ...
+  # runs in the background
 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.
+Async blocks and async methods both return tasks. These can be used to interact with the async block/method.
 
 ```ruby
 require 'eldritch'
@@ -73,9 +89,7 @@ task = async do
   # calculate something that will take a long time
 end
 
-# ...
-
-# now we need to result of the task
+# we need to result of the task
 res = 2 + task.value # waits for the task to finish
 ```
 
@@ -135,20 +149,5 @@ this repository you need to add `lib/` to the include path.
     $ ruby -Ilib examples/the_example.rb
 
 Be aware that if you are running ruby < 2.1.0, some the examples may not work. All the examples that define async
-methods with `async def something; end` will not work. This is because since ruby 2.1.0 def returns the name of the
+methods with `async def something; end` will not work. This is because, since ruby 2.1.0, def returns the name of the
 method defined as a symbol.
-
-Installation
-------------
-
-Add this line to your application's Gemfile:
-
-    gem 'eldritch'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install eldritch

data/lib/eldritch/dsl.rb

@@ -87,17 +87,18 @@ module Eldritch
 
       yield group
 
-      group.wait_all
+      group.join_all
       Thread.current.eldritch_group = old
     end
 
     private
 
     def async_block(&block)
-      task = Task.new do |t|
+      task = Task.new do
         begin
-          t.value = block.call
+          block.call
         rescue InterruptedError
+          # exit silently
         end
       end
       Thread.current.eldritch_group << task

data/lib/eldritch/group.rb

@@ -34,8 +34,8 @@ module Eldritch
       @mutex.synchronize { block.call }
     end
 
-    def wait_all
-      @tasks.each {|t| t.wait}
+    def join_all
+      @tasks.each &:join
     end
 
     # Aborts the other async calls/blocks in the group

data/lib/eldritch/task.rb

@@ -1,8 +1,6 @@
 module Eldritch
   # Runs a block in parallel and allows for interaction with said block
   class Task
-    attr_writer :value
-
     # @return [Thread] underlying ruby thread
     attr_reader :thread
 
@@ -24,14 +22,14 @@ module Eldritch
     #   end
     #   task.start  # calls the block in parallel
     def start
-      @thread = Thread.new self, &@block
+      @thread = Thread.new &@block
       @thread.eldritch_task = self
     end
 
     # Waits for the task to complete
-    def wait
+    def join
       @thread.join
-      @thread.eldritch_task = nil
+      unset_thread_task
     end
 
     # The return value of the task
@@ -40,8 +38,9 @@ module Eldritch
     #
     # @return whatever the block returns
     def value
-      wait
-      @value
+      val = @thread.value
+      unset_thread_task
+      val
     end
 
     # Forces the task to end
@@ -49,6 +48,7 @@ module Eldritch
     # This kills the underlying thread. This is a dangerous call.
     def abort
       @thread.kill
+      unset_thread_task
     end
 
     # Interrupts the task
@@ -59,6 +59,13 @@ module Eldritch
     # You can still handle the exception yourself.
     def interrupt
       @thread.raise InterruptedError.new
+      unset_thread_task
+    end
+
+    private
+
+    def unset_thread_task
+      @thread.eldritch_task = nil
     end
   end
 end

data/lib/eldritch/version.rb

@@ -1,3 +1,3 @@
 module Eldritch
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/spec/dsl_spec.rb

@@ -35,11 +35,11 @@ describe Eldritch::DSL do
       klass.together {}
     end
 
-    it 'should wait on all tasks' do
+    it 'should join on all tasks' do
       group = double('group').as_null_object
       allow(Eldritch::Group).to receive(:new).and_return(group)
 
-      expect(group).to receive(:wait_all)
+      expect(group).to receive(:join_all)
 
       klass.together {}
     end
@@ -92,12 +92,6 @@ describe Eldritch::DSL do
         expect(klass.async {}).to eql(task)
       end
 
-      it 'should set the task value' do
-        expect(task).to receive(:value=).with('something')
-
-        klass.async { 'something' }
-      end
-
       it 'should eat any interrupted errors' do
         block = proc { raise Eldritch::InterruptedError }
 
@@ -144,18 +138,6 @@ describe Eldritch::DSL do
 
           instance.foo(1,2,3)
         end
-
-        it 'should set the task value' do
-          expect(task).to receive(:value=).with(42)
-
-          klass.class_eval do
-            def foo; 42; end
-            async :foo
-          end
-          instance = klass.new
-
-          instance.foo
-        end
       end
     end
   end

data/spec/group_spec.rb

@@ -66,15 +66,15 @@ describe Eldritch::Group do
     end
   end
 
-  describe '#wait_all' do
-    it 'should call wait on all tasks' do
+  describe '#join_all' do
+    it 'should call join on all tasks' do
       task = double('task')
       allow(task).to receive(:start)
       group << task
 
-      expect(task).to receive(:wait)
+      expect(task).to receive(:join)
 
-      group.wait_all
+      group.join_all
     end
   end
 

data/spec/task_spec.rb

@@ -27,7 +27,7 @@ describe Eldritch::Task do
     end
 
     it 'should start a thread' do
-      expect(Thread).to receive(:new).with(task)
+      expect(Thread).to receive(:new)
 
       task.start
     end
@@ -39,45 +39,51 @@ describe Eldritch::Task do
     end
   end
 
-  describe '#wait' do
+  describe '#join' do
     it 'should join the thread' do
       task.start
 
       expect(task.thread).to receive(:join)
-      task.wait
+      task.join
     end
 
     it 'should set the thread task to nil' do
       task.start
 
       expect(thread).to receive(:eldritch_task=).with(nil)
-      task.wait
+      task.join
     end
   end
 
   describe '#value' do
-    it 'should join the thread' do
+    it 'should set the thread task to nil' do
       task.start
 
-      expect(task.thread).to receive(:join)
+      expect(thread).to receive(:eldritch_task=).with(nil)
       task.value
     end
 
-    it 'should set the thread task to nil' do
+    it 'should call Thread#value' do
       task.start
-
-      expect(thread).to receive(:eldritch_task=).with(nil)
+      expect(thread).to receive(:value)
       task.value
     end
 
-    it 'should return the value' do
-      task.value = 42
+    it 'should return what Thread#value returns' do
       task.start
+      allow(thread).to receive(:value).and_return(42)
       expect(task.value).to eql(42)
     end
   end
 
   describe '#abort' do
+    it 'should set the thread task to nil' do
+      task.start
+      expect(thread).to receive(:eldritch_task=).with(nil)
+
+      task.abort
+    end
+
     it 'should kill the thread' do
       expect(thread).to receive(:kill)
 
@@ -87,6 +93,13 @@ describe Eldritch::Task do
   end
 
   describe '#interrupt' do
+    it 'should set the thread task to nil' do
+      task.start
+      expect(thread).to receive(:eldritch_task=).with(nil)
+
+      task.interrupt
+    end
+
     it 'should raise an interrupted error on the thread' do
       expect(thread).to receive(:raise).with(kind_of(Eldritch::InterruptedError))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eldritch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Boris Bera
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler