ractor-lvar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d91be6df13e8cab174be96e651de28aaa9105667331370cf4b3e45f09f7c2dc7
+  data.tar.gz: 35b6656152660e77815514b6a998e1b6def697c46c0e5f8b4c949b0dc507ab3b
+SHA512:
+  metadata.gz: 06243c24f1d5ada37ecbe33615873c603ae655b1ffc85988cce9b6c0a7ed24b33bb047ede1991120a98ee7c35d1bb6110c073d1500da3e4400cdc1401816c852
+  data.tar.gz: 1f39d79815c7c0997dc3c27070ca02c57dc02ca74a067dd64bbaf080521c4b9fb4d208bef0144f3a2495319b477502cf323ab6cc397172c60fd285eb21a60741

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Development
+on: [push,pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: [head, debug]
+
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ matrix.ruby == 'head' || matrix.ruby == 'debug' }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - run: bundle install
+    - run: bundle exec rake

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ractor-lvar.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Koichi Sasada
+
+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,50 @@
+# Ractor::LVar
+
+More flexible Ractor-local variable object.
+
+```ruby
+require 'ractor/lvar'
+
+V = Ractor::LVar.new{ 42 }
+
+r = Ractor.new do
+  V.ractor_local_value *= 10
+  V.ractor_local_value
+end
+
+p [V.ractor_local_value, r.take]
+#=> [42, 420]
+```
+
+## Installation
+
+You need Ruby 3.0 or later.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ractor-lvar'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ractor-lvar
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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/ko1/ractor-lvar.
+
+
+## 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,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rake/extensiontask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+Rake::ExtensionTask.new "ractor/lvar" do |ext|
+
+end
+
+task :test => :compile
+task default: :test

data/bin/console

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

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile('ractor/lvar')

data/ext/ractor/lvar/lvar.c

@@ -0,0 +1,104 @@
+#include "ruby/ruby.h"
+#include "ruby/ractor.h"
+
+static VALUE rb_cRactorLVar;
+
+// hidden C-API
+void rb_ractor_local_storage_delkey(rb_ractor_local_key_t key);
+VALUE rb_proc_isolate(VALUE proc);
+
+struct ractor_lvar {
+    rb_ractor_local_key_t key;
+    VALUE default_proc;
+};
+
+static void
+ractor_lvar_mark(void *ptr)
+{
+    struct ractor_lvar *lvar = (struct ractor_lvar *)ptr;
+    rb_gc_mark(lvar->default_proc);
+}
+
+static void
+ractor_lvar_free(void *ptr)
+{
+    struct ractor_lvar *lvar = (struct ractor_lvar *)ptr;
+    rb_ractor_local_storage_delkey(lvar->key);
+    ruby_xfree(lvar);
+}
+
+static size_t
+ractor_lvar_memsize(const void *ptr)
+{
+    return sizeof(struct ractor_lvar);
+}
+
+static const rb_data_type_t ractor_lvar_data_type = {
+    "ractor/lvar",
+    {
+        ractor_lvar_mark,
+        ractor_lvar_free,
+        ractor_lvar_memsize,
+        NULL, // update
+    },
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
+};
+
+static VALUE
+ractor_lvar_new(VALUE self)
+{
+    VALUE default_proc = rb_block_given_p() ? rb_block_proc() : Qnil;
+
+    struct ractor_lvar *lvar;
+    VALUE lv = TypedData_Make_Struct(rb_cRactorLVar, struct ractor_lvar, &ractor_lvar_data_type, lvar);
+    lvar->key = rb_ractor_local_storage_value_newkey();
+    lvar->default_proc = RTEST(default_proc) ? rb_proc_isolate(default_proc) : Qfalse;
+    FL_SET_RAW(lv, RUBY_FL_SHAREABLE);
+    return lv;
+}
+
+static struct ractor_lvar *
+ractor_lvar_ptr(VALUE self)
+{
+    RUBY_ASSERT(rb_typeddata_is_kind_of(self, &ractor_lvar_data_type));
+    return DATA_PTR(self);
+}
+
+static VALUE
+ractor_lvar_get(VALUE self)
+{
+    rb_ractor_local_key_t key = ractor_lvar_ptr(self)->key;
+    VALUE val;
+    if (rb_ractor_local_storage_value(key, &val)) {
+        return val;
+    }
+    else {
+        VALUE default_proc = ractor_lvar_ptr(self)->default_proc;
+        if (default_proc) {
+            val = rb_proc_call_with_block(default_proc, 0, NULL, Qnil);
+            rb_ractor_local_storage_value_set(key, val);
+            return val;
+        }
+        else {
+            return Qnil;
+        }
+    }
+}
+
+static VALUE
+ractor_lvar_set(VALUE self, VALUE val)
+{
+    rb_ractor_local_key_t key = ractor_lvar_ptr(self)->key;
+    rb_ractor_local_storage_value_set(key, val);
+    return val;
+}
+
+void
+Init_lvar(void)
+{
+    rb_ext_ractor_safe(true);
+    rb_cRactorLVar = rb_define_class_under(rb_cRactor, "LVar", rb_cObject);
+    rb_define_singleton_method(rb_cRactorLVar, "new", ractor_lvar_new, 0);
+    rb_define_method(rb_cRactorLVar, "ractor_local_value", ractor_lvar_get, 0);
+    rb_define_method(rb_cRactorLVar, "ractor_local_value=", ractor_lvar_set, 1);
+}

data/lib/ractor/lvar.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "ractor/lvar/version"
+require 'ractor/lvar.so'

data/lib/ractor/lvar/version.rb

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

data/ractor-lvar.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/ractor/lvar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ractor-lvar"
+  spec.version       = Ractor::LVar::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+
+  spec.summary       = "Ractor::LVar"
+  spec.description   = "Ractor::LVar"
+  spec.homepage      = "https://github.com/ko1/ractor-lvar"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0dev")
+  spec.extensions = %w(ext/ractor/lvar/extconf.rb)
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ko1/ractor-lvar"
+  spec.metadata["changelog_uri"] = "https://github.com/ko1/ractor-lvar"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ractor-lvar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ractor::LVar
+email:
+- ko1@atdot.net
+executables: []
+extensions:
+- ext/ractor/lvar/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/ractor/lvar/extconf.rb
+- ext/ractor/lvar/lvar.c
+- lib/ractor/lvar.rb
+- lib/ractor/lvar/version.rb
+- ractor-lvar.gemspec
+- test.rb
+homepage: https://github.com/ko1/ractor-lvar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ko1/ractor-lvar
+  source_code_uri: https://github.com/ko1/ractor-lvar
+  changelog_uri: https://github.com/ko1/ractor-lvar
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.0.dev
+signing_key:
+specification_version: 4
+summary: Ractor::LVar
+test_files: []