async_resource_pool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75133743aeaeab2c6bee303c2d2497055d9d5563e7b4ccebb3bf6cae0660fe13
+  data.tar.gz: 247147e3ce15590265ac8b9a55d82008c4f031a7d503748e727263b8734384e4
+SHA512:
+  metadata.gz: 5aa8a66212a37bf79160fbcf29f6ca523180512a3a9de16f058db725514aaf2c3dab8ed40605787ccc407feb26c44e90df77b7f079bf8e2ffa36412a44098383
+  data.tar.gz: 5d844e30908ce0c0a448ab0cc33eb7238acd5079defe643a644544896aab7c004ed662ca969f29198834d87a5976e79c8f4e1425d7b4e73fb89834151b154461

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,23 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+dist: trusty
+git:
+  depth: 1
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby-head
+  - ruby-head
+  - rbx-3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3
+before_install:
+  - gem update --system
+  - gem install bundler -v 2.0.1

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 senid231@gmail.com. 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 async_resource_pool.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    async_resource_pool (0.1.0)
+      async
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.15.5)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    rake (10.5.0)
+    timers (4.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  async_resource_pool!
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Denis Talakevich
+
+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,82 @@
+# AsyncResourcePool
+
+[![Build Status](https://travis-ci.com/senid231/async_resource_pool.svg?branch=master)](https://travis-ci.com/senid231/async_resource_pool)
+
+TODO:
+* write description
+* thread safety using Mutex
+* acquire more than one connection
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async_resource_pool'
+```
+
+or 
+
+```ruby
+gem 'async/resource_pool'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install async_resource_pool
+
+## Usage
+
+TODO: Write usage instructions here
+
+```ruby
+pool = Async::ResourcePool.new(2)
+
+Async do
+  
+    Async do
+        pool.acquire do
+            Async::Task.current.sleep(6) 
+        end
+    end
+    
+    Async do
+        pool.acquire
+        Async::Task.current.sleep(6)
+        pool.release
+    end
+    
+    Async do
+        begin
+            pool.acquire(5) do
+                # will not be here because of timeout
+            end
+        rescue Async::ResourcePool::TimeoutError => _
+            # will be here
+        end
+    end
+  
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/async_resource_pool. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AsyncResourcePool project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/async_resource_pool/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/async_resource_pool.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'async_resource_pool'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = %q{Async resource pool for fibers.}
+  spec.description   = %q{Async resource pool for fibers.}
+  spec.homepage      = 'https://github.com/senid231/async_resource_pool'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'async'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "async_resource_pool"
+
+# 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/lib/async/resource_pool.rb

@@ -0,0 +1,105 @@
+require 'async'
+
+module Async
+  class ResourcePool
+    VERSION = '0.1.0'
+
+    class Error < StandardError
+    end
+
+    class DoesNotOwnError < Error
+      def initialize
+        super('current fiber does not own this resource')
+      end
+    end
+
+    class AlreadyOwnError < Error
+      def initialize
+        super('current fiber already own this resource')
+      end
+    end
+
+    class TimeoutError < Error
+      def initialize(timeout)
+        super("timeout #{timeout} seconds was elapsed")
+      end
+    end
+
+    def initialize(limit)
+      @limit = limit
+      @owners = []
+      @waiters = []
+    end
+
+    def acquire(timeout = nil)
+      raise AlreadyOwnError.new if already_acquired?
+
+      unless can_be_acquired?
+        timeout.nil? ? wait : wait_with_timeout(timeout)
+      end
+
+      @owners.push(Fiber.current)
+
+      if block_given?
+        begin
+          yield
+        ensure
+          release
+        end
+      end
+
+      nil
+    end
+
+    def release
+      raise DoesNotOwnError.new unless already_acquired?
+      @owners.delete(Fiber.current)
+      wakeup
+    end
+
+    def already_acquired?
+      @owners.include?(Fiber.current)
+    end
+
+    def can_be_acquired?
+      @owners.size < @limit
+    end
+
+    def info
+      {
+          waiters: @waiters.size,
+          owners: @owners.size,
+          limit: @limit
+      }
+    end
+
+    private
+
+    def wakeup
+      return if @waiters.empty?
+      fiber = @waiters.shift
+      fiber.resume if fiber.alive?
+    end
+
+    def wait
+      @waiters.push(Fiber.current)
+      Async::Task.yield
+    end
+
+    def wait_with_timeout(timeout)
+      fiber = Fiber.current
+      @waiters.push(Fiber.current)
+
+      Async::Task.current.with_timeout(timeout) do |timer|
+        begin
+          Async::Task.yield
+          timer.cancel
+        rescue Async::TimeoutError => _
+          @waiters.delete(fiber)
+          raise TimeoutError.new(timeout)
+        end
+      end
+    end
+
+  end
+end

data/lib/async_resource_pool.rb

@@ -0,0 +1 @@
+require 'async/resource_pool'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: async_resource_pool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Async resource pool for fibers.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- async_resource_pool.gemspec
+- bin/console
+- bin/setup
+- lib/async/resource_pool.rb
+- lib/async_resource_pool.rb
+homepage: https://github.com/senid231/async_resource_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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Async resource pool for fibers.
+test_files: []