ractor-tmvar 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452e6a7f21ca12c8163f6b2c9a90169705b92e28bcbb0e5a2a41fb66c0d6b258
-  data.tar.gz: 33e776a975119f6d61593870cb317bdd8a8b45693178613098ef359d4fefb2f5
+  metadata.gz: 61f2c5af774133ccaca92fd2ab9d5926d1faf7d229d60f62c7928e82c8e06cef
+  data.tar.gz: d5e176ee4886ca2f5feea7f20c9b3989e33778b3a433e7f550e281b43c9bfb72
 SHA512:
-  metadata.gz: 57c2cdd4d7918a3869120ca8565a67de62accad9f1e46fa5e4dced91d4f36eb584122ec5fe0923fd263f2b39b64116509ece1a85b41cf82df9b8182506ba618e
-  data.tar.gz: 26cfe85a897f01216cb68a783e259d03a7563905cf70eacde9a157795db0555cf7cb78417124196fddad46a8f574b7cc490a471593d512d778d0dce6889da326
+  metadata.gz: 605a25ac148a512f7d2a8c18d98e6c73cae522fb69963e7a9b5357b4165efeb044a8b0e425a2172f2ad81278a1a632a434bfeb4d22a8047e4cd44e99630a49c9
+  data.tar.gz: 9523eb78bbef48de3b809df3a442eaa2be9df55573e2ea1e0d4a7b3692977a062ba36ca6de18182800dea1c46b0120aa50e28316d21136816af09fc4d65e5522

data/.rubocop.yml

@@ -12,3 +12,8 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/ClassLength:
+  Enabled: true
+  Exclude:
+    - "test/**/*"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ractor-tmvar (0.1.0)
+    ractor-tmvar (0.2.0)
       ractor-tvar (~> 0.3.0)
 
 GEM

data/lib/ractor/tmvar.rb

@@ -6,48 +6,121 @@ 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 TVar. It needs to be shareable.
     #
     # @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.
+    #
+    # @return [Object] value of internal TVar, only if exists.
+    #
+    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 neet to be shareable
+    #
+    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 neet to be shareable
     #
-    def value=(new_value)
-      raise Ractor::RetryTransaction if @tvar.value != BLANK
+    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 neet to be shareable
+    #
+    def swap(new)
+      v = @tvar.value
+      raise Ractor::RetryTransaction if v == EMPTY
+
+      @tvar.value = new
+      v
     end
   end
 end

data/lib/ractor/tmvar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ractor-tmvar
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - yoshitsugu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ractor-tvar