kanal 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45f85bfae55ce0c37d296113ba2af2933667fd3fd7ec9e181ff12dd17105b524
+  data.tar.gz: 9f160009467a4cbf0412d266ae693b279064286ca91ec53e5ad55bb93582d31a
+SHA512:
+  metadata.gz: f4275c770b3607a4617e5413a4634e2436fcb245af8dd3c6d3c5a86b39b64a70020f87ddb4c23323b9fcf3b640fd45bf572992edee3041bb5b918d6989fc79ab
+  data.tar.gz: 9c11421ecd4b230ab8d994b17a016b9e9649c9820ae9ad04503c8bbfa77798fd323fda5249c47cc6bd712d19493a7373d68dbb78fe559f08f53d4a36194776d3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "ruby.interpreter.commandPath": "/Users/idchlife/.rvm/rubies/ruby-2.7.2/bin/ruby",
+  "ruby.useBundler": false,
+  "solargraph.commandPath": "bin/solargraph",
+  "solargraph.bundlerPath": "bin/bundle",
+  "solargraph.useBundler": true,
+  "solargraph.diagnostics": false
+}

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [Unreleased]
+
+## [0.3.0]
+- Kanal::Core::Core.get_plugin method added to get plugins for additional configuration by other plugins or developer code, if needed
+- Kanal::Core::Plugins::Plugin.rake_tasks method introduced, for plugins to have their own rake tasks that can be merged inside
+  some kind of parent rake tasks, whether it's users Rakefile or kanal framework/interface or something Rakefile
+
+## [0.2.5] - 2022-11-15
+- Private release with more features and tests, basically working core, router,
+  plugins, services, interfaces etc
+
+## [0.1.0] - 2022-05-24
+- Initial release of library in private repository, with basic building blocks
+  like core, router, etc
+

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kanal.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+# gem "method_source", "1.0.0"
+
+# Move outside to plugin repo
+# gem 'telegram-bot-ruby'
+
+group :development do
+  gem "rubocop", "~> 1.21"
+  gem "ruby-debug-ide"
+  gem "solargraph"
+  gem "yard"
+end
+
+group :test do
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    kanal (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mini_portile2 (2.8.0)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.33.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.45.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+
+DEPENDENCIES
+  kanal!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  ruby-debug-ide
+  simplecov
+  solargraph
+  yard
+
+BUNDLED WITH
+   2.3.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 idchlife
+
+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,45 @@
+# Kanal
+
+Welcome to kanal!
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add kanal
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install kanal
+
+## Usage
+
+TODO: Write usage instructions here
+
+## TODO
+
+- [DONE] ~provide default response for branch with subbranches because default response could be handy~
+    Provided with the :flow condition pack with condition :any
+- [DONE] ~rework hooks storage, make hooks without arguments validation~
+- provide default logger with base class. this logger service should be used by every other service/plugin etc
+- provide default response on error, when router node fails with error
+- [DONE] ~provide :source condition for :source~
+    Created :source condition pack
+- Allow to "append" conditions to condition packs
+
+
+## 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/[USERNAME]/kanal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/kanal.gemspec

@@ -0,0 +1,39 @@
+# 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
+end

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

@@ -0,0 +1,36 @@
+module Kanal
+  module Core
+    module Conditions
+      # Base class for conditions
+      # with this class you can
+      class Condition
+        attr_reader :name
+
+        def initialize(name, with_argument: false, &met_block)
+          @name = name
+
+          raise "Cannot create condition without block" unless met_block
+
+          @with_argument = with_argument
+
+          # NOTE: this whole bunch of code, including method, is used to allow
+          # in blocks returns without LocalJumpError
+          # Basically converting block/proc into lambda, which will allow
+          # unexpected returns for the comfortability of writing conditions
+          # Kudos to: https://stackoverflow.com/a/2946734/2739103
+          @proc_to_lambda_object = Object.new
+          @proc_to_lambda_object.define_singleton_method(:met_block, &met_block)
+        end
+
+        def with_argument?
+          @with_argument
+        end
+
+        # Check constructor for more info about this weird met block call
+        def met?(input, core, argument)
+          @proc_to_lambda_object.method(:met_block).call input, core, argument
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Kanal
+  module Core
+    module Conditions
+      # This class helps creating conditions in dsl way,
+      # with using helper methods
+      class ConditionCreator
+        def initialize(name)
+          @name = name
+          @met_block = nil
+          @with_argument = false
+        end
+
+        def create(&block)
+          instance_eval(&block)
+
+          raise "Please provide name for condition" unless @name
+          raise "Please provide met? block for condition #{@name}" unless @met_block
+
+          Condition.new @name, with_argument: @with_argument, &@met_block
+        end
+
+        def with_argument
+          @with_argument = true
+        end
+
+        def met?(&block)
+          @met_block = block
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require_relative "./condition"
+require_relative "./condition_creator"
+
+module Kanal
+  module Core
+    module Conditions
+      # This class stores conditions inside
+      # It is served as some kind of namespace for conditions, with specific
+      # name of pack and helper methods
+      class ConditionPack
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+          @conditions = []
+        end
+
+        def get_condition_by_name!(name)
+          condition = get_condition_by_name name
+
+          raise "Condition #{name} was not found in pack #{@name}. Maybe it was not added?" unless condition
+
+          condition
+        end
+
+        def get_condition_by_name(name)
+          @conditions.find { |c| c.name == name }
+        end
+
+        def register_condition(condition)
+          raise "Can register only conditions that inherit Condition class" unless condition.is_a? Condition
+
+          return self if condition_registered? condition
+
+          @conditions.append condition
+
+          self
+        end
+
+        def condition_registered?(condition)
+          @conditions.each do |c|
+            return true if c.name == condition.name
+          end
+
+          false
+        end
+
+        private :condition_registered?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require_relative "./condition_pack"
+require_relative "./condition_creator"
+
+module Kanal
+  module Core
+    module Conditions
+      # This class helps in condition pack creation
+      # with the help of dsl
+      class ConditionPackCreator
+        TEMP_NAME = :temp_name
+
+        def initialize(name)
+          @name = name
+          @conditions = []
+        end
+
+        def create(&block)
+          instance_eval(&block)
+
+          raise "Please provide condition pack name" unless @name
+
+          raise "Please provide conditions for condition pack #{@name}" if @conditions.empty?
+
+          pack = ConditionPack.new(@name)
+
+          @conditions.each do |c|
+            pack.register_condition c
+          end
+
+          pack
+        end
+
+        def add_condition(name, &block)
+          creator = ConditionCreator.new name
+          condition = creator.create(&block)
+          @conditions.append condition
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module Kanal
+  module Core
+    module Conditions
+      # This class contains all needed functionality to store,
+      # search conditions
+      class ConditionStorage
+        def initialize
+          @condition_packs = []
+        end
+
+        def get_condition_pack_by_name!(name)
+          pack = get_condition_pack_by_name name
+
+          raise "Condition pack #{name} is not registered, but was requested from ConditionStorage" unless pack
+
+          pack
+        end
+
+        def get_condition_pack_by_name(name)
+          @condition_packs.find { |p| p.name == name }
+        end
+
+        def condition_pack_or_condition_exists?(name)
+          pack = get_condition_pack_by_name name
+
+          unless pack
+            found_condition = false
+            # Checking every pack for conditions inside of it
+            @condition_packs.each do |cp|
+              condition = cp.get_condition_by_name name
+
+              if condition
+                found_condition = true
+                break
+              end
+            end
+
+            return found_condition
+          end
+
+          !pack.nil?
+        end
+
+        def register_condition_pack(pack)
+          return if condition_pack_exists? pack
+
+          raise "Condition pack should be descendant of ConditionPack class" unless pack.is_a? ConditionPack
+
+          @condition_packs.append pack
+        end
+
+        def condition_pack_exists?(pack)
+          !(@condition_packs.find { |cp| cp.name == pack.name }).nil?
+        end
+      end
+    end
+  end
+end