access_stack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96173f1b78abdc2fee95955d17cc517d8d0ce49e
+  data.tar.gz: 4373cd19170488ebad5b76ef5a041f9b0ec6b36b
+SHA512:
+  metadata.gz: a08d923069d7cb7d59f3ca5035c0c13e55ec44cf42e0a35c27fdbd31f518f93b2c10c0aad02c6873424dfa76e9298211640a9db2a1b646ceda5555569e556ab0
+  data.tar.gz: b956d7870b89fef820f4b36874c963c2137f3f3cfb31093f1f510bb1209c8e53025fb676cdb92dddbd694df7d398f9a36965b67a22d9aa079eed0ec25e1880ab

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/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+os:
+  - linux
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - ree
+env:
+	- "CODECLIMATE_REPO_TOKEN=ce41872e2a5a6113de9ae79a83e48c01b53bd8aea3fb1b9cf93d18d1e82c4eb1"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Symer
+
+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,80 @@
+# AccessStack
+
+A general-purpose object "pool" for storing general objects. It can be a connection pool, cache, or even just a factory.
+
+## Notes
+
+AccessStack is *very* threadsafe. It uses an internal stack to store the objects and any interaction with that is done with a `Mutex` lock in place.
+
+AccessStack also implements most of the features present in ActiveRecord's connection pool, such as reaping, expiration, and timeout. It takes it a step farther by 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'access_stack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install access_stack
+
+## Usage
+
+You can create a stack:
+
+	require "access_stack"
+
+	s = AccessStack.new(
+	  :size => 10,
+	  :timeout => 3, # how long to wait for access to the stack
+	  :expires => 5, # how long an object lasts in the stack
+	  :create => lambda {
+	    PG.connect
+	  },
+	  :destroy => lambda { |instance|
+	    instance.close
+	  },
+	  :validate => lamda { |instance|
+	    instance.status == CONNECTION_OK
+	  }
+	)
+	
+Set a stack's blocks:
+
+	s.create = lambda {
+	  # Do something
+	}
+	
+Use an instance:
+
+	res = s.with { |inst| inst.exec("SELECT * FROM users;") }
+	# res is a PG::Result now, since that's what the block returned
+	
+Eager-load instances:
+	
+	s.create_objects 5 # Create and add 5 objects to the stack
+	s.fill # Fill the stack to capacity
+	
+Clear out instances:
+
+	s.reap! # Validates each object using expires and validate
+	s.empty! # Empties the stack
+	s.empty? # Checks if the stack is empty
+
+
+## TODO
+
+1. Validate based upon methods on objects in the pool
+2. Reap on an interval
+
+## Contributing
+
+1. Fork it ( https://github.com/fhsjaagshs/access_stack/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/access_stack.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'access_stack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "access_stack"
+  spec.version       = AccessStack::VERSION
+  spec.authors       = ["Nathaniel Symer"]
+  spec.email         = ["nate@natesymer.com"]
+  spec.summary       = %q{Abstract object pooling for cool people.}
+  spec.description   = %q{Abstract object pooling for cool people. See homepage}
+  spec.homepage      = "http://github.com/fhsjaagshs/access_stack"
+  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", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/access_stack.rb

@@ -0,0 +1,124 @@
+require "access_stack/version"
+require "thread"
+require "timeout"
+
+class AccessStack
+	attr_reader :count
+	attr_accessor :expires, :size, :timeout, :create, :destroy, :validate
+
+	TimeoutError = Class.new StandardError
+
+	def initialize(opts={})
+		@timeout = opts[:timeout] || opts["timeout"] || 5
+		@size = opts[:size] || opts["size"] || 5
+		@expires = opts[:expires] || opts["expires"] || -1
+		@expr_hash = {}
+		@stack = []
+		@count = 0
+		@mutex = Mutex.new
+		@create = opts[:create] || opts["create"]
+		@destroy = opts[:destroy] || opts["destroy"]
+		@validate = opts[:validate] || opts["validate"]
+	end
+
+	def with(&block)
+		begin
+			obj = nil
+		
+			threadsafe do
+				obj = @stack.pop
+			end
+		
+			if !(obj_valid obj)
+				obj = nil
+				@count -= 1
+			end
+		
+			if @count < @size && obj.nil?
+				@count += 1
+				obj = create_obj
+			end
+
+			return block.call obj
+		ensure
+			threadsafe do
+				@stack.push obj
+			end
+		end
+	end
+	
+	def reap!
+		return true if @count == 0
+		threadsafe do
+			@stack.reject(&method(:obj_valid)).each do |instance|
+				@destroy.call instance
+				@expr_hash.delete instance
+				@stack.delete instance
+				@count -= 1
+			end
+		end
+	end
+
+	def empty!
+		return if @count == 0
+		threadsafe do
+			@stack.each(&@destroy.method(:call))
+			@expr_hash.clear
+			@stack.clear
+			@count = 0
+		end
+	end
+
+	def fill
+		create_objects @count
+	end
+
+	def create_objects(num=1)
+		created_count = 0
+	
+		threadsafe do
+			num.times do
+				if @count < @size
+					@stack.push create_obj
+					@count += 1
+					created_count += 1
+				end
+			end
+		end
+		
+		created_count
+	end
+
+	def empty?
+		@count == 0
+	end
+
+	private
+
+	def threadsafe(&block)
+		begin
+		  Timeout::timeout @timeout do
+		    @mutex.lock
+		  end
+		
+			block.call
+			@mutex.unlock
+			true
+		rescue Timeout::Error
+			raise TimeoutError, "Failed to obtain a lock fast enough."
+		end
+		false
+	end
+
+	def create_obj
+		obj = @create.call
+		@expr_hash[obj] = Time.now
+		obj
+	end
+
+	def obj_valid(obj)
+		block_valid = @vaildate.call obj rescue true
+		expired = (@expires > 0 && @expr_hash[obj].to_f-Time.now.to_f > @expires)
+		!expired && block_valid
+	end
+end

data/lib/access_stack/version.rb

@@ -0,0 +1,3 @@
+class AccessStack
+  VERSION = "0.0.1"
+end

data/spec/access_stack_spec.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require "rspec"
+require "access_stack"
+
+def create_stack
+	AccessStack.new(
+		:size => 10,
+		:timeout => 3,
+		:create => lambda {
+			"THIS"
+		},
+		:destroy => lambda { |instance|
+			instance = nil
+		},
+		:validate => lambda { |instance|
+			instance.is_a? String && instance.length > 0
+		}
+	)
+end
+
+describe AccessStack do
+	
+	it "should create objects" do
+		stack = create_stack
+		res = stack.with{ |inst| inst + "FOOBAR" } 
+		stack.empty!
+		res == "THISFOOBAR"
+	end
+	
+	it "should work concurrently" do
+		stack = create_stack
+		stack.create_objects 1
+		
+		begin
+			t = []
+			
+			t << Thread.new {
+				stack.with{ |inst| inst + "ONE" }
+			}
+		
+			t << Thread.new {
+				stack.with{ |inst| inst + "TWO" }
+			}
+		
+			t << Thread.new {
+				stack.with{ |inst| inst + "Three" }
+			}
+			
+			t.each(&:join)
+		rescue StandardError => e
+			puts e.message
+			return false
+		end
+		
+		stack.count == 3
+	end
+	
+	it "should be able to time out" do
+		stack = create_stack
+		stack.timeout = 0.0000000000000001
+		begin
+			res = stack.with{ |inst| inst + "FOOBAR" } 
+		rescue
+			return false
+		end
+		true
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'bundler/setup'
+Bundler.setup
+
+require "./lib/access_stack.rb"
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # 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
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: access_stack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathaniel Symer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Abstract object pooling for cool people. See homepage
+email:
+- nate@natesymer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- access_stack.gemspec
+- lib/access_stack.rb
+- lib/access_stack/version.rb
+- spec/access_stack_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fhsjaagshs/access_stack
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Abstract object pooling for cool people.
+test_files:
+- spec/access_stack_spec.rb
+- spec/spec_helper.rb