ract 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ebc9d97681afc2240e5001650e74d7250e76d20eb181955b402192377c8ca8
-  data.tar.gz: 8c121a49a43a61beff3a8f5f068997585951fbb4acd6e4432b89e8cad571ba0d
+  metadata.gz: 3ecff096a9e2b43c0c289ba25728a9948b768feb5c9b58d1921d012b4f753b5d
+  data.tar.gz: 5e68a831315a19d56823f8ebace7b3e1b3da916d98fc5bd36cf3afb9e19b8d42
 SHA512:
-  metadata.gz: 4b82bcf08d12aa28ffd6ac36f66572cb9b40a6a82e5f364d09eb37adbf0e79a7d7ac9f32a608dbd04dd62439487193ddd32ac3bca5d5a07f5d31de1306f8633b
-  data.tar.gz: b6cf72683bd4a7bdf7b7fd7756af98726627c56321ca65938663d47bd8469d8982031d97b2786f347ad4894f27eb255a43ef6766e2870a71cb1f4c42738e4284
+  metadata.gz: c0fa3ffc6fbbc2d5e593847de4b1cff4624f8bece56c3e2ca327ff1a45bb0e21d786a395447045f1740edc8a166a959a34ccadefa071ffef10527e41cca828e6
+  data.tar.gz: 6bf63a41dc25fe9699417f675bdcbfc89164973f17e6562d98f5f2dbd8c9691755684839f2e37d1cba4f39d3379ed93b08b877af7c767708d5598dc9442bd095

data/.rubocop.yml

@@ -0,0 +1,84 @@
+AllCops:
+  DisabledByDefault: false
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'node_modules/**/*'
+
+# Layout
+Layout/LineLength:
+  Max: 120
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+  Enabled: true
+
+Style/WordArray:
+  EnforcedStyle: brackets
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  SafeAutoCorrect: true
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# Metrics
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Naming
+Naming/VariableName:
+  EnforcedStyle: snake_case
+
+Naming/MethodName:
+  EnforcedStyle: snake_case
+
+# Bundler
+Bundler/OrderedGems:
+  Enabled: true

data/Gemfile

@@ -14,5 +14,4 @@ group :test do
   gem 'rspec'
   gem 'simplecov', '~> 0.22.0', require: false
   gem 'simplecov-console', '~> 0.9.3', require: false
-  gem 'standard', '~> 1.49'
 end

data/README.md

@@ -1,10 +1,27 @@
-<h1 style="z-index: 999;">Ract</h1>
+<div href="#" style="text-align: center; width: 50%; margin: 0 auto;">
+  <img src="./images/ract-no-bg.png" alt="Ract Logo"  style="position: relative; margin-top: -50px; z-index: 1; display: flex; align-items: center; justify-content: center; text-align: center; mix-blend-mode: overlay;">
+</div>
 
-<center>
-  <img src="./images/ract-no-bg.png" alt="Ract Logo" width="65%" style="position: relative; margin-top: -50px; z-index: -1; mix-blend-mode: overlay;">
-</center>
+<h1 style="z-index: 999; text-align: center;">Ract</h1>
 
-Ract is a lightweight Promise implementation for Ruby, providing a clean and intuitive way to handle asynchronous operations. It follows a similar pattern to JavaScript Promises, making it easy to write non-blocking code with proper error handling.
+Ract is a lightweight Promise implementation for Ruby, simliar color promises in JavaScript providing a clean and intuitive way to handle asynchronous operations.
+
+> [!NOTE]
+>
+> This gem don't use Ractor, we just Threads/Fibers to handle async operations
+>
+> Enjoy with us!
+
+
+[![CI](https://github.com/thadeu/ract/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/thadeu/ract/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/ract.svg)](https://badge.fury.io/rb/ract)
+
+# Features
+
+- Thread-safe
+- Similar to JavaScript Promises
+- Clean and intuitive API
+- Easy to use
 
 ## Installation
 
@@ -46,7 +63,11 @@ Create a new promise with a block that will be executed asynchronously:
 # Create a promise that resolves with a value
 promise = Ract.new { 42 } # or just Ract { 42 }
 
-# Create a promise that might reject with an error
+# Also use can you without .new
+# IMO, That's is more readable
+promise = Ract { 42 }
+
+# Create a promise that might reject with an error inside de block
 promise = Ract.new do
   if success_condition
     "Success result"
@@ -56,6 +77,9 @@ promise = Ract.new do
 end
 ```
 
+If you only create a IVar with `Ract`, it will be a pending promise, this promise will never resolve or reject itself,
+you need to resolve it using `.then`, `.await`, `Ract#take`, `Ract#all`, `Ract#all_settled`
+
 ### Handling Promise Resolution
 
 Use `.then` to handle successful resolution:
@@ -120,10 +144,11 @@ Wait for multiple promises to complete:
 ```ruby
 # Wait for all promises to resolve (will raise an error if any promise rejects)
 promises = [Ract.new { task1 }, Ract.new { task2 }]
-combined = Ract.all(promises)
+
+combined = Ract.take(promises)
 
 # Wait for all promises to resolve (will not raise errors, returns results with status)
-combined = Ract.all(promises, raise_on_error: false)
+combined = Ract.take(promises, raise_on_error: false)
 
 # Get results when all are settled (resolved or rejected)
 results = Ract.all_settled(promises)

data/lib/ract/class_methods.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true # :rdoc
+
+class Ract
+  module ClassMethods
+    def resolve(value = nil, auto_execute: false)
+      new(auto_execute: true) { value }.await
+    end
+
+    def reject(reason = nil, auto_execute: false)
+      new(auto_execute: true) { raise Rejected, reason }.await
+    end
+
+    def all(array = [], raise_on_error: true, &block)
+      return [] if array.empty?
+
+      result = Settled.new(
+        array,
+        type: :all,
+        executor: executor,
+        raise_on_error: raise_on_error
+      ).run!
+
+      block.call(result.value) if block_given?
+
+      result.value
+    end
+    alias take all
+
+    def all_settled(array = [], &block)
+      return [] if array.empty?
+
+      result = Settled.new(
+        array,
+        type: :all_settled,
+        executor: executor,
+        raise_on_error: false
+      ).run!
+
+      block.call(result.value) if block_given?
+
+      result.value
+    end
+
+    def executor
+      case Ract.config.isolation_level
+      in :thread then Executor::IsolatedThread
+      else
+        raise ArgumentError, "Unknown executor: #{Ract.config.isolation_level}"
+      end
+    end
+    private :executor
+  end
+end

data/lib/ract/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true # :rdoc:
+
+class Ract
+  class Configuration
+    attr_accessor :isolation_level
+
+    def initialize
+      @isolation_level = :thread
+    end
+  end
+
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/ract/executor/isolated_abstract.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true # :rdoc
+
+class Ract
+  class Executor
+    class IsolatedAbstract
+      def initialize(...)
+        raise NotImplementedError
+      end
+
+      def run(&block)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/ract/executor/isolated_thread.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true # :rdoc
+
+class Ract
+  class Executor
+    class IsolatedThread < IsolatedAbstract
+      attr_reader :promises, :remaining
+
+      def initialize(promises)
+        @promises = promises.keep_if { |promise| promise.is_a?(Ract) }
+        @queue = Thread::Queue.new
+        @remaining = promises.size
+      end
+
+      def run(&block)
+        return if @promises.empty?
+
+        enqueue
+        dequeue(&block)
+      end
+
+      def enqueue
+        @promises.each_with_index do |promise, index|
+          Thread.new do
+            try_block!(promise)
+
+            promise.then do |value|
+              @queue << [:success, index, value]
+            end&.rescue do |reason|
+              @queue << [:error, index, reason]
+            end
+          rescue StandardError => e
+            @queue << [:error, index, e]
+          end
+        end
+      end
+
+      def dequeue(&block)
+        while @remaining.positive?
+          block.call(@queue.pop)
+          @remaining -= 1
+        end
+      end
+
+      def try_block!(arr)
+        return unless arr.respond_to?(:execute_block)
+        return unless arr.state == Ract::PENDING
+
+        arr.execute_block
+      end
+    end
+  end
+end

data/lib/ract/ract.rb

@@ -113,7 +113,7 @@ class Ract
   alias catch rescue
 
   class << self
-    include SingleMethods
+    include ClassMethods
   end
 
   private

data/lib/ract/settled.rb

@@ -4,17 +4,15 @@ class Ract
   class Settled
     attr_reader :type, :raise_on_error
 
-    def initialize(promises, type: :all, raise_on_error: true)
+    def initialize(promises, executor: Executor::IsolatedThread, type: :all, raise_on_error: true)
       @results = Array.new(promises.size)
-      @batch = Batch.new(promises)
+      @executor = executor.new(promises)
       @type = type
       @raise_on_error = raise_on_error
     end
 
     def run!
-      return Result.new([]) if @batch.promises.empty?
-
-      @batch.run! do |type, index, value|
+      @executor.run do |type, index, value|
         case type
         when :success
           @results[index] = success_row(value)

data/lib/ract/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true # :rdoc
 
 class Ract
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/ract.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'ract/version'
-require 'ract/batch'
+require 'ract/executor/isolated_abstract'
+require 'ract/executor/isolated_thread'
+require 'ract/class_methods'
+require 'ract/configuration'
 require 'ract/result'
 require 'ract/settled'
 require 'ract/async'
-require 'ract/single_methods'
 require 'ract/ract'
 
 # A lightweight Promise implementation for Ruby

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ract
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Thadeu Esteves Jr
 bindir: exe
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies: []
 description: A simple and lightweight gem to wrapper Threads(Promises) like JavaScript
   in Ruby, adding a color to Ruby Threads
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -30,19 +31,21 @@ files:
 - images/ract-no-bg.png
 - lib/ract.rb
 - lib/ract/async.rb
-- lib/ract/batch.rb
+- lib/ract/class_methods.rb
+- lib/ract/configuration.rb
+- lib/ract/executor/isolated_abstract.rb
+- lib/ract/executor/isolated_thread.rb
 - lib/ract/ract.rb
 - lib/ract/result.rb
 - lib/ract/settled.rb
-- lib/ract/single_methods.rb
 - lib/ract/version.rb
-homepage: https://github.com/thadeu/ract-rb
+homepage: https://github.com/thadeu/ract
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/thadeu/ract-rb
-  source_code_uri: https://github.com/thadeu/ract-rb
-  changelog_uri: https://github.com/thadeu/ract-rb/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/thadeu/ract
+  source_code_uri: https://github.com/thadeu/ract
+  changelog_uri: https://github.com/thadeu/ract/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib

data/lib/ract/batch.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true # :rdoc
-
-class Ract
-  class Batch
-    attr_reader :promises, :remaining
-
-    def initialize(promises)
-      @promises = promises.keep_if { |promise| promise.is_a?(Ract) }
-      @queue = Thread::Queue.new
-      @remaining = promises.size
-    end
-
-    def run!(&block)
-      return if @promises.empty?
-
-      create_threads
-      process_results(&block)
-    end
-
-    def create_threads
-      @promises.each_with_index do |promise, index|
-        Thread.new do
-          try_block!(promise)
-
-          promise.then do |value|
-            @queue << [:success, index, value]
-          end&.rescue do |reason|
-            @queue << [:error, index, reason]
-          end
-        rescue StandardError => e
-          @queue << [:error, index, e]
-        end
-      end
-    end
-
-    def process_results(&block)
-      while @remaining.positive?
-        block.call(@queue.pop)
-        @remaining -= 1
-      end
-    end
-
-    def try_block!(promise)
-      return unless promise.respond_to?(:execute_block)
-      return unless promise.state == Ract::PENDING
-
-      promise.execute_block
-    end
-  end
-end

data/lib/ract/single_methods.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true # :rdoc
-
-class Ract
-  module SingleMethods
-    def resolve(value = nil, auto_execute: false)
-      new(auto_execute: true) { value }.await
-    end
-
-    def reject(reason = nil, auto_execute: false)
-      new(auto_execute: true) { raise Rejected, reason }.await
-    end
-
-    def all(promises, raise_on_error: true, auto_execute: false, &block)
-      return [] if promises.empty?
-
-      result = Settled.new(promises, raise_on_error: raise_on_error).run!
-
-      block.call(result.value) if block_given?
-
-      result.value
-    end
-    alias take all
-
-    def all_settled(promises, auto_execute: false, &block)
-      return [] if promises.empty?
-
-      result = Settled.new(promises, type: :all_settled).run!
-
-      block.call(result.value) if block_given?
-
-      result.value
-    end
-  end
-end