agent-q 0.0.1r2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/coverage
+.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+
+group :test do
+  gem 'simplecov', '>= 0.4.0', :require => false
+  gem 'rspec'
+end
+# Specify your gem's dependencies in q.gemspec
+gemspec

data/Rakefile

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

data/lib/q.rb

@@ -0,0 +1,5 @@
+require "q/version"
+
+module Q
+  # Your code goes here...
+end

data/lib/q/array.rb

@@ -0,0 +1,7 @@
+class Array
+  def symbolize_keys!
+    map do |item|
+      item.symbolize_keys! if item.respond_to? :symbolize_keys!
+    end    
+  end 
+end

data/lib/q/binary_string.rb

@@ -0,0 +1,6 @@
+class BinaryString < String
+  def self.create from_string
+    from_string.force_encoding "BINARY"
+    from_string
+  end 
+end

data/lib/q/collector.rb

@@ -0,0 +1,20 @@
+module Collector
+  include Enumerable
+
+  def [] key
+    collected_items[key] ||= fetch_item key
+  end
+  def keys
+    @keys ||= fetch_keys
+  end
+  def each
+    keys.each do |key|
+      yield self[key]
+    end    
+  end
+  private 
+  def collected_items
+    @collected_items ||= {}
+  end
+  
+end

data/lib/q/dispatcher.rb

@@ -0,0 +1,29 @@
+module Q
+  module Dispatcher
+    class AdapterNotFoundError < StandardError; end
+    class AdapterNotSpecifiedError < StandardError; end
+    
+    def require_pattern pattern
+      @require_pattern = pattern
+    end
+    def constant_suffix suffix
+      @constant_suffix = suffix
+    end
+    def dispatchables
+      @dispatchables ||= {}
+    end
+    private :dispatchables
+        
+    def [] key
+      return dispatchables[key] unless dispatchables[key].nil?
+      begin
+        require(@require_pattern % key.to_s)
+        dispatchables[key] = const_get "#{key.to_s.capitalize}#{@constant_suffix}"
+      rescue LoadError
+        m = "Unable to find #{key} adapter, make sure it is in your load path"
+        raise AdapterNotFoundError, m
+      end
+    end   
+    
+  end
+end

data/lib/q/hash.rb

@@ -0,0 +1,12 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      value = delete key
+      if value.is_a? Hash
+        value.symbolize_keys!
+      end
+      self[(key.to_sym rescue key) || key] = value
+    end
+    self
+  end
+end

data/lib/q/resource_pool.rb

@@ -0,0 +1,97 @@
+require 'monitor'
+
+class ResourcePool
+  class ResourcePoolTimeoutError < StandardError; end
+  
+  def initialize config
+    extend MonitorMixin
+    @config = config
+  end
+  
+  def with_resource
+    result = yield resource
+    checkin
+    result
+  end
+  
+  def create_resource
+    raise NotImplementedError
+  end
+
+  def config
+    @config ||= {}
+  end
+  
+  private
+  def queue
+    @queue ||= new_cond
+  end
+  def resources
+    @resources ||= []
+  end
+  def checked_out
+    @checked_out ||= {}
+  end
+  def timeout
+    config[:timeout] || 5
+  end
+  def size
+    config[:pool] || 5
+  end
+
+  def resource
+    checked_out[Thread.current.object_id] ||= checkout
+  end    
+  
+  def checkin(thread_id=Thread.current.object_id)
+    synchronize do
+      checked_out.delete(thread_id)
+      queue.signal 
+    end
+  end
+  
+  def find_resource
+    if resource_available?
+      find_existing_resource
+    elsif can_create_new?
+      add_new_resource
+    end
+  end
+  
+  def clear_stale_resources!
+    #find all currenly live threads and check in their corresponding connections
+    alive = Thread.list.find_all { |t| t.alive? }.map { |thread| thread.object_id }
+    dead = checked_out.keys - alive
+    dead.each { |t| checkin t }
+  end
+  
+  def resource_available?
+    checked_out.keys.size < resources.size
+  end
+  
+  def can_create_new?
+    resources.size < size
+  end
+  
+  def checkout
+    #Checkout an available connection or create a new one
+    synchronize do
+      resource = find_resource
+      return resource unless resource.nil?
+      queue.wait timeout
+      clear_stale_resources!
+      raise ResourcePoolTimeoutError unless can_create_new? or resource_available?
+    end
+    checkout
+  end      
+
+  def find_existing_resource
+    (resources - checked_out.values).first
+  end
+  
+  def add_new_resource
+    resources << r = create_resource; r
+  end
+  
+end
+  

data/lib/q/string.rb

@@ -0,0 +1,5 @@
+class String
+  def to_pascal
+    split(/_/).map { |string| string.capitalize }.join
+  end
+end

data/lib/q/symbol.rb

@@ -0,0 +1,5 @@
+class Symbol
+  def to_pascal
+    to_s.to_pascal
+  end
+end

data/lib/q/version.rb

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

data/q.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "q/version"
+
+Gem::Specification.new do |s|
+  s.name        = "agent-q"
+  s.version     = Q::VERSION
+  s.authors     = ["Jacob Morris"]
+  s.email       = ["jacob.s.morris@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Q - He's the guy with all the gadgets}
+  s.description = %q{Supplies you with stuff you need, exactly when you need it.}
+
+  s.rubyforge_project = "q"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/array_spec.rb

@@ -0,0 +1,11 @@
+require 'helper'
+require 'q/array'
+
+describe Array do
+  describe '#symbolize_keys!' do
+    it 'runs symbolize_keys! on hash elements' do
+      wrapped_hash = [{'superman' => 'is awesome'}].symbolize_keys!
+      wrapped_hash[0][:superman].should == 'is awesome'
+    end    
+  end  
+end

data/spec/binary_string_spec.rb

@@ -0,0 +1,11 @@
+require 'helper'
+require 'q/binary_string'
+
+describe BinaryString do
+  describe 'create' do 
+    it 'creates a binary string from an existing string' do
+      b = BinaryString.create "from a string"
+      b.encoding.should == Encoding::ASCII_8BIT
+    end
+  end
+end

data/spec/collector_spec.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'q/collector'
+
+class FakeCollector
+  include Collector
+  def fetch_keys
+    [:hello, :world]
+  end
+  def fetch_item key
+   "hello from key -> #{key.to_s}"
+  end
+end
+
+class ItemProvider
+  def self.next_item
+    
+  end  
+end
+
+describe Collector do
+  before :each do
+    @collector = FakeCollector.new
+  end
+  it 'includes enumerable' do
+    @collector.class.included_modules.should include(Enumerable)
+  end
+  it 'defines :each' do
+    @collector.should respond_to(:each)
+  end
+  it 'does not define <=>' do
+    @collector.should_not respond_to(:<)
+    @collector.should_not respond_to('=')
+    @collector.should_not respond_to(:>)
+  end  
+  describe '#keys' do
+    it 'calls :fetch_keys to retrieve a list of keys that correspond to collectible objects' do
+      @collector.should_receive :fetch_keys
+      @collector.keys
+    end
+    it 'caches the responce from :fetch_keys' do
+      keys = @collector.keys
+      keys.should be @collector.keys
+    end
+  end
+  
+  describe '#[]' do
+    it 'calls #fetch_item to retreive an item' do
+      @collector.should_receive(:fetch_item).with(:key)
+      @collector[:key]
+    end
+    it 'caches the respond from #fetch_item' do
+      @collector[:key].should be(@collector[:key])
+    end
+    it 'fetches items that have not been cached' do
+      @collector[:key].should == "hello from key -> key"
+      @collector[:second_key].should == 'hello from key -> second_key'
+    end
+  end
+  
+  describe '#each' do
+    it 'fetches items for all the keys and yeilds them to the block' do
+      @collector.keys.length.should > 0
+      @collector.each do |item|
+        item.should_not be_nil
+      end
+    end    
+  end
+  
+end

data/spec/dispatcher_spec.rb

@@ -0,0 +1,39 @@
+require 'helper'
+require 'q/dispatcher'
+
+
+
+module Q
+  module FakeDispatcher
+    extend Dispatcher
+  end
+
+  describe Dispatcher do
+    it 'responds to require_pattern' do
+      FakeDispatcher.should respond_to(:require_pattern)
+    end
+    it 'responds to constant_suffix' do
+      FakeDispatcher.should respond_to(:constant_suffix)
+    end
+    it 'sets the require pattern variable' do
+       FakeDispatcher.require_pattern "support/%s_adapter"
+       FakeDispatcher.instance_variable_get(:@require_pattern).should == "support/%s_adapter"
+    end
+    it 'sets the constant suffix variable' do
+      FakeDispatcher.constant_suffix "Adapter"
+      FakeDispatcher.instance_variable_get(:@constant_suffix).should == "Adapter"
+    end
+    
+    describe '#[]' do  
+      it 'retrieves a constant for the specified adapter' do
+        ->{ FakeAdapter }.should raise_error(NameError)
+        FakeDispatcher[:fake].should be(FakeAdapter)
+      end
+       
+      it 'raises AdapterNotFoundError when the specified adapter does not exist' do
+        ->{ FakeDispatcher[:batman] }.should raise_error(Dispatcher::AdapterNotFoundError)
+      end
+    end
+    
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,35 @@
+require 'helper'
+require 'q/hash'
+
+describe Hash do
+  describe '#symbolize_keys!' do
+    def hash
+      @hash ||= {
+        'superheros' => { 
+          'batman' => {
+            'whiny' => true,
+            'actual_powers' => nil 
+          },
+          'superman' => {
+            'whiny' => 'so absolutely false',
+            'actual_powers' => [
+              'leaps tall buildings in single bound',
+              'faster than speeding bullet'
+            ]
+          }
+        }
+      }
+    end
+    it 'symbolizes keys' do
+      hash.symbolize_keys!
+      hash.keys.should include(:superheros)        
+    end
+    it 'symbolizes keys recursively' do
+      hash.symbolize_keys!
+      hash[:superheros].keys.should include(:superman)
+      hash[:superheros].keys.should include(:batman)
+      hash[:superheros][:batman].keys.should include(:whiny)
+      hash[:superheros][:superman].keys.should include(:actual_powers)
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require 'simplecov'
+SimpleCov.start
+require 'rspec'

data/spec/resource_pool_spec.rb

@@ -0,0 +1,119 @@
+require 'helper.rb'
+require 'q/resource_pool'
+
+class StringPool < ResourcePool
+  def create_resource
+    "resource ##{@resources.size}"
+  end
+end
+
+module Arc
+  describe ResourcePool do
+    
+    def checked_out(pool)
+      pool.instance_variable_get(:@checked_out)
+    end
+    
+    def thread_resources(pool, count=4)
+      threads = []
+      count.times do |i|
+        threads << Thread.start do
+          resource = pool.send :resource
+          resource.should be_a(String)
+          Thread.current[:resource] = resource
+        end
+      end
+      threads.each {|t| t.join }
+    end
+        
+    describe '#resource' do
+    
+      it "throws NotImplemented when running create_resource, which should be overridden" do
+        p = ResourcePool.new nil
+        ->{ p.create_resource }.should raise_error(NotImplementedError)
+      end
+      it 'creates a new object for each running thread' do
+        pool = StringPool.new :pool => 5, :timeout => 5
+        threads = thread_resources pool, 4
+        checked_out(pool).keys.size.should === 4
+        while t = threads.pop do
+          resources = checked_out(pool)
+          #verify connection is associated to the appropriate thread
+          t[:resource].should === resources.delete(t.object_id)
+          #make sure the array isn't just holding duplicate objects
+          resources.values.should_not include(t[:resource])
+        end
+      end
+    
+      it 'clears resources from expired threads' do
+        pool = StringPool.new :pool => 5, :timeout => 0.1
+        threads = thread_resources(pool, 5)
+        checked_out(pool).keys.size.should == 5
+        c = pool.with_resource do |resource|
+          checked_out(pool).keys.size.should === 1
+          checked_out(pool)[Thread.current.object_id].should === resource          
+        end
+      end
+    
+      it 'raises error when no resources are available after timeout' do
+        pool = StringPool.new :pool => 1, :timeout => 0.1
+        pool.with_resource do |resource|
+          checked_out(pool).keys.size.should === 1
+          Thread.start do
+            ->{ pool.with_resource }.should raise_error ResourcePool::ResourcePoolTimeoutError
+          end.join
+        end
+      end
+    
+    end
+        
+    describe '#checkin' do
+      it 'makes a connection available for use by another thread' do
+        pool = StringPool.new :pool => 1, :timeout => 0.1
+        resource = pool.with_resource do |resource|
+          checked_out(pool).keys.size.should === 1
+          Thread.start do
+            ->{ pool.with_resource }.should raise_error ResourcePool::ResourcePoolTimeoutError
+          end.join
+          resource
+        end
+        final = Thread.start do
+          Thread.current[:resource] = pool.with_resource { |resource| resource }
+        end.join
+        final[:resource].should === resource
+      end
+      
+      it 'uses the current thread id when no argument is passed' do
+        pool = StringPool.new :pool => 5, :timeout => 5
+        c = pool.with_resource do |resource|
+          resource
+        end
+        pool.with_resource do |resource|
+          resource.should be(c)
+        end
+      end
+      
+    end
+    
+    describe '#with_resource' do
+      it 'uses a resource then checks it back in' do
+        pool = StringPool.new :pool => 5, :timeout => 5
+        pool.with_resource do |resource|
+          resource.should be_a(String)
+          checked_out(pool).keys.size.should == 1
+        end
+        checked_out(pool).keys.size.should == 0 
+      end
+      it 'returns the expected value' do
+        pool = StringPool.new :pool => 5, :timeout => 5
+        string = pool.with_resource do |resource|
+          resource.should be_a(String)
+          checked_out(pool).keys.size.should == 1
+          "this is the value"
+        end
+        string.should == "this is the value"        
+      end
+    end
+  
+  end
+end

data/spec/support/fake_adapter.rb

@@ -0,0 +1,2 @@
+class FakeAdapter
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: agent-q
+version: !ruby/object:Gem::Version
+  version: 0.0.1r2
+  prerelease: 5
+platform: ruby
+authors:
+- Jacob Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-21 00:00:00.000000000Z
+dependencies: []
+description: Supplies you with stuff you need, exactly when you need it.
+email:
+- jacob.s.morris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/q.rb
+- lib/q/array.rb
+- lib/q/binary_string.rb
+- lib/q/collector.rb
+- lib/q/dispatcher.rb
+- lib/q/hash.rb
+- lib/q/resource_pool.rb
+- lib/q/string.rb
+- lib/q/symbol.rb
+- lib/q/version.rb
+- q.gemspec
+- spec/array_spec.rb
+- spec/binary_string_spec.rb
+- spec/collector_spec.rb
+- spec/dispatcher_spec.rb
+- spec/hash_spec.rb
+- spec/helper.rb
+- spec/resource_pool_spec.rb
+- spec/support/fake_adapter.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: q
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Q - He's the guy with all the gadgets
+test_files:
+- spec/array_spec.rb
+- spec/binary_string_spec.rb
+- spec/collector_spec.rb
+- spec/dispatcher_spec.rb
+- spec/hash_spec.rb
+- spec/helper.rb
+- spec/resource_pool_spec.rb
+- spec/support/fake_adapter.rb