hyper_thread 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ff934f8b1cf5c637b8c2b8ec3e7cc3cc2d02a4a
+  data.tar.gz: 93e6e09be667cb2590b2f89de8649c6bffff26e2
+SHA512:
+  metadata.gz: 326de2d3a0c88fc6d45997beb6d03bcb9f485df8544a4a6947fe21967dc8bf353191c48fb298ebad8bafc56c9be90849340cf4911d560878dc47515684970ff8
+  data.tar.gz: 2093b5a862a2e5a6efc5e3640266bb9e508319ef1f6d9d9dd6e5ef7a2479c1967ade03511ae061fcf8f22c255a87d7612c2dba788c76a3ccaf4181740d3525af

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kgruber1@emich.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kent Gruber
+
+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,55 @@
+![Hyper Thread Header](https://i.imgur.com/di45BuN.png)
+
+# Hyper Thread
+
+Hyper Thread is simple, flexible thread pool library for Ruby.
+
+## Installation
+
+    $ gem install hyper_thread
+
+## Usage
+
+```ruby
+require 'hyper_thread'
+
+# make a pool of maximum 7 threads
+pool = HyperThread.pool.new(max: 10)
+
+# spawn 7 threads, and 3 jobs will be added to the queue
+pool.async(count: 10) do
+  puts "some work to do"
+end
+
+# spool off queued jobs outside of thread pool
+pool.todo(count: pool.queue.size) do |block|
+  block.call # "some work to do"
+end
+
+# kill off any dead threads
+pool.reap
+
+# queue up 300 jobs
+counter = 0
+
+pool.qsync(count: 300) do
+  puts "some work to do #{counter += 1}"
+end
+
+# spawn 2 threads to manage the queue forever
+pool.async(forever: true, count: 2) do
+  pool.todo do |block|
+    block.call
+  end
+end
+
+# let them manage that queue for roughly 2 seconds
+sleep 2
+
+# shutdown the thread pool
+pool.shutdown
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hyper_thread"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/debug.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'hyper_thread'
+require 'pry'
+
+binding.pry

data/examples/pool_example.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'hyper_thread'
+
+# spawn thread pool
+pool = HyperThread.pool.new(max: 7)
+
+# ask to spawn more threads than max value
+pool.async(count: 9) do
+  "this is some work"
+end
+
+# the extra jobs are in a queue
+pool.queue.size 
+# => 2
+
+# spool off any queue'd jobs outside of pool
+pool.todo(count: pool.queue.size) do |block|
+  puts block.call 
+end
+
+# shutdown pool
+pool.shutdown
+
+
+

data/examples/readme_example.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'hyper_thread'
+
+# make a pool of maximum 7 threads
+pool = HyperThread.pool.new(max: 10)
+
+# spawn 7 threads, and 3 jobs will be added to the queue
+pool.async(count: 10) do
+  puts "some work to do"
+end
+
+# spool off queued jobs
+pool.todo(count: pool.queue.size) do |block|
+  block.call # "some work to do"
+end
+
+# kill off any dead threads
+pool.reap
+
+# queue up 300 jobs
+counter = 0
+
+pool.qsync(count: 300) do
+  puts "some work to do #{counter += 1}"
+end
+
+# spawn 2 threads to manage the queue forever
+pool.async(forever: true, count: 2) do
+  pool.todo do |block|
+    block.call
+  end
+end
+
+pool.qsync(count: 300) do
+  "some work to do #{counter += 1}"
+end
+
+# let them manage that queue for roughly 2 seconds
+sleep 2
+
+# shutdown the thread pool
+puts "Shutting down #{pool.threads.count} threads."
+pool.shutdown

data/examples/with_pcap.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'hyper_thread'
+require 'pcaprub'
+
+cap_pool = HyperThread.pool.new(max: 1)
+
+packets = Queue.new
+
+puts "starting capture"
+
+cap_pool.async do
+  cap = PCAPRUB::Pcap.open_live(Pcap.lookupdev, 65535, true, 0)
+  loop do
+    next unless packet = cap.next
+    packets << packet
+  end
+end
+
+puts "starting parse pool"
+
+parse_pool = HyperThread.pool.new(max: 5)
+
+parse_pool.async(forever: true, count: parse_pool.max) do
+  next unless packet = packets.pop
+	puts packet.size
+end
+
+sleep 2 # let it run for roughly 2 seconds
+
+puts "shutting down capture and parsing pools"
+[ cap_pool, parse_pool ].each do |pool|
+	pool.shutdown
+end
+
+exit 0

data/hyper_thread.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hyper_thread/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hyper_thread"
+  spec.version       = HyperThread::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{Hyper Thread is simple, flexible thread pool library for Ruby.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/picatz/hyper_thread"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "lolize"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hyper_thread.rb

@@ -0,0 +1,28 @@
+require 'thread'
+require "hyper_thread/version"
+require "hyper_thread/pool"
+require "hyper_thread/thread"
+
+# Some code copyright (c) 2005, Zed Shaw
+# Some code Copyright (c) 2011, Evan Phoenix
+# Some code Copyright (c) 2015, Simone Margaritelli
+
+# I basically was refactoring the ThreadPool in BetterCap and made this.
+
+module HyperThread
+
+  def self.easter_egg
+    require 'lolize/auto'
+  rescue
+    raise "Please install lolize!\n$ gem install lolize"
+  end
+
+  def self.pool
+    Pool
+  end
+
+  def self.thread
+    HThread
+  end
+
+end

data/lib/hyper_thread/pool.rb

@@ -0,0 +1,127 @@
+module HyperThread
+  class Pool
+    attr_reader   :queue
+
+    def initialize(max: 2)
+      @threads = []
+      @mutex   = Mutex.new  
+      @queue   = Queue.new  
+      @max     = max.to_i   
+    end
+
+    def max=(value)
+      nsync do
+        if value > @max
+          dead = @threads.sample(value).map(&:exit)
+          @threads -= dead
+        end
+        @max = value
+        return true
+      end
+    end
+
+    def max
+      @max
+    end
+
+    def threads
+      return @threads unless block_given?
+      @threads.each do |thread|
+        yield thread
+      end
+    end
+
+    def shutdown
+      @shutdown = true
+      dead = @threads.map(&:exit)
+      @threads -= dead
+    end
+
+    def reap
+      dead = @threads.reject(&:alive?)
+      dead.map(&:kill)
+      @threads -= dead
+      return true
+    end
+
+    def nsync(&block)
+      @mutex.synchronize do
+        break if @shutdown
+        block.call
+      end
+      return if @shutdown
+    end
+
+    def async(forever: false, count: 1, &block)
+      raise "Required block syntax" unless block_given?
+      count.times do
+        if @threads.count == max
+          @queue << block
+          next
+        end
+        self << Thread.new do
+          if forever
+            loop do
+              nsync do 
+                block.call
+              end
+            end
+          else
+            nsync do 
+              block.call
+            end
+          end
+        end
+      end
+      return @queue if @threads.count == max
+      @threads
+    end
+
+    def todo(forever: false, count: false)
+      raise "Required block syntax" unless block_given?
+      if count
+        count.times do
+          yield @queue.pop
+        end
+      else
+        if forever
+          loop do  
+            while @queue.size > 0
+              yield @queue.pop
+            end
+          end
+        else
+          yield @queue.pop
+        end
+      end
+    end
+
+    def qsync(count: 1, &block)
+      nsync do 
+        raise "Required block syntax" unless block_given?
+        Thread.new do
+          count.times do
+            @queue << block
+          end
+        end
+        true
+      end
+    end
+
+    def todo?
+      nsync do 
+        return true if @queue.size > 0
+        false
+      end
+    end
+
+    def <<(thread)
+      nsync do
+        return false if @threads.count == max
+        @threads << thread
+      end
+    end
+
+  end
+
+end

data/lib/hyper_thread/thread.rb

@@ -0,0 +1,6 @@
+module HyperThread
+	class HThread
+	  # @TODO
+  end
+
+end

data/lib/hyper_thread/version.rb

@@ -0,0 +1,3 @@
+module HyperThread
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: hyper_thread
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lolize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/debug.rb
+- examples/pool_example.rb
+- examples/readme_example.rb
+- examples/with_pcap.rb
+- hyper_thread.gemspec
+- lib/hyper_thread.rb
+- lib/hyper_thread/pool.rb
+- lib/hyper_thread/thread.rb
+- lib/hyper_thread/version.rb
+homepage: https://github.com/picatz/hyper_thread
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Hyper Thread is simple, flexible thread pool library for Ruby.
+test_files: []