kanal 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22224712e17434c60d3b437d44a35a5a997dd739cddcf53eb365d588fdf19fcd
-  data.tar.gz: f6677a4a8bc6eacf2e41469ba4a36da1b324d3b7d9092ae9271aa1b9f3fa8be6
+  metadata.gz: 3a651f7ffee3a091afafa59e96d5c4e90d3f15ebd8fe5c0991ef0f3d25559cb5
+  data.tar.gz: 80a337f6047a542982f5167a1a15c73a9df90ffa95d6d24dc07bba881a4f575e
 SHA512:
-  metadata.gz: 5e1416fb809513b53627cb120d8b09dfb76cae30f952de0212a1c2edde48e01d733afb122189230d0e6426dba812d143a8b2fc35b8561fba95954ea0b0bccbe2
-  data.tar.gz: 3dcc90d49fa16f4df0482d77a94f3f21a7ddc12742983a8925714199100284bfb4d84a96bef19aa289c3ad1ebcc21996d3a27fb9874837b24ca343ba53f700d6
+  metadata.gz: 69b67d9f7886722abe0cc0b8ba27e30daecde925a275e3147b38c5b80bb1b9d041d1acdd33151be97c8e4a668888fbcf1819192dceb763e52104bfaa97a56ce4
+  data.tar.gz: fb12441c0c5797397cbc40e4517cc23c6a70c6604a0314961d4c9b203c02130464baefda7c6671cd31733112d4f131076de3d92482d695f10b7898c7b5c7b2c8

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.4.2] 2023-03-22
+- Adding any number of loggers can be now done with core.add_logger(l) - where l is logger that have same methods as default ruby logger (debug, warn, fatal, etc)
+- To get logger into your class you can include Kanal::Core::Logging::Logger - this will give you method .logger to get logger
+- Batteries now have .keyboard output property and several conditions for input
+
 ## [0.4.1] 2023-03-16
 - Added Attachment that can be used inside new input parameters in Batteries plugin
 - New input and output parameters in Batteries plugin: image, audio, file

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanal (0.5.0)
+    kanal (0.4.2)
 
 GEM
   remote: https://rubygems.org/

data/lib/kanal/core/conditions/condition.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -8,7 +8,7 @@ module Kanal
       # Base class for conditions
       # with this class you can
       class Condition
-        include Logging
+        include Logging::Logger
 
         attr_reader :name
 

data/lib/kanal/core/conditions/condition_creator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -8,7 +8,7 @@ module Kanal
       # This class helps creating conditions in dsl way,
       # with using helper methods
       class ConditionCreator
-        include Logging
+        include Logging::Logger
 
         def initialize(name)
           @name = name

data/lib/kanal/core/conditions/condition_pack.rb

@@ -2,7 +2,7 @@
 
 require_relative "./condition"
 require_relative "./condition_creator"
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -11,7 +11,7 @@ module Kanal
       # It is served as some kind of namespace for conditions, with specific
       # name of pack and helper methods
       class ConditionPack
-        include Logging
+        include Logging::Logger
 
         attr_reader :name
 

data/lib/kanal/core/conditions/condition_pack_creator.rb

@@ -2,7 +2,7 @@
 
 require_relative "./condition_pack"
 require_relative "./condition_creator"
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -10,7 +10,7 @@ module Kanal
       # This class helps in condition pack creation
       # with the help of dsl
       class ConditionPackCreator
-        include Logging
+        include Logging::Logger
 
         TEMP_NAME = :temp_name
 

data/lib/kanal/core/conditions/condition_storage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -8,7 +8,7 @@ module Kanal
       # This class contains all needed functionality to store,
       # search conditions
       class ConditionStorage
-        include Logging
+        include Logging::Logger
 
         def initialize
           @condition_packs = []

data/lib/kanal/core/core.rb

@@ -8,8 +8,8 @@ require_relative "./helpers/parameter_registrator"
 require_relative "./plugins/plugin"
 require_relative "./input/input"
 require_relative "./services/service_container"
-require_relative "./logger/logging"
-
+require_relative "./logging/logger"
+require_relative "./logging/configuration"
 
 module Kanal
   module Core
@@ -36,6 +36,7 @@ module Kanal
       include Plugins
       include Hooks
       include Services
+      include Logging::Logger
       include Logging
 
       # @return [Kanal::Core::Conditions::ConditionStorage]
@@ -223,9 +224,14 @@ module Kanal
       def register_hooks
         @hooks.register :input_just_created # input
         @hooks.register :input_before_router # input
+        @hooks.register :output_just_created # input, output
         @hooks.register :output_before_returned # input, output
       end
 
+      def add_logger(logger)
+        Kanal::Core::Logging::Configuration.add_logger logger
+      end
+
       private :register_hooks
     end
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "parameter_bag"
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -10,7 +10,7 @@ module Kanal
       # and if they are has needed by registrator allowances, types etc, whatever
       # registrator rules are stored for property
       class ParameterBagWithRegistrator < ParameterBag
-        include Logging
+        include Logging::Logger
 
         def initialize(registrator)
           super()

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

@@ -23,7 +23,7 @@ module Kanal
             # like that
             # setters: prop value
             # getters: prop
-            @parameter_bag.set(parameter_name, *args)
+            @parameter_bag.set parameter_name, args.first
           # means it is used as setter in dsl,
           # method call with argument
           else

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -21,7 +21,7 @@ module Kanal
       # Class holds parameter names that are allowed
       # to be used.
       class ParameterRegistrator
-        include Logging
+        include Logging::Logger
 
         def initialize
           @parameters_by_name = {}

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "../output/output"
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
     module Helpers
       class ResponseExecutionBlock
         include Output
-        include Logging
+        include Logging::Logger
 
         attr_reader :response_block, :input
 
@@ -40,6 +40,8 @@ module Kanal
           output = Output::Output.new core.output_parameter_registrator, input, core
 
           begin
+            core.hooks.call :output_just_created, input, output
+
             output.instance_eval(&@response_block.block)
 
             core.hooks.call :output_before_returned, input, output

data/lib/kanal/core/hooks/hook_storage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -10,7 +10,7 @@ module Kanal
       # attaching to hooks, calling hooks with arguments
       #
       class HookStorage
-        include Logging
+        include Logging::Logger
 
         def initialize
           @listeners = {}

data/lib/kanal/core/logging/composite_logger.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Kanal
+  module Core
+    module Logging
+      class CompositeLogger
+        # Property allowed_methods defines which methods can be called.
+        # These methods mirror standard Logger methods.
+        def initialize
+          @loggers = []
+          @allowed_methods = [:debug, :info, :warn, :error, :fatal, :unknown]
+        end
+
+        def add_logger(logger)
+          @loggers << logger
+        end
+
+        # This method gets called when calling any method in @allowed_methods.
+        # It passes message string to method call of every added logger.
+        #
+        # @param method [Symbol]
+        # @param message [String]
+        def method_missing(method, message)
+          # Getting caller class name to put into log message later.
+          begin
+            caller_class_name = "[" + caller[0].split(".rb").first.split("/").last.split('_').collect(&:capitalize).join + "]"
+          rescue
+            caller_class_name = "[ErrorGettingClassName]"
+          end
+
+          raise "Wrong method called for CompositeLogger" unless @allowed_methods.include? method
+
+          @loggers.each do |logger|
+            # progname is a property of standard Logger. It is a prefix for log message.
+            # In our case progname is used to store class name of class which calls for CompositeLogger methods.
+            logger.progname = caller_class_name
+            logger.send method, message
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/kanal/core/logging/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "composite_logger"
+
+module Kanal
+  module Core
+    module Logging
+      module Configuration
+        class << self
+          def composite_logger
+            get_or_create_composite_logger
+          end
+
+          def add_logger(logger)
+            @composite_logger.add_logger logger
+          end
+
+          private
+
+          def get_or_create_composite_logger
+            @composite_logger ||= CompositeLogger.new
+
+            @composite_logger
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/kanal/core/logging/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Kanal
+  module Core
+    module Logging
+      # Mixing in Logger in some class to get access to logger method
+      module Logger
+        # @return [CompositeLogger]
+        def logger
+          Kanal::Core::Logging::Configuration.composite_logger
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 require_relative "./router_node"
 require_relative "../helpers/queue"
 require_relative "../helpers/response_execution_block"
-require_relative "../logger/logging"
+require_relative "../logging/composite_logger"
 
 module Kanal
   module Core
@@ -14,7 +14,7 @@ module Kanal
       # router nodes and have a name.
       class Router
         include Helpers
-        include Logging
+        include Logging::Logger
 
         attr_reader :name, :core, :output_ready_block
 

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

@@ -2,7 +2,7 @@
 
 require_relative "../output/output"
 require_relative "../helpers/response_block"
-require_relative "../logger/logging"
+require_relative "../logging/composite_logger"
 
 module Kanal
   module Core
@@ -14,7 +14,7 @@ module Kanal
       class RouterNode
         include Output
         include Helpers
-        include Logging
+        include Logging::Logger
 
         attr_reader :parent,
                     :children

data/lib/kanal/core/services/service_container.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../logger/logging"
+require_relative "../logging/logger"
 
 module Kanal
   module Core
@@ -28,7 +28,7 @@ module Kanal
       # lifespan types.
       #
       class ServiceContainer
-        include Logging
+        include Logging::Logger
 
         TYPE_SINGLETON = :singleton
         TYPE_TRANSIENT = :transient

data/lib/kanal/plugins/batteries/batteries_plugin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "kanal/core/plugins/plugin"
+require_relative "keyboard"
 
 module Kanal
   module Plugins
@@ -17,7 +18,7 @@ module Kanal
           body_batteries core
           flow_batteries core
           attachments_batteries core
-          reply_markup_batteries core
+          keyboard_batteries core
         end
 
         def flow_batteries(core)
@@ -123,8 +124,12 @@ module Kanal
           core.register_output_parameter :file
         end
 
-        def reply_markup_batteries(core)
-          core.register_output_parameter :reply_markup
+        def keyboard_batteries(core)
+          core.register_output_parameter :keyboard
+
+          core.hooks.attach :output_just_created do |input, output|
+            output.keyboard = Keyboard.new
+          end
         end
       end
     end

data/lib/kanal/plugins/batteries/keyboard.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "kanal/core/logging/composite_logger"
+
+module Kanal
+  module Plugins
+    module Batteries
+      #
+      # This class provides methods to construct and get keyboard.
+      # You can construct keyboard inside respond do block in router.
+      # There are two ways of constructing a keyboard
+      # 1. Using #to_array method: provide 2-dimensional array of button names
+      # 2. Using #build method: provide block with calls to DSL method #row with button names as arguments
+      #
+      class Keyboard
+        include Kanal::Core::Logging
+
+        def initialize
+          @layout = []
+        end
+
+        # Use this method to pass names for buttons in 2-dimensional array of strings.
+        # Each sub-array represents a row of button names.
+        # Example call below is two rows of button names:
+        # keyboard.from_array [["B1", "B2"], ["B3"]]
+        #
+        # @param array [Array<Array<String>>]
+        #
+        def from_array(array)
+          unless array.instance_of? Array
+            logger.error "2-dimensional array was not provided. Type of provided object is #{array.class.name}"
+
+            raise "2-dimensional array was not provided"
+          end
+
+          array.each do |sub_array|
+            unless sub_array.instance_of? Array
+              logger.error "Value provided as row is not of Array type. Type of provided object is #{sub_array.class.name}"
+
+              raise "Value provided as row is not of Array type"
+            end
+
+            sub_array.each do |value|
+              unless value.instance_of? String
+                logger.error "Value provided as button name is not of String type. Type of provided object is #{sub_array.class.name}"
+
+                raise "Value provided as button name is not of String type"
+              end
+            end
+          end
+
+          @layout = array
+        end
+
+        #
+        # Use this method to pass block. Code inside block should call for DSL method row.
+        # Example below is two rows of button names
+        # keyboard.build do
+        #   row "B", "B2"
+        #   row "B3"
+        # end
+        #
+        # @param block [Proc]
+        #
+        def build(&block)
+          instance_eval &block
+        end
+
+        #
+        # Creates a row of button names, takes each provided arg and adds it to a row
+        #
+        # @param args [Array<String>]
+        #
+        def row(*args)
+          args.each do |value|
+            unless value.instance_of? String
+              logger.error "Value provided as button name is not of String type. Type of provided object is #{sub_array.class.name}"
+
+              raise "Value provided as button name is not of String type"
+            end
+          end
+
+          @layout.append args
+        end
+
+        #
+        # Returns constructed 2-dimensional array of strings.
+        # Each sub-array represents a row of button names.
+        #
+        # @return [Array<Array<String>>]
+        #
+        def to_a
+          @layout
+        end
+      end
+    end
+  end
+end

data/lib/kanal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - idchlife
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-03-22 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
@@ -29,7 +29,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- kanal.gemspec
 - lib/kanal.rb
 - lib/kanal/core/conditions/condition.rb
 - lib/kanal/core/conditions/condition_creator.rb
@@ -49,7 +48,9 @@ files:
 - lib/kanal/core/hooks/hook_storage.rb
 - lib/kanal/core/input/input.rb
 - lib/kanal/core/interfaces/interface.rb
-- lib/kanal/core/logger/logging.rb
+- lib/kanal/core/logging/composite_logger.rb
+- lib/kanal/core/logging/configuration.rb
+- lib/kanal/core/logging/logger.rb
 - lib/kanal/core/output/output.rb
 - lib/kanal/core/output/output_creator.rb
 - lib/kanal/core/plugins/plugin.rb
@@ -60,6 +61,7 @@ files:
 - lib/kanal/interfaces/simple_cli/simple_cli_interface.rb
 - lib/kanal/plugins/batteries/attachments/attachment.rb
 - lib/kanal/plugins/batteries/batteries_plugin.rb
+- lib/kanal/plugins/batteries/keyboard.rb
 - lib/kanal/version.rb
 - sig/kanal.rbs
 - sig/kanal/core/conditions/condition_pack.rbs
@@ -73,7 +75,7 @@ metadata:
   source_code_uri: https://github.com/idchlife/kanal
   changelog_uri: https://github.com/idchlife/kanal/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Kanal library
 test_files: []

data/kanal.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/kanal/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "kanal"
-  spec.version = Kanal::VERSION
-  spec.authors = ["idchlife"]
-  spec.email = ["idchlife@gmail.com"]
-
-  spec.summary = "Kanal library"
-  spec.description = "Thanks to the core library, ecosystem of Kanal tools can be extendted to use with input-output bot-like behaviour, with routing"
-  spec.homepage = "https://idchlife.github.io/kanal-documentation/"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.6"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/idchlife/kanal"
-  spec.metadata["changelog_uri"] = "https://github.com/idchlife/kanal/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata["rubygems_mfa_required"] = "true"
-end

data/lib/kanal/core/logger/logging.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-
-module Kanal
-  module Core
-    module Logging
-      # Logger instance will be saved inside class itself for future calls
-      @logger_instance
-
-      # Mixing in Logger in some class adds possibility to use logger instance method
-      def logger
-        @logger_instance ||= Logging.create_logger self.class.name
-      end
-
-      class << self
-        def create_logger(class_name)
-          logger = Logger.new STDOUT
-          logger.progname = class_name.rpartition(':').last
-          logger.datetime_format = "%d-%m-%Y %H:%M:%S"
-          logger
-        end
-      end
-    end
-  end
-end