symbiont-ruby 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2df520b8812cc17063343dec89c82fd4ef94feb5
-  data.tar.gz: 3ef7f4309989802c211aa91f234547c69ecc654a
+SHA256:
+  metadata.gz: 6714f1b3ec4728993c6142a6c1c2afb74fa47bbddb6bd24ba0f07400d1a8dc2a
+  data.tar.gz: bd261c826def843dea5411a74c95e342b2c5eff9d657750c97b7e3369e29c599
 SHA512:
-  metadata.gz: 9c752120deaf778e7cf356b79beec8f2b471de4c3356993bd476239c25c23e7e1dbb540c5c2e39c37627aa6958c0306f209a97176ec038bc07767e9f5d01a708
-  data.tar.gz: 03f7fb48f8b91acd2e37260c4b6cfde7e18b4c2125ab4c2f2db56577c281f33bb4fc77a325ede3edb4a1a3e312afa37f85c4a69fb204b1d89cd96e763853e7b3
+  metadata.gz: e9611312a09174b8c326061d235bc7f89fbb4a3dc5ceed382210a94a9ece33811f3a164be5ea3718624b4de6b1361014740957727fded344eb4649d9da056847
+  data.tar.gz: d398c976b32b14caf11b80d9fd2ab7b026b4e71429f9bdf3c966f611b4f70dfc30bf48a89f008e2d095df2b19a9dd2b82ab66bc1ad181ad46b98f0379de57e94

data/.gitignore

@@ -1,10 +1,10 @@
 /.bundle/
 /.yardoc
 /_yardoc/
-/Gemfile.lock
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
 .rspec_status
+.ruby-version

data/.rspec

@@ -1,3 +1,3 @@
 --color
---format=progress
+--format progress
 --require spec_helper

data/.rubocop.yml

@@ -1,125 +1,30 @@
-require: rubocop-rspec
+inherit_gem:
+  armitage-rubocop:
+    - lib/rubocop.general.yml
+    - lib/rubocop.rspec.yml
 
 AllCops:
-  DisplayCopNames:   true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4.3
+  TargetRubyVersion: 3.0.0
   Include:
-    - lib/**/*
-    - spec/**/*
-  Exclude:
-    - bin/**/*
-    - Gemfile
+    - lib/**/*.rb
+    - spec/**/*.rb
+    - bin/console
     - Rakefile
+    - Gemfile
     - symbiont-ruby.gemspec
+    - Steepfile
 
-Style/SingleLineMethods:
-  Exclude:
-    - spec/**/*
-
-Style/RescueModifier:
-  Exclude:
-    - spec/**/*
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/Alias:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/EmptyCaseCondition:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/InverseMethods:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Style/CommentedKeyword:
-  Enabled: false
-
-Lint/HandleExceptions:
-  Enabled: false
-
-Layout/IndentArray:
-  Enabled: false
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
-Metrics/BlockLength:
+# NOTE: for code examples in tests
+Lint/EmptyBlock:
   Exclude:
-    - spec/**/*
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Metrics/PerceivedComplexity:
-  Max: 10
-
-Metrics/MethodLength:
-  Max: 20
-
-RSpec/ContextWording:
-  Enabled: false
-
-RSpec/HookArgument:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 6
-
-RSpec/MessageSpies:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/LetSetup:
-  Enabled: false
-
-RSpec/AnyInstance:
-  Enabled: false
+    - spec/**/*.rb
 
-RSpec/MultipleSubjects:
+Style/RedundantBegin:
   Enabled: false
 
-RSpec/EmptyLineAfterSubject:
+# NOTE: for code clarity in tests
+RSpec/LeakyConstantDeclaration:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,38 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.7.0] 2021-06-22
+### Added
+- Support for Ruby@2.7.2, Ruby@3.0.0;
+
+### Changed
+- No more `TravisCI` (TODO: migrate to `Github Actions`);
+- Updated development dependencies;
+
+## [0.6.0] 2018-03-28
+### Changed
+- Removed verbose code from `#__actual_context__` and `#method` methods of
+  `Symbiont::PublicTrigger` and `Symbiont::PrivateTrigger` classes.
+
+## [0.5.0] 2018-03-28
+### Added
+- Support for method dispatching for `BasicObject` instances (which does not support `#respond_to?` method);
+- Support for method extracting for `BasicObject` instances (which does not support `#method` method);
+- Updated development dependencies;
+- Support for `Ruby@2.6.2`, `Ruby@2.5.5`;
+
+## [0.4.0] 2018-10-25
+### Added
+- Support for Ruby@2.5.3, Ruby@2.4.5, Ruby@2.3.8;
+- Updated development dependencies;
+
+### Changed
+- End of Ruby@2.2;
+
+## [0.3.0] 2018-06-15
+### Added
+- `Symbiont::Isolator` - proc object isolation layer for delayed invocations;
+
 ## [0.2.0] 2018-04-22
 ### Added
 - Logo ^_^ (special thanks to **Viktoria Karaulova**)

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in symbiont-ruby.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    symbiont-ruby (0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    armitage-rubocop (1.10.0)
+      rubocop (= 1.10.0)
+      rubocop-performance (= 1.9.2)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.2.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    ffi (1.15.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.1)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.2.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    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.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.10.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      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, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.9.2)
+      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.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.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_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    steep (0.44.1)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 2.7)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 1.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
+    typeprof (0.14.1)
+      rbs (>= 1.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  armitage-rubocop (~> 1.8)
+  bundler
+  pry
+  rake
+  rbs (~> 1.0)
+  rspec (~> 3.10)
+  simplecov (~> 0.21)
+  steep (~> 0.40)
+  symbiont-ruby!
+  typeprof (~> 0.12)
+  yard
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Rustam Ibragimov
+Copyright (c) 2017-2020 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,15 +3,13 @@
   <h1 align="center">
     Symbiont<br />
     <a href="https://badge.fury.io/rb/symbiont-ruby"><img src="https://badge.fury.io/rb/symbiont-ruby.svg"></a>
-    <a href="https://travis-ci.org/0exp/symbiont-ruby"><img src="https://travis-ci.org/0exp/symbiont-ruby.svg?branch=master"></a>
-    <a href="https://coveralls.io/github/0exp/symbiont-ruby?branch=master"><img src="https://coveralls.io/repos/github/0exp/symbiont-ruby/badge.svg?branch=master"></a>
   </h1>
 </p>
 
 **Symbiont** is a cool implementation of proc-objects execution algorithm: in the context of other object,
-but with the preservation of the closed environment of the proc object and with the ability of control the method dispatch
+but with the preservation of the captured environment of the proc object and with the ability of control the method dispatch
 inside it. A proc object is executed in three contexts: in the context of required object, in the context of
-a closed proc's environment and in the global (Kernel) context.
+a captured proc's environment and in the global (Kernel) context.
 
 # Installation
 
@@ -45,7 +43,7 @@ require 'symbiont'
 - [Usage](#usage)
   - [Context management](#context-management)
   - [Supported method delegation directions](#supported-methods-delegation-directions)
-  - [Proc object invokation](#proc-object-invokation)
+  - [Proc object invocation](#proc-object-invocation)
     - [Considering public methods only (.evaluate)](#considering-public-methods-only-evaluate)
     - [Considering private and public methods (.evaluate_private)](#considering-private-and-public-methods-evaluate_private)
   - [Getting method-objects (Method)](#getting-method-objects-method)
@@ -55,18 +53,19 @@ require 'symbiont'
     - [Mixing a module with default delegation direction](#mixing-a-module-with-default-delegation-direction)
     - [Mixing a module with certain delegation direction](#mixing-a-module-with-certain-delegation-direction)
   - [Multiple inner contexts](#multiple-inner-contexts)
+  - [Isolator - proc object isolation layer for delayed invocations](#isolator---proc-object-isolation-layer-for-delayed-invocations)
 
 # Problems and motivaiton
 
 The main problem of `instance_eval` / `instance exec` / `class_eval` / `class_exec` is that the binding (self)
-inside a proc-objec is replaced with the object in where a proc object is executed. This allows you to delegate all methods closed by a proc to another object.
-But this leads to the fact that the proc object loses access to the original closed environment.
-Symbiont solves this problem by allowing to proc to be executed in the required context while maintaining access to the methods of the closed environemnt
+inside a proc-object is replaced with the object in where a proc object is executed. This allows you to delegate all methods captured by a proc to another object.
+But this leads to the fact that the proc object loses access to the original captured environment.
+Symbiont solves this problem by allowing the proc to be executed in the required context while maintaining access to the methods of the captured environment
 (including the global context).
 
 ---
 
-A prroblem with `instance_eval` / `instance_exec` / `class_eval` / `class_exec`:
+A problem with `instance_eval` / `instance_exec` / `class_eval` / `class_exec`:
 
 ```ruby
 class TableFactory
@@ -83,7 +82,7 @@ class Migration
   class << self
     def create_table(&block)
       TableFactory.new.tap do |table|
-        table.instance_eval(&block) # NOTE: closure invokation
+        table.instance_eval(&block) # NOTE: closure invocation
       end
     end
   end
@@ -116,7 +115,7 @@ class Migration
   class << self
     def create_table(&block)
       TableFactory.new.tap do |table|
-        Symbiont::Executor.evaluate(table, &block) # NOTE: intercept closure invokation by Symbiont
+        Symbiont::Executor.evaluate(table, &block) # NOTE: intercept closure invocation by Symbiont
       end
     end
   end
@@ -137,15 +136,15 @@ Proc-object is executed in three contexts at the same time:
 Methods (called internally) are delegated to the context that is first able to respond.
 The order of context selection depends on the corresponding context direction parameter.
 By default the delegation order is: object context => closure context => global context.
-If no context is able to respond to the method, an exception is thrown (`Symbiont::Trigger::ContextNoMethodError`).
-Symbiont can consider the visiblity of methods when executing.
+If no context is able to respond to the method, an exception is raised (`Symbiont::Trigger::ContextNoMethodError`).
+Symbiont can consider the visibility of methods when executing.
 
 
 # Usage
 
 ## Context management
 
-Imagine that in a real application we have the following gode and the corresponding closure:
+Imagine having the following code and the corresponding clojure in the real application:
 
 ```ruby
 def object_data
@@ -177,16 +176,15 @@ How a proc object will be processed, which context will be selected, how to make
 
 ## Supported methods delegation directions
 
-Delegation order is set by a constant and passed as a parameter in the execution of the proc
-and the generation of a special mixin module, allowing any class or instance to become a symbiont.
+Delegation order might be passed as a parameter to the proc execution
+and to the special mixin module, allowing any class or instance to become a symbiont.
 
-Supported contexts
+- Supported contexts:
+  - inner context - an object where proc is executed;
+  - outer context - external environment of the proc object;
+  - kernel context - global Kernel context.
 
-- inner context  - an object where proc is executed;
-- outer context  - external environment of the proc object;
-- kernel context - global Kernel context.
-
-Symbiont::IOK is chosen by default (`inner context => outer context => kernel context`)
+Symbiont::IOK is chosen by default (`inner context => outer context => kernel context`).
 
 ```ruby
 Symbiont::IOK # Inner Context  => Outer Context  => Kernel Context (DEFAULT)
@@ -197,7 +195,7 @@ Symbiont::KOI # Kernel Context => Outer Context  => Inner Context
 Symbiont::KIO # Kernel Context => Inner Context  => Outer Context
 ```
 
-## Proc object invokation
+## Proc object invocation
 
 `Symbiont::Executor` allows you to execute proc objects in two modes of the delegation:
 
@@ -206,11 +204,11 @@ Symbiont::KIO # Kernel Context => Inner Context  => Outer Context
 - public and private methods:
   - `evaluate_private(*required_contexts, [context_direction:], &closure)`
 
-If no context is able to respond to the required method - `Symbiont::Trigger::ContextNoMethodError` exception is thrown.
+If none of contexts is able to respond to the required method - `Symbiont::Trigger::ContextNoMethodError` exception is raised.
 
-In the case when an unsupported direction value is used - `Symbiont::Trigger::IncompatibleContextDirectionError` exception is thrown.
+In the case an unsupported direction value is used - `Symbiont::Trigger::IncompatibleContextDirectionError` exception is raised.
 
-If proc object isnt passed to the executor - `Symbiont::Trigger::UnprovidedClosureAttributeError` exception is thrown.
+If proc object isn't passed to the executor - `Symbiont::Trigger::UnprovidedClosureAttributeError` exception is raised.
 
 #### Considering public methods only (.evaluate)
 
@@ -265,9 +263,9 @@ end
 - public and private methods:
   - `private_method(method_name, *required_contexts, [context_direction:], &clojure)`
 
-If no context is able to respond to the required method - `Symbiont::Trigger::ContextNoMethodError` exception is thrown.
+If none of contexts is able to respond to the required method - `Symbiont::Trigger::ContextNoMethodError` exception is raised.
 
-In the case when an unsupported direction value is used - `Symbiont::Trigger::IncompatibleContextDirectionError` exception is thrown.
+In the case an unsupported direction value is used - `Symbiont::Trigger::IncompatibleContextDirectionError` exception is raised.
 
 #### Considering public methods only (.public_method)
 
@@ -305,7 +303,7 @@ Symbiont::Executor.private_method(:object_data, object, context_direction: Symbi
 
 `Symbiont::Context` is a mixin that allows any object to call proc objects in the context of itself as `Symbiont::Executor`.
 
-You can specify the default direction of the context delegation. `Symbiont::IOK` is used by default.
+You can specify the direction of the context delegation. `Symbiont::IOK` is used by default.
 
 #### Mixing a module with default delegation direction
 
@@ -368,7 +366,7 @@ SimpleObject.new.evaluate(Symbiont::IOK) { object_data }
 
 `Symbiont::Executor` allows you to work with multiple inner contexts (can receive a set of objects instead of the one main object).
 Each object will be used as an inner context in order they are passed.
-The method will be addressed to the object that responds first (in accordance with a chosen delegation order).
+The method will be addressed to the object that responds first (according to a chosen delegation order).
 
 ```ruby
 # Usage:
@@ -390,6 +388,48 @@ Symbiont::Executor.public_method(:data, object_a, object_b, &closure).call # =>
 Symbiont::Executor.public_method(:info, object_a, object_b, &closure).call # => "object_info"
 ```
 
+## Isolator - proc object isolation layer for delayed invocations
+
+`Symbiont::Isolator` is a special object that wraps your proc object from any place and provides
+an ability to invoke this proc object lazily inside an any series of contexts.
+All `Symbiont::Executor` features are supported (by the way, `Symbiont::Executor`
+uses `Symbiont::Isolator` under the hood).
+
+```ruby
+# Usage:
+
+# with default direction (Symbiont::IOK)
+isolator = Symbiont::Isolator.new { call_any_method }
+
+# with custom direction
+isolator = Symbiont::Isolator.new(default_direction: Symbiont::KIO) { call_any_method }
+
+# invocation
+isolator.evaluate(object_a, object_b) # use default direction defined on instantiation
+isolator.evaluate(object_a, object_b, direction: Symbiont::KOI) # use custom direction
+# same for #.evaluate_private
+
+# getting a method object
+isolator.public_method(:call_any_method, object_a, object_b) # use default direction defined on instantiation
+isolator.public_method(:call_any_method, object_a, object_b, direction: Symbiont::KIO) # use custom direction
+isolator.private_method(...)
+# same for #.private_method
+```
+
+# Roadmap
+
+- support for toplevel context (`TOPLEVEL_BINDING`);
+- `fiber teleports`;
+- official support for **Ruby@3**;
+
+# Build
+
+```shell
+bundle exec rake rubocop
+bundle exec rake yardoc
+bundle exec rake rspec
+```
+
 # Contributing
 
 - Fork it ( https://github.com/0exp/symbiont-ruby/fork )