lifeguard 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e58ec1398c4d3ed7295eddc101b7e0782b7e410
+  data.tar.gz: a50f5bf81baf9c7b9f61756408dd9ce47affc12b
+SHA512:
+  metadata.gz: e2c8b4660b69d933c3edfb118963e08ae94525a01755f134811e669feff118c84ad4549de81759d155a34f64b635df8361ef752fd0781432644f3b138fa5c599
+  data.tar.gz: 6b47b9c2b0c397c80819f96b550e79b8938c087293b05f50bf33aa8300ab206cd47bab224b8a34a5771c3c8fea7411c9c56a3bd8e20bdb1749afcc9d4d9b9a09

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-*
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--order rand
+--require rspec/pride --format RSpec::Pride

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Stien
+
+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,12 @@
+lifeguard
+=========
+
+Do you have a threadpool?  Do you need someone to watch it?  Look no further!
+
+#### Attributions
+
+This gem is based on the thread pool implementation from [concurrent-ruby 0.5.0](https://github.com/jdantonio/concurrent-ruby/tree/v0.5.0)
+
+After version 0.5.0 the author of concurrent-ruby decided to refactor the threadpool
+implementation, this is an attempt improve the existing implementation rather
+that to write something new from scratch.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run specs (default)"
+task :default => :spec

data/lib/lifeguard/infinite_threadpool.rb

@@ -0,0 +1,49 @@
+require 'thread'
+require 'lifeguard/threadpool'
+
+module Lifeguard
+  class InfiniteThreadpool < ::Lifeguard::Threadpool
+
+    def initialize(opts = {})
+      super(opts)
+      @queued_jobs = ::Queue.new
+      @shutdown = false
+    end
+
+    def async(*args, &block)
+      return false if @shutdown
+
+      job_started = super
+
+      unless job_started
+        @queued_jobs << { :args => args, :block => block }
+      end
+
+      job_started
+    end
+
+    def check_queued_jobs
+      if @queued_jobs.size > 0
+        queued_job = @queued_jobs.pop
+        async(*queued_job[:args], &queued_job[:block])
+      end
+    end
+
+    def kill!(*args)
+      super
+      @shutdown = true
+    end
+
+    def on_thread_exit(thread)
+      return_value = super
+      check_queued_jobs
+      return_value
+    end
+
+    def shutdown(*args)
+      @shutdown = true
+      super
+    end
+
+  end
+end

data/lib/lifeguard/reaper.rb

@@ -0,0 +1,45 @@
+module Lifeguard
+  class Reaper
+    ##
+    # Constructor
+    #
+    def initialize(threadpool, reaping_interval)
+      @threadpool = threadpool
+      @reaping_interval = reaping_interval
+      @thread = ::Thread.new { self.run! }
+    end
+
+    ##
+    # Public Instance Methods
+    #
+    def alive?
+      @thread.alive?
+    end
+
+    def reap!
+      @threadpool.prune_busy_threads
+    end
+
+    def run!
+      loop do
+        sleep(@reaping_interval)
+        reap!
+        timeout!
+        ready_thread_count = @threadpool.pool_size - @threadpool.busy_size
+        
+        if ready_thread_count > 0 && @threadpool.respond_to?(:check_queued_jobs)
+          ready_thread_count.times do
+            @threadpool.check_queued_jobs
+          end
+        end
+      end
+    rescue
+      retry
+    end
+
+    def timeout!
+      @threadpool.timeout!
+    end
+
+  end
+end

data/lib/lifeguard/threadpool.rb

@@ -0,0 +1,133 @@
+require 'thread'
+
+module Lifeguard
+  class Threadpool
+    DEFAULT_REAPING_INTERVAL = 5 # in seconds
+    DEFAULT_POOL_SIZE = 2
+
+    attr_accessor :pool_size
+
+    ##
+    # Constructor
+    #
+    def initialize(opts = {})
+      @pool_size = opts[:pool_size] || DEFAULT_POOL_SIZE
+
+      # Important info about "timeout", it is controlled by the reaper
+      # so you're threads won't timeout immediately, they will wait for
+      # the reaper to run.  Make sure you account for reaper interval
+      # in how you want timeout to work, it may be a bit unexpected in 
+      # it's tardiness of timing out threads
+      #
+      @timeout = opts[:timeout]
+      @mutex = ::Mutex.new
+      @busy_threads = []
+
+      @reaper = ::Lifeguard::Reaper.new(self, opts[:reaping_interval] || DEFAULT_REAPING_INTERVAL)
+    end
+
+    ##
+    # Public Instance Methods
+    #
+    def busy_size
+      @busy_threads.size
+    end
+
+    def kill!
+      @mutex.synchronize do
+        prune_busy_threads_without_mutex
+        @busy_threads.each { |busy_thread| busy_thread.kill }
+        prune_busy_threads_without_mutex
+      end
+    end
+
+    def on_thread_exit(thread)
+      @mutex.synchronize do
+        @busy_threads.delete(thread)
+      end
+    end
+
+    def async(*args, &block)
+      queued_the_work = false
+
+      unless block
+        raise "Threadpool#async must be passed a block"
+      end
+
+      @mutex.synchronize do
+        prune_busy_threads_without_mutex
+
+        if busy_size < pool_size
+          queued_the_work = true
+
+          @busy_threads << ::Thread.new(block, args, self) do |callable, call_args, parent|
+            begin
+              ::Thread.current[:__start_time_in_seconds__] = Time.now.to_i
+              ::Thread.current.abort_on_exception = false
+              callable.call(*call_args) # should we check the args? pass args?
+            ensure
+              parent.on_thread_exit(::Thread.current)
+            end
+          end
+        end
+
+        prune_busy_threads_without_mutex
+        queued_the_work
+      end
+    end
+
+    def prune_busy_threads
+      @mutex.synchronize do
+        prune_busy_threads_without_mutex
+      end
+    end
+
+    def shutdown(shutdown_timeout = 0)
+      @mutex.synchronize do
+        prune_busy_threads_without_mutex
+
+        if @busy_threads.size > 0
+          # Cut the shutdown_timeout by 10 and prune while things finish before the kill
+          (shutdown_timeout/10).times do 
+            sleep (shutdown_timeout / 10.0)
+            prune_busy_threads_without_mutex
+            break if busy_size == 0
+          end
+
+          sleep(shutdown_timeout/10)
+          @busy_threads.each { |busy_thread| busy_thread.kill }
+        end
+
+        prune_busy_threads_without_mutex
+      end
+    end
+
+    def timeout!
+      return unless timeout?
+
+      @mutex.synchronize do
+        @busy_threads.each do |busy_thread|
+          if (Time.now.to_i - busy_thread[:__start_time_in_seconds__] > @timeout)
+            busy_thread.kill
+          end
+        end
+
+        prune_busy_threads_without_mutex
+      end
+    end
+
+    def timeout?
+      !!@timeout
+    end
+
+    private
+
+    ##
+    # Private Instance Methods
+    #
+    def prune_busy_threads_without_mutex
+      @busy_threads.select!(&:alive?)
+    end
+
+  end
+end

data/lib/lifeguard/version.rb

@@ -0,0 +1,3 @@
+module Lifeguard
+  VERSION = "0.0.8"
+end

data/lib/lifeguard.rb

@@ -0,0 +1,8 @@
+require "lifeguard/version"
+
+require "lifeguard/infinite_threadpool"
+require "lifeguard/reaper"
+require "lifeguard/threadpool"
+
+module Lifeguard
+end

data/lifeguard.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lifeguard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lifeguard"
+  spec.version       = Lifeguard::VERSION
+  spec.authors       = ["Brian Stien","Brandon Dewitt"]
+  spec.email         = ["brianastien@gmail.com", "brandonsdewitt@gmail.com"]
+  spec.summary       = %q{A Supervised threadpool implementation in ruby.}
+  spec.description   = %q{Do you have a threadpool? Do you need someone to watch it? Look no further!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "better_receive"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-pride"
+  spec.add_development_dependency "simplecov"
+end

data/spec/lifeguard/reaper_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ::Lifeguard::Reaper do
+  pending
+end

data/spec/lifeguard/threadpool_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe ::Lifeguard::Threadpool do
+
+  subject { described_class.new(:pool_size => 5) }
+
+  after(:each) do
+    subject.kill!
+    sleep(0.1)
+  end
+
+  describe "#timeout!" do
+    it "doesn't timeout when no timeout set" do
+      threadpool = described_class.new()
+      threadpool.timeout?.should be_false
+    end
+
+    it "does timeout when timeout set" do
+      threadpool = described_class.new(:timeout => 30)
+      threadpool.timeout?.should be_true
+    end
+
+    it "uses the reaper to timeout threads that are all wiley" do
+      threadpool = described_class.new(:timeout => 1, :reaping_interval => 1)
+      threadpool.async do
+        sleep(10)
+      end
+
+      threadpool.busy_size.should eq(1)
+      sleep(4)
+      threadpool.busy_size.should eq(0)
+    end
+  end
+
+  describe '#kill!' do
+    it 'attempts to kill all in-progress tasks' do
+      @expected = false
+      subject.async{ sleep(1); @expected = true }
+      sleep(0.1)
+      subject.kill!
+      sleep(1)
+      @expected.should be_false
+    end
+
+    it 'rejects all pending tasks' do
+      @expected = false
+      subject.async{ sleep(0.5) }
+      subject.async{ sleep(0.5); @expected = true }
+      sleep(0.1)
+      subject.kill!
+      sleep(1)
+      @expected.should be_false
+    end
+
+    it 'kills all threads' do
+      before_thread_count = Thread.list.size
+      100.times { subject.async{ sleep(1) } }
+      sleep(0.1)
+      Thread.list.size.should > before_thread_count
+      subject.kill!
+      sleep(0.1)
+      Thread.list.size.should eq(before_thread_count + 1) # +1 for the reaper
+    end
+  end
+
+  describe '#async' do
+    it 'raises an exception if no block is given' do
+      expect { subject.async }.to raise_error
+    end
+
+    it 'returns true when the block is added to the queue' do
+      subject.async{ sleep }.should be_true
+    end
+
+    it 'calls the block with the given arguments' do
+      @expected = nil
+      subject.async(1, 2, 3) do |a, b, c|
+        @expected = a + b + c
+      end
+      sleep(0.5)
+      @expected.should eq 6
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+
+require 'simplecov'
+
+SimpleCov.start do
+  project_name 'lifeguard'
+  add_filter '/coverage/'
+  add_filter '/doc/'
+  add_filter '/pkg/'
+  add_filter '/spec/'
+  add_filter '/tasks/'
+end
+
+Bundler.require(:default, :development, :test)
+
+require 'lifeguard'
+
+# import all the support files
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Thread.list.each do |thread|
+      thread.kill unless thread == Thread.current
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: lifeguard
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Brian Stien
+- Brandon Dewitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: better_receive
+  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: 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: pry-nav
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-pride
+  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: simplecov
+  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'
+description: Do you have a threadpool? Do you need someone to watch it? Look no further!
+email:
+- brianastien@gmail.com
+- brandonsdewitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lifeguard.rb
+- lib/lifeguard/infinite_threadpool.rb
+- lib/lifeguard/reaper.rb
+- lib/lifeguard/threadpool.rb
+- lib/lifeguard/version.rb
+- lifeguard.gemspec
+- spec/lifeguard/reaper_spec.rb
+- spec/lifeguard/threadpool_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: A Supervised threadpool implementation in ruby.
+test_files:
+- spec/lifeguard/reaper_spec.rb
+- spec/lifeguard/threadpool_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep