request_store-fibers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f27de487e2f37ab305e62051b8eab1b67a84a548ebdd21ec8c721c7259beb5a
+  data.tar.gz: a237fc77b22a751c4aef0462a24369a4a9119350b8d824bfcf7dca6021a432e4
+SHA512:
+  metadata.gz: 3c4193e0d24109159afe13b3d27bc040445dce9aa281808cfcab56e114af1edc10393a0ea76eff5bbba8995ce6244d2f7929baefc4fae20d98f6941ee68e6eb4
+  data.tar.gz: 9c45b86a5d2b5400e0f2516652899506f9644f1bb346a55f2284bab84c6231619d2ec5683a86b7a8cafd38f050fb4fc07aa179d5eb7ee126f40c1a185ee96c84

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+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.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    request_store-fibers (0.1.0)
+      fiber_hook
+      request_store
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    fiber_hook (0.1.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    request_store (1.5.0)
+      rack (>= 1.4)
+    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
+  rake (~> 13.0)
+  request_store-fibers!
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  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 @@
+# RequestStore::Fibers
+
+Ya know how sometimes you need to keep track of per-request state in a Rails app?
+You reach for [RequestStore](https://github.com/steveklabnik/request_store)
+to do that, right? Works great.
+
+## The problem
+
+But now you want to start using the [Async](https://github.com/socketry/async)
+gem with the [Falcon](https://github.com/socketry/falcon) server for
+asynchronous I/O and improved performance and scalability. 
+Problem is, those gems work by creating fibers—and the thread-local storage that 
+RequestStore uses is also fiber-local, so
+it doesn’t get passed down into child fibers. You could be in the middle
+of handling a request, start a new fiber to fire off an async I/O request to
+a service, and that fiber no longer has access to the per-request store.
+
+## The solution
+
+Any time a fiber is created, this gem copies the 
+`RequestStore` data into the new fiber’s thread-local storage.
+
+## But how?
+
+Ruby! It’s magical! You can hook into anything, including standard library calls.
+I hook into `Fiber.new` and store `Thread.current[:request_store]` in a 
+variable. Once the newly-created fiber resumes for the first time, I copy that value
+into the fiber’s `Thread.current[:request_store]`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_store-fibers'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install request_store-fibers
+
+## Usage
+
+Make an initializer that does this:
+
+```ruby
+RequestStore::Fibers.init
+```
+
+If you ever need to unhook fiber creation, here’s how:
+
+```ruby
+RequestStore::Fibers.uninit
+```
+
+## 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/request_store-fibers.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+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 "request_store/fibers"
+
+# 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/request_store/fibers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RequestStore
+  module Fibers
+    VERSION = "0.1.0"
+  end
+end

data/lib/request_store/fibers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "request_store"
+require "fiber_hook"
+require_relative "fibers/version"
+
+module RequestStore
+  # Make RequestStore work with fibers.
+  module Fibers
+    class Error < StandardError; end
+
+    def self.init
+      @hook_id = Fiber.hook(
+        new: -> { [RequestStore.store, RequestStore.active?] },
+        resume: ->(value) {
+          RequestStore.store = value[0]
+          if value[1]
+            RequestStore.begin!
+          else
+            RequestStore.end!
+          end
+        }
+      )
+    end
+
+    def self.uninit
+      raise Error, "You must init before you can uninit" unless @hook_id
+
+      Fiber.unhook(@hook_id)
+      @hook_id = nil
+    end
+  end
+end

data/request_store-fibers.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/request_store/fibers/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "request_store-fibers"
+  spec.version = RequestStore::Fibers::VERSION
+  spec.authors = ["Brian Morearty"]
+  spec.email = ["brian@morearty.org"]
+
+  spec.summary = "Lets you use RequestStore with a fiber-based server."
+  spec.description = "Lets you use RequestStore with a fiber-based server by passing " \
+                     "RequestStore’s thread-local variables to child fibers as they are created."
+  spec.homepage = "https://github.com/BMorearty/request_store-fibers"
+  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 == __FILE__) ||
+        f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fiber_hook"
+  spec.add_dependency "request_store"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: request_store-fibers
+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:
+- !ruby/object:Gem::Dependency
+  name: fiber_hook
+  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: request_store
+  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'
+description: Lets you use RequestStore with a fiber-based server by passing RequestStore’s
+  thread-local variables to child fibers as they are created.
+email:
+- brian@morearty.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/request_store/fibers.rb
+- lib/request_store/fibers/version.rb
+- request_store-fibers.gemspec
+homepage: https://github.com/BMorearty/request_store-fibers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BMorearty/request_store-fibers
+  source_code_uri: https://github.com/BMorearty/request_store-fibers
+  changelog_uri: https://github.com/BMorearty/request_store-fibers/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 use RequestStore with a fiber-based server.
+test_files: []