ractor-local_variable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42c3bad37614b48bf00f4d991d3d286a2ee085bc6dc86ac2b786507a0d4e2a16
+  data.tar.gz: e83792f86254b33fc5ced0f9ab7153fe510a6a9145112d1fe992b4701924b0da
+SHA512:
+  metadata.gz: 637e8e4b9289e5321b966435c3c15433128d5f9c600015ca9c7765bbb3fc19ffc4fd99e0197c9da67b2a80ff8301736c6dcc926bda1e16c4d9aaf10d73a5a214
+  data.tar.gz: 7ea5097e4e71b9bc0c20b78d14eea03854917a00ad0315476062253d0518f96b2950c6452cfa2248042a37e82e737407d92bbe28e1e454cd856172aee41c50a5

data/.github/workflows/ractor-local_variable.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    name: >-
+      Specs | ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu ]
+        ruby: [ head ]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: install dependencies
+        run: bundle install --jobs 3 --retry 3
+      - name: spec
+        run:  bundle exec rake
+  internal_investigation:
+    name: >-
+      Coding Style
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu ]
+        ruby: [ head ]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: install dependencies
+        run: bundle install --jobs 3 --retry 3
+      - name: internal investigation
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.rubocop-https*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://raw.githubusercontent.com/ractor-tools/rubocop-ractor-tools/master/.rubocop.yml
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method

data/.ruby-version

@@ -0,0 +1 @@
+3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 github@marc-andre.ca. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ractor-local_variable.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marc-Andre Lafortune
+
+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,66 @@
+# Ractor::LocalVariable
+
+Add Ractor-local storage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ractor-local_variable'
+```
+
+## Usage
+
+```ruby
+STORAGE = Ractor::LocalVariable.new { [] }
+
+STORAGE.ractor_local_value << 1
+Thread.new { STORAGE.ractor_local_value << 2 }.join
+Ractor.new do
+  STORAGE.ractor_local_value << 3
+  Thread.new { STORAGE.ractor_local_value << 4 }.join
+  puts "In Ractor: ", STORAGE.ractor_local_value
+end.take
+
+puts "In Main: ", STORAGE.ractor_local_value
+# => In Ractor: 3, 4; In Main: 1, 2
+```
+
+You can also use a variant that delegates calls to the value:
+
+```ruby
+STORAGE = Ractor::LocalVariable.new(delegate: true) { [] }
+
+STORAGE << 1
+Thread.new { STORAGE << 2 }.join
+Ractor.new do
+  STORAGE << 3
+  Thread.new { STORAGE << 4 }.join
+  puts "In Ractor: ", STORAGE
+end.take
+
+puts "In Main: ", STORAGE
+# => Same as above
+```
+
+In this case, be careful to not do `ractor.send(STORAGE)` since no call is made to the object; you'll need to call `ractor_local_value` in a case like that.
+
+## 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/marcandre/ractor-local_variable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcandre/ractor-local_variable/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Ractor::LocalVariable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcandre/ractor-local_variable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require_relative 'local_variable/version'
+
+class Ractor
+  class LocalVariable
+    module Implementation
+      MUTEX = Ractor.new do
+        loop do
+          Ractor.yield :obtained
+          Ractor.receive
+        end
+      end
+      def MUTEX.synchronize
+        take # => :obtained
+        begin
+          yield
+        ensure
+          send :release
+        end
+      end
+      private_constant :MUTEX
+
+      def initialize(&block)
+        raise ArgumentError, 'No block given' unless block
+
+        @initializer = Ractor.make_shareable(block)
+        @hold_me = Object.new.freeze
+        @unique_id = :"Ractor::LocalVariable<#{@hold_me.object_id}>"
+        freeze
+      end
+
+      def ractor_local_value
+        t = Thread.main
+        t.thread_variable_get(@unique_id) ||
+          MUTEX.synchronize do
+            t.thread_variable_get(@unique_id) ||
+              t.thread_variable_set(@unique_id, @initializer.call ||
+                raise(NotImplementedError,
+                      'Initializer blocks returning `nil` of `false` not supported'))
+          end
+      end
+    end
+
+    include Implementation
+
+    def self.new(delegate: false, &block)
+      return Delegator.new(&block) if delegate
+
+      super()
+    end
+
+    class Delegator < ::Delegator
+      include Implementation
+      alias_method :__getobj__, :ractor_local_value
+      undef_method :marshal_load, :initialize_clone, :initialize_dup
+      define_method :freeze, Kernel.instance_method(:freeze) # do not delegate `freeze`
+    end
+  end
+end

data/lib/ractor/local_variable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Ractor
+  class LocalVariable
+    VERSION = '0.1.0'
+  end
+end

data/ractor-local_variable.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ractor/local_variable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ractor-local_variable'
+  spec.version       = Ractor::LocalVariable::VERSION
+  spec.authors       = ['Marc-Andre Lafortune']
+  spec.email         = ['github@marc-andre.ca']
+
+  spec.summary       = 'Ractor-local storage'
+  spec.description   = 'Ractor-local storage'
+  spec.homepage      = 'https://github.com/marcandre/ractor-local_variable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 { |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']
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ractor-local_variable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc-Andre Lafortune
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-07 00:00:00.000000000 Z
+dependencies: []
+description: Ractor-local storage
+email:
+- github@marc-andre.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ractor-local_variable.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ractor/local_variable.rb
+- lib/ractor/local_variable/version.rb
+- ractor-local_variable.gemspec
+homepage: https://github.com/marcandre/ractor-local_variable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcandre/ractor-local_variable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.rc.2
+signing_key:
+specification_version: 4
+summary: Ractor-local storage
+test_files: []