resource_warden 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6156e0930be5bea9d2114a52a5d23fe29cb466b36b2733f58861af2968a80ef5
+  data.tar.gz: 3124064d103b827665d952445cdbdf53898d02a7a4a6c36fda1c8831a81e3ef8
+SHA512:
+  metadata.gz: 794209e8d0d9740b9f4dbdabef32176779fcfc0ca43ed62a6225eacbd4e2a7c19af919089338536d16e59e494768415a1d16907688a16e767c5133cf8569c135
+  data.tar.gz: 7ade6cfad2a4eeb07eca26f5239577d3e3cc9204ed7f4c60f4505d5359ae5a7bc32079a7f328239abef28f2c35de6d8067e6248f166ad9eb2466d13971d33dbe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.8
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,62 @@
+# Contributor Covenant Code of Conduct
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* 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
+
+## 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 aaron.deibele@capco.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ResourceWarden.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Aaron Deibele
+
+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 @@
+# ResourceWarden
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ResourceWarden`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ResourceWarden'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ResourceWarden
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/ResourceWarden. 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 ResourceWarden project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ResourceWarden/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ResourceWarden.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ResourceWarden/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resource_warden"
+  spec.homepage      = "https://github.com/deibele1/ResourceWarden"
+  spec.version       = ResourceWarden::VERSION
+  spec.authors       = ["Aaron Deibele"]
+  spec.email         = ["deibele1@gmail.com"]
+
+  spec.summary       = %q{Ensures exclusive access to multiple resource across many threads.}
+  spec.description   = %q{Allows exclusive resources to be created which can be requested in lists. Requests for the resources guarantee a resource will be granted provided the jobs sent to the warden all finish at some point}
+  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_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

@@ -0,0 +1,13 @@
+class Key
+  class ReuseException < Exception; end
+  def initialize(&block)
+    @proc = Proc.new(&block)
+  end
+
+  def use
+    throw ReuseException.new("A key can only be used once") unless @proc.is_a?(Proc)
+
+    @proc.call
+    @proc = nil
+  end
+end

data/lib/ResourceWarden/ResourceCell.rb

@@ -0,0 +1,50 @@
+require_relative './Key'
+# wraps a resource to ensure only a keyholder can execute code
+module ResourceWarden
+  class ResourceCell
+    class JailbreakException < Exception; end
+    class Unlock; end
+    private_constant :Unlock
+
+    def initialize(resource)
+      @mutex = Mutex.new
+      @registration = Mutex.new
+      @heir = nil
+      @resource = resource
+      @registry = []
+    end
+
+    # changes the heir to the caller and builds a connector proc to wait on the current thread
+    def get_key
+      heir = nil
+      @registration.synchronize do
+        heir = @heir
+        @heir = Thread.current
+      end
+      Key.new do
+        heir&.join
+        chown(Thread.current)
+        Unlock.new
+      end
+    end
+
+    private def owner
+      @owner
+    end
+
+    private def chown(thread)
+      @mutex.synchronize do
+        @owner = thread
+      end
+    end
+
+    private def method_missing(method_name, *args)
+      return @resource.send(method_name, *args) if Thread.current == owner
+      throw JailbreakException.new("A thread must first use a resource key before accessing a resource")
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || Thread.current == @owner && @resource.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/ResourceWarden/Warden.rb

@@ -0,0 +1,53 @@
+# Resource Exclusion class
+# A block is passed which will then be encapsulated in a thread immediately joined by the current thread.
+# This allows requests for multiple resources and guarantees a lock on all resources will be granted
+# as soon as all prior virtual threads with a claim on a resource terminate.
+# The warden calls the cell which generates a key which will join the prior resource claimant and change ownership
+# of the resource when used. Attempting to use a resource without ownership will result in an exception.
+# Auto joining in this way ensures no resource starvation, no deadlocks, no live-locks and true concurrency.
+# Tasks should be kept small when using this model and all tasks must eventually terminate.
+# This model can solve a generalized dining philosophers problem with any resource exclusion structure.
+require_relative('./ResourceCell')
+module ResourceWarden
+  class Warden
+    @mutex = Mutex.new
+    @registration = Mutex.new
+
+    def initialize(*resources)
+      @cell_block = resources || []
+      @block_mutex = Mutex.new
+    end
+
+    def add(resource)
+      @block_mutex.synchronize { @cell_block << resource }
+    end
+
+    def resources
+      @cell_block
+    end
+
+    def synchronize(&block)
+      @block_mutex.synchronize { Warden.synchronize(*@cell_block, &block) }
+    end
+
+    # global synchronization
+    def self.synchronize(*resources, &block)
+      keys = []
+      # creating a virtual thread to guarantee the owning thread is joinable
+      Thread.new do
+        @registration.synchronize { keys = resources.map(&:get_key) }
+        keys.each(&:use)
+        block.call
+      end.join
+    end
+
+
+    # creates a resource
+    def self.create(object = nil)
+      @registration.synchronize do
+        item = block_given? ? yield : object
+        ResourceCell.new(item)
+      end
+    end
+  end
+end

data/lib/ResourceWarden/types.rbs

@@ -0,0 +1,43 @@
+# Transparent wrapper class ignores requests from any caller other than the current owner
+module ResourceWarden
+  class ResourceCell
+    # Creates the cell that will only allow a owning thread to call any method of the resource
+    def initialize: (untyped) -> void
+    # creates a blocking resource key that can only be used once to change the owner of the resource to the calling thread
+    def get_key: -> void
+
+    # returns the current resource owner
+    private def owner: -> Thread
+    private def chown: (Thread) -> void
+
+    # resource guard method
+    private def method_missing: (Symbol | String, *untyped) -> untyped
+    private def respond_to_missing?: (Symbol | String, *untyped) -> bool
+
+    class Unlock
+      def initialize: () -> void
+    end
+  end
+
+  class Warden
+    # warden instance handles a specific resource group
+    def intialize: (*ResourceCell) -> void
+    # synchronize a block with all resource under the wardens management
+    def synchronize: () { () -> BasicObject } -> void
+    # puts a resource under this wardens management
+    def add: (ResourceCell) -> void
+    # returns the resources managed by this warden
+    def resources: () -> Array[ResourceCell]
+    # synchronizes a block with a resource list
+    def self.synchronize:(*Symbol) { () -> BasicObject } -> void
+    # creates a resourceCell either from an object or a cell
+    def self.create:(untyped) -> ResourceCell | () { () -> Object } -> ResourceCell
+  end
+
+  class Key
+    # creates a key this should only be created by a resource cell
+    def initialize: () {() -> ResourceCell::Unlock } -> void
+    # changes the owner of the creating cell to the current thread after waiting for prior threads to complete
+    def use: () -> void
+  end
+end

data/lib/ResourceWarden/version.rb

@@ -0,0 +1,3 @@
+module ResourceWarden
+  VERSION = "0.1.0"
+end

data/lib/ResourceWarden.rb

@@ -0,0 +1,4 @@
+require_relative "./ResourceWarden/version"
+require_relative "./ResourceWarden/Warden"
+
+module ResourceWarden; end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: resource_warden
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Deibele
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allows exclusive resources to be created which can be requested in lists.
+  Requests for the resources guarantee a resource will be granted provided the jobs
+  sent to the warden all finish at some point
+email:
+- deibele1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ResourceWarden.gemspec
+- bin/console
+- bin/setup
+- lib/ResourceWarden.rb
+- lib/ResourceWarden/Key.rb
+- lib/ResourceWarden/ResourceCell.rb
+- lib/ResourceWarden/Warden.rb
+- lib/ResourceWarden/types.rbs
+- lib/ResourceWarden/version.rb
+homepage: https://github.com/deibele1/ResourceWarden
+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.1
+signing_key: 
+specification_version: 4
+summary: Ensures exclusive access to multiple resource across many threads.
+test_files: []