smart_engine 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48de1362f022e1e37a6a234db4936b0077c9d5cc818ac2bb73a72157f4b949dc
-  data.tar.gz: cf4e6d5a6c51d926fc6d5186d0857006d7a114811be4d4f753283e1872575cdf
+  metadata.gz: 571c427f764fe322ccc465dbe90d760ffde9ffa324bd55a15e6046da6a18909f
+  data.tar.gz: 446a429d3c440bfa0bc1bc16a3abdb58289810d56bd7eec86b66307c59c5227a
 SHA512:
-  metadata.gz: dda02f4e36e5c85f3a1117ba85013ab99120956166501c31e0178f6f58898a8a9fb87a585d80a1d9174d5f0eca72139e954bb73a1b0ea72dd7d79a36a41636e8
-  data.tar.gz: 905bb7bea34f0d101633dd64e0709f50671d81eaa8ed0b7d5880892f760e62a038605173936ea9d27f8e51680d11495f5b1de0cfefd57490450a67f7ebc3ec69
+  metadata.gz: 3493139baf67304edaa0fd7db320987b6ed860efc2d80e393a1baa73d590cd0b63e80e0069430bc3d286f7bcf095161ea51782643792ce0a4f3b8dca4e5e9ce5
+  data.tar.gz: 7702c746ab952d345e935a40a51d581f8f2ecb81f8f12c867e295813e74df9f08bd7b7db31b644194fe6e5e428026577c33de2e17e37a1287c2f6dd42781a20e

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [0.15.0] - 2022-09-30
+### Added
+- `SmartCore::Engine::ReadWriteLock#write_owned?` - checking that write lock is owned by current thread or not;
+
+## [0.14.0] - 2022-09-30
+### Added
+- Read/Write locking mechanizm: `SmartCore::Engine::ReadWriteLock`;
+
+## [0.13.0] - 2022-09-30
 ### Added
 - Simplest in-memory cache storage implementation: `SmartCore::Engine::Cache`;
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_engine (0.13.0)
+    smart_engine (0.15.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -34,6 +34,7 @@ require 'smart_core'
 
 - [Global set of error types](#global-set-of-error-types)
 - [Simple reentrant lock](#simple-reentrant-lock)
+- [Read/Write Lock](#read-write-lock)
 - [Cache Storage](#cache-storage)
 - [Atomic thread-safe value container](#atomic-thread-safe-value-container)
 - [Any Object Frozener](#any-object-frozener) (classic c-level `frozen?`/`freeze`)
@@ -62,6 +63,26 @@ lock.synchronize { your_code }
 
 ---
 
+### Read/Write Lock
+
+- non-controlable reader count;
+- readers does not lock each other;
+- readers waits for writer;
+- writer waits for readers;
+
+```ruby
+lock = SmartCore::Engine::ReadWriteLock.new
+
+lock.read_sync { ...some-read-op... } # waits for writer
+lock.read_sync { ...some-read-op... } # waits for writer
+lock.write_sync { ... some-write-op... } # waits for all readers and current writer
+
+# is write_sync lock is owned by current thread?
+lock.write_owned? # true or false
+```
+
+---
+
 ### Cache Storage
 
 - you can use any object as a cache key;
@@ -275,6 +296,8 @@ end
   - support for `#keys` method;
   - support for `#key?` method;
   - think about some layer of cache object serialization;
+- `SmartCore::Engine::ReadWriteLock`:
+  - an ability to set a maximum count of readers;
 
 ---
 

data/lib/smart_core/engine/lock.rb

@@ -8,7 +8,7 @@ class SmartCore::Engine::Lock
   # @api public
   # @since 0.4.0
   def initialize
-    @lock = Mutex.new
+    @lock = ::Mutex.new
   end
 
   # @param block [Block]

data/lib/smart_core/engine/read_write_lock.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.14.0
+# @version 0.15.0
+class SmartCore::Engine::ReadWriteLock
+  # @return [void]
+  #
+  # @api public
+  # @sicne 0.14.0
+  def initialize
+    # NOTE:
+    #   ivars has no readers cuz we want to avoid
+    #   Ruby VM's context-switching during reade-method invokation.
+    @active_reader = false
+    @write_lock = ::Mutex.new
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.14.0
+  def read_sync(&block)
+    @active_reader = true
+    while @write_lock.locked? do; end
+    yield
+  ensure
+    @active_reader = false
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.15.0
+  def write_owned?
+    @write_lock.owned?
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.14.0
+  def write_sync(&block)
+    while @active_reader do; end
+    @write_lock.synchronize do
+      @active_reader = true
+      begin
+        yield
+      ensure
+        @active_reader = false
+      end
+    end
+  end
+end

data/lib/smart_core/engine/version.rb

@@ -6,7 +6,7 @@ module SmartCore
     #
     # @api public
     # @since 0.1.0
-    # @version 0.13.0
-    VERSION = '0.13.0'
+    # @version 0.15.0
+    VERSION = '0.15.0'
   end
 end

data/lib/smart_core/engine.rb

@@ -5,6 +5,7 @@
 module SmartCore::Engine
   require_relative 'engine/version'
   require_relative 'engine/lock'
+  require_relative 'engine/read_write_lock'
   require_relative 'engine/rescue_ext'
   require_relative 'engine/atom'
   require_relative 'engine/frozener'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_engine
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Rustam Ibragimov
@@ -123,6 +123,7 @@ files:
 - lib/smart_core/engine/ext.rb
 - lib/smart_core/engine/frozener.rb
 - lib/smart_core/engine/lock.rb
+- lib/smart_core/engine/read_write_lock.rb
 - lib/smart_core/engine/rescue_ext.rb
 - lib/smart_core/engine/version.rb
 - lib/smart_core/errors.rb