smart_engine 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3dd0221b83c217c01e45d3f46604971eb84d04d49be0632ce49f755218d76d
-  data.tar.gz: 5b441d31174be2b6d449f7075abea95b5f0ede317db8e416f07245f9d2e3e83c
+  metadata.gz: 48de1362f022e1e37a6a234db4936b0077c9d5cc818ac2bb73a72157f4b949dc
+  data.tar.gz: cf4e6d5a6c51d926fc6d5186d0857006d7a114811be4d4f753283e1872575cdf
 SHA512:
-  metadata.gz: 3da36f25ec0827992a15bbbb2b20ffdbddc7233ace64ec2cbcfe5c6f7d12cf5a95b35d065b8b47d362df8de5b1dd799b8d473ca7459b414b81f651afb43c3db4
-  data.tar.gz: d8efcca5893345b3fb32a0fc0bbe014c9e99bf66d70a6b3bf561a6e037b50ec1f4886894913fc6bb6bc334a92661f4f81face5ce9aec01e7587c71beb1bd7bdb
+  metadata.gz: dda02f4e36e5c85f3a1117ba85013ab99120956166501c31e0178f6f58898a8a9fb87a585d80a1d9174d5f0eca72139e954bb73a1b0ea72dd7d79a36a41636e8
+  data.tar.gz: 905bb7bea34f0d101633dd64e0709f50671d81eaa8ed0b7d5880892f760e62a038605173936ea9d27f8e51680d11495f5b1de0cfefd57490450a67f7ebc3ec69

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 3.0.0
+  TargetRubyVersion: 3.1.0
   NewCops: enable
   Include:
     - lib/**/*.rb

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+### Added
+- Simplest in-memory cache storage implementation: `SmartCore::Engine::Cache`;
+### Changed
+- Minimal Ruby version is `2.5` (`>= 2.5`);
+- Better `BasicObject`'s refinement extention specs;
+- Updated development dependencies;
+
 ## [0.12.0] - 2021-12-09
 ### Added
 - `using SmartCore::Ext::BasicObjectAsObject` provides native support for:

data/Gemfile.lock

@@ -1,102 +1,99 @@
 PATH
   remote: .
   specs:
-    smart_engine (0.12.0)
+    smart_engine (0.13.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    armitage-rubocop (1.7.0.1)
-      rubocop (= 1.7.0)
-      rubocop-performance (= 1.9.1)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.1.0)
-    ast (2.4.1)
+    armitage-rubocop (1.30.1.1)
+      rubocop (= 1.30.1)
+      rubocop-performance (= 1.14.2)
+      rubocop-rails (= 2.15.0)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.11.1)
+    ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    i18n (1.8.7)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rack (3.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.7.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.1)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.15.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.1.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    tzinfo (2.0.4)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
 
 DEPENDENCIES
-  armitage-rubocop (~> 1.7)
-  bundler (~> 2.2)
-  pry (~> 0.13)
+  armitage-rubocop (~> 1.30)
+  bundler (~> 2.3)
+  pry (~> 0.14)
   rake (~> 13.0)
-  rspec (~> 3.10)
+  rspec (~> 3.11)
   simplecov (~> 0.21)
   smart_engine!
 
 BUNDLED WITH
-   2.2.27
+   2.3.17

data/README.md

@@ -34,11 +34,13 @@ require 'smart_core'
 
 - [Global set of error types](#global-set-of-error-types)
 - [Simple reentrant lock](#simple-reentrant-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`)
 - [Basic Object Refinements](#basic-object-refinements) (`SmartCore::Ext::BasicObjectAsObject`)
 - [Inline rescue pipe](#inline-rescue-pipe)
 
+
 ---
 
 ### Global set of error types
@@ -60,6 +62,62 @@ lock.synchronize { your_code }
 
 ---
 
+### Cache Storage
+
+- you can use any object as a cache key;
+- you can store any object as a cache value;
+- you can cache `nil` object too;
+
+- cache `read` has `fetch` semantics:
+  - signature: `#read(key, &fallback)`;
+  - in the event of cache miss the `&fallback` black will be invoked;
+  - the return value of the fallback block will be written to the cache, and that return value will be returned;
+- cache `write`:
+  - signature: `#write(key, value)`;
+  - you can use any object as a cache key;
+  - you can store any object as a value;
+  - you can write `nil` object too;
+- cache clear:
+  - signature: `#clear`;
+
+```ruby
+cache = SmartCore::Engine::Cache.new
+
+# write and read
+cache.write(:amount, 123.456) # => 123.456
+cache.read(:amount) # => 123.456
+
+# read non-existing with a fallback
+cache.read('name') # => nil
+cache.read('name') { 'D@iVeR' } # => 'D@iVeR'
+cache.read('name') # => 'D@iVeR'
+
+# store nil object
+cache.write(:nil_value, nil) # => nil
+cache.read(:nil_value) # => nil
+cache.read(:nil_value) { 'rewritten' } # => nil
+cache.read(:nil_value) # => nil
+
+# clear cache
+cache.clear # => nil
+```
+
+```ruby
+# aliases:
+
+# write:
+cache[:key1] = 'test'
+
+# read:
+cache[:key1] # => 'test'
+
+# read with fallback:
+cache[:key2] { 'test2' } # => 'test2'
+cache[:key2] # => 'test2'
+```
+
+---
+
 ### Atomic thread-safe value container
 
 ```ruby
@@ -116,6 +174,7 @@ Ruby's `BasicObject` class does not have some fundamental (extremely important f
 - `freeze` / `frozen?`
 - `hash`
 - `nil?`
+- `inspect`
 
 `SmartCore::Ext::BasicObjectAsObject` refinement solves this problem (by Ruby's internal API without any manualy-emulated behavior).
 
@@ -130,6 +189,7 @@ basic_obj.freeze # raises ::NoMethodError
 basic_obj.frozen? # raises ::NoMethodError
 basic_object.hash # raises ::NoMethodError
 basic_object.nil? # raises ::NoMethodError
+basic_object.inspect # raises ::NoMethodError
 ```
 
 ```ruby
@@ -152,6 +212,8 @@ basic_obj.frozen? # => true
 basic_obj.nil? # => false
 
 basic_obj.hash # => 2682859680348634421 (some Integer value)
+
+basic_obj.inspect # => "#<BasicObject:0x00007fe428018628>"
 ```
 
 ---
@@ -206,6 +268,13 @@ end
 
 - migrate to Github Actions in CI;
 - thread-safety for BasicObject extensions;
+- `SmartCore::Engine::Cache`:
+  - thread-safety;
+  - support for `ttl:` option for `#write` and for fallback block attribute of `#read`;
+  - support for key-value-pair iteration;
+  - support for `#keys` method;
+  - support for `#key?` method;
+  - think about some layer of cache object serialization;
 
 ---
 

data/lib/smart_core/engine/cache.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.13.0
+class SmartCore::Engine::Cache
+  # @return [void]
+  #
+  # @api public
+  # @since 0.13.0
+  def initialize
+    @store = {}
+    # TODO: thread-safety (use SmartCore::Engine::Lock)
+  end
+
+  # @param key [Any]
+  # @apram value [Any]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.13.0
+  def write(key, value)
+    @store[key] = value
+  end
+  alias_method :[]=, :write
+
+  # @param key [Any]
+  # @param fallback [Block]
+  # @return [Any, NilClass]
+  #
+  # @api public
+  # @since 0.13.0
+  # rubocop:disable Style/NestedTernaryOperator
+  def read(key, &fallback)
+    # @note
+    #   key?-flow is a compromise used to provide an ability to cache `nil` objects too.
+    @store.key?(key) ? @store[key] : (block_given? ? write(key, yield) : nil)
+  end
+  alias_method :[], :read
+  # rubocop:enable Style/NestedTernaryOperator
+
+  # @return [NilClass]
+  #
+  # @api public
+  # @since 0.13.0
+  def clear
+    @store.clear
+    nil
+  end
+end

data/lib/smart_core/engine/frozener.rb

@@ -44,7 +44,10 @@ module SmartCore::Engine::Frozener
     # @since 0.8.0
     # @version 0.9.0
     def freeze(object)
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       FROZENER.bind(object).call
+      # rubocop:enable Performance/BindCall
     end
 
     # @param object [Any]
@@ -54,7 +57,10 @@ module SmartCore::Engine::Frozener
     # @since 0.8.0
     # @version 0.9.0
     def frozen?(object)
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       FROZEN_CHECK.bind(object).call
+      # rubocop:enable Performance/BindCall
     end
   end
 end

data/lib/smart_core/engine/version.rb

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

data/lib/smart_core/engine.rb

@@ -8,4 +8,5 @@ module SmartCore::Engine
   require_relative 'engine/rescue_ext'
   require_relative 'engine/atom'
   require_relative 'engine/frozener'
+  require_relative 'engine/cache'
 end

data/lib/smart_core/errors.rb

@@ -19,13 +19,14 @@ module SmartCore
 
   # @api public
   # @since 0.2.0
-  FrozenError = begin # rubocop:disable Naming/ConstantName
+  FrozenError = # rubocop:disable Naming/ConstantName
     # :nocov:
+    # rubocop:disable Layout/CommentIndentation
     if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
       Class.new(::FrozenError)
     else
       Class.new(::RuntimeError)
     end
     # :nocov:
-  end
+    # rubocop:enable Layout/CommentIndentation
 end

data/lib/smart_core/ext/basic_object_as_object.rb

@@ -22,7 +22,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.9.0
     define_method(:is_a?) do |klass|
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _is_a.bind(self).call(klass)
+      # rubocop:enable Performance/BindCall
     end
     alias_method :kind_of?, :is_a?
 
@@ -32,7 +35,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.9.0
     define_method(:freeze) do
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _freeze.bind(self).call
+      # rubocop:enable Performance/BindCall
     end
 
     # @note Object#frozen? behavior copy
@@ -41,7 +47,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.9.0
     define_method(:frozen?) do
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _frozen.bind(self).call
+      # rubocop:enable Performance/BindCall
     end
 
     # @return [Integer]
@@ -49,7 +58,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.10.0
     define_method(:hash) do
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _hash.bind(self).call
+      # rubocop:enable Performance/BindCall
     end
 
     # @return [Boolean]
@@ -57,7 +69,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.10.0
     define_method(:nil?) do
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _nil.bind(self).call
+      # rubocop:enable Performance/BindCall
     end
 
     # @return [Boolean]
@@ -65,7 +80,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.1.0
     define_method(:instance_of?) do |klass|
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _instance_of.bind(self).call(klass)
+      # rubocop:enable Performance/BindCall
     end
 
     # @return [String]
@@ -73,7 +91,10 @@ module SmartCore::Ext::BasicObjectAsObject
     # @api public
     # @since 0.12.0
     define_method(:inspect) do
+      # rubocop:disable Performance/BindCall
+      # NOTE: disabled in order to support older Ruby versions than Ruby@3
       _inspect.bind(self).call
+      # rubocop:enable Performance/BindCall
     end
   end
 end

data/smart_engine.gemspec

@@ -3,7 +3,7 @@
 require_relative 'lib/smart_core/engine/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.10')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
 
   spec.name     = 'smart_engine'
   spec.version  = SmartCore::Engine::VERSION
@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',          '~> 2.2'
+  spec.add_development_dependency 'bundler',          '~> 2.3'
   spec.add_development_dependency 'rake',             '~> 13.0'
-  spec.add_development_dependency 'rspec',            '~> 3.10'
-  spec.add_development_dependency 'armitage-rubocop', '~> 1.7'
+  spec.add_development_dependency 'rspec',            '~> 3.11'
+  spec.add_development_dependency 'armitage-rubocop', '~> 1.30'
   spec.add_development_dependency 'simplecov',        '~> 0.21'
-  spec.add_development_dependency 'pry',              '~> 0.13'
+  spec.add_development_dependency 'pry',              '~> 0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_engine
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: armitage-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.30'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 description: 'SmartCore Engine - a set of core functionality shared beetwen a series
   of SmartCore gems.
 
@@ -119,6 +119,7 @@ files:
 - lib/smart_core.rb
 - lib/smart_core/engine.rb
 - lib/smart_core/engine/atom.rb
+- lib/smart_core/engine/cache.rb
 - lib/smart_core/engine/ext.rb
 - lib/smart_core/engine/frozener.rb
 - lib/smart_core/engine/lock.rb
@@ -143,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.10
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: SmartCore Engine - a generic subset of SmartCore's functionality.