eldritch 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 126e27cd07d65470ca6636e9fdee32863141f810
-  data.tar.gz: df821431679824457c23f5970d779b907d9371c6
+  metadata.gz: dcbd51f156e97fa93b15dbf1ea64470460156f92
+  data.tar.gz: 6a4463349a3a657c8d528ea74a64d88f8321667a
 SHA512:
-  metadata.gz: 4f8fe3201d12712f927af4e21a8939feaaf4221e293b43d3581a55376ead5ad364329cc7aba43ab4d8896338777e386630ea1b6f40309469f48d37b442f88e87
-  data.tar.gz: 2130979b69b7099a626b06c9e88a9d3640f21c0bc4cdfde89b1d3b0b98f3230677a058b6d5a01dd522a2d5f772cbce7c27ee3c0d8a53c2684e91dfc393a6e6db
+  metadata.gz: 911a4fcdac54808756205139c1256c8b63dccd8bcab7c82df3bf27db03c41f3d91df673213b2c200d127516c8c75ff7fbe71f2449e507094032fffa77dc68de5
+  data.tar.gz: b95e77b84bc0458692fb09a150c1bba0c007f7971abfb0fb163b9383077a4704ab304eea5ea6ac1cdd2229913d859a0dba824e6c9ef19cb102e0d6961f2eba44

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.1.0
   - 2.1.1
+  - jruby-19mode

data/README.md

@@ -33,6 +33,20 @@ send_email(some_email) # runs in the background
 # ...
 ```
 
+#### ruby 1.9.3 and ruby 2.0.0
+
+For all versions of ruby before 2.1.0, you need to define async methods like so:
+
+```ruby
+def foo
+  # stuff
+end
+async :foo
+```
+
+Since ruby 2.1.0, def returns the name of the method defined as a symbol. This allows for the cleaner `async def foo`
+syntax.
+
 ### async blocks
 
 Async blocks are run concurrently.
@@ -106,12 +120,11 @@ MRI has this nasty little feature called a _GIL_ or _Global Interpreter Lock_. T
 thread can run at a time. Let's say that you have 4 cores, running threaded code on MRI will only make use of 1 core.
 Sometimes, you might not gain a speed boost if you make code parallel. This could the case even if theory says otherwise.
 
-Not all ruby implementations use a _GIL_. For example, jRuby does not use a _GIL_. The problem with using jRuby, is that
-this gem requires ruby >= 2.1.0 and jRuby only supports up to 1.9.3 (as of writing this).
+Not all ruby implementations use a _GIL_. For example, jRuby does not use a _GIL_.
 
-You will probably see a speed boost if your code does a lot of IO or anything that's blocking. In that case running on a
-single core is not that much of a hindrance, because most of the threads will be blocked and your code should run more
-often.
+If your ruby implementation has a _GIL_, you will probably see a speed boost if your code does a lot of IO or anything
+that's blocking. In that case running on a single core is not that much of a hindrance, because most of the threads will
+be blocked and your code should run more often.
 
 Running examples
 ----------------
@@ -121,6 +134,10 @@ 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
+method defined as a symbol.
+
 Installation
 ------------
 

data/eldritch.gemspec

@@ -13,9 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/beraboris/eldritch'
   spec.license       = 'MIT'
 
-  # need refinements
-  spec.required_ruby_version = '>= 2.1'
-
   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)/})

data/lib/eldritch/core_ext/thread.rb

@@ -0,0 +1,12 @@
+class Thread
+  attr_writer :eldritch_group
+  attr_accessor :eldritch_task
+
+  def eldritch_group
+    @eldritch_group ||= Eldritch::NilGroup.new
+  end
+
+  def in_eldritch_group?
+    !eldritch_group.nil?
+  end
+end

data/lib/eldritch/dsl.rb

@@ -5,8 +5,6 @@ module Eldritch
   # - {#together together blocks}
   # - {#sync sync keyword}
   module DSL
-    using Eldritch::Refinements
-
     # Creates an asynchronous method or starts an async block
     #
     # If a block is passed, this will be an async block.
@@ -27,6 +25,12 @@ module Eldritch
     #
     #   foo
     #   #=> <Task>
+    # If you are using ruby < 2.1.0, you will need to define async methods like so:
+    #
+    #   def foo
+    #     # will run in parallel
+    #   end
+    #   async :foo
     #
     # @param [Symbol] method the name of the async method.
     # @return [Task] a task representing the async method or block
@@ -76,15 +80,15 @@ module Eldritch
     # @yield [Group] group of async blocks/calls
     # @see Group Group class
     def together
-      old = Thread.current.group
+      old = Thread.current.eldritch_group
 
       group = Group.new
-      Thread.current.group = group
+      Thread.current.eldritch_group = group
 
       yield group
 
       group.wait_all
-      Thread.current.group = old
+      Thread.current.eldritch_group = old
     end
 
     private
@@ -96,7 +100,7 @@ module Eldritch
         rescue InterruptedError
         end
       end
-      Thread.current.group << task
+      Thread.current.eldritch_group << task
       task
     end
 

data/lib/eldritch/group.rb

@@ -4,8 +4,6 @@ module Eldritch
   # Represents a group of {Task tasks} or {DSL#async async calls/block}.
   # It is used to act upon all the tasks in the group.
   class Group
-    using Eldritch::Refinements
-
     def initialize
       @tasks = []
       @mutex = Mutex.new
@@ -14,7 +12,7 @@ module Eldritch
 
     # @return [Array<Task>] the other async calls/blocks in the group
     def others
-      @tasks - [Thread.current.task]
+      @tasks - [Thread.current.eldritch_task]
     end
 
     def <<(task)

data/lib/eldritch/safe.rb

@@ -1,5 +1,5 @@
 require 'eldritch/version'
-require 'eldritch/refinements/thread'
+require 'eldritch/core_ext/thread'
 require 'eldritch/task'
 require 'eldritch/dsl'
 require 'eldritch/group'
@@ -20,6 +20,6 @@ module Eldritch
   #     extend Eldritch::DSL   # for async method declaration
   #   end
   def self.inject_dsl
-    Object.include Eldritch::DSL
+    Object.send :include, Eldritch::DSL
   end
 end

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
-    using Eldritch::Refinements
-
     attr_writer :value
 
     # @return [Thread] underlying ruby thread
@@ -27,13 +25,13 @@ module Eldritch
     #   task.start  # calls the block in parallel
     def start
       @thread = Thread.new self, &@block
-      @thread.task = self
+      @thread.eldritch_task = self
     end
 
     # Waits for the task to complete
     def wait
       @thread.join
-      @thread.task = nil
+      @thread.eldritch_task = nil
     end
 
     # The return value of the task

data/lib/eldritch/version.rb

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

data/spec/dsl_spec.rb

@@ -28,9 +28,9 @@ describe Eldritch::DSL do
     it 'should set the current thread group' do
       group = double('group').as_null_object
       allow(Eldritch::Group).to receive(:new).and_return(group)
-      allow(Thread.current).to receive(:group=).with(anything)
+      allow(Thread.current).to receive(:eldritch_group=).with(anything)
 
-      expect(Thread.current).to receive(:group=).with(group)
+      expect(Thread.current).to receive(:eldritch_group=).with(group)
 
       klass.together {}
     end
@@ -48,11 +48,11 @@ describe Eldritch::DSL do
       group = double('group').as_null_object
       old_group = double('old group').as_null_object
       allow(Eldritch::Group).to receive(:new).and_return(group)
-      allow(Thread.current).to receive(:group).and_return(old_group)
+      allow(Thread.current).to receive(:eldritch_group).and_return(old_group)
 
       klass.together {}
 
-      expect(Thread.current.group).to eql(old_group)
+      expect(Thread.current.eldritch_group).to eql(old_group)
     end
 
     it 'should yield it the new group' do
@@ -78,7 +78,7 @@ describe Eldritch::DSL do
         call_me.call(task)
       end
 
-      allow(Thread.current).to receive(:group).and_return(group)
+      allow(Thread.current).to receive(:eldritch_group).and_return(group)
     end
 
     context 'with 0 arguments' do
@@ -108,7 +108,8 @@ describe Eldritch::DSL do
     context 'with 1 argument' do
       before do
         klass.class_eval do
-          async def foo; end
+          def foo; end
+          async :foo
         end
       end
 
@@ -120,7 +121,8 @@ describe Eldritch::DSL do
         expect(klass).to receive(:define_method).with(:foo)
 
         klass.class_eval do
-          async def foo; end
+          def foo; end
+          async :foo
         end
       end
 
@@ -134,7 +136,8 @@ describe Eldritch::DSL do
 
         it 'should pass all arguments' do
           klass.class_eval do
-            async def foo(_,_,_); end
+            def foo(_,_,_); end
+            async :foo
           end
           instance = klass.new
           expect(instance).to receive(:__async_foo).with(1,2,3)
@@ -146,7 +149,8 @@ describe Eldritch::DSL do
           expect(task).to receive(:value=).with(42)
 
           klass.class_eval do
-            async def foo; 42; end
+            def foo; 42; end
+            async :foo
           end
           instance = klass.new
 

data/spec/group_spec.rb

@@ -46,7 +46,7 @@ describe Eldritch::Group do
   describe '#others' do
     it 'should return an empty array when there is only one task' do
       task = double('task').as_null_object
-      allow(Thread.current).to receive(:task).and_return(task)
+      allow(Thread.current).to receive(:eldritch_task).and_return(task)
 
       group << task
 
@@ -56,7 +56,7 @@ describe Eldritch::Group do
 
     it 'should return all the task except the current one' do
       task = double('task').as_null_object
-      allow(Thread.current).to receive(:task).and_return(task)
+      allow(Thread.current).to receive(:eldritch_task).and_return(task)
       other_task = double('other task').as_null_object
 
       group << task
@@ -96,7 +96,7 @@ describe Eldritch::Group do
     it 'should not call abort on current task' do
       task = double('task').as_null_object
       expect(task).not_to receive(:abort)
-      allow(Thread.current).to receive(:task).and_return(task)
+      allow(Thread.current).to receive(:eldritch_task).and_return(task)
 
       group << task
       group.abort
@@ -115,7 +115,7 @@ describe Eldritch::Group do
     it 'should not call interrupt on current task' do
       task = double('task').as_null_object
       expect(task).not_to receive(:interrupt)
-      allow(Thread.current).to receive(:task).and_return(task)
+      allow(Thread.current).to receive(:eldritch_task).and_return(task)
 
       group << task
       group.interrupt

data/spec/task_spec.rb

@@ -33,7 +33,7 @@ describe Eldritch::Task do
     end
 
     it 'should set the thread task' do
-      expect(thread).to receive(:task=).with(task)
+      expect(thread).to receive(:eldritch_task=).with(task)
 
       task.start
     end
@@ -50,7 +50,7 @@ describe Eldritch::Task do
     it 'should set the thread task to nil' do
       task.start
 
-      expect(thread).to receive(:task=).with(nil)
+      expect(thread).to receive(:eldritch_task=).with(nil)
       task.wait
     end
   end
@@ -66,7 +66,7 @@ describe Eldritch::Task do
     it 'should set the thread task to nil' do
       task.start
 
-      expect(thread).to receive(:task=).with(nil)
+      expect(thread).to receive(:eldritch_task=).with(nil)
       task.value
     end
 

data/spec/thread_spec.rb

@@ -1,49 +1,45 @@
 require 'spec_helper'
-require 'eldritch/refinements/thread'
-
-using Eldritch::Refinements
+require 'eldritch/core_ext/thread'
 
 describe Thread do
   let(:thread) { Thread.new {} }
 
   it 'should have group accessor' do
-    # refinements don't work with #respond_to? and send, we have to check for errors
-    expect{thread.group}.not_to raise_error
-    expect{thread.group = nil}.not_to raise_error
+    expect(thread).to respond_to(:eldritch_group)
+    expect(thread).to respond_to(:eldritch_group=)
   end
 
   it 'should have a task accessor' do
-    # refinements don't work with #respond_to? and send, we have to check for errors
-    expect{thread.task}.not_to raise_error
-    expect{thread.task = nil}.not_to raise_error
+    expect(thread).to respond_to(:eldritch_task)
+    expect(thread).to respond_to(:eldritch_task=)
   end
 
   describe '#group' do
     it 'should return the togther previously set' do
       group = double('group')
-      thread.group = group
-      expect(thread.group).to eql(group)
+      thread.eldritch_group = group
+      expect(thread.eldritch_group).to eql(group)
     end
 
     it 'should return a NilGroup when none are set' do
-      expect(thread.group).to be_a Eldritch::NilGroup
+      expect(thread.eldritch_group).to be_a Eldritch::NilGroup
     end
   end
 
   describe '#in_group?' do
     it 'should be false when group is nil' do
-      thread.group = nil
-      expect(thread.in_group?).to be_false
+      thread.eldritch_group = nil
+      expect(thread.in_eldritch_group?).to be_false
     end
 
     it 'should be false when group is a NilGroup' do
-      thread.group = Eldritch::NilGroup.new
-      expect(thread.in_group?).to be_false
+      thread.eldritch_group = Eldritch::NilGroup.new
+      expect(thread.in_eldritch_group?).to be_false
     end
 
     it 'should be true when group is set' do
-      thread.group = 2
-      expect(thread.in_group?).to be_true
+      thread.eldritch_group = 2
+      expect(thread.in_eldritch_group?).to be_true
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eldritch
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Boris Bera
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,10 +93,10 @@ files:
 - examples/simple_async_method.rb
 - examples/together_simple.rb
 - lib/eldritch.rb
+- lib/eldritch/core_ext/thread.rb
 - lib/eldritch/dsl.rb
 - lib/eldritch/group.rb
 - lib/eldritch/interrupted_error.rb
-- lib/eldritch/refinements/thread.rb
 - lib/eldritch/safe.rb
 - lib/eldritch/task.rb
 - lib/eldritch/version.rb
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/eldritch/refinements/thread.rb

@@ -1,16 +0,0 @@
-module Eldritch
-  module Refinements
-    refine Thread do
-      attr_writer :group
-      attr_accessor :task
-
-      def group
-        @group ||= Eldritch::NilGroup.new
-      end
-
-      def in_group?
-        !group.nil?
-      end
-    end
-  end
-end