fiber_hook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d3fc52fc0617cb7927219a9deffca2cd91ccfde06d37a33d491aa662fdc23bc
+  data.tar.gz: d7ddde91085bb24617ef642774cc26f2206f383a7c160159c0b7f15c716b5cc5
+SHA512:
+  metadata.gz: 69791eff1f24a54ae3358bb0e495944ec9e64763b973c3401450f6a96e630a4fdcaecadcc648a9adf5426bc4cc3d668365123aab2ec860dd2a39cba6d1e1550e
+  data.tar.gz: a200eaaa21532773171f9ac668564ba83146e9bfc8dc50f61b86f2d9d593eff70c178b8bad9033d187297a19636d5e702a1e76200f15f39e8e3f7bde973d9619

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

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

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.23"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    fiber_hook (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  fiber_hook!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.23)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brian Morearty
+
+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,72 @@
+# FiberHook
+
+With this gem you can hook into fiber creation to pass a 
+value from the parent fiber to the child fiber. 
+
+This is useful when you’ve got thread-local storage (which
+is actually fiber-local) that you want also accessible from within
+child fibers. It works without requiring that fibers go through
+your own fiber-creation method, so that even fibers created inside
+gems you don't own will work as expected. 
+
+A potential use case is using the [Async](https://github.com/socketry/async)
+gem with the [Falcon](https://github.com/socketry/falcon) server 
+and you want to use [RequestStore](https://github.com/steveklabnik/request_store) 
+for per-request storage. For this particular use case,
+take a look at the
+[request_store-fibers](https://github.com/BMorearty/request_store-fibers) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fiber_hook'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fiber_hook
+
+## Usage
+
+In this example you’re passing a thread-local `:request_store`
+value from parent fiber to child fiber. They're sharing the
+same object in memory but there's no risk of a race condition
+because these are fibers, not threads.
+
+```ruby
+# `new` is a Proc that returns a value in the parent fiber context.
+# `resume` is a Proc that takes that value as a param and runs
+#   in the child fiber context.
+Fiber.hook(
+  new: -> { Thread.current[:request_store] },
+  resume: ->(value) { Thread.current[:request_store] = value }
+)
+```
+
+Need to remove a hook? Call `Fiber.unhook`:
+
+```ruby
+hook_id = Fiber.hook(...)
+...
+Fiber.unhook(hook_id)
+```
+
+## 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 the created tag, 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/BMorearty/fiber_hook.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fiber_hook"
+
+# 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/fiber_hook.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/fiber_hook/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fiber_hook"
+  spec.version       = FiberHook::VERSION
+  spec.authors       = ["Brian Morearty"]
+  spec.email         = ["brian@morearty.org"]
+
+  spec.summary       = "Lets you hook into Fiber.new and Fiber.resume"
+  spec.description   = "Lets you hook into Fiber.new and Fiber.resume"
+  spec.homepage      = "https://github.com/BMorearty/fiber_hook"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

data/lib/fiber_hook/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FiberHook
+  VERSION = "0.1.0"
+end

data/lib/fiber_hook.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "fiber"
+require_relative "fiber_hook/version"
+
+# Allows you to hook fiber creation so you can call a method from the parent
+# fiber immediately before any child fiber is created, return a value,
+# and then call another method from inside the child fiber the first time the
+# fiber is resumed, passing in the value that was returned from the first
+# method.
+module FiberHook
+  class Error < StandardError; end
+
+  class << self
+    attr_reader :hooks
+  end
+
+  @hooks = {}
+  @prev_id = 0
+
+  # Add a hook and return its id.
+  # @param new [Proc] Method to be called in parent fiber context when +Fiber.new+ is called.
+  #   Takes no params. Its return value will be passed into +resume+.
+  # @param resume [Proc] Method to be called in child fiber's context when +Fiber#resume+
+  #   is called for the first time. Takes a single param: the value returned by +new+.
+  # @return [Integer] The id of the newly-created hook. Can be passed in to +has?+ or
+  #   +remove+.
+  def self.add(new: nil, resume: nil)
+    @prev_id += 1
+    @hooks[@prev_id] = { new: new, resume: resume }
+    @prev_id
+  end
+
+  # Is this hook id valid?
+  def self.has?(hook_id)
+    @hooks.key?(hook_id)
+  end
+
+  # Remove a hook by its id. Afterward, newly-created fibers won't have this hook.
+  def self.remove(hook_id)
+    value = @hooks.delete(hook_id)
+    raise Error, "Hook #{hook_id} not found" unless value
+  end
+
+  # Class methods that will be added to +Fiber+.
+  module ClassMethods
+    def new(*args, &block)
+      # In Fiber.new, call the :new methods of all the hooks. Save the results.
+      values = FiberHook.hooks.transform_values { |hook| hook[:new]&.call }
+
+      fiber_proc = proc do |*block_args|
+        # In Fiber.resume, call the :resume methods of all the hooks.
+        # Pass in the values returned by the :new methods.
+        FiberHook.hooks.each { |id, hook| hook[:resume]&.call(values[id]) }
+        # Then call the original fiber block.
+        block.call(*block_args)
+      end
+
+      super(*args, &fiber_proc)
+    end
+
+    # @see FiberHook.add
+    def hook(**options)
+      FiberHook.add(**options)
+    end
+
+    # @see FiberHook.remove
+    def unhook(hook_id)
+      FiberHook.remove(hook_id)
+    end
+
+    # @see FiberHook.has?
+    def hook?(hook_id)
+      FiberHook.has?(hook_id)
+    end
+  end
+end
+
+Fiber.extend FiberHook::ClassMethods

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: fiber_hook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Morearty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-21 00:00:00.000000000 Z
+dependencies: []
+description: Lets you hook into Fiber.new and Fiber.resume
+email:
+- brian@morearty.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fiber_hook.gemspec
+- lib/fiber_hook.rb
+- lib/fiber_hook/version.rb
+homepage: https://github.com/BMorearty/fiber_hook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BMorearty/fiber_hook
+  source_code_uri: https://github.com/BMorearty/fiber_hook
+  changelog_uri: https://github.com/BMorearty/fiber_hook/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.31
+signing_key:
+specification_version: 4
+summary: Lets you hook into Fiber.new and Fiber.resume
+test_files: []