kanal 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5be4ebd90337cb14ed84dcb5fec86bf2540997335af7ba27a5f23e17248bbb8
-  data.tar.gz: bbf992c6866512b63ced1eff0bb95dc08193defaf789c1e5224305260ea01886
+  metadata.gz: a3fa557dde04dae9b2a64daefc5b05e083331240c38701248bc3d8e2f02f136f
+  data.tar.gz: 2602843cdb547c6633322520e25b158def2d110952466cd8d80de9ab15ea8377
 SHA512:
-  metadata.gz: b89fd5d0408dca8af38358825ced60ca32de676097454fb8f818ab914eb459f8176057723aa73338f2ea3765afe20dc18e8076c571ed897e2ad811016d60f192
-  data.tar.gz: b9534af10b6c79218cd7a2c673a95d10e2a5b83336aee2f60de2bb669e98c9c5b75e7ca981e1c58defc4171635f43095b2b89d10d67ee12d6e5fb4f2ba18f421
+  metadata.gz: b87922aa8cdaaf257ed89b6a6eea547a22181ed7dd60c3284b8bb7f8cb68ed048de256f38fa50ddedc83cd758ed4b35172692513c0aa5773401433833ee82732
+  data.tar.gz: c882a6864449692ae4ce1dd63450b9ed61d12dc3d469468c355ec28b862a6f103ccaffe0eeab87e6993d7ad761d1111adf2f7d80e1d5f603acaa0b0e05a86d55

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.8.0] 2023-05-02
+- after_respond, after_respond_async to store blocks of code to be executed after responses. They do not spawn outputs
+- respond do; cancel end - now we can use cancel DSL keyword in response block if response should not be processed further to spawn an output
+
 ## [0.7.0] 2023-04-25
 - new output property for batteries: specifics. You can now add specific properties for whatever purpose like specifics.add, specifics.get. specifics.has?
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanal (0.7.0)
+    kanal (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -22,21 +22,19 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.1)
     multi_xml (0.6.0)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
     nokogiri (1.14.3-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     racc (1.6.2)
     rainbow (3.1.1)
     rake (13.0.6)
     rbs (2.8.4)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
@@ -44,16 +42,16 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.0)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -63,7 +61,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     ruby-debug-ide (0.7.3)
       rake (>= 0.8.1)
@@ -93,11 +91,11 @@ GEM
     thor (1.2.1)
     tilt (2.1.0)
     unicode-display_width (2.4.2)
-    yard (0.9.33)
+    yard (0.9.34)
 
 PLATFORMS
-  ruby
-  x86_64-darwin-21
+  x86_64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   httparty (= 0.21.0)
@@ -111,4 +109,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.4.5
+   2.4.9

data/lib/kanal/core/helpers/response_block.rb

@@ -3,14 +3,42 @@
 module Kanal
   module Core
     module Helpers
+      #
+      # Response block stores block of code
+      # to be executed at runtime and output to be created
+      #
       class ResponseBlock
         attr_reader :block
 
-        def initialize(block, async: false)
+        #
+        # Creates response block that stores block for evaluation
+        # at runtime, when output is constructed
+        #
+        # @param block [Proc] block of code to be evaluated at runtime and output to be constructed with it
+        # @param async [Boolean] block should be executed in thread
+        # @param functional [Boolean] block should be executed but not shipped as outpu
+        #
+        def initialize(block, async: false, functional: false)
           @block = block
           @async = async
+          @functional = functional
         end
 
+        #
+        # Whether response block is functional, means no output should
+        # be processed after execution of block
+        #
+        # @return [Boolean] <description>
+        #
+        def functional?
+          @functional
+        end
+
+        #
+        # Should execution of block be async?
+        #
+        # @return [Boolean] <description>
+        #
         def async?
           @async
         end

data/lib/kanal/core/helpers/response_execution_block.rb

@@ -7,12 +7,25 @@ require_relative "../helpers/input_output_pair"
 module Kanal
   module Core
     module Helpers
+      #
+      # This class executes response block and constructs output
+      # It is also can execute response block and disable moving it forward to the
+      # queue
+      #
       class ResponseExecutionBlock
         include Output
         include Logging::Logger
 
         attr_reader :response_block, :input
 
+        #
+        # Creating response execution block with all needed parameters
+        #
+        # @param response_block [Kanal::Core::Helpers::ResponseBlock] response block
+        # @param input [Kanal::Core::Input::Input] input provided by router
+        # @param default_error_node [Kanal::Core::Router::RouterNode] default error node if no user defined error node available
+        # @param error_node [Kanal::Core::Router::RouterNode] user (developer of bot) defined error node with information about error
+        #
         def initialize(response_block, input, default_error_node, error_node)
           @response_block = response_block
           @input = input
@@ -20,31 +33,61 @@ module Kanal
           @error_node = error_node
         end
 
+        #
+        # Execute response block and ship created output into the queue
+        #
+        # @param core [Kanal::Core::Core] core to access parameter registrators and stuff TODO: remove core here and provide registrator as dependency
+        # @param input_output_pair_queue [Kanal::Core::Helpers::Queue] queue where Kanal::Core::Helpers::InputOutputPair will be stored
+        #
+        # @return [void] <description>
+        #
         def execute(core, input_output_pair_queue)
           if response_block.async?
             # NOTE: Thread doesnt just die here - it's execution is continued in input_output_pair_queue.enqueue in router
             # then :item_queued hook is called inside and subsequently output_ready_block gets called in this thread
             # TODO: be aware that this can cause unexpected behaviour. Maybe think how to rework it.
             Thread.new do
-              input_output_pair_queue.enqueue InputOutputPair.new(@input, construct_output(core))
+              output = construct_output core
+              unless output.canceled?
+                input_output_pair_queue.enqueue InputOutputPair.new(@input, output)
+              end
             end
           else
-            input_output_pair_queue.enqueue InputOutputPair.new(@input, construct_output(core))
+            output = construct_output core
+            unless output.canceled?
+              input_output_pair_queue.enqueue InputOutputPair.new(@input, output)
+            end
           end
         end
 
         private
 
+        #
+        # Construct output from response block
+        #
+        # @param core [Kanal::Core::Core] core to access registrator
+        #
+        # @return [Kanal::Core::Output::Output] output created
+        #
         def construct_output(core)
           logger.debug "Constructing output for input ##{input.__id__}"
 
           output = Output::Output.new core.output_parameter_registrator, @input, core
 
+          # Canceling output to be processed further if response block is functional.
+          # Whole .functional thing is done to allow after_respond and after_respond_async blocks
+          # that should not spawn outputs
+          output.cancel if @response_block.functional?
+
           begin
             core.hooks.call :output_just_created, input, output
 
+            # Evaluating response block
             output.instance_eval(&@response_block.block)
           rescue => e
+            # Something wrong happened
+            # we try and construct error response provided by the user (dev created bot)
+            # if there is no any - we use default user response block
             logger.error "Failed to construct output for input ##{input.__id__}. Error: '#{e}'"
 
             output = Output::Output.new core.output_parameter_registrator, @input, core
@@ -56,6 +99,9 @@ module Kanal
             begin
               output.instance_eval(&error_node.response_blocks.first.block)
             rescue => e
+              # Something wrong happened in user defined error response or
+              # for some reason even default error response block failed
+              # Logging error and trying default error block
               logger.error "Failed to construct error response for input ##{input.__id__}. Error: '#{e}'"
 
               logger.debug "Trying to construct default error response for input ##{input.__id__}"

data/lib/kanal/core/output/output.rb

@@ -12,23 +12,41 @@ module Kanal
         include Helpers
         include Helpers::ParameterFinderWithMethodMissingMixin
 
-        attr_reader :input, :core
+        attr_reader :input, :core, :canceled
 
         #
-        # @param parameter_registrator [Kanal::Core::Helpers::ParameterRegistrator] 
+        # Creates new output with input, core and registered output parameters
+        #
+        # @param parameter_registrator [Kanal::Core::Helpers::ParameterRegistrator]
         # @param input [Kanal::Core::Input::Input] input required for dsl in respond blocks to have access to input
         # @param core [Kanal::Core::Core] core required also for dsl to access services or other information about core
         def initialize(parameter_registrator, input, core)
           @core = core
           @input = input
           @parameter_bag = ParameterBagWithRegistrator.new parameter_registrator
+          @canceled = false
         end
 
         def configure_dsl(&block)
           instance_eval(&block)
         end
 
+        def canceled?
+          @canceled == true
+        end
+
+        #
+        # Canceles this output.
+        # It won't be processed further and given out from router
+        #
+        # @return [void] <description>
+        #
+        def cancel
+          @canceled = true
+        end
+
         private :core
+
       end
     end
   end

data/lib/kanal/core/router/router.rb

@@ -176,7 +176,9 @@ module Kanal
 
           error_node = @error_node || @default_error_node
 
-          response_execution_blocks = response_blocks.map { |rb| ResponseExecutionBlock.new rb, input, @default_error_node, @error_node }
+          response_execution_blocks = response_blocks.map do |rb|
+            ResponseExecutionBlock.new rb, input, @default_error_node, @error_node
+          end
 
           response_execution_blocks.each do |reb|
             @response_execution_queue.enqueue reb

data/lib/kanal/core/router/router_node.rb

@@ -72,6 +72,18 @@ module Kanal
           @response_blocks.append ResponseBlock.new(block, async: true)
         end
 
+        def after_respond(&block)
+          raise "Router node with children cannot have response" unless @children.empty?
+
+          @response_blocks.append ResponseBlock.new(block, functional: true)
+        end
+
+        def after_respond_async(&block)
+          raise "Router node with children cannot have response" unless @children.empty?
+
+          @response_blocks.append ResponseBlock.new(block, functional: true, async: true)
+        end
+
         def response?
           !@response_blocks.empty?
         end

data/lib/kanal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanal
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - idchlife
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies: []
 description: Thanks to the core library, ecosystem of Kanal tools can be extendted
   to use with input-output bot-like behaviour, with routing