interactor-extended 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5385744e8c2e5ec55ee5003c1d0052ea4d4ee1bd637e9b3257eb8c52b77ce96
+  data.tar.gz: b49f5f6edc03cf2e7029f881968f3352941d0b80a18c8266999fa6a43aaf96cd
+SHA512:
+  metadata.gz: 6608cac5941d6792a7664323e1b4ecfbf5877d05cdf1c197b1aa3e14a6f955a4d6e77fdbdb54b4651d9f842c20e7b6f59707f2c2d9276517744ed6c7e0f69fdd
+  data.tar.gz: 2e0c6ce5ca3b23f3ce8cd194347d11047ad12a38f89c9f32a4cba82921c7d110f619b26e7dc9bb1e086e5a4cae81b7044f812ed4fc9129d608385ca7af8cd5a3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2.2
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'zzz/**/*'
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+  VersionAdded: '0.9'
+  AllowedConstants: []
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods: ['describe', 'context']
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-04-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at prizrack13@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Anatolii Varanytsia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Interactor::Extended
+
+[![Quality Checks](https://github.com/Prizrack13/interactor-extended/actions/workflows/pull-requests.yml/badge.svg)](https://github.com/Prizrack13/interactor-extended/actions/workflows/pull-requests.yml)
+
+A powerful extension for the `interactor` gem, providing a set of modules. Lightweight context, self-documented input/output attributes, logging, job integration, duration tracking debug, and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interactor-extended'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install interactor-extended
+```
+
+## Usage
+
+```ruby
+class MyInteractor
+  include Interactor::Operation
+
+  input :id, Integer, require: true
+  output :user, User
+
+  def call
+    logger.info "Processing user: #{id}"
+    self.user = User.find(id)
+  rescue ActiveRecord::RecordNotFound
+    context.fail!(error: 'User not found')
+  end
+end
+
+result = MyInteractor.call(id: 1)
+result.success? # => true
+result.user     # => #<User ...>
+```
+
+## Documentation
+
+### Core Modules
+- [Operation](docs/operation.md)
+- [Flow](docs/flow.md)
+- [Organize](docs/organize.md)
+- [LightContext](docs/light_context.md)
+- [ContextDefinition & Contextable](docs/context_definition.md)
+
+### Extensions & Utilities
+- [Duration](docs/duration.md)
+- [Loggable](docs/loggable.md)
+- [Jobify](docs/jobify.md)
+- [Populate](docs/populate.md)
+- [Extended](docs/extended.md)
+- [Colorize](docs/colorize.md)
+
+### Additional Guides
+- [Configuration](docs/configuration.md)
+- [Best Practices](docs/best_practices.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/prizrack13/interactor-extended. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/prizrack13/interactor-extended/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Interactor::Extended project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/prizrack13/interactor-extended/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/docs/colorize.md

@@ -0,0 +1,22 @@
+# Interactor::Colorize
+
+Provides ANSI color codes for terminal output. Used internally by `ColorStringFormatter` but available for custom logging.
+
+**Example:**
+```ruby
+require 'interactor/colorize'
+
+puts Interactor::Colorize.colorize('Success', :green)
+puts Interactor::Colorize.colorize('Warning', :yellow)
+puts Interactor::Colorize.colorize('Error', :red)
+
+class SimpleInteractor
+  include Interactor::Operation
+
+  def call
+    puts colorize('Success', :green)
+  end
+end
+```
+
+[Back to README](../README.md)

data/docs/configuration.md

@@ -0,0 +1,63 @@
+# Configuration
+
+Global configuration can be set via `Interactor::Extended.configure`. This is typically done during application boot.
+
+```ruby
+Interactor::Extended.configure do |config|
+  config.logger = Rails.logger
+  config.type = :light # Options: :ctx, :light, :legacy, :all, :all_debug
+  # config.type = [Interactor::Contextable]
+  config.duration_format = :json # Options: :json, :string, :color_string
+  config.on_duration = ->(duration) { print duration }
+end
+```
+
+## Types
+By default, including `Interactor::Operation` includes the full list of modules.
+You can use a predefined set or create your own list.
+
+```ruby
+# Also you can include in a specific class another set
+# include ::Interactor::Operation[:light]
+# for example you need high performance class
+# include ::Interactor::Operation[:base] # just base
+
+TYPES = {
+  base: [], # no extensions just Interactor or Flow 
+  ctx: [::Interactor::Contextable], # improved context.
+  light: [ # Core set with light context definition
+    ::Interactor::Contextable,
+    ::Interactor::LightContextDefinition,
+    ::Interactor::Populate,
+    ::Interactor::Organize
+  ],
+  legacy: [ # Base set with context validation and default + jobify
+    ::Interactor::Contextable,
+    ::Interactor::ContextDefinition,
+    ::Interactor::Populate,
+    ::Interactor::Organize,
+    ::Interactor::Jobify
+  ],
+  all: [ # all modules
+    ::Interactor::Contextable,
+    ::Interactor::ContextDefinition,
+    ::Interactor::Populate,
+    ::Interactor::Organize,
+    ::Interactor::Jobify,
+    ::Interactor::Colorize,
+    ::Interactor::Loggable
+  ],
+  all_debug: [ # all modules + modules good for debug
+    ::Interactor::Contextable,
+    ::Interactor::ContextDefinition,
+    ::Interactor::Populate,
+    ::Interactor::Organize,
+    ::Interactor::Jobify,
+    ::Interactor::Colorize,
+    ::Interactor::Loggable,
+    ::Interactor::Duration
+  ]
+}
+```
+
+[Back to README](../README.md)

data/docs/context_definition.md

@@ -0,0 +1,21 @@
+# Interactor::ContextDefinition
+
+Provides type-safe input/output definitions with validation, requirement checks, and array handling.
+It creates read/write methods and avoid OpenStruct performance issues. Since it is use context[].
+
+**Example:**
+```ruby
+class TypedInteractor
+  include Interactor::Operation
+
+  input :a, Integer
+  input :b, String, require: true
+  output :c, [Integer, String], array: true
+  def call
+    # Validation automatically checks types and requirements
+    self.c = [a, b]
+  end
+end
+```
+
+[Back to README](../README.md)

data/docs/duration.md

@@ -0,0 +1,37 @@
+# Interactor::Duration
+
+Tracks execution time for each interactor in a flow. Supports multiple formatters for output customization.
+
+**Formatters:**
+- :json => `JsonFormatter`: Returns JSON-compatible array of hashes.
+- :string => `StringFormatter`: Returns a plain text table.
+- :color_string => `ColorStringFormatter`: Returns an ANSI-colored string for terminal output.
+
+**Configuration:**
+```ruby
+Interactor::Extended.configure do
+  _1.duration_format = :color_string
+  _1.on_duration = ->(duration) { puts duration }
+end
+```
+
+Also you can do benchmark of methods by calling duration before method or duration(true) to track all methods in class.
+```
+class Operation
+  include Interactor::Operation
+  
+  duration # or duration(true)
+  def call
+    ...
+  end
+end
+```
+
+**Example Output:**
+```
+- Flow   count: 1   time: 53040.76   own: 27358.89
+- Operation count: 2771 time: 9.27     own: 9.27
+- Operation#call count: 2771 time: 9.27     own: 9.27
+```
+
+[Back to README](../README.md)

data/docs/flow.md

@@ -0,0 +1,25 @@
+# Interactor::Flow
+
+Allows chaining multiple interactors sequentially. The context is passed from one interactor to the next, enabling complex workflows.
+
+**Example:**
+```ruby
+class SimpleSecondInteractor
+  include Interactor::Operation
+
+  def call
+    p context.data # Receives data from SimpleInteractor
+  end
+end
+
+class SimpleFlow
+  include Interactor::Flow
+  
+  organize SimpleInteractor, SimpleSecondInteractor
+end
+
+# Runs both interactors in sequence
+SimpleFlow.call!(a: 2)
+```
+
+[Back to README](../README.md)

data/docs/jobify.md

@@ -0,0 +1,38 @@
+# Interactor::Jobify
+
+Integrates interactors with background job queues (e.g., Sidekiq, ActiveJob). Allows conditional async execution.
+
+**Example:**
+```ruby
+class UserInteractorJob < AsyncJob
+  queue_as :default
+
+  def perform(params)
+    user = User.find(params[:user_id])
+    ::UserInteractor.call!(user: user)
+  end
+end
+
+class UserInteractor
+  include Interactor::Operation
+
+  # you can pass klass name
+  # jobify(klass: AnotherJob)
+  # jobify(default: true) # it jobify by default
+  jobify { |interactor| { user_id: interactor.user.id } }
+  
+  input :user, User
+
+  def call
+    logger.debug "Processing user: #{user.email}"
+  end
+end
+
+# Synchronous execution
+UserInteractor.call!(user: User.first)
+
+# Asynchronous execution
+UserInteractor.call!(user: User.first, jobify: true)
+```
+
+[Back to README](../README.md)

data/docs/light_context.md

@@ -0,0 +1,24 @@
+# Interactor::LightContext
+
+A lightweight, `BasicObject`-based context implementation. It minimizes overhead and is ideal for high-performance scenarios where standard context features are unnecessary. Unlike the standard context, it does not inherit from `Struct` or `OpenStruct`, but instead delegates attribute access to an underlying hash.
+
+**Key Features:**
+- Extremely low memory footprint
+- Fast attribute access via `method_missing` delegation
+- Compatible with standard interactor workflows
+
+**Example:**
+```ruby
+class FastInteractor
+  include Interactor::Operation
+
+  def call
+    context.value = 42
+  end
+end
+```
+
+**Note:** Because `LightContext` inherits from `BasicObject`, it lacks many standard Ruby object methods. It relies on `respond_to_missing?` and `method_missing` to provide context-like behavior. Use it when performance is critical and you don't need the full context API.
+In most cases you should use context[:value] for better performance.
+
+[Back to README](../README.md)

data/docs/light_context_definition.md

@@ -0,0 +1,19 @@
+# Interactor::LightContextDefinition
+
+It similar to Interactor::ContextDefinition but it basically creates only read/write methods.
+
+**Example:**
+```ruby
+class TypedInteractor
+  include Interactor::Operation
+
+  input :a, Integer
+  input :b, String, require: true
+  output :c, [Integer, String], array: true
+  def call
+    self.c = [a, b]
+  end
+end
+```
+
+[Back to Table of Contents](../interactors.md)

data/docs/loggable.md

@@ -0,0 +1,17 @@
+# Interactor::Loggable
+
+Adds a logger instance to the interactor context. Automatically configures log levels and formatting.
+
+**Example:**
+```ruby
+class LoggedInteractor
+  include Interactor::Operation
+
+  def call
+    logger.debug "Processing context: #{context.inspect}"
+    logger.info "Completed successfully"
+  end
+end
+```
+
+[Back to README](../README.md)

data/docs/operation.md

@@ -0,0 +1,34 @@
+# Interactor::Operation
+
+The foundational module for creating interactors. It provides context management, success/failure handling, and integrates seamlessly with other extensions.
+
+**Example:**
+```ruby
+class SimpleInteractor
+  include Interactor::Operation
+
+  def call
+    # Access context values
+    p context.a
+    
+    # Fail the interactor if validation fails
+    context.fail!(error: 'Invalid input') unless context.a.is_a?(Integer)
+    
+    # Set output values
+    context.data = context.a * 2
+  end
+end
+
+# Execution
+result = SimpleInteractor.call(a: 1)
+result.success? # => true
+result.data     # => 2
+
+result = SimpleInteractor.call(a: '')
+result.success? # => false
+
+# Raises Interactor::Failure if not successful
+SimpleInteractor.call!(a: '') 
+```
+
+[Back to README](../README.md)

data/docs/organize.md

@@ -0,0 +1,20 @@
+# Interactor::Organize
+
+It adds useful methods.
+With organize key you can run only specific interactors.
+Also, you can run interactos in parallel way using thread method.
+
+**Example:**
+```ruby
+class ParallelFlow
+  include Interactor::Flow
+
+  organize(
+    thread(SimpleInteractor),
+    thread(SimpleSecondInteractor)
+  )
+end
+ParallelFlow.call!(organize: [SimpleInteractor])
+```
+
+[Back to README](../README.md)

data/docs/populate.md

@@ -0,0 +1,34 @@
+# Interactor::Populate
+
+Enables selective context passing between interactors. Useful when you want to copy/update specific keys in the parent context.
+By default, it copies all keys started with underscore.
+
+**Example:**
+```ruby
+class AnotherInteractor
+  include Interactor::Operation
+
+  input :a
+  output :c
+  def call
+    self.c = a * 2
+  end
+end
+
+class SimpleInteractor
+  include Interactor::Operation
+
+  input :a
+  input :b
+  def call
+    AnotherInteractor.call!(context) # it will populate all context
+    p b
+    AnotherInteractor.call!({ a: a * 2 }, context, :c)
+    p context.c
+    # or 
+    # AnotherInteractor.call!(a: a * 2, context: context, context_keys: %i[c])
+  end
+end
+```
+
+[Back to README](../README.md)