ractor-tmvar 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452e6a7f21ca12c8163f6b2c9a90169705b92e28bcbb0e5a2a41fb66c0d6b258
-  data.tar.gz: 33e776a975119f6d61593870cb317bdd8a8b45693178613098ef359d4fefb2f5
+  metadata.gz: bd148e7f28224c4301b6ec77b004a483722f53b4fdd35d3e69886d06358db39d
+  data.tar.gz: c6b21f4ce16240b9d5912dc6528feeb5cddcb0bac6d8dc81ea8cd0cbd0bd1ee5
 SHA512:
-  metadata.gz: 57c2cdd4d7918a3869120ca8565a67de62accad9f1e46fa5e4dced91d4f36eb584122ec5fe0923fd263f2b39b64116509ece1a85b41cf82df9b8182506ba618e
-  data.tar.gz: 26cfe85a897f01216cb68a783e259d03a7563905cf70eacde9a157795db0555cf7cb78417124196fddad46a8f574b7cc490a471593d512d778d0dce6889da326
+  metadata.gz: 7272a5419621fae9ef87a3cbfd895b9a21d6429b009bb6a3af32a56c62d07a6583e7c86e4f8438e1859055755644f8e2e35ccd8f244f35a742a627b634d579d8
+  data.tar.gz: '08abed6a02c3e4832ef99ca5139cf625a85e66559482758371f380fa590669dc7983e0ca14896a01514a1a474254f207a8ecb7987a65029f7fbbecb7e7f0363d'

data/.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu]
-        ruby: [head, debug]
+        ruby: [head, debug, '4.0']
 
     runs-on: ${{ matrix.os }}-latest
     continue-on-error: ${{ matrix.ruby == 'head' || matrix.ruby == 'debug' }}

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/

data/.rubocop.yml

@@ -1,5 +1,7 @@
+plugins:
+  - rubocop-rake
+
 AllCops:
-  TargetRubyVersion: 2.7
   NewCops: enable
 
 Style/StringLiterals:
@@ -12,3 +14,12 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/ClassLength:
+  Enabled: true
+  Exclude:
+    - "test/**/*"
+
+Naming/PredicateMethod:
+  AllowedMethods:
+    - try_put

data/Gemfile

@@ -9,4 +9,6 @@ gem "rake", "~> 13.0"
 
 gem "test-unit", "~> 3.0"
 
-gem "rubocop", "~> 0.80"
+gem "rubocop", "~> 1.91"
+
+gem "rubocop-rake", "~> 0.7"

data/Gemfile.lock

@@ -1,46 +1,85 @@
 PATH
   remote: .
   specs:
-    ractor-tmvar (0.1.0)
-      ractor-tvar (~> 0.3.0)
+    ractor-tmvar (0.3.0)
+      ractor-sharing (~> 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.3)
+    json (3.0.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    parallel (1.28.0)
+    parser (3.3.12.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)
+      racc
+    power_assert (3.1.0)
+    prism (1.9.0)
+    racc (1.8.1)
+    ractor-sharing (0.3.0)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    regexp_parser (2.13.1)
+    rubocop (1.91.0)
+      json (>= 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    ruby-progressbar (1.13.0)
+    test-unit (3.7.8)
       power_assert
-    unicode-display_width (1.7.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   ractor-tmvar!
   rake (~> 13.0)
-  rubocop (~> 0.80)
+  rubocop (~> 1.91)
+  rubocop-rake (~> 0.7)
   test-unit (~> 3.0)
 
+CHECKSUMS
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  bundler (4.0.16) sha256=d6ca5dd440c24f9abce9844cf44cc8e18c6a553de65a47efb4544137af92c47d
+  json (3.0.2) sha256=8e6d7e7b11384c21230430cef90b71f14849a34a1f4452796670f7c981bd19df
+  language_server-protocol (3.17.0.6) sha256=5ef2c0c138f8267e1bc631d3328347d354f96724b0af22f2c79516120443b7f0
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  parallel (1.28.0) sha256=33e6de1484baf2524792d178b0913fc8eb94c628d6cfe45599ad4458c638c970
+  parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
+  power_assert (3.1.0) sha256=fefe98ed5d3140628138f3f9f9194d6ece01f1320e69700d3c928adca7518251
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  ractor-sharing (0.3.0) sha256=9adb2f899e4e38f477a2d3c02368e8ff40be96b119172312253338ee1e22f63f
+  ractor-tmvar (0.3.0)
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  regexp_parser (2.13.1) sha256=5aedb6b7c35688f51e86eef17a15374dfd287c83f4ca644b2c5f3ec50a33b44b
+  rubocop (1.91.0) sha256=9c82b7bf391c5d7e3798c5b9996e22a1fe3bd7468e351dfdeb96140c058296d0
+  rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
+  rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
+  unicode-display_width (3.3.0) sha256=4b7aa66a4b11db50f6f7e98411215cd0dd10eaecb665d36eec5bcacb3fa0b613
+  unicode-emoji (4.3.0) sha256=11c02fa73290378c066bb0562cd4c87d8e1b706fbbe0059ca12746a4244de8ce
+
 BUNDLED WITH
-   2.2.0.rc.2
+  4.0.16

data/README.md

@@ -1,6 +1,6 @@
 # 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).
+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-sharing/blob/main/docs/tvar.md).
 
 ## Installation
 
@@ -20,11 +20,8 @@ Or install it yourself as:
 
 ## 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'
+require 'ractor/tmvar'
 
 tv1 = Ractor::TMVar.new(0)
 tv2 = Ractor::TMVar.new(0)
@@ -33,20 +30,21 @@ rs = 100.times.map do
     value1 = nil
     value2 = nil
     Ractor.atomically do
-      # take value similar to takeTMVar in Haskell
-      value1 = v1.value
-      value2 = v2.value
+      # take value like takeTMVar in Haskell
+      value1 = v1.take
+      value2 = v2.take
     end
     Ractor.atomically do
-      # set value similar to putTMVar in Haskell
-      v2.value = value2 + 2
-      v1.value = value1 + 1
+      # set value like putTMVar in Haskell
+      v2.put(value2 + 2)
+      v1.put(value1 + 1)
     end
   end
 end
-rs.each(&:take)
-assert_equal 100, tv1.value
-assert_equal 200, tv2.value
+rs.each(&:value)
+
+tv1.read #=> 100
+tv2.read #=> 200
 ```
 
 ## Development

data/lib/ractor/tmvar/version.rb

@@ -2,6 +2,6 @@
 
 class Ractor
   class TMVar
-    VERSION = "0.1.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/ractor/tmvar.rb

@@ -6,48 +6,129 @@ class Ractor
   # TMVar for Ractor inspired by Haskell's TMVar based on Ractor::TVar.
   class TMVar
     #
-    # Represents "blank" value for TMVar
+    # represents "empty" value for TMVar
     #
-    BLANK = :RACTOR_TMVAR_BLANK
+    EMPTY = :RACTOR_TMVAR_EMPTY
 
     #
-    # TMVar.new(value) to initialize TMVar
+    # initialize TMVar
     #
-    # @param [Object] tvar neet to be shareable
+    # @param [Object] value value to set. With ractor-sharing 0.3, the value is
+    #   automatically made Ractor-shareable and the passed object is frozen.
+    #   This behavior is provided by the upstream Ractor::TVar, not a TMVar guarantee.
     #
     # @return [TMVar]
     #
-    def initialize(tvar = nil)
-      @tvar = Ractor::TVar.new(tvar)
+    def initialize(value = nil)
+      @tvar = Ractor::TVar.new(value)
     end
 
     #
-    # Get TVar's value and leave the value to "blank".
-    # If the value is already "blank", it will retry the transaction.
+    # get the value and leave the value to "empty"
+    # If the value is already "empty", it will retry the transaction.
+    # @note You need to wrap it by Ractor.atomically even if you only call +take+
+    #       because +TVar#value=+ needs atomically.
     #
     # @return [Object] value of internal TVar.
     #
-    def value
+    def take
       v = @tvar.value
-      raise Ractor::RetryTransaction if v == BLANK
+      raise Ractor::RetryTransaction if v == EMPTY
 
-      # NOTE: TVar cannot be set without `Ractor.atomically`.
-      Ractor.atomically do
-        @tvar.value = BLANK
-      end
+      @tvar.value = EMPTY
       v
     end
 
     #
-    # Put value to TVar's value.
-    # If the value is not "blank", it will retry the transaction.
+    # try to get the value.
+    # If the value is "empty", it returns nil.
     #
-    # @param [Object] new_value neet to be shareable
+    # @return [Object] value of internal TVar, only if exists.
     #
-    def value=(new_value)
-      raise Ractor::RetryTransaction if @tvar.value != BLANK
+    def try_take
+      v = @tvar.value
+      return nil if v == EMPTY
+
+      @tvar.value = EMPTY
+      v
+    end
+
+    #
+    # get the value like +take+.
+    # The difference between +take+ and +read+ is +take+ leaves the value blank,
+    # but +read+ not change the value to blank.
+    #
+    # @return [Object] value of internal TVar.
+    #
+    def read
+      v = @tvar.value
+      raise Ractor::RetryTransaction if v == EMPTY
+
+      v
+    end
+
+    #
+    # read the value like +read+ but it does not retry.
+    #
+    # @return [Object] value of internal TVar.
+    #
+    def try_read
+      v = @tvar.value
+      v == EMPTY ? nil : v
+    end
+
+    #
+    # write the given value.
+    # If the current value is not "empty", it retries the transaction.
+    #
+    # @param [Object] new_value value to set. With ractor-sharing 0.3, the value is
+    #   automatically made Ractor-shareable and the passed object is frozen.
+    #   This behavior is provided by the upstream Ractor::TVar, not a TMVar guarantee.
+    #
+    def put(new_value)
+      raise Ractor::RetryTransaction if @tvar.value != EMPTY
 
       @tvar.value = new_value
     end
+
+    #
+    # try to put value to TVar's value
+    # If the value is not "empty", it will not retry and only return false.
+    # If it succeed to put, it returns true.
+    #
+    # @param [Object] new_value value to set. With ractor-sharing 0.3, the value is
+    #   automatically made Ractor-shareable and the passed object is frozen.
+    #   This behavior is provided by the upstream Ractor::TVar, not a TMVar guarantee.
+    #
+    def try_put(new_value)
+      return false if @tvar.value != EMPTY
+
+      @tvar.value = new_value
+      true
+    end
+
+    #
+    # return the value is "empty" or not.
+    #
+    # @param [Boolean]
+    #
+    def empty?
+      @tvar.value == EMPTY
+    end
+
+    #
+    # get the the value like +get+, and replace the value to the given value if the current value is not "empty"
+    #
+    # @param [Object] new value to set. With ractor-sharing 0.3, the value is
+    #   automatically made Ractor-shareable and the passed object is frozen.
+    #   This behavior is provided by the upstream Ractor::TVar, not a TMVar guarantee.
+    #
+    def swap(new)
+      v = @tvar.value
+      raise Ractor::RetryTransaction if v == EMPTY
+
+      @tvar.value = new
+      v
+    end
   end
 end

data/ractor-tmvar.gemspec

@@ -12,13 +12,14 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = Gem::Requirement.new(">= 4.0")
 
   # 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
+  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.
@@ -29,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "ractor-tvar", "~> 0.3.0"
+  spec.add_dependency "ractor-sharing", "~> 0.3.0"
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ractor-tmvar
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshitsugu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ractor-tvar
+  name: ractor-sharing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -51,7 +50,7 @@ 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:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: '4.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:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ractor::TMVar
 test_files: []