smart_engine 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6541e8d5473adec2d2694952dc216c597868a1d18ec7c87f31d12f3d9bf0ae16
-  data.tar.gz: 4f1edf67c3389b91202778926243ff99c52280bad57a5a833888239a7f5e23cf
+  metadata.gz: 228fbd594308ecee71718fe059d6d8bf57f8e79f33b0607ca4b771fc498a0ac4
+  data.tar.gz: 809d274f771a7de133a1bc8986448ffca67bcefa2f0fd5f3a5d39cf730c448fa
 SHA512:
-  metadata.gz: 71b7cc9b85346c7ed17281c0f50ddf5026cc6ad0b135087a1915fee6620be85019a1bdd0e79ec15ee5a14c8da207da84322ef297917ad1eb1956ec7b85b1b648
-  data.tar.gz: d7a4fabcc86cb65ef4309d99581d8a3f2c215164f7a405a0d6bf5ac5c0deeed5f6320c3b83530ccc6ef5b67bfe70d3d765289ae574b08dd3cf97428b6d4308b6
+  metadata.gz: 29eb3e3f8e005af66036b33c3bdb7260d8da6054dd63177b50d7a1bb0cd6b4a6ba39a61c03a77420a9d2867fbc4424a7a2718e535c0dd6afefa4f699c6c33beb
+  data.tar.gz: 70f57850d865a3dcbfbc083f444c30a86bd24745501e1816efff41db049c294ae5844f2c2bf6856316137a20d7be7b00c32964a852f576245ab0f378d40bb06e

data/.rubocop.yml

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

data/.travis.yml

@@ -1,18 +1,19 @@
 ---
 language: ruby
 cache: bundler
-before_install: gem install bundler -v 2.1.2
+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.9
-  - rvm: 2.5.7
-  - rvm: 2.6.5
-  - rvm: 2.7.0
+  - rvm: 2.4.10
+  - rvm: 2.5.8
+  - rvm: 2.6.6
+  - rvm: 2.7.1
   - rvm: ruby-head
   - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,7 +1,28 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.3.0] -202-01-17
+## [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`);
+- Actualized development dependencies and test environment;
+
+## [0.5.0] - 2020-01-22
+### Added
+- Global error type `SmartCore::TypeError` inherited from `::TypeError`;
+
+## [0.4.0] - 2020-01-19
+### Added
+- `SmartCore::Engine::Lock` - simple reentrant-based locking primitive;
+
+## [0.3.0] - 2020-01-17
 ### Added
 - Global error type `SmartCore::NameError` inherited from `::NameError`;
 

data/Gemfile.lock

@@ -1,81 +1,99 @@
 PATH
   remote: .
   specs:
-    smart_engine (0.3.0)
+    smart_engine (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    armitage-rubocop (0.79.0)
-      rubocop (= 0.79.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.4.1)
-      rubocop-rake (= 0.5.0)
-      rubocop-rspec (= 1.37.1)
-    ast (2.4.0)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    armitage-rubocop (0.87.1)
+      rubocop (= 0.87.1)
+      rubocop-performance (= 1.7.0)
+      rubocop-rails (= 2.6.0)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 1.41.0)
+    ast (2.4.1)
     coderay (1.1.2)
-    diff-lcs (1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    method_source (0.9.2)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.1.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    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.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.87.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.4.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.0)
+      rubocop (>= 0.82.0)
+    rubocop-rails (2.6.0)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rake (0.5.0)
+      rubocop (>= 0.82.0)
+    rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.37.1)
+    rubocop-rspec (1.41.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    unicode-display_width (1.6.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.79)
+  armitage-rubocop (~> 0.87)
   bundler (~> 2.1)
-  pry (~> 0.12)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  simplecov (~> 0.17)
+  simplecov (~> 0.18)
   smart_engine!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -22,11 +22,122 @@ require 'smart_core'
 
 ## Technologies
 
-- **Global set of error types**:
-  - `SmartCore::Error` (inherited from `::StandardError`);
-  - `SmartCore::ArgumentError` (inherited from `::ArgumentError`);
-  - `SmartCore::FrozenError` (inherited from `::FrozenError`);
-  - `SmartCore::NameError` (inherited from `::NameError`);
+- [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)
+- [Inline rescue pipe](#inline-rescue-pipe)
+
+---
+
+### Global set of error types
+
+- `SmartCore::Error` (inherited from `::StandardError`);
+- `SmartCore::ArgumentError` (inherited from `::ArgumentError`);
+- `SmartCore::FrozenError` (inherited from `::FrozenError`);
+- `SmartCore::NameError` (inherited from `::NameError`);
+- `SmartCore::TypeError` (inherited from `::TypeError`);
+
+---
+
+### Simple reentrant lock
+
+```ruby
+lock = SmartCore::Engine::Lock.new
+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`);
+
+```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
+```
+
+---
+
+### Inline rescue pipe
+
+- works with an array of proc objects;
+- returns the result of the first non-failed proc;
+- provides an error interception interface (a block argument);
+- fails with the last failed proc exception (if all procs were failed and interceptor was not passed);
+
+#### Return the result of the first non-failed proc
+
+```ruby
+SmartCore::Engine::RescueExt.inline_rescue_pipe(
+  -> { raise },
+  -> { raise },
+  -> { 123 },
+  -> { 567 },
+  -> { raise },
+)
+# => output: 123
+```
+
+#### Fail with the last failed proc exception
+
+```ruby
+SmartCore::Engine::RescueExt.inline_rescue_pipe(
+  -> { raise(::ArgumentError) },
+  -> { raise(::TypeError) },
+  -> { raise(::ZeroDivisionError) }
+)
+# => fails with ZeroDivisionError
+```
+
+#### Error interception
+
+```ruby
+SmartCore::Engine::RescueExt.inline_rescue_pipe(
+  -> { raise(::ArgumentError) },
+  -> { raise(::TypeError) },
+  -> { raise(::ZeroDivisionError, 'Intercepted exception') }
+) do |error|
+  error.message
+end
+# => output: "Intercepted exception"
+```
 
 ---
 

data/Rakefile

@@ -4,6 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop'
 require 'rubocop/rake_task'
+require 'rubocop-rails'
 require 'rubocop-performance'
 require 'rubocop-rspec'
 require 'rubocop-rake'
@@ -11,8 +12,8 @@ require 'rubocop-rake'
 RuboCop::RakeTask.new(:rubocop) do |t|
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
   t.options = ['--config', config_path]
-  t.requires << 'rubocop-performance'
   t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
   t.requires << 'rubocop-rake'
 end
 

data/lib/smart_core/engine.rb

@@ -4,4 +4,8 @@
 # @since 0.1.0
 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/frozener.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.8.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
+    def freeze(object)
+      FROZENER.bind_call(object)
+    end
+
+    # @param object [Any]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.8.0
+    def frozen?(object)
+      FROZEN_CHECK.bind_call(object)
+    end
+  end
+end

data/lib/smart_core/engine/lock.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.4.0
+class SmartCore::Engine::Lock
+  # @return [void]
+  #
+  # @api public
+  # @since 0.4.0
+  def initialize
+    @lock = Mutex.new
+  end
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.4.0
+  def synchronize(&block)
+    @lock.owned? ? yield : @lock.synchronize(&block)
+  end
+end

data/lib/smart_core/engine/rescue_ext.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.6.0
+module SmartCore::Engine::RescueExt
+  # REASON:
+  #   {module_funciton} is used to be able to include/extend any module/class
+  #   and at the same time to use without any inclusion/extending logic as a service
+
+  module_function
+
+  # @param proks [Array<Proc>]
+  # @param error_interceptor [Block]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.6.0
+  # rubocop:disable Performance/RedundantBlockCall
+  def inline_rescue_pipe(*proks, &error_interceptor)
+    unless proks.all? { |prok| prok.is_a?(::Proc) }
+      raise(SmartCore::ArgumentError, 'Invalid proc object')
+    end
+
+    interceptable_bloks = proks.to_enum
+    pipe_invokation_result = nil
+    last_exception = nil
+
+    begin
+      while current_block = interceptable_bloks.next
+        begin
+          pipe_invokation_result = current_block.call
+          break
+        rescue => error
+          last_exception = error
+        end
+      end
+
+      pipe_invokation_result
+    rescue ::StopIteration
+      error_interceptor ? error_interceptor.call(last_exception) : raise(last_exception)
+    end
+  end
+  # rubocop:enable Performance/RedundantBlockCall
+end

data/lib/smart_core/engine/version.rb

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

data/lib/smart_core/errors.rb

@@ -13,6 +13,10 @@ module SmartCore
   # @since 0.3.0
   NameError = Class.new(::NameError)
 
+  # @api public
+  # @since 0.5.0
+  TypeError = Class.new(::TypeError)
+
   # @api public
   # @since 0.2.0
   FrozenError = begin # rubocop:disable Naming/ConstantName

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.9')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.10')
 
   spec.name     = 'smart_engine'
   spec.version  = SmartCore::Engine::VERSION
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler',          '~> 2.1'
   spec.add_development_dependency 'rake',             '~> 13.0'
   spec.add_development_dependency 'rspec',            '~> 3.9'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.79'
-  spec.add_development_dependency 'simplecov',        '~> 0.17'
-  spec.add_development_dependency 'pry',              '~> 0.12'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.87'
+  spec.add_development_dependency 'simplecov',        '~> 0.18'
+  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.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 description: 'SmartCore Engine - a set of core functionality shared beetwen a series
   of SmartCore gems.
 
@@ -119,6 +119,10 @@ files:
 - bin/setup
 - lib/smart_core.rb
 - lib/smart_core/engine.rb
+- lib/smart_core/engine/atom.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
 - smart_engine.gemspec
@@ -137,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.9
+      version: 2.4.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="