screw 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+false and group :development, :test do
+  gem "guard"
+  gem "guard-bundler"
+  gem "guard-rspec"
+  gem "terminal-notifier-guard"
+  gem "pry-debugger" # required by Guard!
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard :bundler do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")        { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Lanett
+
+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,29 @@
+# Screw
+
+Small classes to help bolt together a threaded application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'screw'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install screw
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/screw/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/screw.rb

@@ -0,0 +1,10 @@
+require "screw/version"
+
+module Screw
+  autoload :Logger,     "screw/logger"
+  autoload :Proxy,      "screw/proxy"
+  autoload :Queue,      "screw/queue"
+  autoload :Semaphore,  "screw/semaphore"
+
+  extend Logger
+end

data/lib/screw/logger.rb

@@ -0,0 +1,57 @@
+require "logger"
+require "thread"
+
+module Screw
+  module Logger
+
+    class SafeLogger
+
+      def initialize(theLogger)
+        @logger = theLogger
+        @mutex  = Mutex.new
+      end
+
+      ::Logger::Severity.constants.each do |sym|
+        level = ::Logger::Severity.const_get(sym)
+        name  = sym.to_s.downcase.to_sym
+        pred  = "#{name}?".to_sym
+        define_method(name) do |message = nil, progname = nil, &block|
+          # Executing blocks in this mutex is not be a good idea. Resolve them first.
+          if block && (level >= @logger.level)
+            message = block.call.to_s
+          end
+          @mutex.synchronize do
+            @logger.add(level, message, progname)
+          end
+        end
+        define_method(pred) do
+          level >= @logger.level
+        end
+      end
+
+      def close
+        @mutex.synchronize do
+          @logger.close
+        end
+      end
+
+    end
+
+    # This logger will be shared by every class which includes the module. It's global.
+    def logger=(aLogger)
+      Thread.exclusive do
+        @@logger = aLogger
+      end
+    end
+
+    def logger
+      # I'm assuming that reads are atomic.
+      @@logger ||= begin
+        Thread.exclusive do
+          @@logger ||= SafeLogger.new(::Logger.new(STDERR))
+        end
+      end
+    end
+
+  end # Logger
+end # Screw

data/lib/screw/proxy.rb

@@ -0,0 +1,20 @@
+module Screw
+  # Proxy allows you to intercept calls to one object and divert them to a handler.
+  # Each method call is memoized using method_missing/define_method.
+  class Proxy
+
+    def initialize(target, &block)
+      @target = target
+      @block  = block
+    end
+
+    def method_missing(method, *arguments, &block)
+      raise ::NoMethodError, method.to_s if ! @target.respond_to?(method)
+      self.singleton_class.send(:define_method, method) do |*arguments,&block|
+        @block.call(method, *arguments, &block)
+      end
+      send(method, *arguments, &block)
+    end
+
+  end # Proxy
+end # Screw

data/lib/screw/queue.rb

@@ -0,0 +1,61 @@
+require "thread"
+
+module Screw
+  class Queue
+
+    Unlimited = 0
+    Forever   = (2 ** (0.size * 8 - 2) - 1) # Ruby uses an extra bit as a Fixnum flag.
+    NoWait    = 0
+
+    class Timeout < ::Exception
+    end
+
+    # @param max is the maximum size of the queue. Optional, defaults to 0 (Unlimited).
+    def initialize(max = Unlimited)
+      raise max.inspect unless (Fixnum === max && max >= 0)
+      @max    = max
+      @queue  = []
+      @mutex  = Mutex.new
+      @nempty = ConditionVariable.new
+      @nfull  = ConditionVariable.new
+    end
+
+    def push(it)
+      @mutex.synchronize do
+        while @max > 0 && @queue.size >= @max do
+          @nfull.wait(@mutex)
+        end
+
+        # Push. But also if anyone else is waiting to pop, they can do it now.
+        @queue << it
+        @nempty.signal
+        self
+      end
+    end
+
+    # @param wait is timeout in seconds; Optional, defaults to Forever.
+    # @raises Timeout in the event of a timeout
+    def pop(wait = Forever)
+      raise wait.inspect unless (Fixnum === wait && wait >= 0)
+
+      @mutex.synchronize do
+        while @queue.size == 0
+
+          # Have we run out of time?
+          raise Timeout if wait <= 0
+
+          # Wait. Subtract wait time from timeout.
+          now = Time.now.to_i
+          @nempty.wait(@mutex, wait)
+          wait -= (Time.now.to_i - now)
+        end
+
+        # Pop
+        it = @queue.shift
+        @nfull.signal
+        it
+      end # synchronize
+    end # pop
+
+  end # Queue
+end

data/lib/screw/semaphore.rb

@@ -0,0 +1,51 @@
+require "thread"
+
+module Screw
+  # Semaphore implements a resource counting control.
+  # Call #wait! to acquire a resource.
+  # Call #signal! to release one.
+  # Originally based on https://gist.github.com/pettyjamesm/3746457, but rewritten and fixed.
+  class Semaphore
+
+    def initialize(max = nil, count = 0)
+      max     = max.to_i unless max.nil?
+      count   = count.to_i
+      raise NonPositiveMax, max.to_s if max and max <= 0
+      raise CountOverflow, count.to_s if max and max < count
+      @max    = max
+      @count  = count
+      @mon    = Mutex.new
+      @nempty = ConditionVariable.new
+      @nfull  = ConditionVariable.new
+    end
+  
+    def count
+      @mon.synchronize { @count }
+    end
+  
+    # e.g. release (back into pool)
+    def signal!
+      @mon.synchronize do
+        @nfull.wait(@mon) while @max and @count == @max
+        @count += 1
+        @nempty.signal
+      end
+    end
+  
+    # e.g. acquire (from pool)
+    def wait!
+      @mon.synchronize do
+        @nempty.wait(@mon) while @count == 0
+        @count -= 1
+        @nfull.signal
+      end
+    end
+
+    class NonPositiveMax < ArgumentError
+    end
+
+    class CountOverflow < ArgumentError
+    end
+
+  end # Semaphore
+end # Screw

data/lib/screw/version.rb

@@ -0,0 +1,3 @@
+module Screw
+  VERSION = "0.0.1"
+end

data/screw.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'screw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "screw"
+  spec.version       = Screw::VERSION
+  spec.authors       = ["Mark Lanett"]
+  spec.email         = ["mark.lanett@gmail.com"]
+  spec.summary       = %q{Small classes to help bolt together a threaded application.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/screw/logger_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+require "logger"
+require "stringio"
+
+describe Screw::Logger::SafeLogger do
+
+  let(:buffer) { StringIO.new("") }
+  let(:base)   { ::Logger.new(buffer).tap { |it| it.formatter = ->(severity, datetime, program, message) { "#{message}\n" } } }
+  subject      { Screw::Logger::SafeLogger.new(base) }
+
+  it "logs" do
+    subject.info "Hello, world"
+    expect(buffer.string).to eq "Hello, world\n"
+  end
+
+  it "resolves blocks" do
+    subject.info { "Hello, world" }
+    expect(buffer.string).to eq "Hello, world\n"
+  end
+
+  it "does not log to quiet loggers" do
+    base.level = 1
+    subject.debug "This is a test."
+    expect(buffer.string.size).to eq 0
+    subject.debug { "This is also a test." }
+    expect(buffer.string.size).to eq 0
+  end
+
+  it "does not interleave output", stress: true do
+    subject # force
+    ((1..100).map { Thread.new { subject.info "Hello, world" } }).shuffle.map(&:join)
+    expect(buffer.string).to eq "Hello, world\n" * 100
+  end
+
+end

data/spec/lib/screw/proxy_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+class ProxyTest
+  attr_accessor :a, :b
+  def one(a)
+    self.a = a
+    self
+  end
+  def two(a,b)
+    self.a = a
+    self.b = b
+    self
+  end
+  def pass(&block)
+    block.call
+  end
+end
+
+describe Screw::Proxy do
+
+  let(:base)     { ProxyTest.new }
+  subject        { Screw::Proxy.new(base,&handler) }
+  let(:subject2) { Screw::Proxy.new(base,&handler) }
+
+  describe "for one argument" do
+    let(:handler) { ->(method, arg1, &block) { base.one(arg1) } }
+
+    it "memoizes methods" do
+      expect(subject).to_not respond_to(:one)
+
+      expect(subject.one(0)).to eq base
+      expect(subject).to respond_to(:one)
+
+      expect(subject2).to_not respond_to(:one)
+    end
+
+    it "passes one argument and returns the source" do
+      expect(subject.one(1)).to eq base
+      expect(base.a).to eq 1
+    end
+  end
+
+  describe "for two arguments" do
+    let(:handler) { ->(method, arg1, arg2, &block) { base.two(arg1,arg2) } }
+    it "passes one argument and returns the source" do
+      subject.two(2,3)
+      expect(base.a).to eq 2
+      expect(base.b).to eq 3
+    end
+  end
+
+  describe "for various arguments" do
+    let(:handler) { ->(method, *arguments, &block) { base.send(method,*arguments) } }
+    it "passes one argument and returns the source" do
+      subject.one(4)
+      expect(base.a).to eq 4
+      subject.two(5,6)
+      expect(base.a).to eq 5
+      expect(base.b).to eq 6
+    end
+  end
+
+  describe "with blocks" do
+    let(:handler) { ->(method, *arguments, &block) { base.send(method,*arguments,&block) } }
+    it "evaluates blocks" do
+      expect(subject.pass { 3 }).to eq 3
+    end
+  end
+
+end

data/spec/lib/screw/queue_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Screw::Queue do
+
+  subject { Screw::Queue.new }
+
+  it "can push and pop ordered in same thread" do
+    subject.push :a
+    subject.push :b
+    expect(subject.pop).to eq :a
+    expect(subject.pop).to eq :b
+  end
+
+  it "can push and pop in different threads" do
+    Thread.new do
+      subject.push :a
+      subject.push :b
+    end
+    expect(subject.pop).to eq :a
+    expect(subject.pop).to eq :b
+  end
+
+end

data/spec/lib/screw/semaphore_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Screw::Semaphore do
+
+  let(:num) { 25 }
+  let(:max) { 5 }
+  subject   { Screw::Semaphore.new(nil, max) }
+  before    { expect(subject.count).to eq max }
+  after     { expect(subject.count).to eq max }
+
+  it "does not deadlock", stress: true do
+    t = (1..num).map do
+      Thread.new do
+        subject.wait!
+        sleep rand
+        subject.signal!
+      end
+    end
+    t.map(&:join)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require "screw"
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: screw
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Lanett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mark.lanett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/screw.rb
+- lib/screw/logger.rb
+- lib/screw/proxy.rb
+- lib/screw/queue.rb
+- lib/screw/semaphore.rb
+- lib/screw/version.rb
+- screw.gemspec
+- spec/lib/screw/logger_spec.rb
+- spec/lib/screw/proxy_spec.rb
+- spec/lib/screw/queue_spec.rb
+- spec/lib/screw/semaphore_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3114135878833884078
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3114135878833884078
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Small classes to help bolt together a threaded application.
+test_files:
+- spec/lib/screw/logger_spec.rb
+- spec/lib/screw/proxy_spec.rb
+- spec/lib/screw/queue_spec.rb
+- spec/lib/screw/semaphore_spec.rb
+- spec/spec_helper.rb