smart_engine 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b137be2c542d4c01e946932a38f2de479072d1161b554371be67a2e05a7ecc7
-  data.tar.gz: 2330b494ac201a1f41ee289a3dcd68acf326686c734b05c9b3e40980bf41c980
+  metadata.gz: '087b1dbf9ee51ac25529cffbb42796a6fcf9fefe5a6450dd55b422f731f24ea5'
+  data.tar.gz: 4ec414dbbf3f033a2051a8f88b9b9304f0741f8b7330d65238dcd4a6b95e4f5f
 SHA512:
-  metadata.gz: 654494695f3f41c544a8aab9eaf65a2f682fb41252dcfcadbd02df058ffb9668ad3885a30176b80625058fbef0f4d343a679818a63d7d379d6ef54a4ccb16847
-  data.tar.gz: 2179458ced3a67eb97649ed057943a4c1ad80df3ebda18f416ed7f3f350e8b5f75dfc111d442e57a920b9f1039e74fa3b99be74d4b76f7418caf2880a22e264f
+  metadata.gz: 0ed532ab1c5d773bdc8b9a2156f70d41b8b68725e812a5a89c5f2576c8595e60c081756dc6427cfe5f53c758cb094078c994aa614c76b3e057f99e87ed0a7e3d
+  data.tar.gz: 3748b43ed40a12b4d65e32b85a87d9ff790791c1987962b2377751a2e6a66d9a877b33dd450b8d2aadaad192d03f3183d272b555236afac538b86ee149d4376f

data/.rubocop.yml

@@ -5,7 +5,8 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.7.1
+  TargetRubyVersion: 2.7.2
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
@@ -13,3 +14,7 @@ AllCops:
     - Rakefile
     - smart_engine.gemspec
     - bin/console
+
+# NOTE: for better representativeness of test examples
+RSpec/DescribedClass:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,39 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.11.0] - 2021-01-17
+### Added
+- Support for *Ruby@3*;
+
+## [0.10.0] - 2020-12-22
+### Added
+- Support for `#hash` and `#instance_of?` for `SmartCore::Ext::BasicObjectAsObject` refinement;
+
+## [0.9.0] - 2020-12-20
+### Added
+- New type of utilities: *Extensions* (`SmartCore::Ext`);
+- New extension: `SmartCore::Ext::BasicObjectAsObject` refinement:
+  - `using SmartCore::Ext::BasicObjectAsObject` provides native support for:
+    - `BasicObject#is_a?`;
+    - `BasicObject#kind_of?`;
+    - `BasicObject#freeze`;
+    - `BasicObject#frozen?`;
+
+### Changed
+- Updated development dependencies;
+- Support for *Ruby@2.4* has ended;
+
+### Fixed
+- `SmartCore::Engine::Frozener` can not be used with rubies lower than `@2.7`;
+
+## [0.8.0] - 2020-07-25
+### Added
+- Any object frozener (`SmartCore::Engine::Frozener`, `SmartCore::Engine::Frozener::Mixin`);
+
+## [0.7.0] - 2020-07-03
+### Added
+- Atomic threadsafe value container (`SmartCore::Engine::Atom`);
+
 ## [0.6.0] - 2020-05-03
 ### Added
 - Inline rescue pipe (`SmartCore::Engine::RescueExt.inline_rescue_pipe`);

data/Gemfile.lock

@@ -1,96 +1,102 @@
 PATH
   remote: .
   specs:
-    smart_engine (0.6.0)
+    smart_engine (0.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    armitage-rubocop (0.82.0.2)
-      rubocop (= 0.82.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.5.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 (= 1.39.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    i18n (1.8.2)
+      rubocop-rspec (= 2.1.0)
+    ast (2.4.1)
+    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.0)
-    jaro_winkler (1.5.4)
     method_source (1.0.0)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.1)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.5.2)
-      activesupport
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
+      rubocop (>= 0.90.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.82)
-  bundler (~> 2.1)
+  armitage-rubocop (~> 1.7)
+  bundler (~> 2.2)
   pry (~> 0.13)
   rake (~> 13.0)
-  rspec (~> 3.9)
-  simplecov (~> 0.18)
+  rspec (~> 3.10)
+  simplecov (~> 0.21)
   smart_engine!
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -24,7 +24,11 @@ require 'smart_core'
 
 - [Global set of error types](#global-set-of-error-types)
 - [Simple reentrant lock](#simple-reentrant-lock)
+- [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)
+- [Roadmap](#roadmap)
 
 ---
 
@@ -47,6 +51,96 @@ lock.synchronize { your_code }
 
 ---
 
+### Atomic thread-safe value container
+
+```ruby
+atom = SmartCore::Engine::Atom.new # initial value - nil
+atom.value # => nil
+# --- or ---
+atom = SmartCore::Engine::Atom.new(7) # initial value - 7
+atom.value # => 7
+
+# set new value (thread-safely)
+atom.swap { |original_value| original_value * 2 }
+atom.value # => 14
+```
+
+---
+
+### Any Object Frozener
+
+- works with any type of ruby objects (event with `BasicObject`);
+- uses classic Ruby C-level `frozen?`/`freeze` functionality;
+
+```ruby
+# as a singleton
+
+object = BasicObject.new
+SmartCore::Engine::Frozener.frozen?(object) # => false
+
+SmartCore::Engine::Frozener.freeze(object)
+SmartCore::Engine::Frozener.frozen?(object) # => true
+```
+
+```ruby
+# as a mixin
+
+class EmptyObject < BasicObject
+  include SmartCore::Engine::Frozener::Mixin
+end
+
+object = EmptyObject.new
+
+object.frozen? # => false
+object.freeze
+object.frozen? # => true
+```
+
+---
+
+### Basic Object Refinements
+
+Ruby's `BasicObject` class does not have some fundamental (extremely important for instrumenting) methods:
+
+- `is_a?` / `kind_of?`
+- `instance_of?`
+- `freeze` / `frozen?`
+- `hash`
+- `nil?`
+
+`SmartCore::Ext::BasicObjectAsObject` refinement solves this problem (by Ruby's internal API without any manualy-emulated behavior).
+
+```ruby
+# without refinement:
+basic_obj = ::BasicObject.new
+
+basic_obj.is_a?(::BasicObject) # raises ::NoMethodError
+basic_obj.kind_of?(::BasicObject) # raises ::NoMethodError
+basic_obj.instance_of?(::BasicObject) # rasies ::NoMethodError
+basic_obj.freeze # raises ::NoMethodError
+basic_obj.frozen? # raises ::NoMethodError
+```
+
+```ruby
+# with refinement:
+using SmartCore::Ext::BasicObjectAsObject
+
+basic_obj = ::BasicObject.new
+
+basic_obj.is_a?(::BasicObject) # => true
+basic_obj.kind_of?(::BasicObject) # => true
+basic_obj.instance_of?(::BasicObject) # => true
+basic_obj.instance_of?(::Object) # => false
+basic_obj.is_a?(::Integer) # => false
+basic_obj.kind_of?(::Integer) # => false
+
+basic_obj.frozen? # => false
+basic_obj.freeze # => self
+basic_obj.frozen? # => true
+```
+
+---
+
 ### Inline rescue pipe
 
 - works with an array of proc objects;
@@ -93,6 +187,12 @@ end
 
 ---
 
+## Roadmap
+
+- thread-safety for BasicObject extensions;
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/smart-rb/smart_engine )

data/lib/smart_core.rb

@@ -5,4 +5,5 @@
 module SmartCore
   require_relative 'smart_core/errors'
   require_relative 'smart_core/engine'
+  require_relative 'smart_core/ext'
 end

data/lib/smart_core/engine.rb

@@ -6,4 +6,6 @@ module SmartCore::Engine
   require_relative 'engine/version'
   require_relative 'engine/lock'
   require_relative 'engine/rescue_ext'
+  require_relative 'engine/atom'
+  require_relative 'engine/frozener'
 end

data/lib/smart_core/engine/atom.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.7.0
+class SmartCore::Engine::Atom
+  # @param initial_value [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(initial_value = nil)
+    @value = initial_value
+    @barrier = SmartCore::Engine::Lock.new
+  end
+
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.7.0
+  def value
+    with_barrier { @value }
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.7.0
+  def swap(&block)
+    with_barrier { @value = yield(@value) }
+  end
+
+  private
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def with_barrier(&block)
+    @barrier.synchronize(&block)
+  end
+end

data/lib/smart_core/engine/ext.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.9.0
+module SmartCore::Engine::Ext
+  require_relative 'ext/basic_object_as_object'
+end

data/lib/smart_core/engine/frozener.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.8.0
+# @version 0.9.0
+module SmartCore::Engine::Frozener
+  # @api public
+  # @since 0.8.0
+  module Mixin
+    # @return [self]
+    #
+    # @api public
+    # @since 0.8.0
+    def freeze
+      SmartCore::Engine::Frozener.freeze(self)
+    end
+
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.8.0
+    def frozen?
+      SmartCore::Engine::Frozener.frozen?(self)
+    end
+  end
+
+  # @return [UnboundMethod]
+  #
+  # @api private
+  # @since 0.8.0
+  FROZENER = Object.new.method(:freeze).unbind.tap(&:freeze)
+
+  # @return [UnboundMethod]
+  #
+  # @api private
+  # @since 0.8.0
+  FROZEN_CHECK = Object.new.method(:frozen?).unbind.tap(&:freeze)
+
+  class << self
+    # @param object [Any]
+    # @return [object]
+    #
+    # @api public
+    # @since 0.8.0
+    # @version 0.9.0
+    def freeze(object)
+      FROZENER.bind(object).call
+    end
+
+    # @param object [Any]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.8.0
+    # @version 0.9.0
+    def frozen?(object)
+      FROZEN_CHECK.bind(object).call
+    end
+  end
+end

data/lib/smart_core/engine/version.rb

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

data/lib/smart_core/ext.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.9.0
+module SmartCore::Ext
+  require_relative 'ext/basic_object_as_object'
+end

data/lib/smart_core/ext/basic_object_as_object.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.9.0
+# @version 0.10.0
+module SmartCore::Ext::BasicObjectAsObject
+  refine BasicObject do
+    _m_obj = ::Object.new
+
+    _is_a        = _m_obj.method(:is_a?).unbind.tap(&:freeze)
+    _freeze      = _m_obj.method(:freeze).unbind.tap(&:freeze)
+    _frozen      = _m_obj.method(:frozen?).unbind.tap(&:freeze)
+    _hash        = _m_obj.method(:hash).unbind.tap(&:freeze)
+    _nil         = _m_obj.method(:nil?).unbind.tap(&:freeze)
+    _instance_of = _m_obj.method(:instance_of?).unbind.tap(&:freeze)
+
+    # @note Object#is_a? behavior copy
+    # @param klass [Class]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.9.0
+    define_method(:is_a?) do |klass|
+      _is_a.bind(self).call(klass)
+    end
+    alias_method :kind_of?, :is_a?
+
+    # @note Object#freeze behavior copy
+    # @return [self]
+    #
+    # @api public
+    # @since 0.9.0
+    define_method(:freeze) do
+      _freeze.bind(self).call
+    end
+
+    # @note Object#frozen? behavior copy
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.9.0
+    define_method(:frozen?) do
+      _frozen.bind(self).call
+    end
+
+    # @return [Integer]
+    #
+    # @api public
+    # @since 0.10.0
+    define_method(:hash) do
+      _hash.bind(self).call
+    end
+
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.10.0
+    define_method(:nil?) do
+      _nil.bind(self).call
+    end
+
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.1.0
+    define_method(:instance_of?) do |klass|
+      _instance_of.bind(self).call(klass)
+    end
+  end
+end

data/smart_engine.gemspec

@@ -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.1'
+  spec.add_development_dependency 'bundler',          '~> 2.2'
   spec.add_development_dependency 'rake',             '~> 13.0'
-  spec.add_development_dependency 'rspec',            '~> 3.9'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.82'
-  spec.add_development_dependency 'simplecov',        '~> 0.18'
+  spec.add_development_dependency 'rspec',            '~> 3.10'
+  spec.add_development_dependency 'armitage-rubocop', '~> 1.7'
+  spec.add_development_dependency 'simplecov',        '~> 0.21'
   spec.add_development_dependency 'pry',              '~> 0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_engine
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rustam Ibragimov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: armitage-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +107,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -119,10 +118,15 @@ files:
 - bin/setup
 - lib/smart_core.rb
 - lib/smart_core/engine.rb
+- lib/smart_core/engine/atom.rb
+- lib/smart_core/engine/ext.rb
+- lib/smart_core/engine/frozener.rb
 - lib/smart_core/engine/lock.rb
 - lib/smart_core/engine/rescue_ext.rb
 - lib/smart_core/engine/version.rb
 - lib/smart_core/errors.rb
+- lib/smart_core/ext.rb
+- lib/smart_core/ext/basic_object_as_object.rb
 - smart_engine.gemspec
 homepage: https://github.com/smart-rb/smart_engine
 licenses:
@@ -131,7 +135,7 @@ metadata:
   homepage_uri: https://github.com/smart-rb/smart_engine
   source_code_uri: https://github.com/smart-rb/smart_engine
   changelog_uri: https://github.com/smart-rb/smart_engine/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: SmartCore Engine - a generic subset of SmartCore's functionality.
 test_files: []

data/.travis.yml

@@ -1,21 +0,0 @@
----
-language: ruby
-cache: bundler
-before_install: gem install bundler
-os: linux
-dist: xenial
-script:
-- bundle exec rake rubocop
-- bundle exec rake rspec
-jobs:
-  fast_finish: true
-  include:
-  - rvm: 2.4.10
-  - rvm: 2.5.8
-  - rvm: 2.6.6
-  - rvm: 2.7.1
-  - rvm: ruby-head
-  - rvm: jruby-head
-  allow_failures:
-  - rvm: ruby-head
-  - rvm: jruby-head