ractor-tmvar 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 452e6a7f21ca12c8163f6b2c9a90169705b92e28bcbb0e5a2a41fb66c0d6b258
+  data.tar.gz: 33e776a975119f6d61593870cb317bdd8a8b45693178613098ef359d4fefb2f5
+SHA512:
+  metadata.gz: 57c2cdd4d7918a3869120ca8565a67de62accad9f1e46fa5e4dced91d4f36eb584122ec5fe0923fd263f2b39b64116509ece1a85b41cf82df9b8182506ba618e
+  data.tar.gz: 26cfe85a897f01216cb68a783e259d03a7563905cf70eacde9a157795db0555cf7cb78417124196fddad46a8f574b7cc490a471593d512d778d0dce6889da326

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

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    ractor-tmvar (0.1.0)
+      ractor-tvar (~> 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    power_assert (1.2.0)
+    ractor-tvar (0.3.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.2.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    test-unit (3.3.7)
+      power_assert
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ractor-tmvar!
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.2.0.rc.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 yoshitsugu
+
+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,64 @@
+# Ractor::TMVar
+
+TMVar for Ractor inspired by [Haskell's TMVar](https://hackage.haskell.org/package/stm-2.5.0.0/docs/Control-Concurrent-STM-TMVar.html) based on [Ractor::TVar](https://github.com/ko1/ractor-tvar).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ractor-tmvar'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ractor-tmvar
+
+## Usage
+
+Please see [Ractor::TVar](https://github.com/ko1/ractor-tvar) before using this.  
+Now we have only `value` and `value=` operations.
+
+```ruby
+require 'ractor-tmvar'
+
+tv1 = Ractor::TMVar.new(0)
+tv2 = Ractor::TMVar.new(0)
+rs = 100.times.map do
+  Ractor.new tv1, tv2 do |v1, v2|
+    value1 = nil
+    value2 = nil
+    Ractor.atomically do
+      # take value similar to takeTMVar in Haskell
+      value1 = v1.value
+      value2 = v2.value
+    end
+    Ractor.atomically do
+      # set value similar to putTMVar in Haskell
+      v2.value = value2 + 2
+      v1.value = value1 + 1
+    end
+  end
+end
+rs.each(&:take)
+assert_equal 100, tv1.value
+assert_equal 200, tv2.value
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/yoshitsugu/ractor-tmvar.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "ractor/tvar"
+
+class Ractor
+  # TMVar for Ractor inspired by Haskell's TMVar based on Ractor::TVar.
+  class TMVar
+    #
+    # Represents "blank" value for TMVar
+    #
+    BLANK = :RACTOR_TMVAR_BLANK
+
+    #
+    # TMVar.new(value) to initialize TMVar
+    #
+    # @param [Object] tvar neet to be shareable
+    #
+    # @return [TMVar]
+    #
+    def initialize(tvar = nil)
+      @tvar = Ractor::TVar.new(tvar)
+    end
+
+    #
+    # Get TVar's value and leave the value to "blank".
+    # If the value is already "blank", it will retry the transaction.
+    #
+    # @return [Object] value of internal TVar.
+    #
+    def value
+      v = @tvar.value
+      raise Ractor::RetryTransaction if v == BLANK
+
+      # NOTE: TVar cannot be set without `Ractor.atomically`.
+      Ractor.atomically do
+        @tvar.value = BLANK
+      end
+      v
+    end
+
+    #
+    # Put value to TVar's value.
+    # If the value is not "blank", it will retry the transaction.
+    #
+    # @param [Object] new_value neet to be shareable
+    #
+    def value=(new_value)
+      raise Ractor::RetryTransaction if @tvar.value != BLANK
+
+      @tvar.value = new_value
+    end
+  end
+end

data/lib/ractor/tmvar/version.rb

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

data/ractor-tmvar.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/ractor/tmvar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ractor-tmvar"
+  spec.version       = Ractor::TMVar::VERSION
+  spec.authors       = ["yoshitsugu"]
+  spec.email         = ["yoshitsugu@users.noreply.github.com"]
+
+  spec.summary       = "Ractor::TMVar"
+  spec.description   = "Introduce Ractor::TMVar based on Ractor::TVar"
+  spec.homepage      = "https://github.com/yoshitsugu/ractor-tmvar"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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"]
+
+  spec.add_runtime_dependency "ractor-tvar", "~> 0.3.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ractor-tmvar
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- yoshitsugu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ractor-tvar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: Introduce Ractor::TMVar based on Ractor::TVar
+email:
+- yoshitsugu@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ractor/tmvar.rb
+- lib/ractor/tmvar/version.rb
+- ractor-tmvar.gemspec
+homepage: https://github.com/yoshitsugu/ractor-tmvar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yoshitsugu/ractor-tmvar
+  source_code_uri: https://github.com/yoshitsugu/ractor-tmvar
+  changelog_uri: https://github.com/yoshitsugu/ractor-tmvar
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+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::TMVar
+test_files: []