lalka 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41fe8edb888640fa3d3eb9d43d97ea5070854340
-  data.tar.gz: f7be63f6f945e73393619c1d8362460c501f9203
+  metadata.gz: 8a73f1888ec88d74b7512761a7ef1a1b225896ea
+  data.tar.gz: d9414cfc7f078a2ca1b5fb55db185109b7939bc8
 SHA512:
-  metadata.gz: 01926a458f59fdabd143ddf2d21e6d9c7a3ed5f05159fd5b4e4fccb68ad341e801f485152965951efc034f71b7459385e23233363251ab7eb3eec193c7488b14
-  data.tar.gz: b036dd53768ca2df155bd152d1e21560b43819e8f85de9e820ec0c3250dc366d2ee82ccf676f9e778276bbf0bc710797af386fe408a5029ad92e5dd9fc2e854d
+  metadata.gz: b0ad66f8cb854dd0ba9d7796af9d6ca7b397aaa874fbf781913450e83b3e3626c61d474461604e4e4034fd81a051da61d6b49788d0644259751167cd042f4ceb
+  data.tar.gz: fad058b50f8e5231a817d733ed995ba04f409742b08b377a8761b6bf0ff5c8f936870f3378a0bc8a38c202a553d07c0edce36bc1dec9d622b726e752477b76c5

data/README.md

@@ -4,6 +4,113 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 TODO: Delete this and the text above, and describe your gem
 
+# Usage
+
+### Create:
+```ruby
+  task = Lalka::Task.new do |t| # block is not executed untill fork or fork_wait is called
+    t.resolve(value) # resolve task to a value
+    # or
+    t.reject(error) # reject task with an error
+  end
+```
+
+### Create with predefined state:
+```ruby
+  resolved_task = Lalka::Task.resolve(value) # task which resolves to a value
+  rejected_task = Lalka::Task.reject(error) # task which rejects to a value
+```
+
+### fork:
+```ruby
+  # fork is nonblocking, returns nil
+  task.fork do |t|
+    t.on_success do |value|
+      # do something with a value
+    end
+
+    t.on_error do |error|
+      # handle error
+    end
+  end
+```
+
+### fork_wait:
+```ruby
+  # fork_wait blocks and returns Either from "dry-monads" gem
+  task = Lalka::Task.resolve(99)
+
+  result = task.fork_wait do |t|
+    t.on_success do |value|
+      value + 1
+    end
+
+    t.on_error do |error|
+      # ...
+    end
+  end
+
+  result # Right(100)
+```
+
+```ruby
+  task = Lalka::Task.reject('error')
+
+  result = task.fork_wait do |t|
+    t.on_success do |value|
+      # ...
+    end
+
+    t.on_error do |error|
+      "Error: " + error
+    end
+  end
+
+  result # Left("Error: error")
+```
+
+### map:
+```ruby
+  task = Lalka::Task.resolve(99).map { |v| v + 1 }.map { |v| v.to_s + "!" }
+
+  result = task.fork_wait
+  result # Right("100!")
+```
+
+```ruby
+  task = Lalka::Task.reject('error').map { |v| v + 1 }.map { |v| v.to_s + "!" }
+
+  result = task.fork_wait
+  result # Left("error")
+```
+
+### bind:
+```ruby
+  task = Lalka::Task.resolve(99).bind { |v| Lalka::Task.resolve(v + 1) }
+
+  result = task.fork_wait
+  result # Right(100)
+```
+
+### ap:
+```ruby
+  task = Lalka::Task.resolve(-> (v) { v + 1 }).ap(Lalka::Task.resolve(99))
+
+  result = task.fork_wait
+  result # Right(100)
+```
+
+```ruby
+  task1 = Lalka::Task.resolve(99)
+  task2 = Lalka::Task.resolve(1)
+
+  result = task1.map { |x| -> (y) { x + y } }.ap(task2).fork_wait
+  result # Right(100)
+
+  result = Lalka::Task.resolve(-> (x) { -> (y) { x + y } }).ap(task1).ap(task2).fork_wait
+  result # Right(100)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/lalka/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Lalka
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/lalka.rb

@@ -18,6 +18,11 @@ module Lalka
           t.reject(error)
         end
       end
+
+      def id(internal)
+        internal.on_success { |v| v }
+        internal.on_error { |e| e }
+      end
     end
 
     def initialize(&block)
@@ -27,7 +32,13 @@ module Lalka
     def fork_wait
       queue = Queue.new
       internal = Internal.new(queue)
-      yield internal
+
+      if block_given?
+        yield internal
+      else
+        Task.id(internal)
+      end
+
       @computation.call(internal)
       queue.pop
     end
@@ -42,7 +53,7 @@ module Lalka
     def map
       Task.new do |t|
         fork do |this|
-          this.on_sucess do |value|
+          this.on_success do |value|
             t.resolve(yield value)
           end
 
@@ -56,11 +67,11 @@ module Lalka
     def bind
       Task.new do |t|
         fork do |this|
-          this.on_sucess do |first_value|
+          this.on_success do |first_value|
             other_task = yield first_value
 
             other_task.fork do |other|
-              other.on_sucess do |second_value|
+              other.on_success do |second_value|
                 t.resolve(second_value)
               end
 
@@ -82,7 +93,7 @@ module Lalka
         q = Queue.new
 
         fork do |this|
-          this.on_sucess do |fn|
+          this.on_success do |fn|
             q.push [:fn, fn]
           end
 
@@ -92,7 +103,7 @@ module Lalka
         end
 
         other_task.fork do |other|
-          other.on_sucess do |value|
+          other.on_success do |value|
             q.push [:arg, value]
           end
 
@@ -130,15 +141,15 @@ module Lalka
 
   class InternalAsync
     def resolve(value)
-      @on_sucess.call(value)
+      @on_success.call(value)
     end
 
     def reject(error)
       @on_error.call(error)
     end
 
-    def on_sucess(&block)
-      @on_sucess = block
+    def on_success(&block)
+      @on_success = block
       nil
     end
 
@@ -154,7 +165,7 @@ module Lalka
     end
 
     def resolve(value)
-      result = @on_sucess.call(value)
+      result = @on_success.call(value)
       @queue.push Dry::Monads.Right(result)
     end
 
@@ -163,8 +174,8 @@ module Lalka
       @queue.push Dry::Monads.Left(result)
     end
 
-    def on_sucess(&block)
-      @on_sucess = block
+    def on_success(&block)
+      @on_success = block
     end
 
     def on_error(&block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lalka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vlad Shmyhlo