easy_threadpool 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjcxNmE2YmZiNTQzMGNhMWJjMzk5N2Y0OGVkMTE2NmIwMDY0YzFmMw==
+  data.tar.gz: !binary |-
+    ZmVlMTM2NDQwYmVjZmUwZGUyNDZmYWY2NzU5NDFjYTg5MGQ5MDRiOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YWNhZTMzMjQ3MGEyZmNjMzg1NzdkMGZmMzc0ODcxN2JhZTU0MzJiM2E0OGEy
+    NTQyMWJlZGNkZmEzN2Q4YTEwNDkxMmVlODhiYWE5NWJmNDk3ZWFjNzA0ZjE3
+    NTZlZGQxZWY4ZDI2YzFkZWI0Yzc5ZjcxNWIwMmRkNTI0MWJiOWI=
+  data.tar.gz: !binary |-
+    NDFjZTkwOTA0NjBkNWRjODVjNGQ4ODAzMWIwOWMxMGNjZmJkYThkNTEwZjVl
+    MTEzOTEwZGIyMWRjOThlYWZhOWU1NDEzZWEzYWMyN2E2NmExYWIyNjEwZjIw
+    NTYxM2Y0YmUzOTljNWQ0ZmFhNGEzNzk5MjM0M2U3NDJhZWZjYTU=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Francesco Laurita
+
+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,46 @@
+# EasyThreadpool
+
+  This gem has been written keeping semplicity in mind
+
+  It implements Thread Pool Pattern described here http://en.wikipedia.org/wiki/Thread_pool_pattern
+
+  Recommended for I/O activities are easily parallelizable, such as downloading remote resources, web scraping, bulk API calls, etc 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_threadpool'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_threadpool
+
+## Usage
+
+```ruby
+require "easy_threadpool"
+pool = Thread.pool(10)
+
+20.times {
+  pool.process do 
+    # Put your slow task here
+    sleep rand(0.3..2)
+    puts "Task consumed by worker ##{Thread.current[:id]}"
+  end
+}
+pool.shutdown
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/easy_threadpool.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_threadpool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_threadpool"
+  spec.version       = EasyThreadpool::VERSION
+  spec.authors       = ["Francesco Laurita"]
+  spec.email         = ["francesco.laurita@gmail.com"]
+  spec.description   = %q{An easy to use Thread Pool implementation}
+  spec.summary       = %q{
+    This gem has been written keeping semplicity in mind
+    It implements Thread Pool Pattern described here http://en.wikipedia.org/wiki/Thread_pool_pattern
+    Recommended for I/O activities are easily parallelizable, such as downloading
+    remote resources, web scraping, bulk API calls, etc 
+  }
+  spec.homepage      = "https://github.com/taganaka/easy_threadpool_rb"
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/examples/sample.rb

@@ -0,0 +1,23 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easy_threadpool"
+require "open-uri"
+require "logger"
+
+@logger = Logger.new(STDOUT)
+
+def download(url)
+  open(url).read
+  @logger.info "Url #{url} fetched by worker ##{Thread.current[:id]}"
+end
+
+pool = Thread.pool(10)
+urls = []
+open("https://rubygems.org/gems?letter=A").read.scan(/a href="(\/gems\/.*)"/) { |match| urls << "https://rubygems.org#{match.first}"}
+urls.each do |u|
+  pool.process u do |url|
+    download url
+  end
+end
+pool.shutdown
+@logger.info "Consumed #{pool.task_consumed} tasks by #{pool.size} workers"

data/lib/easy_threadpool.rb

@@ -0,0 +1,10 @@
+require "easy_threadpool/version"
+require "easy_threadpool/pool"
+
+# It adds a shortcut to the Thread class
+# pool = Thread.pool(10)
+class Thread
+  def self.pool(size)
+    EasyThreadpool::Pool.new size
+  end
+end

data/lib/easy_threadpool/pool.rb

@@ -0,0 +1,61 @@
+require "thread"
+module EasyThreadpool
+  class Pool
+    
+    # Creating a new ThreadPool of size equal to @size
+    # It defines how many threads we will have
+    # spawned internally.
+    def initialize(size = 10)
+      # Pool size
+      @size  = size
+      # Queue holds tasks
+      @queue = Queue.new
+      # Threads are created
+      @pool = Array.new(size) { |i| worker i}
+
+      @consumed = 0
+    end
+
+    # It schedules a job.
+    # The block of code will be executed once a thread is available
+    def process(*args, &block)
+      @queue << [block, args]
+    end
+
+    # Graceful shutdown
+    # Always call pool.shutdow to ensure all of your enqueud
+    # task are executed
+    def shutdown
+      1.upto(@size) {|i| @queue << [:EXIT]}
+      @pool.map(&:join)
+    end
+
+    # Force shutdown
+    def shutdown!
+      @pool.map(&:exit)
+    end
+
+    def task_consumed
+      @consumed
+    end
+
+    def size
+      @size
+    end
+
+    private
+      # It creates a task consumer
+      # :EXIT is a special internal message to handle Graceful shutdown
+      def worker id
+        Thread.new do
+          Thread.current[:id] = id
+          while true do
+            code, args = @queue.pop
+            break if code == :EXIT
+            @consumed += 1
+            code.call(*args)
+          end
+        end
+      end
+  end
+end

data/lib/easy_threadpool/version.rb

@@ -0,0 +1,3 @@
+module EasyThreadpool
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: easy_threadpool
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Francesco Laurita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: An easy to use Thread Pool implementation
+email:
+- francesco.laurita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_threadpool.gemspec
+- examples/sample.rb
+- lib/easy_threadpool.rb
+- lib/easy_threadpool/pool.rb
+- lib/easy_threadpool/version.rb
+homepage: https://github.com/taganaka/easy_threadpool_rb
+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.0.7
+signing_key: 
+specification_version: 4
+summary: This gem has been written keeping semplicity in mind It implements Thread
+  Pool Pattern described here http://en.wikipedia.org/wiki/Thread_pool_pattern Recommended
+  for I/O activities are easily parallelizable, such as downloading remote resources,
+  web scraping, bulk API calls, etc
+test_files: []