quack_pool 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e99542e0d54f7d86d03719c0cdd3caed78da2dc5
+  data.tar.gz: 696ec9dedffd4e8d5a4bad879efc5b1a60db6c0a
+SHA512:
+  metadata.gz: 7ee146d9ed9182397ba63a8a2c9b8e5868486ea21a4581ab47369ca1abf02af809f0d45b69410c2d4fe0db529624270d9fe0728dcb5b74cb321e59c3140dcbc7
+  data.tar.gz: 54c20fa04f7dff1f3bf759289bf3166d231a35735aca1e5fdf31323a6df9be1396936d314f4d3c9421a9ec76836cbb558b0991d7282e0b45b3ba532f802bbbc4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rob Fors
+
+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,43 @@
+# QuackPool
+*QuackPool* is a ruby gem. It is a simple resource pool that accepts a resource class to build the pool's resources from.
+
+# Features
+* thread safe
+* only builds new resources as needed
+* you can specify a max resource limit
+
+# Intall
+`gem install quack_pool`
+
+# Example
+```ruby
+require 'quack_pool'
+
+class Resource
+end
+
+# unlimited resources
+pool = QuackPool.new(resource_class: Resource)
+resource1 = pool.release_resource
+resource2 = pool.release_resource
+# use resources ...
+pool.absorb_resource(resource1)
+pool.absorb_resource(resource2)
+
+# limited resources
+pool = QuackPool.new(resource_class: Resource, size: 2)
+resource1 = pool.release_resource
+thread = Thread.new do
+  resource2 = pool.release_resource
+  # use resource ...
+  sleep 2
+  pool.absorb_resource(resource1)
+end
+sleep 1
+resource3 = pool.release_resource # will block until a resource is available
+# use resources ...
+pool.absorb_resource(resource1)
+pool.absorb_resource(resource3)
+thread.join
+
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) 
+
+task :test  => :spec
+task :default  => :test

data/lib/quack_pool.rb

@@ -0,0 +1,54 @@
+class QuackPool
+
+  def initialize(resource_class: , size: Float::INFINITY)
+    raise ArgumentError, "'resource_class' must respond_to 'new'" unless resource_class.respond_to?(:new)
+    @resource_class = resource_class
+    raise ArgumentError, "'size' must be an Integer" unless size.is_a?(Integer) || size == Float::INFINITY
+    @max_size = size
+    @resources = []
+    @available_resources = []
+    @mutex = Mutex.new
+    @condition_variable = ConditionVariable.new
+  end
+  
+  def release_resource
+    @mutex.synchronize do
+      if @available_resources.any?
+        release_available_resource
+      elsif @resources.length < @max_size
+        build_new_resource
+      else
+        release_next_available_resource
+      end
+    end
+  end
+  
+  def absorb_resource(resource)
+    @mutex.synchronize do
+      raise ArgumentError, "'resource' does not belong to this pool" unless @resources.include?(resource)
+      raise ArgumentError, "'resource' already in pool" if @available_resources.include?(resource)
+      @available_resources.push(resource)
+      @condition_variable.signal
+    end
+    nil
+  end
+  
+  private
+  
+  def release_available_resource
+    @available_resources.pop
+  end
+  
+  def build_new_resource
+    new_resource = @resource_class.new
+    raise "'new_resource' must be unique" if @resources.include?(new_resource)
+    @resources << new_resource
+    new_resource
+  end
+  
+  def release_next_available_resource
+    @condition_variable.wait(@mutex)
+    release_available_resource
+  end
+  
+end

data/spec/quack_pool_spec.rb

@@ -0,0 +1,90 @@
+require 'quack_pool'
+
+RSpec.describe QuackPool do
+  resource_class = Class.new
+  
+  context "when resource class is passed that does not respond to 'new'" do
+    it "should raise error" do
+      klass = Class.new
+      klass.private_class_method(:new)
+      stub_const 'BadResource', klass
+      expect { QuackPool.new(resource_class: BadResource) }.to raise_error ArgumentError
+    end
+  end
+  
+  context "when size is not specified" do
+  
+    pool = QuackPool.new(resource_class: resource_class)
+  
+    describe "#release_resource" do
+    
+      it "should return instance of given resource class" do
+        resource = pool.release_resource
+        expect(resource).to be_a(resource_class)
+        resource = pool.release_resource
+        expect(resource).to be_a(resource_class)
+      end
+      
+      context "when resource it rereturned to pool" do
+        it "should return instance of given resource class" do
+          resource = pool.release_resource
+          pool.absorb_resource(resource)
+          resource = pool.release_resource
+          expect(resource).to be_a(resource_class)
+        end
+      end
+      
+    end
+    
+    describe "#absorb_resource" do
+      
+      it "should accept resource" do
+        resource = pool.release_resource
+        expect { pool.absorb_resource(resource) }.not_to raise_error
+      end
+      
+      context "when resource is absorbed twice" do
+        it "should raise error" do
+          resource = pool.release_resource
+          pool.absorb_resource(resource)
+          expect { pool.absorb_resource(resource) }.to raise_error ArgumentError
+        end
+      end
+      
+      context "when resource is returned to wrong pool" do
+        it "should raise error" do
+          resource = pool.release_resource
+          pool2 = QuackPool.new(resource_class: resource_class)
+          expect { pool2.absorb_resource(resource) }.to raise_error ArgumentError
+        end
+      end
+    
+    end
+    
+  end
+  
+  context "when size is specified" do
+    pool = QuackPool.new(resource_class: resource_class, size: 2)
+    
+    describe "#release_resource" do
+    
+      context "when no resources are available" do
+        it "will wait until resource has been returned to pool" do
+          thread = Thread.new do
+            resource1 = pool.release_resource
+            resource2 = pool.release_resource
+            sleep 2
+            pool.absorb_resource(resource1)
+          end
+          sleep 1
+          resource = pool.release_resource
+          thread.join
+          expect(resource).to be_a(resource_class)
+        end
+      end
+      
+    end
+  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# 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, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # 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|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  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|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = 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
+=end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: quack_pool
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rob Fors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-03 00:00:00.000000000 Z
+dependencies: []
+description: A simple resource pool that accepts a resource class to build the pool's
+  resources from.
+email: mail@robfors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/quack_pool.rb
+- spec/quack_pool_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robfors/quack_pool
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple resource pool
+test_files: []