mock-thread 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 281c06e996f0ecee2b850ec80a6a01ad49959d2d
+  data.tar.gz: 234cfa97de1a6a42edca8ea87ffbabac9207bbe8
+SHA512:
+  metadata.gz: 5d9fb91bfe79f17557b7da312ed1d841ad3359f0b0d051f07b09c4a0a97a3dc805292b357044bcc2b017d78ee685955eab07f7c5ea090f708c01c36182258a55
+  data.tar.gz: 99a1ff15e91b629c893aa02f7300655ddb3fffa044e675bb51b6f8f2565077b5d81cf2a6ca5f177b77862a04368c078ec92cb8212a8051039f87742a45cab531

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2014, Joel VanderWerf, vjoel@users.sourceforge.net
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,4 @@
+mock-thread
+===========
+
+Use Fibers to test Thread code

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/testtask'
+
+PRJ = "mock-thread"
+
+def version
+  @version ||= begin
+    require 'mock-thread/version'
+    warn "MockThread::VERSION not a string" unless
+      MockThread::VERSION.kind_of? String
+    MockThread::VERSION
+  end
+end
+
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
+
+desc "Run tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "ext"
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+desc "Commit, tag, and push repo; build and push gem"
+task :release => "release:is_new_version" do
+  require 'tempfile'
+  
+  sh "gem build #{PRJ}.gemspec"
+
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
+
+  sh "git tag #{tag}"
+  sh "git push"
+  sh "git push --tags"
+  
+  sh "gem push #{tag}.gem"
+end
+
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
+
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
+
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
+end

data/lib/mock-thread/mock-queue.rb

@@ -0,0 +1,42 @@
+class MockQueue
+  class QueueEmptyError < StandardError; end
+  
+  attr_reader :entries
+  attr_reader :yield_on_push
+  attr_reader :yield_on_pop
+  
+  def initialize yield_on_push: false, yield_on_pop: false
+    @entries = []
+    @yield_on_push = yield_on_push
+    @yield_on_pop = yield_on_pop
+  end
+  
+  def empty?
+    entries.empty?
+  end
+  
+  def push val
+    @entries << val
+    if yield_on_push
+      Fiber.yield([:push, val]) rescue FiberError
+    end
+  end
+  alias << push
+  
+  def pop
+    begin
+      while @entries.empty?
+        Fiber.yield :block
+      end
+    rescue FiberError => ex
+      raise QueueEmptyError, "queue empty (#{ex.message})"
+    end
+    
+    val = @entries.shift
+    if yield_on_pop
+      Fiber.yield([:pop, val]) rescue FiberError
+    end
+    val
+  end
+end
+

data/lib/mock-thread/mock-thread.rb

@@ -0,0 +1,103 @@
+require 'fiber'
+
+require 'mock-thread/mock-queue.rb'
+
+class MockThread
+  class IsBlocked < RuntimeError; end
+  class IsDone < RuntimeError; end
+
+  def make_queue
+    MockQueue.new
+  end
+  
+  # Override to update any state before running a step. For example, update
+  # part of the system that is not expressed by a mock thread, such as
+  # a component that processes what mock threads have sent to a queue.
+  def update_before; end
+
+  # Override to update any state after running a step.
+  def update_after; end
+  
+  # Schedule some code for deferred execution. For example:
+  #
+  #   c.will {foo}.will {bar}
+  #
+  # The #foo and #bar methods of c will be called later.
+  #
+  def will &block
+    (@will_do ||= []) << Fiber.new { instance_eval &block }
+    self
+  end
+  
+  def step
+    loop do
+      fiber = @will_do[0] or raise IsDone, "nothing to do"
+
+      if fiber.alive?
+        update_before
+        val = fiber.resume
+        update_after
+        return val
+      end
+
+      @will_do.shift
+    end
+  end
+  
+  def run limit: 100
+    loop do
+      fiber = @will_do[0] or raise IsDone, "nothing to do"
+
+      count = 0
+      while fiber.alive?
+        update_before
+        val = fiber.resume
+        update_after
+        if fiber.alive? or @will_do.size > 1
+          if val == :block
+            count += 1
+            if count > limit
+              raise IsBlocked, "exceeded blocking limit"
+            end
+          else
+            count = 0
+            yield val if block_given?
+          end
+        else
+          return val
+        end
+      end
+
+      @will_do.shift
+    end
+  end
+  
+  def run_until_blocked limit: 100, &block
+    begin
+      run limit: limit, &block
+    rescue IsBlocked
+      return
+    end
+    raise IsDone, "run_until_blocked never blocked"
+  end
+  
+  def now limit: 100, &block
+    fiber = Fiber.new { instance_eval &block }
+    val = nil
+    count = 0
+    update_before
+    while fiber.alive?
+      val = fiber.resume
+      if val == :block
+        count += 1
+        if count > limit
+          raise IsBlocked, "cannot now do that -- exceeded blocking limit"
+        end
+      else
+        count = 0
+      end
+      update_after
+    end
+    val
+  end
+end

data/lib/mock-thread/version.rb

@@ -0,0 +1,3 @@
+module MockThread
+  VERSION = "0.1"
+end

data/test/test-mock-queue.rb

@@ -0,0 +1,93 @@
+require 'minitest/autorun'
+
+require 'mock-thread/mock-queue.rb'
+
+class TestMockQueueWithPushPopYields < Minitest::Test
+  def setup
+    @q = MockQueue.new yield_on_push: true, yield_on_pop: true
+  end
+  
+  def test_push
+    f = Fiber.new do |val|
+      loop do
+        val = @q.push val
+      end
+    end
+    
+    a = []
+    assert_equal a, @q.entries
+    
+    3.times do |i|
+      op, val = f.resume i
+      assert_equal :push, op
+      assert_equal i, val
+      a << i
+      assert_equal a, @q.entries
+    end
+  end
+  
+  def test_pop
+    a = []
+    f = Fiber.new do
+      loop do
+        a << @q.pop
+      end
+    end
+    
+    3.times do
+      op = f.resume
+      assert_equal :block, op
+      assert_equal [], a
+    end
+    
+    @q.entries.concat (0...10).to_a
+    
+    10.times do |i|
+      op, val = f.resume
+      assert_equal :pop, op
+      assert_equal i, val
+    end
+    
+    op = f.resume
+    assert_equal :block, op
+    assert_equal a, (0...10).to_a
+  end
+end
+
+class TestMockQueueSimpler < Minitest::Test
+  def setup
+    @q = MockQueue.new
+  end
+  
+  def test_push
+    a = []
+    assert_equal a, @q.entries
+    
+    3.times do |i|
+      @q.push i
+      a << i
+      assert_equal a, @q.entries
+    end
+  end
+  
+  def test_pop
+    a = []
+    f = Fiber.new do
+      loop do
+        a << @q.pop
+      end
+    end
+    
+    3.times do
+      op = f.resume
+      assert_equal :block, op
+      assert_equal [], a
+    end
+    
+    @q.entries.concat (0...10).to_a
+    
+    op = f.resume
+    assert_equal :block, op
+    assert_equal a, (0...10).to_a
+  end
+end

data/test/test-mock-thread.rb

@@ -0,0 +1,93 @@
+require 'minitest/autorun'
+
+require 'mock-thread/mock-thread.rb'
+
+class TestMockThread < Minitest::Test
+  def test_step
+    mt = MockThread.new
+    
+    mt.will do
+      3.times do |i|
+        Fiber.yield i
+      end
+      "done"
+    end
+
+    assert_equal 0, mt.step
+    assert_equal 1, mt.step
+    assert_equal 2, mt.step
+    assert_equal "done", mt.step
+    assert_raises MockThread::IsDone do
+      mt.step
+    end
+  end
+  
+  def test_run
+    mt = MockThread.new
+    
+    mt.will do
+      3.times do |i|
+        Fiber.yield i
+      end
+      "done"
+    end
+    
+    a = []
+    r = mt.run do |val|
+      a << val
+    end
+    
+    assert_equal "done", r
+    assert_equal [0,1,2], a
+  end
+  
+  def test_run_until_blocked
+    mt = MockThread.new
+    
+    mt.will do
+      3.times do |i|
+        Fiber.yield i
+      end
+      11.times do
+        Fiber.yield :block
+      end
+      "done"
+    end
+    
+    a = []
+    mt.run_until_blocked limit:10 do |val|
+      a << val
+    end
+    
+    assert_equal [0,1,2], a
+
+    r = mt.run
+    assert_equal "done", r
+  end
+
+  def test_now
+    mt = MockThread.new
+    
+    result = mt.now do
+      3.times do
+        Fiber.yield :block
+      end
+      "done"
+    end
+    
+    assert_equal "done", result
+  end
+  
+  def test_now_limit
+    mt = MockThread.new
+    
+    assert_raises MockThread::IsBlocked do
+      mt.now limit: 2 do
+        3.times do
+          Fiber.yield :block
+        end
+        "done"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mock-thread
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Joel VanderWerf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Use Fibers to test Thread code.
+email: vjoel@users.sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- COPYING
+- README.md
+- Rakefile
+- lib/mock-thread/mock-queue.rb
+- lib/mock-thread/mock-thread.rb
+- lib/mock-thread/version.rb
+- test/test-mock-queue.rb
+- test/test-mock-thread.rb
+homepage: https://github.com/vjoel/mock-thread
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- MockThread
+- "--main"
+- README.md
+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: Use Fibers to test Thread code
+test_files:
+- test/test-mock-thread.rb
+- test/test-mock-queue.rb
+has_rdoc: